@selfcommunity/api-services 0.5.0-live.79 → 0.5.0-live.80
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/constants/Endpoints.js +31 -0
- package/lib/cjs/index.d.ts +3 -2
- package/lib/cjs/index.js +4 -1
- package/lib/cjs/services/livestream/index.d.ts +115 -0
- package/lib/cjs/services/livestream/index.js +159 -0
- package/lib/cjs/types/index.d.ts +2 -1
- package/lib/cjs/types/liveStream.d.ts +29 -0
- package/lib/cjs/types/liveStream.js +2 -0
- package/lib/esm/constants/Endpoints.js +31 -0
- package/lib/esm/index.d.ts +3 -2
- package/lib/esm/index.js +2 -1
- package/lib/esm/services/livestream/index.d.ts +115 -0
- package/lib/esm/services/livestream/index.js +154 -0
- package/lib/esm/types/index.d.ts +2 -1
- package/lib/esm/types/liveStream.d.ts +29 -0
- package/lib/esm/types/liveStream.js +1 -0
- package/lib/umd/api-services.js +1 -1
- package/package.json +4 -4
|
@@ -1340,6 +1340,37 @@ const Endpoints = {
|
|
|
1340
1340
|
url: (0, utils_1.urlReplacer)('/api/v2/event/$(id)/gallery/'),
|
|
1341
1341
|
method: 'DELETE'
|
|
1342
1342
|
},
|
|
1343
|
+
/**
|
|
1344
|
+
* LiveStream
|
|
1345
|
+
*/
|
|
1346
|
+
GetLiveStreamInfo: {
|
|
1347
|
+
url: (0, utils_1.urlReplacer)('/api/v2/live_stream/$(id)/'),
|
|
1348
|
+
method: 'GET'
|
|
1349
|
+
},
|
|
1350
|
+
SearchLiveStream: {
|
|
1351
|
+
url: (0, utils_1.urlReplacer)('/api/v2/live_stream/search/'),
|
|
1352
|
+
method: 'GET'
|
|
1353
|
+
},
|
|
1354
|
+
CreateLiveStream: {
|
|
1355
|
+
url: (0, utils_1.urlReplacer)('/api/v2/live_stream/'),
|
|
1356
|
+
method: 'POST'
|
|
1357
|
+
},
|
|
1358
|
+
UpdateLiveStream: {
|
|
1359
|
+
url: (0, utils_1.urlReplacer)('/api/v2/live_stream/$(id)/'),
|
|
1360
|
+
method: 'PUT'
|
|
1361
|
+
},
|
|
1362
|
+
DeleteLiveStream: {
|
|
1363
|
+
url: (0, utils_1.urlReplacer)('/api/v2/live_stream/$(id)/'),
|
|
1364
|
+
method: 'DELETE'
|
|
1365
|
+
},
|
|
1366
|
+
PatchLiveStream: {
|
|
1367
|
+
url: (0, utils_1.urlReplacer)('/api/v2/live_stream/$(id)/'),
|
|
1368
|
+
method: 'PATCH'
|
|
1369
|
+
},
|
|
1370
|
+
JoinLiveStream: {
|
|
1371
|
+
url: (0, utils_1.urlReplacer)('/api/v2/live_stream/$(id)/join/'),
|
|
1372
|
+
method: 'POST'
|
|
1373
|
+
},
|
|
1343
1374
|
/**
|
|
1344
1375
|
* OnBoarding
|
|
1345
1376
|
*/
|
package/lib/cjs/index.d.ts
CHANGED
|
@@ -48,12 +48,13 @@ import WebhookService, { WebhookApiClient, WebhookApiClientInterface } from './s
|
|
|
48
48
|
import ReactionService, { ReactionApiClient, ReactionApiClientInterface } from './services/reactions';
|
|
49
49
|
import GroupService, { GroupApiClient, GroupApiClientInterface } from './services/group';
|
|
50
50
|
import EventService, { EventApiClient, EventApiClientInterface } from './services/event';
|
|
51
|
+
import LiveStreamService, { LiveStreamApiClient, LiveStreamApiClientInterface } from './services/livestream';
|
|
51
52
|
import OnBoardingService, { OnBoardingApiClient, OnBoardingApiClientInterface } from './services/onboarding';
|
|
52
53
|
/**
|
|
53
54
|
* Types
|
|
54
55
|
*/
|
|
55
|
-
import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams, StartStepParams, OnBoardingStep } from './types';
|
|
56
|
+
import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams, LiveStreamCreateParams, StartStepParams, OnBoardingStep } from './types';
|
|
56
57
|
/**
|
|
57
58
|
* Export all
|
|
58
59
|
*/
|
|
59
|
-
export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface, OnBoardingService, OnBoardingApiClientInterface, OnBoardingApiClient, StartStepParams, OnBoardingStep };
|
|
60
|
+
export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface, LiveStreamService, LiveStreamApiClient, LiveStreamApiClientInterface, LiveStreamCreateParams, OnBoardingService, OnBoardingApiClientInterface, OnBoardingApiClient, StartStepParams, OnBoardingStep };
|
package/lib/cjs/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
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;
|
|
4
|
-
exports.OnBoardingStep = exports.OnBoardingApiClient = exports.OnBoardingService = exports.EventApiClient = exports.EventService = exports.GroupApiClient = exports.GroupService = exports.ReactionApiClient = exports.ReactionService = exports.MediaTypes = exports.WebhookApiClient = exports.WebhookService = exports.TagApiClient = exports.TagService = exports.SuggestionApiClient = exports.SuggestionService = exports.SSOApiClient = exports.SSOService = exports.ScoreApiClient = exports.ScoreService = exports.PromoApiClient = exports.PromoService = exports.PrivateMessageApiClient = exports.PrivateMessageService = exports.NotificationApiClient = exports.NotificationService = exports.ModerationApiClient = void 0;
|
|
4
|
+
exports.OnBoardingStep = exports.OnBoardingApiClient = exports.OnBoardingService = exports.LiveStreamApiClient = exports.LiveStreamService = exports.EventApiClient = exports.EventService = exports.GroupApiClient = exports.GroupService = exports.ReactionApiClient = exports.ReactionService = exports.MediaTypes = exports.WebhookApiClient = exports.WebhookService = exports.TagApiClient = exports.TagService = exports.SuggestionApiClient = exports.SuggestionService = exports.SSOApiClient = exports.SSOService = exports.ScoreApiClient = exports.ScoreService = exports.PromoApiClient = exports.PromoService = exports.PrivateMessageApiClient = exports.PrivateMessageService = exports.NotificationApiClient = exports.NotificationService = exports.ModerationApiClient = void 0;
|
|
5
5
|
const tslib_1 = require("tslib");
|
|
6
6
|
/**
|
|
7
7
|
* Axios client wrapper
|
|
@@ -126,6 +126,9 @@ Object.defineProperty(exports, "GroupApiClient", { enumerable: true, get: functi
|
|
|
126
126
|
const event_1 = tslib_1.__importStar(require("./services/event"));
|
|
127
127
|
exports.EventService = event_1.default;
|
|
128
128
|
Object.defineProperty(exports, "EventApiClient", { enumerable: true, get: function () { return event_1.EventApiClient; } });
|
|
129
|
+
const livestream_1 = tslib_1.__importStar(require("./services/livestream"));
|
|
130
|
+
exports.LiveStreamService = livestream_1.default;
|
|
131
|
+
Object.defineProperty(exports, "LiveStreamApiClient", { enumerable: true, get: function () { return livestream_1.LiveStreamApiClient; } });
|
|
129
132
|
const onboarding_1 = tslib_1.__importStar(require("./services/onboarding"));
|
|
130
133
|
exports.OnBoardingService = onboarding_1.default;
|
|
131
134
|
Object.defineProperty(exports, "OnBoardingApiClient", { enumerable: true, get: function () { return onboarding_1.OnBoardingApiClient; } });
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { SCLiveStreamConnectionDetailsType, SCLiveStreamType } from '@selfcommunity/types';
|
|
2
|
+
import { AxiosRequestConfig } from 'axios';
|
|
3
|
+
import { BaseSearchParams, EventCreateParams, SCPaginatedResponse } from '../../types';
|
|
4
|
+
import { LiveStreamCreateParams } from '../../types/liveStream';
|
|
5
|
+
export interface LiveStreamApiClientInterface {
|
|
6
|
+
search(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
|
|
7
|
+
getSpecificInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
8
|
+
create(data: LiveStreamCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
9
|
+
update(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
10
|
+
patch(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
11
|
+
delete(id: number | string, config?: AxiosRequestConfig): Promise<any>;
|
|
12
|
+
changeCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
13
|
+
join(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamConnectionDetailsType>;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Contains all the endpoints needed to manage LiveStreams.
|
|
17
|
+
*/
|
|
18
|
+
export declare class LiveStreamApiClient {
|
|
19
|
+
/**
|
|
20
|
+
* This endpoint performs LiveStreams search
|
|
21
|
+
* @param params
|
|
22
|
+
* @param config
|
|
23
|
+
*/
|
|
24
|
+
static search(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
|
|
25
|
+
/**
|
|
26
|
+
* This endpoint retrieves a specific LiveStream.
|
|
27
|
+
* @param id
|
|
28
|
+
* @param config
|
|
29
|
+
*/
|
|
30
|
+
static getSpecificInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
31
|
+
/**
|
|
32
|
+
* This endpoint creates an LiveStream.
|
|
33
|
+
* @param data
|
|
34
|
+
* @param config
|
|
35
|
+
*/
|
|
36
|
+
static create(data: LiveStreamCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
37
|
+
/**
|
|
38
|
+
* This endpoint updates an LiveStream.
|
|
39
|
+
* @param id
|
|
40
|
+
* @param data
|
|
41
|
+
* @param config
|
|
42
|
+
*/
|
|
43
|
+
static update(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
44
|
+
/**
|
|
45
|
+
* This endpoint patches an LiveStream.
|
|
46
|
+
* @param id
|
|
47
|
+
* @param data
|
|
48
|
+
* @param config
|
|
49
|
+
*/
|
|
50
|
+
static patch(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
51
|
+
/**
|
|
52
|
+
* This endpoint deletes an LiveStream.
|
|
53
|
+
* @param id
|
|
54
|
+
* @param config
|
|
55
|
+
*/
|
|
56
|
+
static delete(id: number | string, config?: AxiosRequestConfig): Promise<any>;
|
|
57
|
+
/**
|
|
58
|
+
* This endpoint changes the LiveStream avatar
|
|
59
|
+
* @param id
|
|
60
|
+
* @param data
|
|
61
|
+
* @param config
|
|
62
|
+
*/
|
|
63
|
+
static changeCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
64
|
+
/**
|
|
65
|
+
* This endpoint allows to attend an LiveStream
|
|
66
|
+
* @param id
|
|
67
|
+
* @param config
|
|
68
|
+
*/
|
|
69
|
+
static join(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamConnectionDetailsType>;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
:::tip LiveStream service can be used in the following way:
|
|
74
|
+
|
|
75
|
+
```jsx
|
|
76
|
+
1. Import the service from our library:
|
|
77
|
+
|
|
78
|
+
import {LiveStreamService} from "@selfcommunity/api-services";
|
|
79
|
+
```
|
|
80
|
+
```jsx
|
|
81
|
+
2. Create a function and put the service inside it!
|
|
82
|
+
The async function `search` will return the LiveStreams matching the search query.
|
|
83
|
+
|
|
84
|
+
async searchLiveStreams() {
|
|
85
|
+
return await LiveStreamService.search();
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
```jsx
|
|
89
|
+
In case of required `params`, just add them inside the brackets.
|
|
90
|
+
|
|
91
|
+
async getSpecificInfo(liveStreamId) {
|
|
92
|
+
return await LiveStreamService.getSpecificInfo(liveStreamId);
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
```jsx
|
|
96
|
+
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
|
|
97
|
+
|
|
98
|
+
1. Declare it(or declare them, it is possible to add multiple params)
|
|
99
|
+
|
|
100
|
+
const headers = headers: {Authorization: `Bearer ${yourToken}`}
|
|
101
|
+
|
|
102
|
+
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
|
|
103
|
+
```
|
|
104
|
+
:::
|
|
105
|
+
*/
|
|
106
|
+
export default class LiveStreamService {
|
|
107
|
+
static search(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
|
|
108
|
+
static getSpecificInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
109
|
+
static create(data: EventCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
110
|
+
static update(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
111
|
+
static patch(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
112
|
+
static delete(id: number | string, config?: AxiosRequestConfig): Promise<any>;
|
|
113
|
+
static changeCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
114
|
+
static join(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamConnectionDetailsType>;
|
|
115
|
+
}
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.LiveStreamApiClient = void 0;
|
|
4
|
+
const tslib_1 = require("tslib");
|
|
5
|
+
const Endpoints_1 = tslib_1.__importDefault(require("../../constants/Endpoints"));
|
|
6
|
+
const apiRequest_1 = require("../../utils/apiRequest");
|
|
7
|
+
const url_1 = require("../../utils/url");
|
|
8
|
+
/**
|
|
9
|
+
* Contains all the endpoints needed to manage LiveStreams.
|
|
10
|
+
*/
|
|
11
|
+
class LiveStreamApiClient {
|
|
12
|
+
/**
|
|
13
|
+
* This endpoint performs LiveStreams search
|
|
14
|
+
* @param params
|
|
15
|
+
* @param config
|
|
16
|
+
*/
|
|
17
|
+
static search(params, config) {
|
|
18
|
+
const p = (0, url_1.urlParams)(params);
|
|
19
|
+
return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: `${Endpoints_1.default.SearchLiveStream.url({})}?${p.toString()}`, method: Endpoints_1.default.SearchEvents.method }));
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* This endpoint retrieves a specific LiveStream.
|
|
23
|
+
* @param id
|
|
24
|
+
* @param config
|
|
25
|
+
*/
|
|
26
|
+
static getSpecificInfo(id, config) {
|
|
27
|
+
return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetLiveStreamInfo.url({ id }), method: Endpoints_1.default.GetLiveStreamInfo.method }));
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* This endpoint creates an LiveStream.
|
|
31
|
+
* @param data
|
|
32
|
+
* @param config
|
|
33
|
+
*/
|
|
34
|
+
static create(data, config) {
|
|
35
|
+
return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.CreateLiveStream.url({}), method: Endpoints_1.default.CreateLiveStream.method, data: data }));
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* This endpoint updates an LiveStream.
|
|
39
|
+
* @param id
|
|
40
|
+
* @param data
|
|
41
|
+
* @param config
|
|
42
|
+
*/
|
|
43
|
+
static update(id, data, config) {
|
|
44
|
+
return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UpdateLiveStream.url({ id }), method: Endpoints_1.default.UpdateLiveStream.method, data: data }));
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* This endpoint patches an LiveStream.
|
|
48
|
+
* @param id
|
|
49
|
+
* @param data
|
|
50
|
+
* @param config
|
|
51
|
+
*/
|
|
52
|
+
static patch(id, data, config) {
|
|
53
|
+
return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.PatchLiveStream.url({ id }), method: Endpoints_1.default.PatchLiveStream.method, data: data }));
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* This endpoint deletes an LiveStream.
|
|
57
|
+
* @param id
|
|
58
|
+
* @param config
|
|
59
|
+
*/
|
|
60
|
+
static delete(id, config) {
|
|
61
|
+
return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.DeleteLiveStream.url({ id }), method: Endpoints_1.default.DeleteLiveStream.method }));
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* This endpoint changes the LiveStream avatar
|
|
65
|
+
* @param id
|
|
66
|
+
* @param data
|
|
67
|
+
* @param config
|
|
68
|
+
*/
|
|
69
|
+
static changeCover(id, data, config) {
|
|
70
|
+
return (0, apiRequest_1.apiRequest)(Object.assign({ url: Endpoints_1.default.PatchLiveStream.url({ id }), method: Endpoints_1.default.PatchLiveStream.method, data }, config));
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* This endpoint allows to attend an LiveStream
|
|
74
|
+
* @param id
|
|
75
|
+
* @param config
|
|
76
|
+
*/
|
|
77
|
+
static join(id, config) {
|
|
78
|
+
return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.JoinLiveStream.url({ id }), method: Endpoints_1.default.JoinLiveStream.method }));
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
exports.LiveStreamApiClient = LiveStreamApiClient;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
:::tip LiveStream service can be used in the following way:
|
|
85
|
+
|
|
86
|
+
```jsx
|
|
87
|
+
1. Import the service from our library:
|
|
88
|
+
|
|
89
|
+
import {LiveStreamService} from "@selfcommunity/api-services";
|
|
90
|
+
```
|
|
91
|
+
```jsx
|
|
92
|
+
2. Create a function and put the service inside it!
|
|
93
|
+
The async function `search` will return the LiveStreams matching the search query.
|
|
94
|
+
|
|
95
|
+
async searchLiveStreams() {
|
|
96
|
+
return await LiveStreamService.search();
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
```jsx
|
|
100
|
+
In case of required `params`, just add them inside the brackets.
|
|
101
|
+
|
|
102
|
+
async getSpecificInfo(liveStreamId) {
|
|
103
|
+
return await LiveStreamService.getSpecificInfo(liveStreamId);
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
```jsx
|
|
107
|
+
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
|
|
108
|
+
|
|
109
|
+
1. Declare it(or declare them, it is possible to add multiple params)
|
|
110
|
+
|
|
111
|
+
const headers = headers: {Authorization: `Bearer ${yourToken}`}
|
|
112
|
+
|
|
113
|
+
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
|
|
114
|
+
```
|
|
115
|
+
:::
|
|
116
|
+
*/
|
|
117
|
+
class LiveStreamService {
|
|
118
|
+
static search(params, config) {
|
|
119
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
120
|
+
return LiveStreamApiClient.search(params, config);
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
static getSpecificInfo(id, config) {
|
|
124
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
125
|
+
return LiveStreamApiClient.getSpecificInfo(id, config);
|
|
126
|
+
});
|
|
127
|
+
}
|
|
128
|
+
static create(data, config) {
|
|
129
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
130
|
+
return LiveStreamApiClient.create(data, config);
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
static update(id, data, config) {
|
|
134
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
135
|
+
return LiveStreamApiClient.update(id, data, config);
|
|
136
|
+
});
|
|
137
|
+
}
|
|
138
|
+
static patch(id, data, config) {
|
|
139
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
140
|
+
return LiveStreamApiClient.patch(id, data, config);
|
|
141
|
+
});
|
|
142
|
+
}
|
|
143
|
+
static delete(id, config) {
|
|
144
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
145
|
+
return LiveStreamApiClient.delete(id, config);
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
static changeCover(id, data, config) {
|
|
149
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
150
|
+
return LiveStreamApiClient.changeCover(id, data, config);
|
|
151
|
+
});
|
|
152
|
+
}
|
|
153
|
+
static join(id, config) {
|
|
154
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
155
|
+
return LiveStreamApiClient.join(id, config);
|
|
156
|
+
});
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
exports.default = LiveStreamService;
|
package/lib/cjs/types/index.d.ts
CHANGED
|
@@ -25,5 +25,6 @@ import { InsightCommonParams, InsightEmbedParams, InsightUserParams, InsightCont
|
|
|
25
25
|
import { ReactionParams } from './reaction';
|
|
26
26
|
import { GroupCreateParams, GroupFeedParams } from './group';
|
|
27
27
|
import { EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams } from './event';
|
|
28
|
+
import { LiveStreamCreateParams } from './liveStream';
|
|
28
29
|
import { StartStepParams, OnBoardingStep } from './onBoarding';
|
|
29
|
-
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 };
|
|
30
|
+
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 };
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LiveStreamCreateParams interface
|
|
3
|
+
*/
|
|
4
|
+
export interface LiveStreamCreateParams {
|
|
5
|
+
/**
|
|
6
|
+
* A unique name for the live
|
|
7
|
+
*/
|
|
8
|
+
name: string;
|
|
9
|
+
/**
|
|
10
|
+
* The livestream description
|
|
11
|
+
*/
|
|
12
|
+
description?: string;
|
|
13
|
+
/**
|
|
14
|
+
* The users to invite to the group
|
|
15
|
+
*/
|
|
16
|
+
invite_users?: number[];
|
|
17
|
+
/**
|
|
18
|
+
* The liveStream image
|
|
19
|
+
*/
|
|
20
|
+
cover?: File;
|
|
21
|
+
/**
|
|
22
|
+
* The liveStream slug
|
|
23
|
+
*/
|
|
24
|
+
slug?: string;
|
|
25
|
+
/**
|
|
26
|
+
* The livestream settings
|
|
27
|
+
*/
|
|
28
|
+
settings?: Record<string, any>;
|
|
29
|
+
}
|
|
@@ -1338,6 +1338,37 @@ const Endpoints = {
|
|
|
1338
1338
|
url: urlReplacer('/api/v2/event/$(id)/gallery/'),
|
|
1339
1339
|
method: 'DELETE'
|
|
1340
1340
|
},
|
|
1341
|
+
/**
|
|
1342
|
+
* LiveStream
|
|
1343
|
+
*/
|
|
1344
|
+
GetLiveStreamInfo: {
|
|
1345
|
+
url: urlReplacer('/api/v2/live_stream/$(id)/'),
|
|
1346
|
+
method: 'GET'
|
|
1347
|
+
},
|
|
1348
|
+
SearchLiveStream: {
|
|
1349
|
+
url: urlReplacer('/api/v2/live_stream/search/'),
|
|
1350
|
+
method: 'GET'
|
|
1351
|
+
},
|
|
1352
|
+
CreateLiveStream: {
|
|
1353
|
+
url: urlReplacer('/api/v2/live_stream/'),
|
|
1354
|
+
method: 'POST'
|
|
1355
|
+
},
|
|
1356
|
+
UpdateLiveStream: {
|
|
1357
|
+
url: urlReplacer('/api/v2/live_stream/$(id)/'),
|
|
1358
|
+
method: 'PUT'
|
|
1359
|
+
},
|
|
1360
|
+
DeleteLiveStream: {
|
|
1361
|
+
url: urlReplacer('/api/v2/live_stream/$(id)/'),
|
|
1362
|
+
method: 'DELETE'
|
|
1363
|
+
},
|
|
1364
|
+
PatchLiveStream: {
|
|
1365
|
+
url: urlReplacer('/api/v2/live_stream/$(id)/'),
|
|
1366
|
+
method: 'PATCH'
|
|
1367
|
+
},
|
|
1368
|
+
JoinLiveStream: {
|
|
1369
|
+
url: urlReplacer('/api/v2/live_stream/$(id)/join/'),
|
|
1370
|
+
method: 'POST'
|
|
1371
|
+
},
|
|
1341
1372
|
/**
|
|
1342
1373
|
* OnBoarding
|
|
1343
1374
|
*/
|
package/lib/esm/index.d.ts
CHANGED
|
@@ -48,12 +48,13 @@ import WebhookService, { WebhookApiClient, WebhookApiClientInterface } from './s
|
|
|
48
48
|
import ReactionService, { ReactionApiClient, ReactionApiClientInterface } from './services/reactions';
|
|
49
49
|
import GroupService, { GroupApiClient, GroupApiClientInterface } from './services/group';
|
|
50
50
|
import EventService, { EventApiClient, EventApiClientInterface } from './services/event';
|
|
51
|
+
import LiveStreamService, { LiveStreamApiClient, LiveStreamApiClientInterface } from './services/livestream';
|
|
51
52
|
import OnBoardingService, { OnBoardingApiClient, OnBoardingApiClientInterface } from './services/onboarding';
|
|
52
53
|
/**
|
|
53
54
|
* Types
|
|
54
55
|
*/
|
|
55
|
-
import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams, StartStepParams, OnBoardingStep } from './types';
|
|
56
|
+
import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams, LiveStreamCreateParams, StartStepParams, OnBoardingStep } from './types';
|
|
56
57
|
/**
|
|
57
58
|
* Export all
|
|
58
59
|
*/
|
|
59
|
-
export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface, OnBoardingService, OnBoardingApiClientInterface, OnBoardingApiClient, StartStepParams, OnBoardingStep };
|
|
60
|
+
export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface, LiveStreamService, LiveStreamApiClient, LiveStreamApiClientInterface, LiveStreamCreateParams, OnBoardingService, OnBoardingApiClientInterface, OnBoardingApiClient, StartStepParams, OnBoardingStep };
|
package/lib/esm/index.js
CHANGED
|
@@ -48,6 +48,7 @@ import WebhookService, { WebhookApiClient } from './services/webhook';
|
|
|
48
48
|
import ReactionService, { ReactionApiClient } from './services/reactions';
|
|
49
49
|
import GroupService, { GroupApiClient } from './services/group';
|
|
50
50
|
import EventService, { EventApiClient } from './services/event';
|
|
51
|
+
import LiveStreamService, { LiveStreamApiClient } from './services/livestream';
|
|
51
52
|
import OnBoardingService, { OnBoardingApiClient } from './services/onboarding';
|
|
52
53
|
/**
|
|
53
54
|
* Types
|
|
@@ -56,4 +57,4 @@ import { MediaTypes, OnBoardingStep } from './types';
|
|
|
56
57
|
/**
|
|
57
58
|
* Export all
|
|
58
59
|
*/
|
|
59
|
-
export { http, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, AccountService, AccountApiClient, PreferenceService, PreferenceApiClient, UserService, UserApiClient, FeatureService, FeatureApiClient, CategoryService, CategoryApiClient, CommentService, CommentApiClient, CustomAdvService, CustomAdvApiClient, CustomMenuService, CustomMenuApiClient, CustomPageService, CustomPageApiClient, DataPortabilityService, DataPortabilityApiClient, EmbedService, EmbedApiClient, FeedService, FeedApiClient, FeedObjectService, FeedObjectApiClient, IncubatorService, IncubatorApiClient, InsightService, InsightApiClient, InviteService, InviteApiClient, LegalPageService, LegalPageApiClient, LocalityService, LocalityApiClient, LoyaltyService, LoyaltyApiClient, MediaService, MediaApiClient, ModerationService, ModerationApiClient, NotificationService, NotificationApiClient, PrivateMessageService, PrivateMessageApiClient, PromoService, PromoApiClient, ScoreService, ScoreApiClient, SSOService, SSOApiClient, SuggestionService, SuggestionApiClient, TagService, TagApiClient, WebhookService, WebhookApiClient, MediaTypes, ReactionService, ReactionApiClient, GroupService, GroupApiClient, EventService, EventApiClient, OnBoardingService, OnBoardingApiClient, OnBoardingStep };
|
|
60
|
+
export { http, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, AccountService, AccountApiClient, PreferenceService, PreferenceApiClient, UserService, UserApiClient, FeatureService, FeatureApiClient, CategoryService, CategoryApiClient, CommentService, CommentApiClient, CustomAdvService, CustomAdvApiClient, CustomMenuService, CustomMenuApiClient, CustomPageService, CustomPageApiClient, DataPortabilityService, DataPortabilityApiClient, EmbedService, EmbedApiClient, FeedService, FeedApiClient, FeedObjectService, FeedObjectApiClient, IncubatorService, IncubatorApiClient, InsightService, InsightApiClient, InviteService, InviteApiClient, LegalPageService, LegalPageApiClient, LocalityService, LocalityApiClient, LoyaltyService, LoyaltyApiClient, MediaService, MediaApiClient, ModerationService, ModerationApiClient, NotificationService, NotificationApiClient, PrivateMessageService, PrivateMessageApiClient, PromoService, PromoApiClient, ScoreService, ScoreApiClient, SSOService, SSOApiClient, SuggestionService, SuggestionApiClient, TagService, TagApiClient, WebhookService, WebhookApiClient, MediaTypes, ReactionService, ReactionApiClient, GroupService, GroupApiClient, EventService, EventApiClient, LiveStreamService, LiveStreamApiClient, OnBoardingService, OnBoardingApiClient, OnBoardingStep };
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import { SCLiveStreamConnectionDetailsType, SCLiveStreamType } from '@selfcommunity/types';
|
|
2
|
+
import { AxiosRequestConfig } from 'axios';
|
|
3
|
+
import { BaseSearchParams, EventCreateParams, SCPaginatedResponse } from '../../types';
|
|
4
|
+
import { LiveStreamCreateParams } from '../../types/liveStream';
|
|
5
|
+
export interface LiveStreamApiClientInterface {
|
|
6
|
+
search(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
|
|
7
|
+
getSpecificInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
8
|
+
create(data: LiveStreamCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
9
|
+
update(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
10
|
+
patch(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
11
|
+
delete(id: number | string, config?: AxiosRequestConfig): Promise<any>;
|
|
12
|
+
changeCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
13
|
+
join(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamConnectionDetailsType>;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Contains all the endpoints needed to manage LiveStreams.
|
|
17
|
+
*/
|
|
18
|
+
export declare class LiveStreamApiClient {
|
|
19
|
+
/**
|
|
20
|
+
* This endpoint performs LiveStreams search
|
|
21
|
+
* @param params
|
|
22
|
+
* @param config
|
|
23
|
+
*/
|
|
24
|
+
static search(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
|
|
25
|
+
/**
|
|
26
|
+
* This endpoint retrieves a specific LiveStream.
|
|
27
|
+
* @param id
|
|
28
|
+
* @param config
|
|
29
|
+
*/
|
|
30
|
+
static getSpecificInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
31
|
+
/**
|
|
32
|
+
* This endpoint creates an LiveStream.
|
|
33
|
+
* @param data
|
|
34
|
+
* @param config
|
|
35
|
+
*/
|
|
36
|
+
static create(data: LiveStreamCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
37
|
+
/**
|
|
38
|
+
* This endpoint updates an LiveStream.
|
|
39
|
+
* @param id
|
|
40
|
+
* @param data
|
|
41
|
+
* @param config
|
|
42
|
+
*/
|
|
43
|
+
static update(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
44
|
+
/**
|
|
45
|
+
* This endpoint patches an LiveStream.
|
|
46
|
+
* @param id
|
|
47
|
+
* @param data
|
|
48
|
+
* @param config
|
|
49
|
+
*/
|
|
50
|
+
static patch(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
51
|
+
/**
|
|
52
|
+
* This endpoint deletes an LiveStream.
|
|
53
|
+
* @param id
|
|
54
|
+
* @param config
|
|
55
|
+
*/
|
|
56
|
+
static delete(id: number | string, config?: AxiosRequestConfig): Promise<any>;
|
|
57
|
+
/**
|
|
58
|
+
* This endpoint changes the LiveStream avatar
|
|
59
|
+
* @param id
|
|
60
|
+
* @param data
|
|
61
|
+
* @param config
|
|
62
|
+
*/
|
|
63
|
+
static changeCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
64
|
+
/**
|
|
65
|
+
* This endpoint allows to attend an LiveStream
|
|
66
|
+
* @param id
|
|
67
|
+
* @param config
|
|
68
|
+
*/
|
|
69
|
+
static join(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamConnectionDetailsType>;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
:::tip LiveStream service can be used in the following way:
|
|
74
|
+
|
|
75
|
+
```jsx
|
|
76
|
+
1. Import the service from our library:
|
|
77
|
+
|
|
78
|
+
import {LiveStreamService} from "@selfcommunity/api-services";
|
|
79
|
+
```
|
|
80
|
+
```jsx
|
|
81
|
+
2. Create a function and put the service inside it!
|
|
82
|
+
The async function `search` will return the LiveStreams matching the search query.
|
|
83
|
+
|
|
84
|
+
async searchLiveStreams() {
|
|
85
|
+
return await LiveStreamService.search();
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
```jsx
|
|
89
|
+
In case of required `params`, just add them inside the brackets.
|
|
90
|
+
|
|
91
|
+
async getSpecificInfo(liveStreamId) {
|
|
92
|
+
return await LiveStreamService.getSpecificInfo(liveStreamId);
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
```jsx
|
|
96
|
+
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
|
|
97
|
+
|
|
98
|
+
1. Declare it(or declare them, it is possible to add multiple params)
|
|
99
|
+
|
|
100
|
+
const headers = headers: {Authorization: `Bearer ${yourToken}`}
|
|
101
|
+
|
|
102
|
+
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
|
|
103
|
+
```
|
|
104
|
+
:::
|
|
105
|
+
*/
|
|
106
|
+
export default class LiveStreamService {
|
|
107
|
+
static search(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
|
|
108
|
+
static getSpecificInfo(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
109
|
+
static create(data: EventCreateParams | FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
110
|
+
static update(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
111
|
+
static patch(id: number | string, data: SCLiveStreamType, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
112
|
+
static delete(id: number | string, config?: AxiosRequestConfig): Promise<any>;
|
|
113
|
+
static changeCover(id: number | string, data: FormData, config?: AxiosRequestConfig): Promise<SCLiveStreamType>;
|
|
114
|
+
static join(id: number | string, config?: AxiosRequestConfig): Promise<SCLiveStreamConnectionDetailsType>;
|
|
115
|
+
}
|