@connectedxm/admin-sdk 13.6.0 → 13.8.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 +2 -0
- package/README.md +2 -2
- package/api.ts +240 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +128 -1
- package/dist/api.js +191 -22
- 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 +128 -1
- package/dist/esm/api.js +170 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/GetStreamSessionViewers200Response.md +26 -0
- package/docs/StreamSessionViewer.md +26 -0
- package/docs/StreamsSessionsApi.md +119 -0
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 13.
|
|
5
|
+
* The version of the OpenAPI document: 13.8.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -9697,6 +9697,15 @@ export interface GetStreamSessionByIdSubscriptions200Response {
|
|
|
9697
9697
|
export declare enum GetStreamSessionByIdSubscriptions200ResponseStatusEnum {
|
|
9698
9698
|
Ok = "ok"
|
|
9699
9699
|
}
|
|
9700
|
+
export interface GetStreamSessionViewers200Response {
|
|
9701
|
+
'status': GetStreamSessionViewers200ResponseStatusEnum;
|
|
9702
|
+
'message': string;
|
|
9703
|
+
'data': Array<StreamSessionViewer>;
|
|
9704
|
+
'count'?: number;
|
|
9705
|
+
}
|
|
9706
|
+
export declare enum GetStreamSessionViewers200ResponseStatusEnum {
|
|
9707
|
+
Ok = "ok"
|
|
9708
|
+
}
|
|
9700
9709
|
export interface GetStreamVideos200Response {
|
|
9701
9710
|
'status': GetStreamVideos200ResponseStatusEnum;
|
|
9702
9711
|
'message': string;
|
|
@@ -13485,6 +13494,12 @@ export interface StreamSessionUpdateInputs {
|
|
|
13485
13494
|
'eventId'?: string | null;
|
|
13486
13495
|
'eventSessionId'?: string | null;
|
|
13487
13496
|
}
|
|
13497
|
+
export interface StreamSessionViewer {
|
|
13498
|
+
'accountId': string | null;
|
|
13499
|
+
'account': BaseAccount | null;
|
|
13500
|
+
'activeConnections': number;
|
|
13501
|
+
'connectedAt': string;
|
|
13502
|
+
}
|
|
13488
13503
|
export interface StripeActivationFormParams {
|
|
13489
13504
|
'clientPublicKey': string;
|
|
13490
13505
|
'clientSecret': string;
|
|
@@ -83067,6 +83082,15 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83067
83082
|
* @throws {RequiredError}
|
|
83068
83083
|
*/
|
|
83069
83084
|
closeStreamSession: (streamId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83085
|
+
/**
|
|
83086
|
+
* 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.
|
|
83087
|
+
* @summary Delete a stream session chat message
|
|
83088
|
+
* @param {string} sessionId The session identifier
|
|
83089
|
+
* @param {string} messageId The message identifier
|
|
83090
|
+
* @param {*} [options] Override http request option.
|
|
83091
|
+
* @throws {RequiredError}
|
|
83092
|
+
*/
|
|
83093
|
+
deleteStreamSessionChatMessage: (sessionId: string, messageId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83070
83094
|
/**
|
|
83071
83095
|
* 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.
|
|
83072
83096
|
* @summary Request an export of a stream session
|
|
@@ -83160,6 +83184,18 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83160
83184
|
* @throws {RequiredError}
|
|
83161
83185
|
*/
|
|
83162
83186
|
getStreamSessionSubscriptions: (streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83187
|
+
/**
|
|
83188
|
+
* Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83189
|
+
* @summary List the people watching a stream session
|
|
83190
|
+
* @param {string} sessionId The session identifier
|
|
83191
|
+
* @param {number} [page] Page number
|
|
83192
|
+
* @param {number} [pageSize] Number of items per page
|
|
83193
|
+
* @param {string} [orderBy] Field to order by
|
|
83194
|
+
* @param {string} [search] Search query
|
|
83195
|
+
* @param {*} [options] Override http request option.
|
|
83196
|
+
* @throws {RequiredError}
|
|
83197
|
+
*/
|
|
83198
|
+
getStreamSessionViewers: (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83163
83199
|
/**
|
|
83164
83200
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83165
83201
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -83196,6 +83232,15 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83196
83232
|
* @throws {RequiredError}
|
|
83197
83233
|
*/
|
|
83198
83234
|
closeStreamSession(streamId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
83235
|
+
/**
|
|
83236
|
+
* 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.
|
|
83237
|
+
* @summary Delete a stream session chat message
|
|
83238
|
+
* @param {string} sessionId The session identifier
|
|
83239
|
+
* @param {string} messageId The message identifier
|
|
83240
|
+
* @param {*} [options] Override http request option.
|
|
83241
|
+
* @throws {RequiredError}
|
|
83242
|
+
*/
|
|
83243
|
+
deleteStreamSessionChatMessage(sessionId: string, messageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
83199
83244
|
/**
|
|
83200
83245
|
* 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.
|
|
83201
83246
|
* @summary Request an export of a stream session
|
|
@@ -83289,6 +83334,18 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83289
83334
|
* @throws {RequiredError}
|
|
83290
83335
|
*/
|
|
83291
83336
|
getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
|
|
83337
|
+
/**
|
|
83338
|
+
* Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83339
|
+
* @summary List the people watching a stream session
|
|
83340
|
+
* @param {string} sessionId The session identifier
|
|
83341
|
+
* @param {number} [page] Page number
|
|
83342
|
+
* @param {number} [pageSize] Number of items per page
|
|
83343
|
+
* @param {string} [orderBy] Field to order by
|
|
83344
|
+
* @param {string} [search] Search query
|
|
83345
|
+
* @param {*} [options] Override http request option.
|
|
83346
|
+
* @throws {RequiredError}
|
|
83347
|
+
*/
|
|
83348
|
+
getStreamSessionViewers(sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
|
|
83292
83349
|
/**
|
|
83293
83350
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83294
83351
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -83324,6 +83381,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83324
83381
|
* @throws {RequiredError}
|
|
83325
83382
|
*/
|
|
83326
83383
|
closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
83384
|
+
/**
|
|
83385
|
+
* 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.
|
|
83386
|
+
* @summary Delete a stream session chat message
|
|
83387
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
83388
|
+
* @param {*} [options] Override http request option.
|
|
83389
|
+
* @throws {RequiredError}
|
|
83390
|
+
*/
|
|
83391
|
+
deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
83327
83392
|
/**
|
|
83328
83393
|
* 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.
|
|
83329
83394
|
* @summary Request an export of a stream session
|
|
@@ -83396,6 +83461,14 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83396
83461
|
* @throws {RequiredError}
|
|
83397
83462
|
*/
|
|
83398
83463
|
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
|
|
83464
|
+
/**
|
|
83465
|
+
* Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83466
|
+
* @summary List the people watching a stream session
|
|
83467
|
+
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
83468
|
+
* @param {*} [options] Override http request option.
|
|
83469
|
+
* @throws {RequiredError}
|
|
83470
|
+
*/
|
|
83471
|
+
getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionViewers200Response>;
|
|
83399
83472
|
/**
|
|
83400
83473
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83401
83474
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -83426,6 +83499,19 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
|
|
|
83426
83499
|
*/
|
|
83427
83500
|
readonly sessionId: string;
|
|
83428
83501
|
}
|
|
83502
|
+
/**
|
|
83503
|
+
* Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
|
|
83504
|
+
*/
|
|
83505
|
+
export interface StreamsSessionsApiDeleteStreamSessionChatMessageRequest {
|
|
83506
|
+
/**
|
|
83507
|
+
* The session identifier
|
|
83508
|
+
*/
|
|
83509
|
+
readonly sessionId: string;
|
|
83510
|
+
/**
|
|
83511
|
+
* The message identifier
|
|
83512
|
+
*/
|
|
83513
|
+
readonly messageId: string;
|
|
83514
|
+
}
|
|
83429
83515
|
/**
|
|
83430
83516
|
* Request parameters for exportStreamSession operation in StreamsSessionsApi.
|
|
83431
83517
|
*/
|
|
@@ -83591,6 +83677,31 @@ export interface StreamsSessionsApiGetStreamSessionSubscriptionsRequest {
|
|
|
83591
83677
|
*/
|
|
83592
83678
|
readonly search?: string;
|
|
83593
83679
|
}
|
|
83680
|
+
/**
|
|
83681
|
+
* Request parameters for getStreamSessionViewers operation in StreamsSessionsApi.
|
|
83682
|
+
*/
|
|
83683
|
+
export interface StreamsSessionsApiGetStreamSessionViewersRequest {
|
|
83684
|
+
/**
|
|
83685
|
+
* The session identifier
|
|
83686
|
+
*/
|
|
83687
|
+
readonly sessionId: string;
|
|
83688
|
+
/**
|
|
83689
|
+
* Page number
|
|
83690
|
+
*/
|
|
83691
|
+
readonly page?: number;
|
|
83692
|
+
/**
|
|
83693
|
+
* Number of items per page
|
|
83694
|
+
*/
|
|
83695
|
+
readonly pageSize?: number;
|
|
83696
|
+
/**
|
|
83697
|
+
* Field to order by
|
|
83698
|
+
*/
|
|
83699
|
+
readonly orderBy?: string;
|
|
83700
|
+
/**
|
|
83701
|
+
* Search query
|
|
83702
|
+
*/
|
|
83703
|
+
readonly search?: string;
|
|
83704
|
+
}
|
|
83594
83705
|
/**
|
|
83595
83706
|
* Request parameters for getStreamSessions operation in StreamsSessionsApi.
|
|
83596
83707
|
*/
|
|
@@ -83642,6 +83753,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
83642
83753
|
* @throws {RequiredError}
|
|
83643
83754
|
*/
|
|
83644
83755
|
closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
83756
|
+
/**
|
|
83757
|
+
* 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.
|
|
83758
|
+
* @summary Delete a stream session chat message
|
|
83759
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
83760
|
+
* @param {*} [options] Override http request option.
|
|
83761
|
+
* @throws {RequiredError}
|
|
83762
|
+
*/
|
|
83763
|
+
deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
83645
83764
|
/**
|
|
83646
83765
|
* 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.
|
|
83647
83766
|
* @summary Request an export of a stream session
|
|
@@ -83714,6 +83833,14 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
83714
83833
|
* @throws {RequiredError}
|
|
83715
83834
|
*/
|
|
83716
83835
|
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
|
|
83836
|
+
/**
|
|
83837
|
+
* Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83838
|
+
* @summary List the people watching a stream session
|
|
83839
|
+
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
83840
|
+
* @param {*} [options] Override http request option.
|
|
83841
|
+
* @throws {RequiredError}
|
|
83842
|
+
*/
|
|
83843
|
+
getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionViewers200Response, any, {}, any>>;
|
|
83717
83844
|
/**
|
|
83718
83845
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83719
83846
|
* @summary List a stream\'s broadcast sessions
|
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.8.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2010,6 +2010,10 @@ export var GetStreamSessionByIdSubscriptions200ResponseStatusEnum;
|
|
|
2010
2010
|
(function (GetStreamSessionByIdSubscriptions200ResponseStatusEnum) {
|
|
2011
2011
|
GetStreamSessionByIdSubscriptions200ResponseStatusEnum["Ok"] = "ok";
|
|
2012
2012
|
})(GetStreamSessionByIdSubscriptions200ResponseStatusEnum || (GetStreamSessionByIdSubscriptions200ResponseStatusEnum = {}));
|
|
2013
|
+
export var GetStreamSessionViewers200ResponseStatusEnum;
|
|
2014
|
+
(function (GetStreamSessionViewers200ResponseStatusEnum) {
|
|
2015
|
+
GetStreamSessionViewers200ResponseStatusEnum["Ok"] = "ok";
|
|
2016
|
+
})(GetStreamSessionViewers200ResponseStatusEnum || (GetStreamSessionViewers200ResponseStatusEnum = {}));
|
|
2013
2017
|
export var GetStreamVideos200ResponseStatusEnum;
|
|
2014
2018
|
(function (GetStreamVideos200ResponseStatusEnum) {
|
|
2015
2019
|
GetStreamVideos200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -106791,6 +106795,44 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
106791
106795
|
options: localVarRequestOptions,
|
|
106792
106796
|
};
|
|
106793
106797
|
}),
|
|
106798
|
+
/**
|
|
106799
|
+
* 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.
|
|
106800
|
+
* @summary Delete a stream session chat message
|
|
106801
|
+
* @param {string} sessionId The session identifier
|
|
106802
|
+
* @param {string} messageId The message identifier
|
|
106803
|
+
* @param {*} [options] Override http request option.
|
|
106804
|
+
* @throws {RequiredError}
|
|
106805
|
+
*/
|
|
106806
|
+
deleteStreamSessionChatMessage: (sessionId_1, messageId_1, ...args_1) => __awaiter(this, [sessionId_1, messageId_1, ...args_1], void 0, function* (sessionId, messageId, options = {}) {
|
|
106807
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
106808
|
+
assertParamExists('deleteStreamSessionChatMessage', 'sessionId', sessionId);
|
|
106809
|
+
// verify required parameter 'messageId' is not null or undefined
|
|
106810
|
+
assertParamExists('deleteStreamSessionChatMessage', 'messageId', messageId);
|
|
106811
|
+
const localVarPath = `/streams/sessions/{sessionId}/chat/{messageId}`
|
|
106812
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)))
|
|
106813
|
+
.replace('{messageId}', encodeURIComponent(String(messageId)));
|
|
106814
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
106815
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
106816
|
+
let baseOptions;
|
|
106817
|
+
if (configuration) {
|
|
106818
|
+
baseOptions = configuration.baseOptions;
|
|
106819
|
+
}
|
|
106820
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
106821
|
+
const localVarHeaderParameter = {};
|
|
106822
|
+
const localVarQueryParameter = {};
|
|
106823
|
+
// authentication ApiKeyAuth required
|
|
106824
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
106825
|
+
// authentication OrganizationId required
|
|
106826
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
106827
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
106828
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
106829
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
106830
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
106831
|
+
return {
|
|
106832
|
+
url: toPathString(localVarUrlObj),
|
|
106833
|
+
options: localVarRequestOptions,
|
|
106834
|
+
};
|
|
106835
|
+
}),
|
|
106794
106836
|
/**
|
|
106795
106837
|
* 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.
|
|
106796
106838
|
* @summary Request an export of a stream session
|
|
@@ -107181,6 +107223,56 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107181
107223
|
options: localVarRequestOptions,
|
|
107182
107224
|
};
|
|
107183
107225
|
}),
|
|
107226
|
+
/**
|
|
107227
|
+
* Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
|
|
107228
|
+
* @summary List the people watching a stream session
|
|
107229
|
+
* @param {string} sessionId The session identifier
|
|
107230
|
+
* @param {number} [page] Page number
|
|
107231
|
+
* @param {number} [pageSize] Number of items per page
|
|
107232
|
+
* @param {string} [orderBy] Field to order by
|
|
107233
|
+
* @param {string} [search] Search query
|
|
107234
|
+
* @param {*} [options] Override http request option.
|
|
107235
|
+
* @throws {RequiredError}
|
|
107236
|
+
*/
|
|
107237
|
+
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 = {}) {
|
|
107238
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
107239
|
+
assertParamExists('getStreamSessionViewers', 'sessionId', sessionId);
|
|
107240
|
+
const localVarPath = `/streams/sessions/{sessionId}/viewers`
|
|
107241
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
107242
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
107243
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
107244
|
+
let baseOptions;
|
|
107245
|
+
if (configuration) {
|
|
107246
|
+
baseOptions = configuration.baseOptions;
|
|
107247
|
+
}
|
|
107248
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
107249
|
+
const localVarHeaderParameter = {};
|
|
107250
|
+
const localVarQueryParameter = {};
|
|
107251
|
+
// authentication ApiKeyAuth required
|
|
107252
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107253
|
+
// authentication OrganizationId required
|
|
107254
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107255
|
+
if (page !== undefined) {
|
|
107256
|
+
localVarQueryParameter['page'] = page;
|
|
107257
|
+
}
|
|
107258
|
+
if (pageSize !== undefined) {
|
|
107259
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
107260
|
+
}
|
|
107261
|
+
if (orderBy !== undefined) {
|
|
107262
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
107263
|
+
}
|
|
107264
|
+
if (search !== undefined) {
|
|
107265
|
+
localVarQueryParameter['search'] = search;
|
|
107266
|
+
}
|
|
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
|
+
return {
|
|
107272
|
+
url: toPathString(localVarUrlObj),
|
|
107273
|
+
options: localVarRequestOptions,
|
|
107274
|
+
};
|
|
107275
|
+
}),
|
|
107184
107276
|
/**
|
|
107185
107277
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
107186
107278
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -107299,6 +107391,23 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
107299
107391
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107300
107392
|
});
|
|
107301
107393
|
},
|
|
107394
|
+
/**
|
|
107395
|
+
* 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.
|
|
107396
|
+
* @summary Delete a stream session chat message
|
|
107397
|
+
* @param {string} sessionId The session identifier
|
|
107398
|
+
* @param {string} messageId The message identifier
|
|
107399
|
+
* @param {*} [options] Override http request option.
|
|
107400
|
+
* @throws {RequiredError}
|
|
107401
|
+
*/
|
|
107402
|
+
deleteStreamSessionChatMessage(sessionId, messageId, options) {
|
|
107403
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107404
|
+
var _a, _b, _c;
|
|
107405
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteStreamSessionChatMessage(sessionId, messageId, options);
|
|
107406
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107407
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.deleteStreamSessionChatMessage']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107408
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107409
|
+
});
|
|
107410
|
+
},
|
|
107302
107411
|
/**
|
|
107303
107412
|
* 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.
|
|
107304
107413
|
* @summary Request an export of a stream session
|
|
@@ -107464,6 +107573,26 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
107464
107573
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107465
107574
|
});
|
|
107466
107575
|
},
|
|
107576
|
+
/**
|
|
107577
|
+
* Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
|
|
107578
|
+
* @summary List the people watching a stream session
|
|
107579
|
+
* @param {string} sessionId The session identifier
|
|
107580
|
+
* @param {number} [page] Page number
|
|
107581
|
+
* @param {number} [pageSize] Number of items per page
|
|
107582
|
+
* @param {string} [orderBy] Field to order by
|
|
107583
|
+
* @param {string} [search] Search query
|
|
107584
|
+
* @param {*} [options] Override http request option.
|
|
107585
|
+
* @throws {RequiredError}
|
|
107586
|
+
*/
|
|
107587
|
+
getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options) {
|
|
107588
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
107589
|
+
var _a, _b, _c;
|
|
107590
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options);
|
|
107591
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107592
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionViewers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107593
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
107594
|
+
});
|
|
107595
|
+
},
|
|
107467
107596
|
/**
|
|
107468
107597
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
107469
107598
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -107520,6 +107649,16 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
107520
107649
|
closeStreamSession(requestParameters, options) {
|
|
107521
107650
|
return localVarFp.closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107522
107651
|
},
|
|
107652
|
+
/**
|
|
107653
|
+
* 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.
|
|
107654
|
+
* @summary Delete a stream session chat message
|
|
107655
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
107656
|
+
* @param {*} [options] Override http request option.
|
|
107657
|
+
* @throws {RequiredError}
|
|
107658
|
+
*/
|
|
107659
|
+
deleteStreamSessionChatMessage(requestParameters, options) {
|
|
107660
|
+
return localVarFp.deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(axios, basePath));
|
|
107661
|
+
},
|
|
107523
107662
|
/**
|
|
107524
107663
|
* 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.
|
|
107525
107664
|
* @summary Request an export of a stream session
|
|
@@ -107610,6 +107749,16 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
107610
107749
|
getStreamSessionSubscriptions(requestParameters, options) {
|
|
107611
107750
|
return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107612
107751
|
},
|
|
107752
|
+
/**
|
|
107753
|
+
* Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
|
|
107754
|
+
* @summary List the people watching a stream session
|
|
107755
|
+
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
107756
|
+
* @param {*} [options] Override http request option.
|
|
107757
|
+
* @throws {RequiredError}
|
|
107758
|
+
*/
|
|
107759
|
+
getStreamSessionViewers(requestParameters, options) {
|
|
107760
|
+
return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107761
|
+
},
|
|
107613
107762
|
/**
|
|
107614
107763
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
107615
107764
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -107646,6 +107795,16 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
107646
107795
|
closeStreamSession(requestParameters, options) {
|
|
107647
107796
|
return StreamsSessionsApiFp(this.configuration).closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107648
107797
|
}
|
|
107798
|
+
/**
|
|
107799
|
+
* 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.
|
|
107800
|
+
* @summary Delete a stream session chat message
|
|
107801
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
107802
|
+
* @param {*} [options] Override http request option.
|
|
107803
|
+
* @throws {RequiredError}
|
|
107804
|
+
*/
|
|
107805
|
+
deleteStreamSessionChatMessage(requestParameters, options) {
|
|
107806
|
+
return StreamsSessionsApiFp(this.configuration).deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(this.axios, this.basePath));
|
|
107807
|
+
}
|
|
107649
107808
|
/**
|
|
107650
107809
|
* 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.
|
|
107651
107810
|
* @summary Request an export of a stream session
|
|
@@ -107736,6 +107895,16 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
107736
107895
|
getStreamSessionSubscriptions(requestParameters, options) {
|
|
107737
107896
|
return 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));
|
|
107738
107897
|
}
|
|
107898
|
+
/**
|
|
107899
|
+
* Returns a paginated list of the accounts currently watching the given stream session, one row per account with how many active connections it holds and when its earliest one connected; the count is the number of people watching, where the subscriptions list counts connections. Requires read permission on streams.
|
|
107900
|
+
* @summary List the people watching a stream session
|
|
107901
|
+
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
107902
|
+
* @param {*} [options] Override http request option.
|
|
107903
|
+
* @throws {RequiredError}
|
|
107904
|
+
*/
|
|
107905
|
+
getStreamSessionViewers(requestParameters, options) {
|
|
107906
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
107907
|
+
}
|
|
107739
107908
|
/**
|
|
107740
107909
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
107741
107910
|
* @summary List a stream\'s broadcast sessions
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 13.
|
|
5
|
+
* The version of the OpenAPI document: 13.8.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.8.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 13.
|
|
5
|
+
* The version of the OpenAPI document: 13.8.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 13.
|
|
7
|
+
* The version of the OpenAPI document: 13.8.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 13.
|
|
5
|
+
* The version of the OpenAPI document: 13.8.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 13.
|
|
6
|
+
* The version of the OpenAPI document: 13.8.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetStreamSessionViewers200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<StreamSessionViewer>**](StreamSessionViewer.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetStreamSessionViewers200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetStreamSessionViewers200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# StreamSessionViewer
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**accountId** | **string** | | [default to undefined]
|
|
9
|
+
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
10
|
+
**activeConnections** | **number** | | [default to undefined]
|
|
11
|
+
**connectedAt** | **string** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { StreamSessionViewer } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: StreamSessionViewer = {
|
|
19
|
+
accountId,
|
|
20
|
+
account,
|
|
21
|
+
activeConnections,
|
|
22
|
+
connectedAt,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|