@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/.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).
|
|
@@ -2154,6 +2154,9 @@ export interface BaseEventSponsorshipLevel {
|
|
|
2154
2154
|
'advertisementWeight': number;
|
|
2155
2155
|
'benefitAllowance': number;
|
|
2156
2156
|
'benefitPriority': number;
|
|
2157
|
+
'postAllowance': number;
|
|
2158
|
+
'postWindowStart': string | null;
|
|
2159
|
+
'postWindowEnd': string | null;
|
|
2157
2160
|
}
|
|
2158
2161
|
export interface BaseEventTrack {
|
|
2159
2162
|
'id': string;
|
|
@@ -3007,6 +3010,8 @@ export interface BaseStreamInput {
|
|
|
3007
3010
|
'locale': string;
|
|
3008
3011
|
'webRTC': boolean;
|
|
3009
3012
|
'webRTCPlaybackUrl': string | null;
|
|
3013
|
+
'dvrEnabled': boolean;
|
|
3014
|
+
'connected': boolean;
|
|
3010
3015
|
}
|
|
3011
3016
|
export interface BaseStreamSession {
|
|
3012
3017
|
'id': string;
|
|
@@ -3016,6 +3021,7 @@ export interface BaseStreamSession {
|
|
|
3016
3021
|
'eventId': string | null;
|
|
3017
3022
|
'eventSessionId': string | null;
|
|
3018
3023
|
'status': StreamSessionStatus;
|
|
3024
|
+
'slowModeSeconds': number;
|
|
3019
3025
|
'startedAt': string | null;
|
|
3020
3026
|
'endedAt': string | null;
|
|
3021
3027
|
'createdAt': string;
|
|
@@ -5157,6 +5163,16 @@ export enum CreateStreamInputOutput200ResponseStatusEnum {
|
|
|
5157
5163
|
Ok = 'ok'
|
|
5158
5164
|
}
|
|
5159
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
|
+
|
|
5160
5176
|
export interface CreateSupportTicket200Response {
|
|
5161
5177
|
'status': CreateSupportTicket200ResponseStatusEnum;
|
|
5162
5178
|
'message': string;
|
|
@@ -7380,6 +7396,9 @@ export interface EventSponsorshipLevel {
|
|
|
7380
7396
|
'advertisementWeight': number;
|
|
7381
7397
|
'benefitAllowance': number;
|
|
7382
7398
|
'benefitPriority': number;
|
|
7399
|
+
'postAllowance': number;
|
|
7400
|
+
'postWindowStart': string | null;
|
|
7401
|
+
'postWindowEnd': string | null;
|
|
7383
7402
|
'sortOrder': number;
|
|
7384
7403
|
'sponsors': Array<BaseEventSponsorship>;
|
|
7385
7404
|
'createdAt': string;
|
|
@@ -7395,6 +7414,9 @@ export interface EventSponsorshipLevelCreateInputs {
|
|
|
7395
7414
|
'advertisementWeight'?: number;
|
|
7396
7415
|
'benefitAllowance'?: number;
|
|
7397
7416
|
'benefitPriority'?: number;
|
|
7417
|
+
'postAllowance'?: number;
|
|
7418
|
+
'postWindowStart'?: string | null;
|
|
7419
|
+
'postWindowEnd'?: string | null;
|
|
7398
7420
|
}
|
|
7399
7421
|
export interface EventSponsorshipLevelSurvey {
|
|
7400
7422
|
'id': string;
|
|
@@ -7431,6 +7453,9 @@ export interface EventSponsorshipLevelUpdateInputs {
|
|
|
7431
7453
|
'advertisementWeight'?: number;
|
|
7432
7454
|
'benefitAllowance'?: number;
|
|
7433
7455
|
'benefitPriority'?: number;
|
|
7456
|
+
'postAllowance'?: number;
|
|
7457
|
+
'postWindowStart'?: string | null;
|
|
7458
|
+
'postWindowEnd'?: string | null;
|
|
7434
7459
|
}
|
|
7435
7460
|
export interface EventSponsorshipProgress {
|
|
7436
7461
|
'id': string;
|
|
@@ -15128,6 +15153,8 @@ export interface StreamInput {
|
|
|
15128
15153
|
'locale': string;
|
|
15129
15154
|
'webRTC': boolean;
|
|
15130
15155
|
'webRTCPlaybackUrl': string | null;
|
|
15156
|
+
'dvrEnabled': boolean;
|
|
15157
|
+
'connected': boolean;
|
|
15131
15158
|
'event': BaseEvent | null;
|
|
15132
15159
|
'session': BaseEventSession | null;
|
|
15133
15160
|
'group': BaseGroup | null;
|
|
@@ -15153,6 +15180,7 @@ export interface StreamInputCreateInputs {
|
|
|
15153
15180
|
'public'?: boolean;
|
|
15154
15181
|
'locale'?: string | null;
|
|
15155
15182
|
'webRTC'?: boolean;
|
|
15183
|
+
'dvrEnabled'?: boolean;
|
|
15156
15184
|
}
|
|
15157
15185
|
export interface StreamInputDetails {
|
|
15158
15186
|
'uid': string;
|
|
@@ -15221,12 +15249,21 @@ export interface StreamInputUpdateInputs {
|
|
|
15221
15249
|
'public'?: boolean;
|
|
15222
15250
|
'locale'?: string | null;
|
|
15223
15251
|
'webRTC'?: boolean;
|
|
15252
|
+
'dvrEnabled'?: boolean;
|
|
15224
15253
|
}
|
|
15225
15254
|
export interface StreamOutputCreateInputs {
|
|
15226
15255
|
'enabled': boolean;
|
|
15227
15256
|
'streamKey': string;
|
|
15228
15257
|
'url': string;
|
|
15229
15258
|
}
|
|
15259
|
+
|
|
15260
|
+
export enum StreamReaction {
|
|
15261
|
+
Love = 'love',
|
|
15262
|
+
Applause = 'applause',
|
|
15263
|
+
Agree = 'agree'
|
|
15264
|
+
}
|
|
15265
|
+
|
|
15266
|
+
|
|
15230
15267
|
export interface StreamSession {
|
|
15231
15268
|
'id': string;
|
|
15232
15269
|
'organizationId': string;
|
|
@@ -15235,6 +15272,7 @@ export interface StreamSession {
|
|
|
15235
15272
|
'eventId': string | null;
|
|
15236
15273
|
'eventSessionId': string | null;
|
|
15237
15274
|
'status': StreamSessionStatus;
|
|
15275
|
+
'slowModeSeconds': number;
|
|
15238
15276
|
'startedAt': string | null;
|
|
15239
15277
|
'endedAt': string | null;
|
|
15240
15278
|
'createdAt': string;
|
|
@@ -15243,6 +15281,7 @@ export interface StreamSession {
|
|
|
15243
15281
|
'event': BaseEvent | null;
|
|
15244
15282
|
'eventSession': BaseEventSession | null;
|
|
15245
15283
|
'organization': BaseOrganization;
|
|
15284
|
+
'reactions'?: { [key: string]: any; };
|
|
15246
15285
|
}
|
|
15247
15286
|
|
|
15248
15287
|
|
|
@@ -15255,6 +15294,19 @@ export interface StreamSessionChatMessage {
|
|
|
15255
15294
|
'connectionId': string;
|
|
15256
15295
|
'message': string;
|
|
15257
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;
|
|
15258
15310
|
}
|
|
15259
15311
|
|
|
15260
15312
|
export enum StreamSessionStatus {
|
|
@@ -15278,6 +15330,7 @@ export interface StreamSessionUpdateInputs {
|
|
|
15278
15330
|
'name'?: string | null;
|
|
15279
15331
|
'eventId'?: string | null;
|
|
15280
15332
|
'eventSessionId'?: string | null;
|
|
15333
|
+
'slowModeSeconds'?: number;
|
|
15281
15334
|
}
|
|
15282
15335
|
export interface StreamSessionViewer {
|
|
15283
15336
|
'accountId': string | null;
|
|
@@ -152535,6 +152588,51 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
152535
152588
|
options: localVarRequestOptions,
|
|
152536
152589
|
};
|
|
152537
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
|
+
},
|
|
152538
152636
|
/**
|
|
152539
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.
|
|
152540
152638
|
* @summary Delete a stream session chat message
|
|
@@ -153239,6 +153337,20 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
153239
153337
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.closeStreamSession']?.[localVarOperationServerIndex]?.url;
|
|
153240
153338
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
153241
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
|
+
},
|
|
153242
153354
|
/**
|
|
153243
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.
|
|
153244
153356
|
* @summary Delete a stream session chat message
|
|
@@ -153460,6 +153572,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
153460
153572
|
closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
153461
153573
|
return localVarFp.closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
153462
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
|
+
},
|
|
153463
153585
|
/**
|
|
153464
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.
|
|
153465
153587
|
* @summary Delete a stream session chat message
|
|
@@ -153608,6 +153730,18 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
|
|
|
153608
153730
|
readonly sessionId: string
|
|
153609
153731
|
}
|
|
153610
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
|
+
|
|
153611
153745
|
/**
|
|
153612
153746
|
* Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
|
|
153613
153747
|
*/
|
|
@@ -153915,6 +154049,17 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
153915
154049
|
return StreamsSessionsApiFp(this.configuration).closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
153916
154050
|
}
|
|
153917
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
|
+
|
|
153918
154063
|
/**
|
|
153919
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.
|
|
153920
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).
|
|
@@ -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
|