@connectedxm/admin-sdk 15.5.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 +134 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +81 -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 +81 -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/BaseStreamInput.md +4 -0
- package/docs/BaseStreamSession.md +2 -0
- package/docs/CreateStreamSessionChatMessage200Response.md +24 -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/.openapi-generator/FILES
CHANGED
|
@@ -500,6 +500,7 @@ docs/CreateSeriesQuestionChoice200Response.md
|
|
|
500
500
|
docs/CreateSeriesRegistration200Response.md
|
|
501
501
|
docs/CreateStreamInput200Response.md
|
|
502
502
|
docs/CreateStreamInputOutput200Response.md
|
|
503
|
+
docs/CreateStreamSessionChatMessage200Response.md
|
|
503
504
|
docs/CreateSupportTicket200Response.md
|
|
504
505
|
docs/CreateSupportTicketMessage200Response.md
|
|
505
506
|
docs/CreateSurvey200Response.md
|
|
@@ -1569,8 +1570,10 @@ docs/StreamInputOutputCreateInputs.md
|
|
|
1569
1570
|
docs/StreamInputOutputUpdateInputs.md
|
|
1570
1571
|
docs/StreamInputUpdateInputs.md
|
|
1571
1572
|
docs/StreamOutputCreateInputs.md
|
|
1573
|
+
docs/StreamReaction.md
|
|
1572
1574
|
docs/StreamSession.md
|
|
1573
1575
|
docs/StreamSessionChatMessage.md
|
|
1576
|
+
docs/StreamSessionChatMessageCreateInputs.md
|
|
1574
1577
|
docs/StreamSessionStatus.md
|
|
1575
1578
|
docs/StreamSessionSubscription.md
|
|
1576
1579
|
docs/StreamSessionUpdateInputs.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@15.
|
|
1
|
+
## @connectedxm/admin-sdk@15.6.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@15.
|
|
39
|
+
npm install @connectedxm/admin-sdk@15.6.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
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).
|
|
@@ -3010,6 +3010,8 @@ export interface BaseStreamInput {
|
|
|
3010
3010
|
'locale': string;
|
|
3011
3011
|
'webRTC': boolean;
|
|
3012
3012
|
'webRTCPlaybackUrl': string | null;
|
|
3013
|
+
'dvrEnabled': boolean;
|
|
3014
|
+
'connected': boolean;
|
|
3013
3015
|
}
|
|
3014
3016
|
export interface BaseStreamSession {
|
|
3015
3017
|
'id': string;
|
|
@@ -3019,6 +3021,7 @@ export interface BaseStreamSession {
|
|
|
3019
3021
|
'eventId': string | null;
|
|
3020
3022
|
'eventSessionId': string | null;
|
|
3021
3023
|
'status': StreamSessionStatus;
|
|
3024
|
+
'slowModeSeconds': number;
|
|
3022
3025
|
'startedAt': string | null;
|
|
3023
3026
|
'endedAt': string | null;
|
|
3024
3027
|
'createdAt': string;
|
|
@@ -5160,6 +5163,16 @@ export enum CreateStreamInputOutput200ResponseStatusEnum {
|
|
|
5160
5163
|
Ok = 'ok'
|
|
5161
5164
|
}
|
|
5162
5165
|
|
|
5166
|
+
export interface CreateStreamSessionChatMessage200Response {
|
|
5167
|
+
'status': CreateStreamSessionChatMessage200ResponseStatusEnum;
|
|
5168
|
+
'message': string;
|
|
5169
|
+
'data': StreamSessionChatMessage;
|
|
5170
|
+
}
|
|
5171
|
+
|
|
5172
|
+
export enum CreateStreamSessionChatMessage200ResponseStatusEnum {
|
|
5173
|
+
Ok = 'ok'
|
|
5174
|
+
}
|
|
5175
|
+
|
|
5163
5176
|
export interface CreateSupportTicket200Response {
|
|
5164
5177
|
'status': CreateSupportTicket200ResponseStatusEnum;
|
|
5165
5178
|
'message': string;
|
|
@@ -15140,6 +15153,8 @@ export interface StreamInput {
|
|
|
15140
15153
|
'locale': string;
|
|
15141
15154
|
'webRTC': boolean;
|
|
15142
15155
|
'webRTCPlaybackUrl': string | null;
|
|
15156
|
+
'dvrEnabled': boolean;
|
|
15157
|
+
'connected': boolean;
|
|
15143
15158
|
'event': BaseEvent | null;
|
|
15144
15159
|
'session': BaseEventSession | null;
|
|
15145
15160
|
'group': BaseGroup | null;
|
|
@@ -15165,6 +15180,7 @@ export interface StreamInputCreateInputs {
|
|
|
15165
15180
|
'public'?: boolean;
|
|
15166
15181
|
'locale'?: string | null;
|
|
15167
15182
|
'webRTC'?: boolean;
|
|
15183
|
+
'dvrEnabled'?: boolean;
|
|
15168
15184
|
}
|
|
15169
15185
|
export interface StreamInputDetails {
|
|
15170
15186
|
'uid': string;
|
|
@@ -15233,12 +15249,21 @@ export interface StreamInputUpdateInputs {
|
|
|
15233
15249
|
'public'?: boolean;
|
|
15234
15250
|
'locale'?: string | null;
|
|
15235
15251
|
'webRTC'?: boolean;
|
|
15252
|
+
'dvrEnabled'?: boolean;
|
|
15236
15253
|
}
|
|
15237
15254
|
export interface StreamOutputCreateInputs {
|
|
15238
15255
|
'enabled': boolean;
|
|
15239
15256
|
'streamKey': string;
|
|
15240
15257
|
'url': string;
|
|
15241
15258
|
}
|
|
15259
|
+
|
|
15260
|
+
export enum StreamReaction {
|
|
15261
|
+
Love = 'love',
|
|
15262
|
+
Applause = 'applause',
|
|
15263
|
+
Agree = 'agree'
|
|
15264
|
+
}
|
|
15265
|
+
|
|
15266
|
+
|
|
15242
15267
|
export interface StreamSession {
|
|
15243
15268
|
'id': string;
|
|
15244
15269
|
'organizationId': string;
|
|
@@ -15247,6 +15272,7 @@ export interface StreamSession {
|
|
|
15247
15272
|
'eventId': string | null;
|
|
15248
15273
|
'eventSessionId': string | null;
|
|
15249
15274
|
'status': StreamSessionStatus;
|
|
15275
|
+
'slowModeSeconds': number;
|
|
15250
15276
|
'startedAt': string | null;
|
|
15251
15277
|
'endedAt': string | null;
|
|
15252
15278
|
'createdAt': string;
|
|
@@ -15255,6 +15281,7 @@ export interface StreamSession {
|
|
|
15255
15281
|
'event': BaseEvent | null;
|
|
15256
15282
|
'eventSession': BaseEventSession | null;
|
|
15257
15283
|
'organization': BaseOrganization;
|
|
15284
|
+
'reactions'?: { [key: string]: any; };
|
|
15258
15285
|
}
|
|
15259
15286
|
|
|
15260
15287
|
|
|
@@ -15267,6 +15294,19 @@ export interface StreamSessionChatMessage {
|
|
|
15267
15294
|
'connectionId': string;
|
|
15268
15295
|
'message': string;
|
|
15269
15296
|
'timestamp': number;
|
|
15297
|
+
'videoTime': number | null;
|
|
15298
|
+
'videoId': string | null;
|
|
15299
|
+
'role': StreamSessionChatMessageRoleEnum | null;
|
|
15300
|
+
}
|
|
15301
|
+
|
|
15302
|
+
export enum StreamSessionChatMessageRoleEnum {
|
|
15303
|
+
Host = 'host',
|
|
15304
|
+
Moderator = 'moderator'
|
|
15305
|
+
}
|
|
15306
|
+
|
|
15307
|
+
export interface StreamSessionChatMessageCreateInputs {
|
|
15308
|
+
'message': string;
|
|
15309
|
+
'name'?: string;
|
|
15270
15310
|
}
|
|
15271
15311
|
|
|
15272
15312
|
export enum StreamSessionStatus {
|
|
@@ -15290,6 +15330,7 @@ export interface StreamSessionUpdateInputs {
|
|
|
15290
15330
|
'name'?: string | null;
|
|
15291
15331
|
'eventId'?: string | null;
|
|
15292
15332
|
'eventSessionId'?: string | null;
|
|
15333
|
+
'slowModeSeconds'?: number;
|
|
15293
15334
|
}
|
|
15294
15335
|
export interface StreamSessionViewer {
|
|
15295
15336
|
'accountId': string | null;
|
|
@@ -152547,6 +152588,51 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
152547
152588
|
options: localVarRequestOptions,
|
|
152548
152589
|
};
|
|
152549
152590
|
},
|
|
152591
|
+
/**
|
|
152592
|
+
* 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.
|
|
152593
|
+
* @summary Post a chat message as the host
|
|
152594
|
+
* @param {string} sessionId The session identifier
|
|
152595
|
+
* @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs
|
|
152596
|
+
* @param {*} [options] Override http request option.
|
|
152597
|
+
* @throws {RequiredError}
|
|
152598
|
+
*/
|
|
152599
|
+
createStreamSessionChatMessage: async (sessionId: string, streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152600
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
152601
|
+
assertParamExists('createStreamSessionChatMessage', 'sessionId', sessionId)
|
|
152602
|
+
// verify required parameter 'streamSessionChatMessageCreateInputs' is not null or undefined
|
|
152603
|
+
assertParamExists('createStreamSessionChatMessage', 'streamSessionChatMessageCreateInputs', streamSessionChatMessageCreateInputs)
|
|
152604
|
+
const localVarPath = `/streams/sessions/{sessionId}/chat`
|
|
152605
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
152606
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
152607
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152608
|
+
let baseOptions;
|
|
152609
|
+
if (configuration) {
|
|
152610
|
+
baseOptions = configuration.baseOptions;
|
|
152611
|
+
}
|
|
152612
|
+
|
|
152613
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
152614
|
+
const localVarHeaderParameter = {} as any;
|
|
152615
|
+
const localVarQueryParameter = {} as any;
|
|
152616
|
+
|
|
152617
|
+
// authentication ApiKeyAuth required
|
|
152618
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
152619
|
+
|
|
152620
|
+
// authentication OrganizationId required
|
|
152621
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
152622
|
+
|
|
152623
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
152624
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
152625
|
+
|
|
152626
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
152627
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
152628
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
152629
|
+
localVarRequestOptions.data = serializeDataIfNeeded(streamSessionChatMessageCreateInputs, localVarRequestOptions, configuration)
|
|
152630
|
+
|
|
152631
|
+
return {
|
|
152632
|
+
url: toPathString(localVarUrlObj),
|
|
152633
|
+
options: localVarRequestOptions,
|
|
152634
|
+
};
|
|
152635
|
+
},
|
|
152550
152636
|
/**
|
|
152551
152637
|
* 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.
|
|
152552
152638
|
* @summary Delete a stream session chat message
|
|
@@ -153251,6 +153337,20 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
153251
153337
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.closeStreamSession']?.[localVarOperationServerIndex]?.url;
|
|
153252
153338
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
153253
153339
|
},
|
|
153340
|
+
/**
|
|
153341
|
+
* 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.
|
|
153342
|
+
* @summary Post a chat message as the host
|
|
153343
|
+
* @param {string} sessionId The session identifier
|
|
153344
|
+
* @param {StreamSessionChatMessageCreateInputs} streamSessionChatMessageCreateInputs
|
|
153345
|
+
* @param {*} [options] Override http request option.
|
|
153346
|
+
* @throws {RequiredError}
|
|
153347
|
+
*/
|
|
153348
|
+
async createStreamSessionChatMessage(sessionId: string, streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateStreamSessionChatMessage200Response>> {
|
|
153349
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createStreamSessionChatMessage(sessionId, streamSessionChatMessageCreateInputs, options);
|
|
153350
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
153351
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.createStreamSessionChatMessage']?.[localVarOperationServerIndex]?.url;
|
|
153352
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
153353
|
+
},
|
|
153254
153354
|
/**
|
|
153255
153355
|
* 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.
|
|
153256
153356
|
* @summary Delete a stream session chat message
|
|
@@ -153472,6 +153572,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
153472
153572
|
closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
153473
153573
|
return localVarFp.closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
153474
153574
|
},
|
|
153575
|
+
/**
|
|
153576
|
+
* 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.
|
|
153577
|
+
* @summary Post a chat message as the host
|
|
153578
|
+
* @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
153579
|
+
* @param {*} [options] Override http request option.
|
|
153580
|
+
* @throws {RequiredError}
|
|
153581
|
+
*/
|
|
153582
|
+
createStreamSessionChatMessage(requestParameters: StreamsSessionsApiCreateStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateStreamSessionChatMessage200Response> {
|
|
153583
|
+
return localVarFp.createStreamSessionChatMessage(requestParameters.sessionId, requestParameters.streamSessionChatMessageCreateInputs, options).then((request) => request(axios, basePath));
|
|
153584
|
+
},
|
|
153475
153585
|
/**
|
|
153476
153586
|
* 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.
|
|
153477
153587
|
* @summary Delete a stream session chat message
|
|
@@ -153620,6 +153730,18 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
|
|
|
153620
153730
|
readonly sessionId: string
|
|
153621
153731
|
}
|
|
153622
153732
|
|
|
153733
|
+
/**
|
|
153734
|
+
* Request parameters for createStreamSessionChatMessage operation in StreamsSessionsApi.
|
|
153735
|
+
*/
|
|
153736
|
+
export interface StreamsSessionsApiCreateStreamSessionChatMessageRequest {
|
|
153737
|
+
/**
|
|
153738
|
+
* The session identifier
|
|
153739
|
+
*/
|
|
153740
|
+
readonly sessionId: string
|
|
153741
|
+
|
|
153742
|
+
readonly streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs
|
|
153743
|
+
}
|
|
153744
|
+
|
|
153623
153745
|
/**
|
|
153624
153746
|
* Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
|
|
153625
153747
|
*/
|
|
@@ -153927,6 +154049,17 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
153927
154049
|
return StreamsSessionsApiFp(this.configuration).closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
153928
154050
|
}
|
|
153929
154051
|
|
|
154052
|
+
/**
|
|
154053
|
+
* 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.
|
|
154054
|
+
* @summary Post a chat message as the host
|
|
154055
|
+
* @param {StreamsSessionsApiCreateStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
154056
|
+
* @param {*} [options] Override http request option.
|
|
154057
|
+
* @throws {RequiredError}
|
|
154058
|
+
*/
|
|
154059
|
+
public createStreamSessionChatMessage(requestParameters: StreamsSessionsApiCreateStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig) {
|
|
154060
|
+
return StreamsSessionsApiFp(this.configuration).createStreamSessionChatMessage(requestParameters.sessionId, requestParameters.streamSessionChatMessageCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
154061
|
+
}
|
|
154062
|
+
|
|
153930
154063
|
/**
|
|
153931
154064
|
* 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.
|
|
153932
154065
|
* @summary Delete a stream session chat message
|
package/base.ts
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/common.ts
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/configuration.ts
CHANGED
|
@@ -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).
|
package/dist/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).
|
|
@@ -2781,6 +2781,8 @@ export interface BaseStreamInput {
|
|
|
2781
2781
|
'locale': string;
|
|
2782
2782
|
'webRTC': boolean;
|
|
2783
2783
|
'webRTCPlaybackUrl': string | null;
|
|
2784
|
+
'dvrEnabled': boolean;
|
|
2785
|
+
'connected': boolean;
|
|
2784
2786
|
}
|
|
2785
2787
|
export interface BaseStreamSession {
|
|
2786
2788
|
'id': string;
|
|
@@ -2790,6 +2792,7 @@ export interface BaseStreamSession {
|
|
|
2790
2792
|
'eventId': string | null;
|
|
2791
2793
|
'eventSessionId': string | null;
|
|
2792
2794
|
'status': StreamSessionStatus;
|
|
2795
|
+
'slowModeSeconds': number;
|
|
2793
2796
|
'startedAt': string | null;
|
|
2794
2797
|
'endedAt': string | null;
|
|
2795
2798
|
'createdAt': string;
|
|
@@ -4689,6 +4692,14 @@ export interface CreateStreamInputOutput200Response {
|
|
|
4689
4692
|
export declare enum CreateStreamInputOutput200ResponseStatusEnum {
|
|
4690
4693
|
Ok = "ok"
|
|
4691
4694
|
}
|
|
4695
|
+
export interface CreateStreamSessionChatMessage200Response {
|
|
4696
|
+
'status': CreateStreamSessionChatMessage200ResponseStatusEnum;
|
|
4697
|
+
'message': string;
|
|
4698
|
+
'data': StreamSessionChatMessage;
|
|
4699
|
+
}
|
|
4700
|
+
export declare enum CreateStreamSessionChatMessage200ResponseStatusEnum {
|
|
4701
|
+
Ok = "ok"
|
|
4702
|
+
}
|
|
4692
4703
|
export interface CreateSupportTicket200Response {
|
|
4693
4704
|
'status': CreateSupportTicket200ResponseStatusEnum;
|
|
4694
4705
|
'message': string;
|
|
@@ -13457,6 +13468,8 @@ export interface StreamInput {
|
|
|
13457
13468
|
'locale': string;
|
|
13458
13469
|
'webRTC': boolean;
|
|
13459
13470
|
'webRTCPlaybackUrl': string | null;
|
|
13471
|
+
'dvrEnabled': boolean;
|
|
13472
|
+
'connected': boolean;
|
|
13460
13473
|
'event': BaseEvent | null;
|
|
13461
13474
|
'session': BaseEventSession | null;
|
|
13462
13475
|
'group': BaseGroup | null;
|
|
@@ -13482,6 +13495,7 @@ export interface StreamInputCreateInputs {
|
|
|
13482
13495
|
'public'?: boolean;
|
|
13483
13496
|
'locale'?: string | null;
|
|
13484
13497
|
'webRTC'?: boolean;
|
|
13498
|
+
'dvrEnabled'?: boolean;
|
|
13485
13499
|
}
|
|
13486
13500
|
export interface StreamInputDetails {
|
|
13487
13501
|
'uid': string;
|
|
@@ -13550,12 +13564,18 @@ export interface StreamInputUpdateInputs {
|
|
|
13550
13564
|
'public'?: boolean;
|
|
13551
13565
|
'locale'?: string | null;
|
|
13552
13566
|
'webRTC'?: boolean;
|
|
13567
|
+
'dvrEnabled'?: boolean;
|
|
13553
13568
|
}
|
|
13554
13569
|
export interface StreamOutputCreateInputs {
|
|
13555
13570
|
'enabled': boolean;
|
|
13556
13571
|
'streamKey': string;
|
|
13557
13572
|
'url': string;
|
|
13558
13573
|
}
|
|
13574
|
+
export declare enum StreamReaction {
|
|
13575
|
+
Love = "love",
|
|
13576
|
+
Applause = "applause",
|
|
13577
|
+
Agree = "agree"
|
|
13578
|
+
}
|
|
13559
13579
|
export interface StreamSession {
|
|
13560
13580
|
'id': string;
|
|
13561
13581
|
'organizationId': string;
|
|
@@ -13564,6 +13584,7 @@ export interface StreamSession {
|
|
|
13564
13584
|
'eventId': string | null;
|
|
13565
13585
|
'eventSessionId': string | null;
|
|
13566
13586
|
'status': StreamSessionStatus;
|
|
13587
|
+
'slowModeSeconds': number;
|
|
13567
13588
|
'startedAt': string | null;
|
|
13568
13589
|
'endedAt': string | null;
|
|
13569
13590
|
'createdAt': string;
|
|
@@ -13572,6 +13593,9 @@ export interface StreamSession {
|
|
|
13572
13593
|
'event': BaseEvent | null;
|
|
13573
13594
|
'eventSession': BaseEventSession | null;
|
|
13574
13595
|
'organization': BaseOrganization;
|
|
13596
|
+
'reactions'?: {
|
|
13597
|
+
[key: string]: any;
|
|
13598
|
+
};
|
|
13575
13599
|
}
|
|
13576
13600
|
export interface StreamSessionChatMessage {
|
|
13577
13601
|
'messageId': string;
|
|
@@ -13582,6 +13606,17 @@ export interface StreamSessionChatMessage {
|
|
|
13582
13606
|
'connectionId': string;
|
|
13583
13607
|
'message': string;
|
|
13584
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;
|
|
13585
13620
|
}
|
|
13586
13621
|
export declare enum StreamSessionStatus {
|
|
13587
13622
|
Active = "ACTIVE",
|
|
@@ -13602,6 +13637,7 @@ export interface StreamSessionUpdateInputs {
|
|
|
13602
13637
|
'name'?: string | null;
|
|
13603
13638
|
'eventId'?: string | null;
|
|
13604
13639
|
'eventSessionId'?: string | null;
|
|
13640
|
+
'slowModeSeconds'?: number;
|
|
13605
13641
|
}
|
|
13606
13642
|
export interface StreamSessionViewer {
|
|
13607
13643
|
'accountId': string | null;
|
|
@@ -83463,6 +83499,15 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83463
83499
|
* @throws {RequiredError}
|
|
83464
83500
|
*/
|
|
83465
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>;
|
|
83466
83511
|
/**
|
|
83467
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.
|
|
83468
83513
|
* @summary Delete a stream session chat message
|
|
@@ -83614,6 +83659,15 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83614
83659
|
* @throws {RequiredError}
|
|
83615
83660
|
*/
|
|
83616
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>>;
|
|
83617
83671
|
/**
|
|
83618
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.
|
|
83619
83673
|
* @summary Delete a stream session chat message
|
|
@@ -83764,6 +83818,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83764
83818
|
* @throws {RequiredError}
|
|
83765
83819
|
*/
|
|
83766
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>;
|
|
83767
83829
|
/**
|
|
83768
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.
|
|
83769
83831
|
* @summary Delete a stream session chat message
|
|
@@ -83882,6 +83944,16 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
|
|
|
83882
83944
|
*/
|
|
83883
83945
|
readonly sessionId: string;
|
|
83884
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
|
+
}
|
|
83885
83957
|
/**
|
|
83886
83958
|
* Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
|
|
83887
83959
|
*/
|
|
@@ -84140,6 +84212,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
84140
84212
|
* @throws {RequiredError}
|
|
84141
84213
|
*/
|
|
84142
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>>;
|
|
84143
84223
|
/**
|
|
84144
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.
|
|
84145
84225
|
* @summary Delete a stream session chat message
|