@connectedxm/admin-sdk 15.4.0 → 15.6.0
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/.openapi-generator/FILES +3 -0
- package/README.md +2 -2
- package/api.ts +146 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +93 -1
- package/dist/api.js +121 -29
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +93 -1
- package/dist/esm/api.js +92 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/BaseEventSponsorshipLevel.md +6 -0
- package/docs/BaseStreamInput.md +4 -0
- package/docs/BaseStreamSession.md +2 -0
- package/docs/CreateStreamSessionChatMessage200Response.md +24 -0
- package/docs/EventSponsorshipLevel.md +6 -0
- package/docs/EventSponsorshipLevelCreateInputs.md +6 -0
- package/docs/EventSponsorshipLevelUpdateInputs.md +6 -0
- package/docs/StreamInput.md +4 -0
- package/docs/StreamInputCreateInputs.md +2 -0
- package/docs/StreamInputUpdateInputs.md +2 -0
- package/docs/StreamReaction.md +12 -0
- package/docs/StreamSession.md +4 -0
- package/docs/StreamSessionChatMessage.md +6 -0
- package/docs/StreamSessionChatMessageCreateInputs.md +22 -0
- package/docs/StreamSessionUpdateInputs.md +2 -0
- package/docs/StreamsSessionsApi.md +56 -0
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 15.
|
|
5
|
+
* The version of the OpenAPI document: 15.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1984,6 +1984,9 @@ export interface BaseEventSponsorshipLevel {
|
|
|
1984
1984
|
'advertisementWeight': number;
|
|
1985
1985
|
'benefitAllowance': number;
|
|
1986
1986
|
'benefitPriority': number;
|
|
1987
|
+
'postAllowance': number;
|
|
1988
|
+
'postWindowStart': string | null;
|
|
1989
|
+
'postWindowEnd': string | null;
|
|
1987
1990
|
}
|
|
1988
1991
|
export interface BaseEventTrack {
|
|
1989
1992
|
'id': string;
|
|
@@ -2778,6 +2781,8 @@ export interface BaseStreamInput {
|
|
|
2778
2781
|
'locale': string;
|
|
2779
2782
|
'webRTC': boolean;
|
|
2780
2783
|
'webRTCPlaybackUrl': string | null;
|
|
2784
|
+
'dvrEnabled': boolean;
|
|
2785
|
+
'connected': boolean;
|
|
2781
2786
|
}
|
|
2782
2787
|
export interface BaseStreamSession {
|
|
2783
2788
|
'id': string;
|
|
@@ -2787,6 +2792,7 @@ export interface BaseStreamSession {
|
|
|
2787
2792
|
'eventId': string | null;
|
|
2788
2793
|
'eventSessionId': string | null;
|
|
2789
2794
|
'status': StreamSessionStatus;
|
|
2795
|
+
'slowModeSeconds': number;
|
|
2790
2796
|
'startedAt': string | null;
|
|
2791
2797
|
'endedAt': string | null;
|
|
2792
2798
|
'createdAt': string;
|
|
@@ -4686,6 +4692,14 @@ export interface CreateStreamInputOutput200Response {
|
|
|
4686
4692
|
export declare enum CreateStreamInputOutput200ResponseStatusEnum {
|
|
4687
4693
|
Ok = "ok"
|
|
4688
4694
|
}
|
|
4695
|
+
export interface CreateStreamSessionChatMessage200Response {
|
|
4696
|
+
'status': CreateStreamSessionChatMessage200ResponseStatusEnum;
|
|
4697
|
+
'message': string;
|
|
4698
|
+
'data': StreamSessionChatMessage;
|
|
4699
|
+
}
|
|
4700
|
+
export declare enum CreateStreamSessionChatMessage200ResponseStatusEnum {
|
|
4701
|
+
Ok = "ok"
|
|
4702
|
+
}
|
|
4689
4703
|
export interface CreateSupportTicket200Response {
|
|
4690
4704
|
'status': CreateSupportTicket200ResponseStatusEnum;
|
|
4691
4705
|
'message': string;
|
|
@@ -6757,6 +6771,9 @@ export interface EventSponsorshipLevel {
|
|
|
6757
6771
|
'advertisementWeight': number;
|
|
6758
6772
|
'benefitAllowance': number;
|
|
6759
6773
|
'benefitPriority': number;
|
|
6774
|
+
'postAllowance': number;
|
|
6775
|
+
'postWindowStart': string | null;
|
|
6776
|
+
'postWindowEnd': string | null;
|
|
6760
6777
|
'sortOrder': number;
|
|
6761
6778
|
'sponsors': Array<BaseEventSponsorship>;
|
|
6762
6779
|
'createdAt': string;
|
|
@@ -6772,6 +6789,9 @@ export interface EventSponsorshipLevelCreateInputs {
|
|
|
6772
6789
|
'advertisementWeight'?: number;
|
|
6773
6790
|
'benefitAllowance'?: number;
|
|
6774
6791
|
'benefitPriority'?: number;
|
|
6792
|
+
'postAllowance'?: number;
|
|
6793
|
+
'postWindowStart'?: string | null;
|
|
6794
|
+
'postWindowEnd'?: string | null;
|
|
6775
6795
|
}
|
|
6776
6796
|
export interface EventSponsorshipLevelSurvey {
|
|
6777
6797
|
'id': string;
|
|
@@ -6806,6 +6826,9 @@ export interface EventSponsorshipLevelUpdateInputs {
|
|
|
6806
6826
|
'advertisementWeight'?: number;
|
|
6807
6827
|
'benefitAllowance'?: number;
|
|
6808
6828
|
'benefitPriority'?: number;
|
|
6829
|
+
'postAllowance'?: number;
|
|
6830
|
+
'postWindowStart'?: string | null;
|
|
6831
|
+
'postWindowEnd'?: string | null;
|
|
6809
6832
|
}
|
|
6810
6833
|
export interface EventSponsorshipProgress {
|
|
6811
6834
|
'id': string;
|
|
@@ -13445,6 +13468,8 @@ export interface StreamInput {
|
|
|
13445
13468
|
'locale': string;
|
|
13446
13469
|
'webRTC': boolean;
|
|
13447
13470
|
'webRTCPlaybackUrl': string | null;
|
|
13471
|
+
'dvrEnabled': boolean;
|
|
13472
|
+
'connected': boolean;
|
|
13448
13473
|
'event': BaseEvent | null;
|
|
13449
13474
|
'session': BaseEventSession | null;
|
|
13450
13475
|
'group': BaseGroup | null;
|
|
@@ -13470,6 +13495,7 @@ export interface StreamInputCreateInputs {
|
|
|
13470
13495
|
'public'?: boolean;
|
|
13471
13496
|
'locale'?: string | null;
|
|
13472
13497
|
'webRTC'?: boolean;
|
|
13498
|
+
'dvrEnabled'?: boolean;
|
|
13473
13499
|
}
|
|
13474
13500
|
export interface StreamInputDetails {
|
|
13475
13501
|
'uid': string;
|
|
@@ -13538,12 +13564,18 @@ export interface StreamInputUpdateInputs {
|
|
|
13538
13564
|
'public'?: boolean;
|
|
13539
13565
|
'locale'?: string | null;
|
|
13540
13566
|
'webRTC'?: boolean;
|
|
13567
|
+
'dvrEnabled'?: boolean;
|
|
13541
13568
|
}
|
|
13542
13569
|
export interface StreamOutputCreateInputs {
|
|
13543
13570
|
'enabled': boolean;
|
|
13544
13571
|
'streamKey': string;
|
|
13545
13572
|
'url': string;
|
|
13546
13573
|
}
|
|
13574
|
+
export declare enum StreamReaction {
|
|
13575
|
+
Love = "love",
|
|
13576
|
+
Applause = "applause",
|
|
13577
|
+
Agree = "agree"
|
|
13578
|
+
}
|
|
13547
13579
|
export interface StreamSession {
|
|
13548
13580
|
'id': string;
|
|
13549
13581
|
'organizationId': string;
|
|
@@ -13552,6 +13584,7 @@ export interface StreamSession {
|
|
|
13552
13584
|
'eventId': string | null;
|
|
13553
13585
|
'eventSessionId': string | null;
|
|
13554
13586
|
'status': StreamSessionStatus;
|
|
13587
|
+
'slowModeSeconds': number;
|
|
13555
13588
|
'startedAt': string | null;
|
|
13556
13589
|
'endedAt': string | null;
|
|
13557
13590
|
'createdAt': string;
|
|
@@ -13560,6 +13593,9 @@ export interface StreamSession {
|
|
|
13560
13593
|
'event': BaseEvent | null;
|
|
13561
13594
|
'eventSession': BaseEventSession | null;
|
|
13562
13595
|
'organization': BaseOrganization;
|
|
13596
|
+
'reactions'?: {
|
|
13597
|
+
[key: string]: any;
|
|
13598
|
+
};
|
|
13563
13599
|
}
|
|
13564
13600
|
export interface StreamSessionChatMessage {
|
|
13565
13601
|
'messageId': string;
|
|
@@ -13570,6 +13606,17 @@ export interface StreamSessionChatMessage {
|
|
|
13570
13606
|
'connectionId': string;
|
|
13571
13607
|
'message': string;
|
|
13572
13608
|
'timestamp': number;
|
|
13609
|
+
'videoTime': number | null;
|
|
13610
|
+
'videoId': string | null;
|
|
13611
|
+
'role': StreamSessionChatMessageRoleEnum | null;
|
|
13612
|
+
}
|
|
13613
|
+
export declare enum StreamSessionChatMessageRoleEnum {
|
|
13614
|
+
Host = "host",
|
|
13615
|
+
Moderator = "moderator"
|
|
13616
|
+
}
|
|
13617
|
+
export interface StreamSessionChatMessageCreateInputs {
|
|
13618
|
+
'message': string;
|
|
13619
|
+
'name'?: string;
|
|
13573
13620
|
}
|
|
13574
13621
|
export declare enum StreamSessionStatus {
|
|
13575
13622
|
Active = "ACTIVE",
|
|
@@ -13590,6 +13637,7 @@ export interface StreamSessionUpdateInputs {
|
|
|
13590
13637
|
'name'?: string | null;
|
|
13591
13638
|
'eventId'?: string | null;
|
|
13592
13639
|
'eventSessionId'?: string | null;
|
|
13640
|
+
'slowModeSeconds'?: number;
|
|
13593
13641
|
}
|
|
13594
13642
|
export interface StreamSessionViewer {
|
|
13595
13643
|
'accountId': string | null;
|
|
@@ -83451,6 +83499,15 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83451
83499
|
* @throws {RequiredError}
|
|
83452
83500
|
*/
|
|
83453
83501
|
closeStreamSession: (streamId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83502
|
+
/**
|
|
83503
|
+
* Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
|
|
83504
|
+
* @summary Post a chat message as the host
|
|
83505
|
+
* @param {string} sessionId The session identifier
|
|
83506
|
+
* @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs
|
|
83507
|
+
* @param {*} [options] Override http request option.
|
|
83508
|
+
* @throws {RequiredError}
|
|
83509
|
+
*/
|
|
83510
|
+
createStreamSessionChatMessage: (sessionId: string, streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83454
83511
|
/**
|
|
83455
83512
|
* Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
|
|
83456
83513
|
* @summary Delete a stream session chat message
|
|
@@ -83602,6 +83659,15 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83602
83659
|
* @throws {RequiredError}
|
|
83603
83660
|
*/
|
|
83604
83661
|
closeStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
83662
|
+
/**
|
|
83663
|
+
* Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
|
|
83664
|
+
* @summary Post a chat message as the host
|
|
83665
|
+
* @param {string} sessionId The session identifier
|
|
83666
|
+
* @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs
|
|
83667
|
+
* @param {*} [options] Override http request option.
|
|
83668
|
+
* @throws {RequiredError}
|
|
83669
|
+
*/
|
|
83670
|
+
createStreamSessionChatMessage(sessionId: string, streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStreamSessionChatMessage200Response>>;
|
|
83605
83671
|
/**
|
|
83606
83672
|
* Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
|
|
83607
83673
|
* @summary Delete a stream session chat message
|
|
@@ -83752,6 +83818,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83752
83818
|
* @throws {RequiredError}
|
|
83753
83819
|
*/
|
|
83754
83820
|
closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
83821
|
+
/**
|
|
83822
|
+
* Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
|
|
83823
|
+
* @summary Post a chat message as the host
|
|
83824
|
+
* @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
83825
|
+
* @param {*} [options] Override http request option.
|
|
83826
|
+
* @throws {RequiredError}
|
|
83827
|
+
*/
|
|
83828
|
+
createStreamSessionChatMessage(requestParameters: StreamsSessionsApiCreateStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateStreamSessionChatMessage200Response>;
|
|
83755
83829
|
/**
|
|
83756
83830
|
* Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
|
|
83757
83831
|
* @summary Delete a stream session chat message
|
|
@@ -83870,6 +83944,16 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
|
|
|
83870
83944
|
*/
|
|
83871
83945
|
readonly sessionId: string;
|
|
83872
83946
|
}
|
|
83947
|
+
/**
|
|
83948
|
+
* Request parameters for createStreamSessionChatMessage operation in StreamsSessionsApi.
|
|
83949
|
+
*/
|
|
83950
|
+
export interface StreamsSessionsApiCreateStreamSessionChatMessageRequest {
|
|
83951
|
+
/**
|
|
83952
|
+
* The session identifier
|
|
83953
|
+
*/
|
|
83954
|
+
readonly sessionId: string;
|
|
83955
|
+
readonly streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs;
|
|
83956
|
+
}
|
|
83873
83957
|
/**
|
|
83874
83958
|
* Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
|
|
83875
83959
|
*/
|
|
@@ -84128,6 +84212,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
84128
84212
|
* @throws {RequiredError}
|
|
84129
84213
|
*/
|
|
84130
84214
|
closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
84215
|
+
/**
|
|
84216
|
+
* Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
|
|
84217
|
+
* @summary Post a chat message as the host
|
|
84218
|
+
* @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
84219
|
+
* @param {*} [options] Override http request option.
|
|
84220
|
+
* @throws {RequiredError}
|
|
84221
|
+
*/
|
|
84222
|
+
createStreamSessionChatMessage(requestParameters: StreamsSessionsApiCreateStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateStreamSessionChatMessage200Response, any, {}, any>>;
|
|
84131
84223
|
/**
|
|
84132
84224
|
* Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
|
|
84133
84225
|
* @summary Delete a stream session chat message
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 15.
|
|
7
|
+
* The version of the OpenAPI document: 15.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -591,6 +591,10 @@ export var CreateStreamInputOutput200ResponseStatusEnum;
|
|
|
591
591
|
(function (CreateStreamInputOutput200ResponseStatusEnum) {
|
|
592
592
|
CreateStreamInputOutput200ResponseStatusEnum["Ok"] = "ok";
|
|
593
593
|
})(CreateStreamInputOutput200ResponseStatusEnum || (CreateStreamInputOutput200ResponseStatusEnum = {}));
|
|
594
|
+
export var CreateStreamSessionChatMessage200ResponseStatusEnum;
|
|
595
|
+
(function (CreateStreamSessionChatMessage200ResponseStatusEnum) {
|
|
596
|
+
CreateStreamSessionChatMessage200ResponseStatusEnum["Ok"] = "ok";
|
|
597
|
+
})(CreateStreamSessionChatMessage200ResponseStatusEnum || (CreateStreamSessionChatMessage200ResponseStatusEnum = {}));
|
|
594
598
|
export var CreateSupportTicket200ResponseStatusEnum;
|
|
595
599
|
(function (CreateSupportTicket200ResponseStatusEnum) {
|
|
596
600
|
CreateSupportTicket200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -2849,6 +2853,17 @@ export var StreamInputDetailsRecordingModeEnum;
|
|
|
2849
2853
|
StreamInputDetailsRecordingModeEnum["Automatic"] = "automatic";
|
|
2850
2854
|
StreamInputDetailsRecordingModeEnum["Off"] = "off";
|
|
2851
2855
|
})(StreamInputDetailsRecordingModeEnum || (StreamInputDetailsRecordingModeEnum = {}));
|
|
2856
|
+
export var StreamReaction;
|
|
2857
|
+
(function (StreamReaction) {
|
|
2858
|
+
StreamReaction["Love"] = "love";
|
|
2859
|
+
StreamReaction["Applause"] = "applause";
|
|
2860
|
+
StreamReaction["Agree"] = "agree";
|
|
2861
|
+
})(StreamReaction || (StreamReaction = {}));
|
|
2862
|
+
export var StreamSessionChatMessageRoleEnum;
|
|
2863
|
+
(function (StreamSessionChatMessageRoleEnum) {
|
|
2864
|
+
StreamSessionChatMessageRoleEnum["Host"] = "host";
|
|
2865
|
+
StreamSessionChatMessageRoleEnum["Moderator"] = "moderator";
|
|
2866
|
+
})(StreamSessionChatMessageRoleEnum || (StreamSessionChatMessageRoleEnum = {}));
|
|
2852
2867
|
export var StreamSessionStatus;
|
|
2853
2868
|
(function (StreamSessionStatus) {
|
|
2854
2869
|
StreamSessionStatus["Active"] = "ACTIVE";
|
|
@@ -107202,6 +107217,45 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107202
107217
|
options: localVarRequestOptions,
|
|
107203
107218
|
};
|
|
107204
107219
|
}),
|
|
107220
|
+
/**
|
|
107221
|
+
* Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
|
|
107222
|
+
* @summary Post a chat message as the host
|
|
107223
|
+
* @param {string} sessionId The session identifier
|
|
107224
|
+
* @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs
|
|
107225
|
+
* @param {*} [options] Override http request option.
|
|
107226
|
+
* @throws {RequiredError}
|
|
107227
|
+
*/
|
|
107228
|
+
createStreamSessionChatMessage: (sessionId_1, streamSessionChatMessageCreateInputs_1, ...args_1) => __awaiter(this, [sessionId_1, streamSessionChatMessageCreateInputs_1, ...args_1], void 0, function* (sessionId, streamSessionChatMessageCreateInputs, options = {}) {
|
|
107229
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
107230
|
+
assertParamExists('createStreamSessionChatMessage', 'sessionId', sessionId);
|
|
107231
|
+
// verify required parameter 'streamSessionChatMessageCreateInputs' is not null or undefined
|
|
107232
|
+
assertParamExists('createStreamSessionChatMessage', 'streamSessionChatMessageCreateInputs', streamSessionChatMessageCreateInputs);
|
|
107233
|
+
const localVarPath = `/streams/sessions/{sessionId}/chat`
|
|
107234
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
107235
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107236
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107237
|
+
let baseOptions;
|
|
107238
|
+
if (configuration) {
|
|
107239
|
+
baseOptions = configuration.baseOptions;
|
|
107240
|
+
}
|
|
107241
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
107242
|
+
const localVarHeaderParameter = {};
|
|
107243
|
+
const localVarQueryParameter = {};
|
|
107244
|
+
// authentication ApiKeyAuth required
|
|
107245
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107246
|
+
// authentication OrganizationId required
|
|
107247
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107248
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
107249
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
107250
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
107251
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
107252
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107253
|
+
localVarRequestOptions.data = serializeDataIfNeeded(streamSessionChatMessageCreateInputs, localVarRequestOptions, configuration);
|
|
107254
|
+
return {
|
|
107255
|
+
url: toPathString(localVarUrlObj),
|
|
107256
|
+
options: localVarRequestOptions,
|
|
107257
|
+
};
|
|
107258
|
+
}),
|
|
107205
107259
|
/**
|
|
107206
107260
|
* Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
|
|
107207
107261
|
* @summary Delete a stream session chat message
|
|
@@ -107802,6 +107856,23 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
107802
107856
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107803
107857
|
});
|
|
107804
107858
|
},
|
|
107859
|
+
/**
|
|
107860
|
+
* Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
|
|
107861
|
+
* @summary Post a chat message as the host
|
|
107862
|
+
* @param {string} sessionId The session identifier
|
|
107863
|
+
* @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs
|
|
107864
|
+
* @param {*} [options] Override http request option.
|
|
107865
|
+
* @throws {RequiredError}
|
|
107866
|
+
*/
|
|
107867
|
+
createStreamSessionChatMessage(sessionId, streamSessionChatMessageCreateInputs, options) {
|
|
107868
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107869
|
+
var _a, _b, _c;
|
|
107870
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createStreamSessionChatMessage(sessionId, streamSessionChatMessageCreateInputs, options);
|
|
107871
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107872
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.createStreamSessionChatMessage']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107873
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107874
|
+
});
|
|
107875
|
+
},
|
|
107805
107876
|
/**
|
|
107806
107877
|
* Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
|
|
107807
107878
|
* @summary Delete a stream session chat message
|
|
@@ -108061,6 +108132,16 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
108061
108132
|
closeStreamSession(requestParameters, options) {
|
|
108062
108133
|
return localVarFp.closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
108063
108134
|
},
|
|
108135
|
+
/**
|
|
108136
|
+
* Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
|
|
108137
|
+
* @summary Post a chat message as the host
|
|
108138
|
+
* @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
108139
|
+
* @param {*} [options] Override http request option.
|
|
108140
|
+
* @throws {RequiredError}
|
|
108141
|
+
*/
|
|
108142
|
+
createStreamSessionChatMessage(requestParameters, options) {
|
|
108143
|
+
return localVarFp.createStreamSessionChatMessage(requestParameters.sessionId, requestParameters.streamSessionChatMessageCreateInputs, options).then((request) => request(axios, basePath));
|
|
108144
|
+
},
|
|
108064
108145
|
/**
|
|
108065
108146
|
* Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
|
|
108066
108147
|
* @summary Delete a stream session chat message
|
|
@@ -108207,6 +108288,16 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
108207
108288
|
closeStreamSession(requestParameters, options) {
|
|
108208
108289
|
return StreamsSessionsApiFp(this.configuration).closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
108209
108290
|
}
|
|
108291
|
+
/**
|
|
108292
|
+
* Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
|
|
108293
|
+
* @summary Post a chat message as the host
|
|
108294
|
+
* @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
108295
|
+
* @param {*} [options] Override http request option.
|
|
108296
|
+
* @throws {RequiredError}
|
|
108297
|
+
*/
|
|
108298
|
+
createStreamSessionChatMessage(requestParameters, options) {
|
|
108299
|
+
return StreamsSessionsApiFp(this.configuration).createStreamSessionChatMessage(requestParameters.sessionId, requestParameters.streamSessionChatMessageCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
108300
|
+
}
|
|
108210
108301
|
/**
|
|
108211
108302
|
* Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
|
|
108212
108303
|
* @summary Delete a stream session chat message
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 15.
|
|
5
|
+
* The version of the OpenAPI document: 15.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 15.
|
|
7
|
+
* The version of the OpenAPI document: 15.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 15.
|
|
5
|
+
* The version of the OpenAPI document: 15.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 15.
|
|
7
|
+
* The version of the OpenAPI document: 15.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 15.
|
|
5
|
+
* The version of the OpenAPI document: 15.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 15.
|
|
6
|
+
* The version of the OpenAPI document: 15.6.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -14,6 +14,9 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**advertisementWeight** | **number** | | [default to undefined]
|
|
15
15
|
**benefitAllowance** | **number** | | [default to undefined]
|
|
16
16
|
**benefitPriority** | **number** | | [default to undefined]
|
|
17
|
+
**postAllowance** | **number** | | [default to undefined]
|
|
18
|
+
**postWindowStart** | **string** | | [default to undefined]
|
|
19
|
+
**postWindowEnd** | **string** | | [default to undefined]
|
|
17
20
|
|
|
18
21
|
## Example
|
|
19
22
|
|
|
@@ -30,6 +33,9 @@ const instance: BaseEventSponsorshipLevel = {
|
|
|
30
33
|
advertisementWeight,
|
|
31
34
|
benefitAllowance,
|
|
32
35
|
benefitPriority,
|
|
36
|
+
postAllowance,
|
|
37
|
+
postWindowStart,
|
|
38
|
+
postWindowEnd,
|
|
33
39
|
};
|
|
34
40
|
```
|
|
35
41
|
|
package/docs/BaseStreamInput.md
CHANGED
|
@@ -17,6 +17,8 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**locale** | **string** | | [default to undefined]
|
|
18
18
|
**webRTC** | **boolean** | | [default to undefined]
|
|
19
19
|
**webRTCPlaybackUrl** | **string** | | [default to undefined]
|
|
20
|
+
**dvrEnabled** | **boolean** | | [default to undefined]
|
|
21
|
+
**connected** | **boolean** | | [default to undefined]
|
|
20
22
|
|
|
21
23
|
## Example
|
|
22
24
|
|
|
@@ -36,6 +38,8 @@ const instance: BaseStreamInput = {
|
|
|
36
38
|
locale,
|
|
37
39
|
webRTC,
|
|
38
40
|
webRTCPlaybackUrl,
|
|
41
|
+
dvrEnabled,
|
|
42
|
+
connected,
|
|
39
43
|
};
|
|
40
44
|
```
|
|
41
45
|
|
|
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**eventId** | **string** | | [default to undefined]
|
|
13
13
|
**eventSessionId** | **string** | | [default to undefined]
|
|
14
14
|
**status** | [**StreamSessionStatus**](StreamSessionStatus.md) | | [default to undefined]
|
|
15
|
+
**slowModeSeconds** | **number** | | [default to undefined]
|
|
15
16
|
**startedAt** | **string** | | [default to undefined]
|
|
16
17
|
**endedAt** | **string** | | [default to undefined]
|
|
17
18
|
**createdAt** | **string** | | [default to undefined]
|
|
@@ -30,6 +31,7 @@ const instance: BaseStreamSession = {
|
|
|
30
31
|
eventId,
|
|
31
32
|
eventSessionId,
|
|
32
33
|
status,
|
|
34
|
+
slowModeSeconds,
|
|
33
35
|
startedAt,
|
|
34
36
|
endedAt,
|
|
35
37
|
createdAt,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CreateStreamSessionChatMessage200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**StreamSessionChatMessage**](StreamSessionChatMessage.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CreateStreamSessionChatMessage200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CreateStreamSessionChatMessage200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -14,6 +14,9 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**advertisementWeight** | **number** | | [default to undefined]
|
|
15
15
|
**benefitAllowance** | **number** | | [default to undefined]
|
|
16
16
|
**benefitPriority** | **number** | | [default to undefined]
|
|
17
|
+
**postAllowance** | **number** | | [default to undefined]
|
|
18
|
+
**postWindowStart** | **string** | | [default to undefined]
|
|
19
|
+
**postWindowEnd** | **string** | | [default to undefined]
|
|
17
20
|
**sortOrder** | **number** | | [default to undefined]
|
|
18
21
|
**sponsors** | [**Array<BaseEventSponsorship>**](BaseEventSponsorship.md) | | [default to undefined]
|
|
19
22
|
**createdAt** | **string** | | [default to undefined]
|
|
@@ -34,6 +37,9 @@ const instance: EventSponsorshipLevel = {
|
|
|
34
37
|
advertisementWeight,
|
|
35
38
|
benefitAllowance,
|
|
36
39
|
benefitPriority,
|
|
40
|
+
postAllowance,
|
|
41
|
+
postWindowStart,
|
|
42
|
+
postWindowEnd,
|
|
37
43
|
sortOrder,
|
|
38
44
|
sponsors,
|
|
39
45
|
createdAt,
|
|
@@ -14,6 +14,9 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**advertisementWeight** | **number** | | [optional] [default to undefined]
|
|
15
15
|
**benefitAllowance** | **number** | | [optional] [default to undefined]
|
|
16
16
|
**benefitPriority** | **number** | | [optional] [default to undefined]
|
|
17
|
+
**postAllowance** | **number** | | [optional] [default to undefined]
|
|
18
|
+
**postWindowStart** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**postWindowEnd** | **string** | | [optional] [default to undefined]
|
|
17
20
|
|
|
18
21
|
## Example
|
|
19
22
|
|
|
@@ -30,6 +33,9 @@ const instance: EventSponsorshipLevelCreateInputs = {
|
|
|
30
33
|
advertisementWeight,
|
|
31
34
|
benefitAllowance,
|
|
32
35
|
benefitPriority,
|
|
36
|
+
postAllowance,
|
|
37
|
+
postWindowStart,
|
|
38
|
+
postWindowEnd,
|
|
33
39
|
};
|
|
34
40
|
```
|
|
35
41
|
|
|
@@ -14,6 +14,9 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**advertisementWeight** | **number** | | [optional] [default to undefined]
|
|
15
15
|
**benefitAllowance** | **number** | | [optional] [default to undefined]
|
|
16
16
|
**benefitPriority** | **number** | | [optional] [default to undefined]
|
|
17
|
+
**postAllowance** | **number** | | [optional] [default to undefined]
|
|
18
|
+
**postWindowStart** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**postWindowEnd** | **string** | | [optional] [default to undefined]
|
|
17
20
|
|
|
18
21
|
## Example
|
|
19
22
|
|
|
@@ -30,6 +33,9 @@ const instance: EventSponsorshipLevelUpdateInputs = {
|
|
|
30
33
|
advertisementWeight,
|
|
31
34
|
benefitAllowance,
|
|
32
35
|
benefitPriority,
|
|
36
|
+
postAllowance,
|
|
37
|
+
postWindowStart,
|
|
38
|
+
postWindowEnd,
|
|
33
39
|
};
|
|
34
40
|
```
|
|
35
41
|
|
package/docs/StreamInput.md
CHANGED
|
@@ -17,6 +17,8 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**locale** | **string** | | [default to undefined]
|
|
18
18
|
**webRTC** | **boolean** | | [default to undefined]
|
|
19
19
|
**webRTCPlaybackUrl** | **string** | | [default to undefined]
|
|
20
|
+
**dvrEnabled** | **boolean** | | [default to undefined]
|
|
21
|
+
**connected** | **boolean** | | [default to undefined]
|
|
20
22
|
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
21
23
|
**session** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
|
|
22
24
|
**group** | [**BaseGroup**](BaseGroup.md) | | [default to undefined]
|
|
@@ -46,6 +48,8 @@ const instance: StreamInput = {
|
|
|
46
48
|
locale,
|
|
47
49
|
webRTC,
|
|
48
50
|
webRTCPlaybackUrl,
|
|
51
|
+
dvrEnabled,
|
|
52
|
+
connected,
|
|
49
53
|
event,
|
|
50
54
|
session,
|
|
51
55
|
group,
|
|
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**_public** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**locale** | **string** | | [optional] [default to undefined]
|
|
20
20
|
**webRTC** | **boolean** | | [optional] [default to undefined]
|
|
21
|
+
**dvrEnabled** | **boolean** | | [optional] [default to undefined]
|
|
21
22
|
|
|
22
23
|
## Example
|
|
23
24
|
|
|
@@ -38,6 +39,7 @@ const instance: StreamInputCreateInputs = {
|
|
|
38
39
|
_public,
|
|
39
40
|
locale,
|
|
40
41
|
webRTC,
|
|
42
|
+
dvrEnabled,
|
|
41
43
|
};
|
|
42
44
|
```
|
|
43
45
|
|
|
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**_public** | **boolean** | | [optional] [default to undefined]
|
|
19
19
|
**locale** | **string** | | [optional] [default to undefined]
|
|
20
20
|
**webRTC** | **boolean** | | [optional] [default to undefined]
|
|
21
|
+
**dvrEnabled** | **boolean** | | [optional] [default to undefined]
|
|
21
22
|
|
|
22
23
|
## Example
|
|
23
24
|
|
|
@@ -38,6 +39,7 @@ const instance: StreamInputUpdateInputs = {
|
|
|
38
39
|
_public,
|
|
39
40
|
locale,
|
|
40
41
|
webRTC,
|
|
42
|
+
dvrEnabled,
|
|
41
43
|
};
|
|
42
44
|
```
|
|
43
45
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# StreamReaction
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Love` (value: `'love'`)
|
|
7
|
+
|
|
8
|
+
* `Applause` (value: `'applause'`)
|
|
9
|
+
|
|
10
|
+
* `Agree` (value: `'agree'`)
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|