@connectedxm/admin-sdk 13.4.0 → 13.5.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 +6 -4
- package/README.md +2 -2
- package/api.ts +734 -65
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +378 -40
- package/dist/api.js +537 -46
- 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 +378 -40
- package/dist/esm/api.js +512 -21
- 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/BaseStreamSession.md +7 -1
- package/docs/{GetStreamSessions200Response.md → GetAllStreamSessions200Response.md} +3 -3
- package/docs/{GetStreamSession200Response.md → GetStreamSessionById200Response.md} +3 -3
- package/docs/{GetStreamSessionChat200Response.md → GetStreamSessionByIdChat200Response.md} +3 -3
- package/docs/{GetStreamSessionSubscriptions200Response.md → GetStreamSessionByIdSubscriptions200Response.md} +3 -3
- package/docs/StreamSession.md +11 -1
- package/docs/StreamSessionStatus.md +10 -0
- package/docs/StreamSessionUpdateInputs.md +24 -0
- package/docs/StreamsApi.md +1 -1
- package/docs/StreamsSessionsApi.md +360 -8
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.5.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -894,6 +894,10 @@ export var GetAllAccountMerges200ResponseStatusEnum;
|
|
|
894
894
|
(function (GetAllAccountMerges200ResponseStatusEnum) {
|
|
895
895
|
GetAllAccountMerges200ResponseStatusEnum["Ok"] = "ok";
|
|
896
896
|
})(GetAllAccountMerges200ResponseStatusEnum || (GetAllAccountMerges200ResponseStatusEnum = {}));
|
|
897
|
+
export var GetAllStreamSessions200ResponseStatusEnum;
|
|
898
|
+
(function (GetAllStreamSessions200ResponseStatusEnum) {
|
|
899
|
+
GetAllStreamSessions200ResponseStatusEnum["Ok"] = "ok";
|
|
900
|
+
})(GetAllStreamSessions200ResponseStatusEnum || (GetAllStreamSessions200ResponseStatusEnum = {}));
|
|
897
901
|
export var GetAnnouncementAudienceAccounts200ResponseStatusEnum;
|
|
898
902
|
(function (GetAnnouncementAudienceAccounts200ResponseStatusEnum) {
|
|
899
903
|
GetAnnouncementAudienceAccounts200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -1994,22 +1998,18 @@ export var GetStreamInputs200ResponseStatusEnum;
|
|
|
1994
1998
|
(function (GetStreamInputs200ResponseStatusEnum) {
|
|
1995
1999
|
GetStreamInputs200ResponseStatusEnum["Ok"] = "ok";
|
|
1996
2000
|
})(GetStreamInputs200ResponseStatusEnum || (GetStreamInputs200ResponseStatusEnum = {}));
|
|
1997
|
-
export var
|
|
1998
|
-
(function (
|
|
1999
|
-
|
|
2000
|
-
})(
|
|
2001
|
-
export var
|
|
2002
|
-
(function (
|
|
2003
|
-
|
|
2004
|
-
})(
|
|
2005
|
-
export var
|
|
2006
|
-
(function (
|
|
2007
|
-
|
|
2008
|
-
})(
|
|
2009
|
-
export var GetStreamSessions200ResponseStatusEnum;
|
|
2010
|
-
(function (GetStreamSessions200ResponseStatusEnum) {
|
|
2011
|
-
GetStreamSessions200ResponseStatusEnum["Ok"] = "ok";
|
|
2012
|
-
})(GetStreamSessions200ResponseStatusEnum || (GetStreamSessions200ResponseStatusEnum = {}));
|
|
2001
|
+
export var GetStreamSessionById200ResponseStatusEnum;
|
|
2002
|
+
(function (GetStreamSessionById200ResponseStatusEnum) {
|
|
2003
|
+
GetStreamSessionById200ResponseStatusEnum["Ok"] = "ok";
|
|
2004
|
+
})(GetStreamSessionById200ResponseStatusEnum || (GetStreamSessionById200ResponseStatusEnum = {}));
|
|
2005
|
+
export var GetStreamSessionByIdChat200ResponseStatusEnum;
|
|
2006
|
+
(function (GetStreamSessionByIdChat200ResponseStatusEnum) {
|
|
2007
|
+
GetStreamSessionByIdChat200ResponseStatusEnum["Ok"] = "ok";
|
|
2008
|
+
})(GetStreamSessionByIdChat200ResponseStatusEnum || (GetStreamSessionByIdChat200ResponseStatusEnum = {}));
|
|
2009
|
+
export var GetStreamSessionByIdSubscriptions200ResponseStatusEnum;
|
|
2010
|
+
(function (GetStreamSessionByIdSubscriptions200ResponseStatusEnum) {
|
|
2011
|
+
GetStreamSessionByIdSubscriptions200ResponseStatusEnum["Ok"] = "ok";
|
|
2012
|
+
})(GetStreamSessionByIdSubscriptions200ResponseStatusEnum || (GetStreamSessionByIdSubscriptions200ResponseStatusEnum = {}));
|
|
2013
2013
|
export var GetStreamVideos200ResponseStatusEnum;
|
|
2014
2014
|
(function (GetStreamVideos200ResponseStatusEnum) {
|
|
2015
2015
|
GetStreamVideos200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -2816,6 +2816,11 @@ export var StreamInputDetailsRecordingModeEnum;
|
|
|
2816
2816
|
StreamInputDetailsRecordingModeEnum["Automatic"] = "automatic";
|
|
2817
2817
|
StreamInputDetailsRecordingModeEnum["Off"] = "off";
|
|
2818
2818
|
})(StreamInputDetailsRecordingModeEnum || (StreamInputDetailsRecordingModeEnum = {}));
|
|
2819
|
+
export var StreamSessionStatus;
|
|
2820
|
+
(function (StreamSessionStatus) {
|
|
2821
|
+
StreamSessionStatus["Active"] = "ACTIVE";
|
|
2822
|
+
StreamSessionStatus["Ended"] = "ENDED";
|
|
2823
|
+
})(StreamSessionStatus || (StreamSessionStatus = {}));
|
|
2819
2824
|
export var SupportTicketActivitySource;
|
|
2820
2825
|
(function (SupportTicketActivitySource) {
|
|
2821
2826
|
SupportTicketActivitySource["System"] = "SYSTEM";
|
|
@@ -105773,7 +105778,7 @@ export const StreamsApiAxiosParamCreator = function (configuration) {
|
|
|
105773
105778
|
};
|
|
105774
105779
|
}),
|
|
105775
105780
|
/**
|
|
105776
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
105781
|
+
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
|
|
105777
105782
|
* @summary Delete a stream input
|
|
105778
105783
|
* @param {string} streamId The stream identifier
|
|
105779
105784
|
* @param {*} [options] Override http request option.
|
|
@@ -106055,7 +106060,7 @@ export const StreamsApiFp = function (configuration) {
|
|
|
106055
106060
|
});
|
|
106056
106061
|
},
|
|
106057
106062
|
/**
|
|
106058
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
106063
|
+
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
|
|
106059
106064
|
* @summary Delete a stream input
|
|
106060
106065
|
* @param {string} streamId The stream identifier
|
|
106061
106066
|
* @param {*} [options] Override http request option.
|
|
@@ -106182,7 +106187,7 @@ export const StreamsApiFactory = function (configuration, basePath, axios) {
|
|
|
106182
106187
|
return localVarFp.createStreamInput(requestParameters.streamInputCreateInputs, options).then((request) => request(axios, basePath));
|
|
106183
106188
|
},
|
|
106184
106189
|
/**
|
|
106185
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
106190
|
+
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
|
|
106186
106191
|
* @summary Delete a stream input
|
|
106187
106192
|
* @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
|
|
106188
106193
|
* @param {*} [options] Override http request option.
|
|
@@ -106258,7 +106263,7 @@ export class StreamsApi extends BaseAPI {
|
|
|
106258
106263
|
return StreamsApiFp(this.configuration).createStreamInput(requestParameters.streamInputCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
106259
106264
|
}
|
|
106260
106265
|
/**
|
|
106261
|
-
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input; requires the read and delete permissions on streams.
|
|
106266
|
+
* Permanently deletes the stream input (streamId) and its associated Cloudflare live input. Its sessions, their chat history and its recordings are kept, and any active session is ended; requires the read and delete permissions on streams.
|
|
106262
106267
|
* @summary Delete a stream input
|
|
106263
106268
|
* @param {StreamsApiDeleteStreamInputRequest} requestParameters Request parameters.
|
|
106264
106269
|
* @param {*} [options] Override http request option.
|
|
@@ -106824,6 +106829,102 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
106824
106829
|
options: localVarRequestOptions,
|
|
106825
106830
|
};
|
|
106826
106831
|
}),
|
|
106832
|
+
/**
|
|
106833
|
+
* Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
106834
|
+
* @summary Request an export of a stream session by session id
|
|
106835
|
+
* @param {string} sessionId The session identifier
|
|
106836
|
+
* @param {*} [options] Override http request option.
|
|
106837
|
+
* @throws {RequiredError}
|
|
106838
|
+
*/
|
|
106839
|
+
exportStreamSessionById: (sessionId_1, ...args_1) => __awaiter(this, [sessionId_1, ...args_1], void 0, function* (sessionId, options = {}) {
|
|
106840
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
106841
|
+
assertParamExists('exportStreamSessionById', 'sessionId', sessionId);
|
|
106842
|
+
const localVarPath = `/streams/sessions/{sessionId}/export`
|
|
106843
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
106844
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106845
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
106846
|
+
let baseOptions;
|
|
106847
|
+
if (configuration) {
|
|
106848
|
+
baseOptions = configuration.baseOptions;
|
|
106849
|
+
}
|
|
106850
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
106851
|
+
const localVarHeaderParameter = {};
|
|
106852
|
+
const localVarQueryParameter = {};
|
|
106853
|
+
// authentication ApiKeyAuth required
|
|
106854
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
106855
|
+
// authentication OrganizationId required
|
|
106856
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
106857
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
106858
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
106859
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
106860
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
106861
|
+
return {
|
|
106862
|
+
url: toPathString(localVarUrlObj),
|
|
106863
|
+
options: localVarRequestOptions,
|
|
106864
|
+
};
|
|
106865
|
+
}),
|
|
106866
|
+
/**
|
|
106867
|
+
* Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
|
|
106868
|
+
* @summary List stream sessions across all stream inputs
|
|
106869
|
+
* @param {string} [streamId] Filter by streamId
|
|
106870
|
+
* @param {string} [eventId] Filter by eventId
|
|
106871
|
+
* @param {string} [eventSessionId] Filter by eventSessionId
|
|
106872
|
+
* @param {string} [status] Filter by status
|
|
106873
|
+
* @param {number} [page] Page number
|
|
106874
|
+
* @param {number} [pageSize] Number of items per page
|
|
106875
|
+
* @param {string} [orderBy] Field to order by
|
|
106876
|
+
* @param {string} [search] Search query
|
|
106877
|
+
* @param {*} [options] Override http request option.
|
|
106878
|
+
* @throws {RequiredError}
|
|
106879
|
+
*/
|
|
106880
|
+
getAllStreamSessions: (streamId_1, eventId_1, eventSessionId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [streamId_1, eventId_1, eventSessionId_1, status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (streamId, eventId, eventSessionId, status, page, pageSize, orderBy, search, options = {}) {
|
|
106881
|
+
const localVarPath = `/streams/sessions`;
|
|
106882
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106883
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
106884
|
+
let baseOptions;
|
|
106885
|
+
if (configuration) {
|
|
106886
|
+
baseOptions = configuration.baseOptions;
|
|
106887
|
+
}
|
|
106888
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
106889
|
+
const localVarHeaderParameter = {};
|
|
106890
|
+
const localVarQueryParameter = {};
|
|
106891
|
+
// authentication ApiKeyAuth required
|
|
106892
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
106893
|
+
// authentication OrganizationId required
|
|
106894
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
106895
|
+
if (streamId !== undefined) {
|
|
106896
|
+
localVarQueryParameter['streamId'] = streamId;
|
|
106897
|
+
}
|
|
106898
|
+
if (eventId !== undefined) {
|
|
106899
|
+
localVarQueryParameter['eventId'] = eventId;
|
|
106900
|
+
}
|
|
106901
|
+
if (eventSessionId !== undefined) {
|
|
106902
|
+
localVarQueryParameter['eventSessionId'] = eventSessionId;
|
|
106903
|
+
}
|
|
106904
|
+
if (status !== undefined) {
|
|
106905
|
+
localVarQueryParameter['status'] = status;
|
|
106906
|
+
}
|
|
106907
|
+
if (page !== undefined) {
|
|
106908
|
+
localVarQueryParameter['page'] = page;
|
|
106909
|
+
}
|
|
106910
|
+
if (pageSize !== undefined) {
|
|
106911
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
106912
|
+
}
|
|
106913
|
+
if (orderBy !== undefined) {
|
|
106914
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
106915
|
+
}
|
|
106916
|
+
if (search !== undefined) {
|
|
106917
|
+
localVarQueryParameter['search'] = search;
|
|
106918
|
+
}
|
|
106919
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
106920
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
106921
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
106922
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
106923
|
+
return {
|
|
106924
|
+
url: toPathString(localVarUrlObj),
|
|
106925
|
+
options: localVarRequestOptions,
|
|
106926
|
+
};
|
|
106927
|
+
}),
|
|
106827
106928
|
/**
|
|
106828
106929
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
106829
106930
|
* @summary Get a single stream session
|
|
@@ -106862,6 +106963,128 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
106862
106963
|
options: localVarRequestOptions,
|
|
106863
106964
|
};
|
|
106864
106965
|
}),
|
|
106966
|
+
/**
|
|
106967
|
+
* Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
|
|
106968
|
+
* @summary Get a stream session by id
|
|
106969
|
+
* @param {string} sessionId The session identifier
|
|
106970
|
+
* @param {*} [options] Override http request option.
|
|
106971
|
+
* @throws {RequiredError}
|
|
106972
|
+
*/
|
|
106973
|
+
getStreamSessionById: (sessionId_1, ...args_1) => __awaiter(this, [sessionId_1, ...args_1], void 0, function* (sessionId, options = {}) {
|
|
106974
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
106975
|
+
assertParamExists('getStreamSessionById', 'sessionId', sessionId);
|
|
106976
|
+
const localVarPath = `/streams/sessions/{sessionId}`
|
|
106977
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
106978
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106979
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
106980
|
+
let baseOptions;
|
|
106981
|
+
if (configuration) {
|
|
106982
|
+
baseOptions = configuration.baseOptions;
|
|
106983
|
+
}
|
|
106984
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
106985
|
+
const localVarHeaderParameter = {};
|
|
106986
|
+
const localVarQueryParameter = {};
|
|
106987
|
+
// authentication ApiKeyAuth required
|
|
106988
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
106989
|
+
// authentication OrganizationId required
|
|
106990
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
106991
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
106992
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
106993
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
106994
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
106995
|
+
return {
|
|
106996
|
+
url: toPathString(localVarUrlObj),
|
|
106997
|
+
options: localVarRequestOptions,
|
|
106998
|
+
};
|
|
106999
|
+
}),
|
|
107000
|
+
/**
|
|
107001
|
+
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
|
|
107002
|
+
* @summary List a stream session\'s chat messages by session id
|
|
107003
|
+
* @param {string} sessionId The session identifier
|
|
107004
|
+
* @param {*} [options] Override http request option.
|
|
107005
|
+
* @throws {RequiredError}
|
|
107006
|
+
*/
|
|
107007
|
+
getStreamSessionByIdChat: (sessionId_1, ...args_1) => __awaiter(this, [sessionId_1, ...args_1], void 0, function* (sessionId, options = {}) {
|
|
107008
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
107009
|
+
assertParamExists('getStreamSessionByIdChat', 'sessionId', sessionId);
|
|
107010
|
+
const localVarPath = `/streams/sessions/{sessionId}/chat`
|
|
107011
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
107012
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107013
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107014
|
+
let baseOptions;
|
|
107015
|
+
if (configuration) {
|
|
107016
|
+
baseOptions = configuration.baseOptions;
|
|
107017
|
+
}
|
|
107018
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
107019
|
+
const localVarHeaderParameter = {};
|
|
107020
|
+
const localVarQueryParameter = {};
|
|
107021
|
+
// authentication ApiKeyAuth required
|
|
107022
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107023
|
+
// authentication OrganizationId required
|
|
107024
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107025
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
107026
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
107027
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
107028
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107029
|
+
return {
|
|
107030
|
+
url: toPathString(localVarUrlObj),
|
|
107031
|
+
options: localVarRequestOptions,
|
|
107032
|
+
};
|
|
107033
|
+
}),
|
|
107034
|
+
/**
|
|
107035
|
+
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
107036
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
107037
|
+
* @param {string} sessionId The session identifier
|
|
107038
|
+
* @param {boolean} [active] Filter by active
|
|
107039
|
+
* @param {number} [page] Page number
|
|
107040
|
+
* @param {number} [pageSize] Number of items per page
|
|
107041
|
+
* @param {string} [orderBy] Field to order by
|
|
107042
|
+
* @param {string} [search] Search query
|
|
107043
|
+
* @param {*} [options] Override http request option.
|
|
107044
|
+
* @throws {RequiredError}
|
|
107045
|
+
*/
|
|
107046
|
+
getStreamSessionByIdSubscriptions: (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 = {}) {
|
|
107047
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
107048
|
+
assertParamExists('getStreamSessionByIdSubscriptions', 'sessionId', sessionId);
|
|
107049
|
+
const localVarPath = `/streams/sessions/{sessionId}/subscriptions`
|
|
107050
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
107051
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107052
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107053
|
+
let baseOptions;
|
|
107054
|
+
if (configuration) {
|
|
107055
|
+
baseOptions = configuration.baseOptions;
|
|
107056
|
+
}
|
|
107057
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
107058
|
+
const localVarHeaderParameter = {};
|
|
107059
|
+
const localVarQueryParameter = {};
|
|
107060
|
+
// authentication ApiKeyAuth required
|
|
107061
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107062
|
+
// authentication OrganizationId required
|
|
107063
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107064
|
+
if (active !== undefined) {
|
|
107065
|
+
localVarQueryParameter['active'] = active;
|
|
107066
|
+
}
|
|
107067
|
+
if (page !== undefined) {
|
|
107068
|
+
localVarQueryParameter['page'] = page;
|
|
107069
|
+
}
|
|
107070
|
+
if (pageSize !== undefined) {
|
|
107071
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
107072
|
+
}
|
|
107073
|
+
if (orderBy !== undefined) {
|
|
107074
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
107075
|
+
}
|
|
107076
|
+
if (search !== undefined) {
|
|
107077
|
+
localVarQueryParameter['search'] = search;
|
|
107078
|
+
}
|
|
107079
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
107080
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
107081
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
107082
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107083
|
+
return {
|
|
107084
|
+
url: toPathString(localVarUrlObj),
|
|
107085
|
+
options: localVarRequestOptions,
|
|
107086
|
+
};
|
|
107087
|
+
}),
|
|
106865
107088
|
/**
|
|
106866
107089
|
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
|
|
106867
107090
|
* @summary List a stream session\'s chat messages
|
|
@@ -107012,6 +107235,45 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107012
107235
|
options: localVarRequestOptions,
|
|
107013
107236
|
};
|
|
107014
107237
|
}),
|
|
107238
|
+
/**
|
|
107239
|
+
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
107240
|
+
* @summary Update a stream session
|
|
107241
|
+
* @param {string} sessionId The session identifier
|
|
107242
|
+
* @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
|
|
107243
|
+
* @param {*} [options] Override http request option.
|
|
107244
|
+
* @throws {RequiredError}
|
|
107245
|
+
*/
|
|
107246
|
+
updateStreamSession: (sessionId_1, streamSessionUpdateInputs_1, ...args_1) => __awaiter(this, [sessionId_1, streamSessionUpdateInputs_1, ...args_1], void 0, function* (sessionId, streamSessionUpdateInputs, options = {}) {
|
|
107247
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
107248
|
+
assertParamExists('updateStreamSession', 'sessionId', sessionId);
|
|
107249
|
+
// verify required parameter 'streamSessionUpdateInputs' is not null or undefined
|
|
107250
|
+
assertParamExists('updateStreamSession', 'streamSessionUpdateInputs', streamSessionUpdateInputs);
|
|
107251
|
+
const localVarPath = `/streams/sessions/{sessionId}`
|
|
107252
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
107253
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107254
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107255
|
+
let baseOptions;
|
|
107256
|
+
if (configuration) {
|
|
107257
|
+
baseOptions = configuration.baseOptions;
|
|
107258
|
+
}
|
|
107259
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
107260
|
+
const localVarHeaderParameter = {};
|
|
107261
|
+
const localVarQueryParameter = {};
|
|
107262
|
+
// authentication ApiKeyAuth required
|
|
107263
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107264
|
+
// authentication OrganizationId required
|
|
107265
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107266
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
107267
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
107268
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
107269
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
107270
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107271
|
+
localVarRequestOptions.data = serializeDataIfNeeded(streamSessionUpdateInputs, localVarRequestOptions, configuration);
|
|
107272
|
+
return {
|
|
107273
|
+
url: toPathString(localVarUrlObj),
|
|
107274
|
+
options: localVarRequestOptions,
|
|
107275
|
+
};
|
|
107276
|
+
}),
|
|
107015
107277
|
};
|
|
107016
107278
|
};
|
|
107017
107279
|
/**
|
|
@@ -107054,6 +107316,45 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
107054
107316
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107055
107317
|
});
|
|
107056
107318
|
},
|
|
107319
|
+
/**
|
|
107320
|
+
* Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
107321
|
+
* @summary Request an export of a stream session by session id
|
|
107322
|
+
* @param {string} sessionId The session identifier
|
|
107323
|
+
* @param {*} [options] Override http request option.
|
|
107324
|
+
* @throws {RequiredError}
|
|
107325
|
+
*/
|
|
107326
|
+
exportStreamSessionById(sessionId, options) {
|
|
107327
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107328
|
+
var _a, _b, _c;
|
|
107329
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportStreamSessionById(sessionId, options);
|
|
107330
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107331
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.exportStreamSessionById']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107332
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107333
|
+
});
|
|
107334
|
+
},
|
|
107335
|
+
/**
|
|
107336
|
+
* Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
|
|
107337
|
+
* @summary List stream sessions across all stream inputs
|
|
107338
|
+
* @param {string} [streamId] Filter by streamId
|
|
107339
|
+
* @param {string} [eventId] Filter by eventId
|
|
107340
|
+
* @param {string} [eventSessionId] Filter by eventSessionId
|
|
107341
|
+
* @param {string} [status] Filter by status
|
|
107342
|
+
* @param {number} [page] Page number
|
|
107343
|
+
* @param {number} [pageSize] Number of items per page
|
|
107344
|
+
* @param {string} [orderBy] Field to order by
|
|
107345
|
+
* @param {string} [search] Search query
|
|
107346
|
+
* @param {*} [options] Override http request option.
|
|
107347
|
+
* @throws {RequiredError}
|
|
107348
|
+
*/
|
|
107349
|
+
getAllStreamSessions(streamId, eventId, eventSessionId, status, page, pageSize, orderBy, search, options) {
|
|
107350
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107351
|
+
var _a, _b, _c;
|
|
107352
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getAllStreamSessions(streamId, eventId, eventSessionId, status, page, pageSize, orderBy, search, options);
|
|
107353
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107354
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getAllStreamSessions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107355
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107356
|
+
});
|
|
107357
|
+
},
|
|
107057
107358
|
/**
|
|
107058
107359
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
107059
107360
|
* @summary Get a single stream session
|
|
@@ -107071,6 +107372,59 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
107071
107372
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107072
107373
|
});
|
|
107073
107374
|
},
|
|
107375
|
+
/**
|
|
107376
|
+
* Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
|
|
107377
|
+
* @summary Get a stream session by id
|
|
107378
|
+
* @param {string} sessionId The session identifier
|
|
107379
|
+
* @param {*} [options] Override http request option.
|
|
107380
|
+
* @throws {RequiredError}
|
|
107381
|
+
*/
|
|
107382
|
+
getStreamSessionById(sessionId, options) {
|
|
107383
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107384
|
+
var _a, _b, _c;
|
|
107385
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionById(sessionId, options);
|
|
107386
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107387
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionById']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107388
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107389
|
+
});
|
|
107390
|
+
},
|
|
107391
|
+
/**
|
|
107392
|
+
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
|
|
107393
|
+
* @summary List a stream session\'s chat messages by session id
|
|
107394
|
+
* @param {string} sessionId The session identifier
|
|
107395
|
+
* @param {*} [options] Override http request option.
|
|
107396
|
+
* @throws {RequiredError}
|
|
107397
|
+
*/
|
|
107398
|
+
getStreamSessionByIdChat(sessionId, options) {
|
|
107399
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107400
|
+
var _a, _b, _c;
|
|
107401
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionByIdChat(sessionId, options);
|
|
107402
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107403
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionByIdChat']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107404
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107405
|
+
});
|
|
107406
|
+
},
|
|
107407
|
+
/**
|
|
107408
|
+
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
107409
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
107410
|
+
* @param {string} sessionId The session identifier
|
|
107411
|
+
* @param {boolean} [active] Filter by active
|
|
107412
|
+
* @param {number} [page] Page number
|
|
107413
|
+
* @param {number} [pageSize] Number of items per page
|
|
107414
|
+
* @param {string} [orderBy] Field to order by
|
|
107415
|
+
* @param {string} [search] Search query
|
|
107416
|
+
* @param {*} [options] Override http request option.
|
|
107417
|
+
* @throws {RequiredError}
|
|
107418
|
+
*/
|
|
107419
|
+
getStreamSessionByIdSubscriptions(sessionId, active, page, pageSize, orderBy, search, options) {
|
|
107420
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107421
|
+
var _a, _b, _c;
|
|
107422
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionByIdSubscriptions(sessionId, active, page, pageSize, orderBy, search, options);
|
|
107423
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107424
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionByIdSubscriptions']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107425
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107426
|
+
});
|
|
107427
|
+
},
|
|
107074
107428
|
/**
|
|
107075
107429
|
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
|
|
107076
107430
|
* @summary List a stream session\'s chat messages
|
|
@@ -107131,6 +107485,23 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
107131
107485
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107132
107486
|
});
|
|
107133
107487
|
},
|
|
107488
|
+
/**
|
|
107489
|
+
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
107490
|
+
* @summary Update a stream session
|
|
107491
|
+
* @param {string} sessionId The session identifier
|
|
107492
|
+
* @param {StreamSessionUpdateInputs} streamSessionUpdateInputs
|
|
107493
|
+
* @param {*} [options] Override http request option.
|
|
107494
|
+
* @throws {RequiredError}
|
|
107495
|
+
*/
|
|
107496
|
+
updateStreamSession(sessionId, streamSessionUpdateInputs, options) {
|
|
107497
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107498
|
+
var _a, _b, _c;
|
|
107499
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateStreamSession(sessionId, streamSessionUpdateInputs, options);
|
|
107500
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107501
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.updateStreamSession']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107502
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107503
|
+
});
|
|
107504
|
+
},
|
|
107134
107505
|
};
|
|
107135
107506
|
};
|
|
107136
107507
|
/**
|
|
@@ -107159,6 +107530,26 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
107159
107530
|
exportStreamSession(requestParameters, options) {
|
|
107160
107531
|
return localVarFp.exportStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107161
107532
|
},
|
|
107533
|
+
/**
|
|
107534
|
+
* Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
107535
|
+
* @summary Request an export of a stream session by session id
|
|
107536
|
+
* @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
|
|
107537
|
+
* @param {*} [options] Override http request option.
|
|
107538
|
+
* @throws {RequiredError}
|
|
107539
|
+
*/
|
|
107540
|
+
exportStreamSessionById(requestParameters, options) {
|
|
107541
|
+
return localVarFp.exportStreamSessionById(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107542
|
+
},
|
|
107543
|
+
/**
|
|
107544
|
+
* Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
|
|
107545
|
+
* @summary List stream sessions across all stream inputs
|
|
107546
|
+
* @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
|
|
107547
|
+
* @param {*} [options] Override http request option.
|
|
107548
|
+
* @throws {RequiredError}
|
|
107549
|
+
*/
|
|
107550
|
+
getAllStreamSessions(requestParameters = {}, options) {
|
|
107551
|
+
return localVarFp.getAllStreamSessions(requestParameters.streamId, requestParameters.eventId, requestParameters.eventSessionId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107552
|
+
},
|
|
107162
107553
|
/**
|
|
107163
107554
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
107164
107555
|
* @summary Get a single stream session
|
|
@@ -107169,6 +107560,36 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
107169
107560
|
getStreamSession(requestParameters, options) {
|
|
107170
107561
|
return localVarFp.getStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107171
107562
|
},
|
|
107563
|
+
/**
|
|
107564
|
+
* Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
|
|
107565
|
+
* @summary Get a stream session by id
|
|
107566
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
|
|
107567
|
+
* @param {*} [options] Override http request option.
|
|
107568
|
+
* @throws {RequiredError}
|
|
107569
|
+
*/
|
|
107570
|
+
getStreamSessionById(requestParameters, options) {
|
|
107571
|
+
return localVarFp.getStreamSessionById(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107572
|
+
},
|
|
107573
|
+
/**
|
|
107574
|
+
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
|
|
107575
|
+
* @summary List a stream session\'s chat messages by session id
|
|
107576
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
|
|
107577
|
+
* @param {*} [options] Override http request option.
|
|
107578
|
+
* @throws {RequiredError}
|
|
107579
|
+
*/
|
|
107580
|
+
getStreamSessionByIdChat(requestParameters, options) {
|
|
107581
|
+
return localVarFp.getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107582
|
+
},
|
|
107583
|
+
/**
|
|
107584
|
+
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
107585
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
107586
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
107587
|
+
* @param {*} [options] Override http request option.
|
|
107588
|
+
* @throws {RequiredError}
|
|
107589
|
+
*/
|
|
107590
|
+
getStreamSessionByIdSubscriptions(requestParameters, options) {
|
|
107591
|
+
return localVarFp.getStreamSessionByIdSubscriptions(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107592
|
+
},
|
|
107172
107593
|
/**
|
|
107173
107594
|
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
|
|
107174
107595
|
* @summary List a stream session\'s chat messages
|
|
@@ -107199,6 +107620,16 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
107199
107620
|
getStreamSessions(requestParameters, options) {
|
|
107200
107621
|
return localVarFp.getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107201
107622
|
},
|
|
107623
|
+
/**
|
|
107624
|
+
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
107625
|
+
* @summary Update a stream session
|
|
107626
|
+
* @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
|
|
107627
|
+
* @param {*} [options] Override http request option.
|
|
107628
|
+
* @throws {RequiredError}
|
|
107629
|
+
*/
|
|
107630
|
+
updateStreamSession(requestParameters, options) {
|
|
107631
|
+
return localVarFp.updateStreamSession(requestParameters.sessionId, requestParameters.streamSessionUpdateInputs, options).then((request) => request(axios, basePath));
|
|
107632
|
+
},
|
|
107202
107633
|
};
|
|
107203
107634
|
};
|
|
107204
107635
|
/**
|
|
@@ -107225,6 +107656,26 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
107225
107656
|
exportStreamSession(requestParameters, options) {
|
|
107226
107657
|
return StreamsSessionsApiFp(this.configuration).exportStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107227
107658
|
}
|
|
107659
|
+
/**
|
|
107660
|
+
* Queues an asynchronous export job for the given stream session (sessionId), whether or not its stream input still exists, emailing the requesting user a download when the export completes; requires the read permission on streams.
|
|
107661
|
+
* @summary Request an export of a stream session by session id
|
|
107662
|
+
* @param {StreamsSessionsApiExportStreamSessionByIdRequest} requestParameters Request parameters.
|
|
107663
|
+
* @param {*} [options] Override http request option.
|
|
107664
|
+
* @throws {RequiredError}
|
|
107665
|
+
*/
|
|
107666
|
+
exportStreamSessionById(requestParameters, options) {
|
|
107667
|
+
return StreamsSessionsApiFp(this.configuration).exportStreamSessionById(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107668
|
+
}
|
|
107669
|
+
/**
|
|
107670
|
+
* Returns a paginated list of the organization\'s broadcast sessions across every stream input, including sessions whose input has been deleted, filterable by stream input, event, event session and status and searchable by session or input name; requires read permission on streams.
|
|
107671
|
+
* @summary List stream sessions across all stream inputs
|
|
107672
|
+
* @param {StreamsSessionsApiGetAllStreamSessionsRequest} requestParameters Request parameters.
|
|
107673
|
+
* @param {*} [options] Override http request option.
|
|
107674
|
+
* @throws {RequiredError}
|
|
107675
|
+
*/
|
|
107676
|
+
getAllStreamSessions(requestParameters = {}, options) {
|
|
107677
|
+
return StreamsSessionsApiFp(this.configuration).getAllStreamSessions(requestParameters.streamId, requestParameters.eventId, requestParameters.eventSessionId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
107678
|
+
}
|
|
107228
107679
|
/**
|
|
107229
107680
|
* Returns details for one broadcast session of the given stream input, such as its status and timing information; requires read permission on streams.
|
|
107230
107681
|
* @summary Get a single stream session
|
|
@@ -107235,6 +107686,36 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
107235
107686
|
getStreamSession(requestParameters, options) {
|
|
107236
107687
|
return StreamsSessionsApiFp(this.configuration).getStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107237
107688
|
}
|
|
107689
|
+
/**
|
|
107690
|
+
* Returns one broadcast session by its id alone, whether or not its stream input still exists, with its name, status, timing and the event and event session it belongs to; requires read permission on streams.
|
|
107691
|
+
* @summary Get a stream session by id
|
|
107692
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdRequest} requestParameters Request parameters.
|
|
107693
|
+
* @param {*} [options] Override http request option.
|
|
107694
|
+
* @throws {RequiredError}
|
|
107695
|
+
*/
|
|
107696
|
+
getStreamSessionById(requestParameters, options) {
|
|
107697
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionById(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107698
|
+
}
|
|
107699
|
+
/**
|
|
107700
|
+
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, whether or not its stream input still exists; requires read permission on streams.
|
|
107701
|
+
* @summary List a stream session\'s chat messages by session id
|
|
107702
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdChatRequest} requestParameters Request parameters.
|
|
107703
|
+
* @param {*} [options] Override http request option.
|
|
107704
|
+
* @throws {RequiredError}
|
|
107705
|
+
*/
|
|
107706
|
+
getStreamSessionByIdChat(requestParameters, options) {
|
|
107707
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107708
|
+
}
|
|
107709
|
+
/**
|
|
107710
|
+
* Returns a paginated list of viewer WebSocket subscriptions for the given stream session, whether or not its stream input still exists, optionally filtered to only active (not yet disconnected) subscriptions; requires read permission on streams.
|
|
107711
|
+
* @summary List a stream session\'s viewer connections by session id
|
|
107712
|
+
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
107713
|
+
* @param {*} [options] Override http request option.
|
|
107714
|
+
* @throws {RequiredError}
|
|
107715
|
+
*/
|
|
107716
|
+
getStreamSessionByIdSubscriptions(requestParameters, options) {
|
|
107717
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionByIdSubscriptions(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
107718
|
+
}
|
|
107238
107719
|
/**
|
|
107239
107720
|
* Returns a cursor-paginated list of the most recent chat messages sent during the given stream session, ordered for chronological display; requires read permission on streams.
|
|
107240
107721
|
* @summary List a stream session\'s chat messages
|
|
@@ -107265,6 +107746,16 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
107265
107746
|
getStreamSessions(requestParameters, options) {
|
|
107266
107747
|
return StreamsSessionsApiFp(this.configuration).getStreamSessions(requestParameters.streamId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
107267
107748
|
}
|
|
107749
|
+
/**
|
|
107750
|
+
* Renames a broadcast session (sessionId) or changes the event and event session it belongs to; eventSessionId requires eventId, and changing eventId without an eventSessionId clears the event session; requires the read and update permissions on streams.
|
|
107751
|
+
* @summary Update a stream session
|
|
107752
|
+
* @param {StreamsSessionsApiUpdateStreamSessionRequest} requestParameters Request parameters.
|
|
107753
|
+
* @param {*} [options] Override http request option.
|
|
107754
|
+
* @throws {RequiredError}
|
|
107755
|
+
*/
|
|
107756
|
+
updateStreamSession(requestParameters, options) {
|
|
107757
|
+
return StreamsSessionsApiFp(this.configuration).updateStreamSession(requestParameters.sessionId, requestParameters.streamSessionUpdateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
107758
|
+
}
|
|
107268
107759
|
}
|
|
107269
107760
|
/**
|
|
107270
107761
|
* SupportApi - axios parameter creator
|