@connectedxm/admin-sdk 13.7.0 → 14.0.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/README.md +2 -2
- package/api.ts +123 -14
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +68 -11
- package/dist/api.js +94 -14
- 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 +68 -11
- package/dist/esm/api.js +94 -14
- 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/StreamSessionViewer.md +8 -0
- package/docs/StreamsSessionsApi.md +60 -2
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document:
|
|
8
|
+
* The version of the OpenAPI document: 14.0.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -107571,6 +107571,44 @@ const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107571
107571
|
options: localVarRequestOptions,
|
|
107572
107572
|
};
|
|
107573
107573
|
}),
|
|
107574
|
+
/**
|
|
107575
|
+
* 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.
|
|
107576
|
+
* @summary Delete a stream session chat message
|
|
107577
|
+
* @param {string} sessionId The session identifier
|
|
107578
|
+
* @param {string} messageId The message identifier
|
|
107579
|
+
* @param {*} [options] Override http request option.
|
|
107580
|
+
* @throws {RequiredError}
|
|
107581
|
+
*/
|
|
107582
|
+
deleteStreamSessionChatMessage: (sessionId_1, messageId_1, ...args_1) => __awaiter(this, [sessionId_1, messageId_1, ...args_1], void 0, function* (sessionId, messageId, options = {}) {
|
|
107583
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
107584
|
+
(0, common_1.assertParamExists)('deleteStreamSessionChatMessage', 'sessionId', sessionId);
|
|
107585
|
+
// verify required parameter 'messageId' is not null or undefined
|
|
107586
|
+
(0, common_1.assertParamExists)('deleteStreamSessionChatMessage', 'messageId', messageId);
|
|
107587
|
+
const localVarPath = `/streams/sessions/{sessionId}/chat/{messageId}`
|
|
107588
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)))
|
|
107589
|
+
.replace('{messageId}', encodeURIComponent(String(messageId)));
|
|
107590
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107591
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
107592
|
+
let baseOptions;
|
|
107593
|
+
if (configuration) {
|
|
107594
|
+
baseOptions = configuration.baseOptions;
|
|
107595
|
+
}
|
|
107596
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
107597
|
+
const localVarHeaderParameter = {};
|
|
107598
|
+
const localVarQueryParameter = {};
|
|
107599
|
+
// authentication ApiKeyAuth required
|
|
107600
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
107601
|
+
// authentication OrganizationId required
|
|
107602
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
107603
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
107604
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
107605
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
107606
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107607
|
+
return {
|
|
107608
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
107609
|
+
options: localVarRequestOptions,
|
|
107610
|
+
};
|
|
107611
|
+
}),
|
|
107574
107612
|
/**
|
|
107575
107613
|
* Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
107576
107614
|
* @summary Request an export of a stream session
|
|
@@ -107962,9 +108000,10 @@ const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107962
108000
|
};
|
|
107963
108001
|
}),
|
|
107964
108002
|
/**
|
|
107965
|
-
* Returns a paginated list of the accounts
|
|
107966
|
-
* @summary List the people
|
|
108003
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
108004
|
+
* @summary List the people who watched a stream session
|
|
107967
108005
|
* @param {string} sessionId The session identifier
|
|
108006
|
+
* @param {boolean} [active] Filter by active
|
|
107968
108007
|
* @param {number} [page] Page number
|
|
107969
108008
|
* @param {number} [pageSize] Number of items per page
|
|
107970
108009
|
* @param {string} [orderBy] Field to order by
|
|
@@ -107972,7 +108011,7 @@ const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107972
108011
|
* @param {*} [options] Override http request option.
|
|
107973
108012
|
* @throws {RequiredError}
|
|
107974
108013
|
*/
|
|
107975
|
-
getStreamSessionViewers: (sessionId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [sessionId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (sessionId, page, pageSize, orderBy, search, options = {}) {
|
|
108014
|
+
getStreamSessionViewers: (sessionId_1, active_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [sessionId_1, active_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (sessionId, active, page, pageSize, orderBy, search, options = {}) {
|
|
107976
108015
|
// verify required parameter 'sessionId' is not null or undefined
|
|
107977
108016
|
(0, common_1.assertParamExists)('getStreamSessionViewers', 'sessionId', sessionId);
|
|
107978
108017
|
const localVarPath = `/streams/sessions/{sessionId}/viewers`
|
|
@@ -107990,6 +108029,9 @@ const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107990
108029
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
107991
108030
|
// authentication OrganizationId required
|
|
107992
108031
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
108032
|
+
if (active !== undefined) {
|
|
108033
|
+
localVarQueryParameter['active'] = active;
|
|
108034
|
+
}
|
|
107993
108035
|
if (page !== undefined) {
|
|
107994
108036
|
localVarQueryParameter['page'] = page;
|
|
107995
108037
|
}
|
|
@@ -108130,6 +108172,23 @@ const StreamsSessionsApiFp = function (configuration) {
|
|
|
108130
108172
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
108131
108173
|
});
|
|
108132
108174
|
},
|
|
108175
|
+
/**
|
|
108176
|
+
* 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.
|
|
108177
|
+
* @summary Delete a stream session chat message
|
|
108178
|
+
* @param {string} sessionId The session identifier
|
|
108179
|
+
* @param {string} messageId The message identifier
|
|
108180
|
+
* @param {*} [options] Override http request option.
|
|
108181
|
+
* @throws {RequiredError}
|
|
108182
|
+
*/
|
|
108183
|
+
deleteStreamSessionChatMessage(sessionId, messageId, options) {
|
|
108184
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
108185
|
+
var _a, _b, _c;
|
|
108186
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteStreamSessionChatMessage(sessionId, messageId, options);
|
|
108187
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
108188
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['StreamsSessionsApi.deleteStreamSessionChatMessage']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
108189
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
108190
|
+
});
|
|
108191
|
+
},
|
|
108133
108192
|
/**
|
|
108134
108193
|
* Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
108135
108194
|
* @summary Request an export of a stream session
|
|
@@ -108296,9 +108355,10 @@ const StreamsSessionsApiFp = function (configuration) {
|
|
|
108296
108355
|
});
|
|
108297
108356
|
},
|
|
108298
108357
|
/**
|
|
108299
|
-
* Returns a paginated list of the accounts
|
|
108300
|
-
* @summary List the people
|
|
108358
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
108359
|
+
* @summary List the people who watched a stream session
|
|
108301
108360
|
* @param {string} sessionId The session identifier
|
|
108361
|
+
* @param {boolean} [active] Filter by active
|
|
108302
108362
|
* @param {number} [page] Page number
|
|
108303
108363
|
* @param {number} [pageSize] Number of items per page
|
|
108304
108364
|
* @param {string} [orderBy] Field to order by
|
|
@@ -108306,10 +108366,10 @@ const StreamsSessionsApiFp = function (configuration) {
|
|
|
108306
108366
|
* @param {*} [options] Override http request option.
|
|
108307
108367
|
* @throws {RequiredError}
|
|
108308
108368
|
*/
|
|
108309
|
-
getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options) {
|
|
108369
|
+
getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options) {
|
|
108310
108370
|
return __awaiter(this, void 0, void 0, function* () {
|
|
108311
108371
|
var _a, _b, _c;
|
|
108312
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options);
|
|
108372
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options);
|
|
108313
108373
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
108314
108374
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['StreamsSessionsApi.getStreamSessionViewers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
108315
108375
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -108372,6 +108432,16 @@ const StreamsSessionsApiFactory = function (configuration, basePath, axios) {
|
|
|
108372
108432
|
closeStreamSession(requestParameters, options) {
|
|
108373
108433
|
return localVarFp.closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
108374
108434
|
},
|
|
108435
|
+
/**
|
|
108436
|
+
* 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.
|
|
108437
|
+
* @summary Delete a stream session chat message
|
|
108438
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
108439
|
+
* @param {*} [options] Override http request option.
|
|
108440
|
+
* @throws {RequiredError}
|
|
108441
|
+
*/
|
|
108442
|
+
deleteStreamSessionChatMessage(requestParameters, options) {
|
|
108443
|
+
return localVarFp.deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(axios, basePath));
|
|
108444
|
+
},
|
|
108375
108445
|
/**
|
|
108376
108446
|
* Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
108377
108447
|
* @summary Request an export of a stream session
|
|
@@ -108463,14 +108533,14 @@ const StreamsSessionsApiFactory = function (configuration, basePath, axios) {
|
|
|
108463
108533
|
return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108464
108534
|
},
|
|
108465
108535
|
/**
|
|
108466
|
-
* Returns a paginated list of the accounts
|
|
108467
|
-
* @summary List the people
|
|
108536
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
108537
|
+
* @summary List the people who watched a stream session
|
|
108468
108538
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
108469
108539
|
* @param {*} [options] Override http request option.
|
|
108470
108540
|
* @throws {RequiredError}
|
|
108471
108541
|
*/
|
|
108472
108542
|
getStreamSessionViewers(requestParameters, options) {
|
|
108473
|
-
return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108543
|
+
return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108474
108544
|
},
|
|
108475
108545
|
/**
|
|
108476
108546
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
@@ -108509,6 +108579,16 @@ class StreamsSessionsApi extends base_1.BaseAPI {
|
|
|
108509
108579
|
closeStreamSession(requestParameters, options) {
|
|
108510
108580
|
return (0, exports.StreamsSessionsApiFp)(this.configuration).closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
108511
108581
|
}
|
|
108582
|
+
/**
|
|
108583
|
+
* 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.
|
|
108584
|
+
* @summary Delete a stream session chat message
|
|
108585
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
108586
|
+
* @param {*} [options] Override http request option.
|
|
108587
|
+
* @throws {RequiredError}
|
|
108588
|
+
*/
|
|
108589
|
+
deleteStreamSessionChatMessage(requestParameters, options) {
|
|
108590
|
+
return (0, exports.StreamsSessionsApiFp)(this.configuration).deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(this.axios, this.basePath));
|
|
108591
|
+
}
|
|
108512
108592
|
/**
|
|
108513
108593
|
* Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
108514
108594
|
* @summary Request an export of a stream session
|
|
@@ -108600,14 +108680,14 @@ class StreamsSessionsApi extends base_1.BaseAPI {
|
|
|
108600
108680
|
return (0, exports.StreamsSessionsApiFp)(this.configuration).getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108601
108681
|
}
|
|
108602
108682
|
/**
|
|
108603
|
-
* Returns a paginated list of the accounts
|
|
108604
|
-
* @summary List the people
|
|
108683
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
108684
|
+
* @summary List the people who watched a stream session
|
|
108605
108685
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
108606
108686
|
* @param {*} [options] Override http request option.
|
|
108607
108687
|
* @throws {RequiredError}
|
|
108608
108688
|
*/
|
|
108609
108689
|
getStreamSessionViewers(requestParameters, options) {
|
|
108610
|
-
return (0, exports.StreamsSessionsApiFp)(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108690
|
+
return (0, exports.StreamsSessionsApiFp)(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108611
108691
|
}
|
|
108612
108692
|
/**
|
|
108613
108693
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
package/dist/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:
|
|
5
|
+
* The version of the OpenAPI document: 14.0.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document:
|
|
8
|
+
* The version of the OpenAPI document: 14.0.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/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:
|
|
5
|
+
* The version of the OpenAPI document: 14.0.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document:
|
|
8
|
+
* The version of the OpenAPI document: 14.0.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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:
|
|
5
|
+
* The version of the OpenAPI document: 14.0.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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:
|
|
7
|
+
* The version of the OpenAPI document: 14.0.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
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:
|
|
5
|
+
* The version of the OpenAPI document: 14.0.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13497,8 +13497,12 @@ export interface StreamSessionUpdateInputs {
|
|
|
13497
13497
|
export interface StreamSessionViewer {
|
|
13498
13498
|
'accountId': string | null;
|
|
13499
13499
|
'account': BaseAccount | null;
|
|
13500
|
+
'active': boolean;
|
|
13500
13501
|
'activeConnections': number;
|
|
13502
|
+
'connections': number;
|
|
13501
13503
|
'connectedAt': string;
|
|
13504
|
+
'disconnectedAt': string | null;
|
|
13505
|
+
'duration': number;
|
|
13502
13506
|
}
|
|
13503
13507
|
export interface StripeActivationFormParams {
|
|
13504
13508
|
'clientPublicKey': string;
|
|
@@ -83082,6 +83086,15 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83082
83086
|
* @throws {RequiredError}
|
|
83083
83087
|
*/
|
|
83084
83088
|
closeStreamSession: (streamId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83089
|
+
/**
|
|
83090
|
+
* 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.
|
|
83091
|
+
* @summary Delete a stream session chat message
|
|
83092
|
+
* @param {string} sessionId The session identifier
|
|
83093
|
+
* @param {string} messageId The message identifier
|
|
83094
|
+
* @param {*} [options] Override http request option.
|
|
83095
|
+
* @throws {RequiredError}
|
|
83096
|
+
*/
|
|
83097
|
+
deleteStreamSessionChatMessage: (sessionId: string, messageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83085
83098
|
/**
|
|
83086
83099
|
* Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
83087
83100
|
* @summary Request an export of a stream session
|
|
@@ -83176,9 +83189,10 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83176
83189
|
*/
|
|
83177
83190
|
getStreamSessionSubscriptions: (streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83178
83191
|
/**
|
|
83179
|
-
* Returns a paginated list of the accounts
|
|
83180
|
-
* @summary List the people
|
|
83192
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83193
|
+
* @summary List the people who watched a stream session
|
|
83181
83194
|
* @param {string} sessionId The session identifier
|
|
83195
|
+
* @param {boolean} [active] Filter by active
|
|
83182
83196
|
* @param {number} [page] Page number
|
|
83183
83197
|
* @param {number} [pageSize] Number of items per page
|
|
83184
83198
|
* @param {string} [orderBy] Field to order by
|
|
@@ -83186,7 +83200,7 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83186
83200
|
* @param {*} [options] Override http request option.
|
|
83187
83201
|
* @throws {RequiredError}
|
|
83188
83202
|
*/
|
|
83189
|
-
getStreamSessionViewers: (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83203
|
+
getStreamSessionViewers: (sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83190
83204
|
/**
|
|
83191
83205
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83192
83206
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -83223,6 +83237,15 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83223
83237
|
* @throws {RequiredError}
|
|
83224
83238
|
*/
|
|
83225
83239
|
closeStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
83240
|
+
/**
|
|
83241
|
+
* 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.
|
|
83242
|
+
* @summary Delete a stream session chat message
|
|
83243
|
+
* @param {string} sessionId The session identifier
|
|
83244
|
+
* @param {string} messageId The message identifier
|
|
83245
|
+
* @param {*} [options] Override http request option.
|
|
83246
|
+
* @throws {RequiredError}
|
|
83247
|
+
*/
|
|
83248
|
+
deleteStreamSessionChatMessage(sessionId: string, messageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
83226
83249
|
/**
|
|
83227
83250
|
* Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
83228
83251
|
* @summary Request an export of a stream session
|
|
@@ -83317,9 +83340,10 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83317
83340
|
*/
|
|
83318
83341
|
getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
|
|
83319
83342
|
/**
|
|
83320
|
-
* Returns a paginated list of the accounts
|
|
83321
|
-
* @summary List the people
|
|
83343
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83344
|
+
* @summary List the people who watched a stream session
|
|
83322
83345
|
* @param {string} sessionId The session identifier
|
|
83346
|
+
* @param {boolean} [active] Filter by active
|
|
83323
83347
|
* @param {number} [page] Page number
|
|
83324
83348
|
* @param {number} [pageSize] Number of items per page
|
|
83325
83349
|
* @param {string} [orderBy] Field to order by
|
|
@@ -83327,7 +83351,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83327
83351
|
* @param {*} [options] Override http request option.
|
|
83328
83352
|
* @throws {RequiredError}
|
|
83329
83353
|
*/
|
|
83330
|
-
getStreamSessionViewers(sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
|
|
83354
|
+
getStreamSessionViewers(sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
|
|
83331
83355
|
/**
|
|
83332
83356
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83333
83357
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -83363,6 +83387,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83363
83387
|
* @throws {RequiredError}
|
|
83364
83388
|
*/
|
|
83365
83389
|
closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
83390
|
+
/**
|
|
83391
|
+
* 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.
|
|
83392
|
+
* @summary Delete a stream session chat message
|
|
83393
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
83394
|
+
* @param {*} [options] Override http request option.
|
|
83395
|
+
* @throws {RequiredError}
|
|
83396
|
+
*/
|
|
83397
|
+
deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
83366
83398
|
/**
|
|
83367
83399
|
* Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
83368
83400
|
* @summary Request an export of a stream session
|
|
@@ -83436,8 +83468,8 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83436
83468
|
*/
|
|
83437
83469
|
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
|
|
83438
83470
|
/**
|
|
83439
|
-
* Returns a paginated list of the accounts
|
|
83440
|
-
* @summary List the people
|
|
83471
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83472
|
+
* @summary List the people who watched a stream session
|
|
83441
83473
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
83442
83474
|
* @param {*} [options] Override http request option.
|
|
83443
83475
|
* @throws {RequiredError}
|
|
@@ -83473,6 +83505,19 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
|
|
|
83473
83505
|
*/
|
|
83474
83506
|
readonly sessionId: string;
|
|
83475
83507
|
}
|
|
83508
|
+
/**
|
|
83509
|
+
* Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
|
|
83510
|
+
*/
|
|
83511
|
+
export interface StreamsSessionsApiDeleteStreamSessionChatMessageRequest {
|
|
83512
|
+
/**
|
|
83513
|
+
* The session identifier
|
|
83514
|
+
*/
|
|
83515
|
+
readonly sessionId: string;
|
|
83516
|
+
/**
|
|
83517
|
+
* The message identifier
|
|
83518
|
+
*/
|
|
83519
|
+
readonly messageId: string;
|
|
83520
|
+
}
|
|
83476
83521
|
/**
|
|
83477
83522
|
* Request parameters for exportStreamSession operation in StreamsSessionsApi.
|
|
83478
83523
|
*/
|
|
@@ -83646,6 +83691,10 @@ export interface StreamsSessionsApiGetStreamSessionViewersRequest {
|
|
|
83646
83691
|
* The session identifier
|
|
83647
83692
|
*/
|
|
83648
83693
|
readonly sessionId: string;
|
|
83694
|
+
/**
|
|
83695
|
+
* Filter by active
|
|
83696
|
+
*/
|
|
83697
|
+
readonly active?: boolean;
|
|
83649
83698
|
/**
|
|
83650
83699
|
* Page number
|
|
83651
83700
|
*/
|
|
@@ -83714,6 +83763,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
83714
83763
|
* @throws {RequiredError}
|
|
83715
83764
|
*/
|
|
83716
83765
|
closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
83766
|
+
/**
|
|
83767
|
+
* 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.
|
|
83768
|
+
* @summary Delete a stream session chat message
|
|
83769
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
83770
|
+
* @param {*} [options] Override http request option.
|
|
83771
|
+
* @throws {RequiredError}
|
|
83772
|
+
*/
|
|
83773
|
+
deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
83717
83774
|
/**
|
|
83718
83775
|
* Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
83719
83776
|
* @summary Request an export of a stream session
|
|
@@ -83787,8 +83844,8 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
83787
83844
|
*/
|
|
83788
83845
|
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
|
|
83789
83846
|
/**
|
|
83790
|
-
* Returns a paginated list of the accounts
|
|
83791
|
-
* @summary List the people
|
|
83847
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83848
|
+
* @summary List the people who watched a stream session
|
|
83792
83849
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
83793
83850
|
* @param {*} [options] Override http request option.
|
|
83794
83851
|
* @throws {RequiredError}
|