@connectedxm/admin-sdk 13.8.0 → 14.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +33 -18
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +25 -15
- package/dist/api.js +23 -18
- 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 +25 -15
- package/dist/esm/api.js +23 -18
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/StreamSessionViewer.md +8 -0
- package/docs/StreamsSessionsApi.md +6 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@
|
|
1
|
+
## @connectedxm/admin-sdk@14.1.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@
|
|
39
|
+
npm install @connectedxm/admin-sdk@14.1.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 14.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -15167,8 +15167,12 @@ export interface StreamSessionUpdateInputs {
|
|
|
15167
15167
|
export interface StreamSessionViewer {
|
|
15168
15168
|
'accountId': string | null;
|
|
15169
15169
|
'account': BaseAccount | null;
|
|
15170
|
+
'active': boolean;
|
|
15170
15171
|
'activeConnections': number;
|
|
15172
|
+
'connections': number;
|
|
15171
15173
|
'connectedAt': string;
|
|
15174
|
+
'disconnectedAt': string | null;
|
|
15175
|
+
'duration': number;
|
|
15172
15176
|
}
|
|
15173
15177
|
export interface StripeActivationFormParams {
|
|
15174
15178
|
'clientPublicKey': string;
|
|
@@ -152227,7 +152231,7 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
152227
152231
|
};
|
|
152228
152232
|
},
|
|
152229
152233
|
/**
|
|
152230
|
-
* 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.
|
|
152234
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
152231
152235
|
* @summary List a stream session\'s viewer connections by session id
|
|
152232
152236
|
* @param {string} sessionId The session identifier
|
|
152233
152237
|
* @param {boolean} [active] Filter by active
|
|
@@ -152405,9 +152409,10 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
152405
152409
|
};
|
|
152406
152410
|
},
|
|
152407
152411
|
/**
|
|
152408
|
-
* Returns a paginated list of the accounts
|
|
152409
|
-
* @summary List the people
|
|
152412
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
152413
|
+
* @summary List the people who watched a stream session
|
|
152410
152414
|
* @param {string} sessionId The session identifier
|
|
152415
|
+
* @param {boolean} [active] Filter by active
|
|
152411
152416
|
* @param {number} [page] Page number
|
|
152412
152417
|
* @param {number} [pageSize] Number of items per page
|
|
152413
152418
|
* @param {string} [orderBy] Field to order by
|
|
@@ -152415,7 +152420,7 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
152415
152420
|
* @param {*} [options] Override http request option.
|
|
152416
152421
|
* @throws {RequiredError}
|
|
152417
152422
|
*/
|
|
152418
|
-
getStreamSessionViewers: async (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152423
|
+
getStreamSessionViewers: async (sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152419
152424
|
// verify required parameter 'sessionId' is not null or undefined
|
|
152420
152425
|
assertParamExists('getStreamSessionViewers', 'sessionId', sessionId)
|
|
152421
152426
|
const localVarPath = `/streams/sessions/{sessionId}/viewers`
|
|
@@ -152437,6 +152442,10 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
152437
152442
|
// authentication OrganizationId required
|
|
152438
152443
|
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
152439
152444
|
|
|
152445
|
+
if (active !== undefined) {
|
|
152446
|
+
localVarQueryParameter['active'] = active;
|
|
152447
|
+
}
|
|
152448
|
+
|
|
152440
152449
|
if (page !== undefined) {
|
|
152441
152450
|
localVarQueryParameter['page'] = page;
|
|
152442
152451
|
}
|
|
@@ -152699,7 +152708,7 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
152699
152708
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152700
152709
|
},
|
|
152701
152710
|
/**
|
|
152702
|
-
* 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.
|
|
152711
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
152703
152712
|
* @summary List a stream session\'s viewer connections by session id
|
|
152704
152713
|
* @param {string} sessionId The session identifier
|
|
152705
152714
|
* @param {boolean} [active] Filter by active
|
|
@@ -152750,9 +152759,10 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
152750
152759
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152751
152760
|
},
|
|
152752
152761
|
/**
|
|
152753
|
-
* Returns a paginated list of the accounts
|
|
152754
|
-
* @summary List the people
|
|
152762
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
152763
|
+
* @summary List the people who watched a stream session
|
|
152755
152764
|
* @param {string} sessionId The session identifier
|
|
152765
|
+
* @param {boolean} [active] Filter by active
|
|
152756
152766
|
* @param {number} [page] Page number
|
|
152757
152767
|
* @param {number} [pageSize] Number of items per page
|
|
152758
152768
|
* @param {string} [orderBy] Field to order by
|
|
@@ -152760,8 +152770,8 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
152760
152770
|
* @param {*} [options] Override http request option.
|
|
152761
152771
|
* @throws {RequiredError}
|
|
152762
152772
|
*/
|
|
152763
|
-
async getStreamSessionViewers(sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>> {
|
|
152764
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options);
|
|
152773
|
+
async getStreamSessionViewers(sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>> {
|
|
152774
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options);
|
|
152765
152775
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152766
152776
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionViewers']?.[localVarOperationServerIndex]?.url;
|
|
152767
152777
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -152888,7 +152898,7 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
152888
152898
|
return localVarFp.getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
152889
152899
|
},
|
|
152890
152900
|
/**
|
|
152891
|
-
* 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.
|
|
152901
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
152892
152902
|
* @summary List a stream session\'s viewer connections by session id
|
|
152893
152903
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
152894
152904
|
* @param {*} [options] Override http request option.
|
|
@@ -152918,14 +152928,14 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
152918
152928
|
return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
152919
152929
|
},
|
|
152920
152930
|
/**
|
|
152921
|
-
* Returns a paginated list of the accounts
|
|
152922
|
-
* @summary List the people
|
|
152931
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
152932
|
+
* @summary List the people who watched a stream session
|
|
152923
152933
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
152924
152934
|
* @param {*} [options] Override http request option.
|
|
152925
152935
|
* @throws {RequiredError}
|
|
152926
152936
|
*/
|
|
152927
152937
|
getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionViewers200Response> {
|
|
152928
|
-
return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
152938
|
+
return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
152929
152939
|
},
|
|
152930
152940
|
/**
|
|
152931
152941
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
@@ -153184,6 +153194,11 @@ export interface StreamsSessionsApiGetStreamSessionViewersRequest {
|
|
|
153184
153194
|
*/
|
|
153185
153195
|
readonly sessionId: string
|
|
153186
153196
|
|
|
153197
|
+
/**
|
|
153198
|
+
* Filter by active
|
|
153199
|
+
*/
|
|
153200
|
+
readonly active?: boolean
|
|
153201
|
+
|
|
153187
153202
|
/**
|
|
153188
153203
|
* Page number
|
|
153189
153204
|
*/
|
|
@@ -153345,7 +153360,7 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
153345
153360
|
}
|
|
153346
153361
|
|
|
153347
153362
|
/**
|
|
153348
|
-
* 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.
|
|
153363
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
153349
153364
|
* @summary List a stream session\'s viewer connections by session id
|
|
153350
153365
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
153351
153366
|
* @param {*} [options] Override http request option.
|
|
@@ -153378,14 +153393,14 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
153378
153393
|
}
|
|
153379
153394
|
|
|
153380
153395
|
/**
|
|
153381
|
-
* Returns a paginated list of the accounts
|
|
153382
|
-
* @summary List the people
|
|
153396
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
153397
|
+
* @summary List the people who watched a stream session
|
|
153383
153398
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
153384
153399
|
* @param {*} [options] Override http request option.
|
|
153385
153400
|
* @throws {RequiredError}
|
|
153386
153401
|
*/
|
|
153387
153402
|
public getStreamSessionViewers(requestParameters: StreamsSessionsApiGetStreamSessionViewersRequest, options?: RawAxiosRequestConfig) {
|
|
153388
|
-
return StreamsSessionsApiFp(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
153403
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
153389
153404
|
}
|
|
153390
153405
|
|
|
153391
153406
|
/**
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 14.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 14.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document:
|
|
6
|
+
* The version of the OpenAPI document: 14.1.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 14.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13497,8 +13497,12 @@ export interface StreamSessionUpdateInputs {
|
|
|
13497
13497
|
export interface StreamSessionViewer {
|
|
13498
13498
|
'accountId': string | null;
|
|
13499
13499
|
'account': BaseAccount | null;
|
|
13500
|
+
'active': boolean;
|
|
13500
13501
|
'activeConnections': number;
|
|
13502
|
+
'connections': number;
|
|
13501
13503
|
'connectedAt': string;
|
|
13504
|
+
'disconnectedAt': string | null;
|
|
13505
|
+
'duration': number;
|
|
13502
13506
|
}
|
|
13503
13507
|
export interface StripeActivationFormParams {
|
|
13504
13508
|
'clientPublicKey': string;
|
|
@@ -83149,7 +83153,7 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83149
83153
|
*/
|
|
83150
83154
|
getStreamSessionByIdChat: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83151
83155
|
/**
|
|
83152
|
-
* 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.
|
|
83156
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
83153
83157
|
* @summary List a stream session\'s viewer connections by session id
|
|
83154
83158
|
* @param {string} sessionId The session identifier
|
|
83155
83159
|
* @param {boolean} [active] Filter by active
|
|
@@ -83185,9 +83189,10 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83185
83189
|
*/
|
|
83186
83190
|
getStreamSessionSubscriptions: (streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83187
83191
|
/**
|
|
83188
|
-
* Returns a paginated list of the accounts
|
|
83189
|
-
* @summary List the people
|
|
83192
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83193
|
+
* @summary List the people who watched a stream session
|
|
83190
83194
|
* @param {string} sessionId The session identifier
|
|
83195
|
+
* @param {boolean} [active] Filter by active
|
|
83191
83196
|
* @param {number} [page] Page number
|
|
83192
83197
|
* @param {number} [pageSize] Number of items per page
|
|
83193
83198
|
* @param {string} [orderBy] Field to order by
|
|
@@ -83195,7 +83200,7 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83195
83200
|
* @param {*} [options] Override http request option.
|
|
83196
83201
|
* @throws {RequiredError}
|
|
83197
83202
|
*/
|
|
83198
|
-
getStreamSessionViewers: (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83203
|
+
getStreamSessionViewers: (sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83199
83204
|
/**
|
|
83200
83205
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83201
83206
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -83299,7 +83304,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83299
83304
|
*/
|
|
83300
83305
|
getStreamSessionByIdChat(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdChat200Response>>;
|
|
83301
83306
|
/**
|
|
83302
|
-
* 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.
|
|
83307
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
83303
83308
|
* @summary List a stream session\'s viewer connections by session id
|
|
83304
83309
|
* @param {string} sessionId The session identifier
|
|
83305
83310
|
* @param {boolean} [active] Filter by active
|
|
@@ -83335,9 +83340,10 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83335
83340
|
*/
|
|
83336
83341
|
getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
|
|
83337
83342
|
/**
|
|
83338
|
-
* Returns a paginated list of the accounts
|
|
83339
|
-
* @summary List the people
|
|
83343
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83344
|
+
* @summary List the people who watched a stream session
|
|
83340
83345
|
* @param {string} sessionId The session identifier
|
|
83346
|
+
* @param {boolean} [active] Filter by active
|
|
83341
83347
|
* @param {number} [page] Page number
|
|
83342
83348
|
* @param {number} [pageSize] Number of items per page
|
|
83343
83349
|
* @param {string} [orderBy] Field to order by
|
|
@@ -83345,7 +83351,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83345
83351
|
* @param {*} [options] Override http request option.
|
|
83346
83352
|
* @throws {RequiredError}
|
|
83347
83353
|
*/
|
|
83348
|
-
getStreamSessionViewers(sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
|
|
83354
|
+
getStreamSessionViewers(sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
|
|
83349
83355
|
/**
|
|
83350
83356
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83351
83357
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -83438,7 +83444,7 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83438
83444
|
*/
|
|
83439
83445
|
getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response>;
|
|
83440
83446
|
/**
|
|
83441
|
-
* 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.
|
|
83447
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
83442
83448
|
* @summary List a stream session\'s viewer connections by session id
|
|
83443
83449
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
83444
83450
|
* @param {*} [options] Override http request option.
|
|
@@ -83462,8 +83468,8 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83462
83468
|
*/
|
|
83463
83469
|
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
|
|
83464
83470
|
/**
|
|
83465
|
-
* Returns a paginated list of the accounts
|
|
83466
|
-
* @summary List the people
|
|
83471
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83472
|
+
* @summary List the people who watched a stream session
|
|
83467
83473
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
83468
83474
|
* @param {*} [options] Override http request option.
|
|
83469
83475
|
* @throws {RequiredError}
|
|
@@ -83685,6 +83691,10 @@ export interface StreamsSessionsApiGetStreamSessionViewersRequest {
|
|
|
83685
83691
|
* The session identifier
|
|
83686
83692
|
*/
|
|
83687
83693
|
readonly sessionId: string;
|
|
83694
|
+
/**
|
|
83695
|
+
* Filter by active
|
|
83696
|
+
*/
|
|
83697
|
+
readonly active?: boolean;
|
|
83688
83698
|
/**
|
|
83689
83699
|
* Page number
|
|
83690
83700
|
*/
|
|
@@ -83810,7 +83820,7 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
83810
83820
|
*/
|
|
83811
83821
|
getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdChat200Response, any, {}, any>>;
|
|
83812
83822
|
/**
|
|
83813
|
-
* 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.
|
|
83823
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
83814
83824
|
* @summary List a stream session\'s viewer connections by session id
|
|
83815
83825
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
83816
83826
|
* @param {*} [options] Override http request option.
|
|
@@ -83834,8 +83844,8 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
83834
83844
|
*/
|
|
83835
83845
|
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
|
|
83836
83846
|
/**
|
|
83837
|
-
* Returns a paginated list of the accounts
|
|
83838
|
-
* @summary List the people
|
|
83847
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83848
|
+
* @summary List the people who watched a stream session
|
|
83839
83849
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
83840
83850
|
* @param {*} [options] Override http request option.
|
|
83841
83851
|
* @throws {RequiredError}
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document:
|
|
8
|
+
* The version of the OpenAPI document: 14.1.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -107850,7 +107850,7 @@ const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107850
107850
|
};
|
|
107851
107851
|
}),
|
|
107852
107852
|
/**
|
|
107853
|
-
* 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.
|
|
107853
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
107854
107854
|
* @summary List a stream session\'s viewer connections by session id
|
|
107855
107855
|
* @param {string} sessionId The session identifier
|
|
107856
107856
|
* @param {boolean} [active] Filter by active
|
|
@@ -108000,9 +108000,10 @@ const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
108000
108000
|
};
|
|
108001
108001
|
}),
|
|
108002
108002
|
/**
|
|
108003
|
-
* Returns a paginated list of the accounts
|
|
108004
|
-
* @summary List the people
|
|
108003
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
108004
|
+
* @summary List the people who watched a stream session
|
|
108005
108005
|
* @param {string} sessionId The session identifier
|
|
108006
|
+
* @param {boolean} [active] Filter by active
|
|
108006
108007
|
* @param {number} [page] Page number
|
|
108007
108008
|
* @param {number} [pageSize] Number of items per page
|
|
108008
108009
|
* @param {string} [orderBy] Field to order by
|
|
@@ -108010,7 +108011,7 @@ const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
108010
108011
|
* @param {*} [options] Override http request option.
|
|
108011
108012
|
* @throws {RequiredError}
|
|
108012
108013
|
*/
|
|
108013
|
-
getStreamSessionViewers: (sessionId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [sessionId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (sessionId, page, pageSize, orderBy, search, options = {}) {
|
|
108014
|
+
getStreamSessionViewers: (sessionId_1, active_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [sessionId_1, active_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (sessionId, active, page, pageSize, orderBy, search, options = {}) {
|
|
108014
108015
|
// verify required parameter 'sessionId' is not null or undefined
|
|
108015
108016
|
(0, common_1.assertParamExists)('getStreamSessionViewers', 'sessionId', sessionId);
|
|
108016
108017
|
const localVarPath = `/streams/sessions/{sessionId}/viewers`
|
|
@@ -108028,6 +108029,9 @@ const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
108028
108029
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "api-key", configuration);
|
|
108029
108030
|
// authentication OrganizationId required
|
|
108030
108031
|
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "organization", configuration);
|
|
108032
|
+
if (active !== undefined) {
|
|
108033
|
+
localVarQueryParameter['active'] = active;
|
|
108034
|
+
}
|
|
108031
108035
|
if (page !== undefined) {
|
|
108032
108036
|
localVarQueryParameter['page'] = page;
|
|
108033
108037
|
}
|
|
@@ -108291,7 +108295,7 @@ const StreamsSessionsApiFp = function (configuration) {
|
|
|
108291
108295
|
});
|
|
108292
108296
|
},
|
|
108293
108297
|
/**
|
|
108294
|
-
* 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.
|
|
108298
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
108295
108299
|
* @summary List a stream session\'s viewer connections by session id
|
|
108296
108300
|
* @param {string} sessionId The session identifier
|
|
108297
108301
|
* @param {boolean} [active] Filter by active
|
|
@@ -108351,9 +108355,10 @@ const StreamsSessionsApiFp = function (configuration) {
|
|
|
108351
108355
|
});
|
|
108352
108356
|
},
|
|
108353
108357
|
/**
|
|
108354
|
-
* Returns a paginated list of the accounts
|
|
108355
|
-
* @summary List the people
|
|
108358
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
108359
|
+
* @summary List the people who watched a stream session
|
|
108356
108360
|
* @param {string} sessionId The session identifier
|
|
108361
|
+
* @param {boolean} [active] Filter by active
|
|
108357
108362
|
* @param {number} [page] Page number
|
|
108358
108363
|
* @param {number} [pageSize] Number of items per page
|
|
108359
108364
|
* @param {string} [orderBy] Field to order by
|
|
@@ -108361,10 +108366,10 @@ const StreamsSessionsApiFp = function (configuration) {
|
|
|
108361
108366
|
* @param {*} [options] Override http request option.
|
|
108362
108367
|
* @throws {RequiredError}
|
|
108363
108368
|
*/
|
|
108364
|
-
getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options) {
|
|
108369
|
+
getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options) {
|
|
108365
108370
|
return __awaiter(this, void 0, void 0, function* () {
|
|
108366
108371
|
var _a, _b, _c;
|
|
108367
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options);
|
|
108372
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options);
|
|
108368
108373
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
108369
108374
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['StreamsSessionsApi.getStreamSessionViewers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
108370
108375
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -108498,7 +108503,7 @@ const StreamsSessionsApiFactory = function (configuration, basePath, axios) {
|
|
|
108498
108503
|
return localVarFp.getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
108499
108504
|
},
|
|
108500
108505
|
/**
|
|
108501
|
-
* 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.
|
|
108506
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
108502
108507
|
* @summary List a stream session\'s viewer connections by session id
|
|
108503
108508
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
108504
108509
|
* @param {*} [options] Override http request option.
|
|
@@ -108528,14 +108533,14 @@ const StreamsSessionsApiFactory = function (configuration, basePath, axios) {
|
|
|
108528
108533
|
return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108529
108534
|
},
|
|
108530
108535
|
/**
|
|
108531
|
-
* Returns a paginated list of the accounts
|
|
108532
|
-
* @summary List the people
|
|
108536
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
108537
|
+
* @summary List the people who watched a stream session
|
|
108533
108538
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
108534
108539
|
* @param {*} [options] Override http request option.
|
|
108535
108540
|
* @throws {RequiredError}
|
|
108536
108541
|
*/
|
|
108537
108542
|
getStreamSessionViewers(requestParameters, options) {
|
|
108538
|
-
return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108543
|
+
return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
108539
108544
|
},
|
|
108540
108545
|
/**
|
|
108541
108546
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
@@ -108645,7 +108650,7 @@ class StreamsSessionsApi extends base_1.BaseAPI {
|
|
|
108645
108650
|
return (0, exports.StreamsSessionsApiFp)(this.configuration).getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
108646
108651
|
}
|
|
108647
108652
|
/**
|
|
108648
|
-
* 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.
|
|
108653
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
108649
108654
|
* @summary List a stream session\'s viewer connections by session id
|
|
108650
108655
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
108651
108656
|
* @param {*} [options] Override http request option.
|
|
@@ -108675,14 +108680,14 @@ class StreamsSessionsApi extends base_1.BaseAPI {
|
|
|
108675
108680
|
return (0, exports.StreamsSessionsApiFp)(this.configuration).getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108676
108681
|
}
|
|
108677
108682
|
/**
|
|
108678
|
-
* Returns a paginated list of the accounts
|
|
108679
|
-
* @summary List the people
|
|
108683
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
108684
|
+
* @summary List the people who watched a stream session
|
|
108680
108685
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
108681
108686
|
* @param {*} [options] Override http request option.
|
|
108682
108687
|
* @throws {RequiredError}
|
|
108683
108688
|
*/
|
|
108684
108689
|
getStreamSessionViewers(requestParameters, options) {
|
|
108685
|
-
return (0, exports.StreamsSessionsApiFp)(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108690
|
+
return (0, exports.StreamsSessionsApiFp)(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
108686
108691
|
}
|
|
108687
108692
|
/**
|
|
108688
108693
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 14.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document:
|
|
8
|
+
* The version of the OpenAPI document: 14.1.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 14.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document:
|
|
8
|
+
* The version of the OpenAPI document: 14.1.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 14.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document:
|
|
7
|
+
* The version of the OpenAPI document: 14.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 14.1.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13497,8 +13497,12 @@ export interface StreamSessionUpdateInputs {
|
|
|
13497
13497
|
export interface StreamSessionViewer {
|
|
13498
13498
|
'accountId': string | null;
|
|
13499
13499
|
'account': BaseAccount | null;
|
|
13500
|
+
'active': boolean;
|
|
13500
13501
|
'activeConnections': number;
|
|
13502
|
+
'connections': number;
|
|
13501
13503
|
'connectedAt': string;
|
|
13504
|
+
'disconnectedAt': string | null;
|
|
13505
|
+
'duration': number;
|
|
13502
13506
|
}
|
|
13503
13507
|
export interface StripeActivationFormParams {
|
|
13504
13508
|
'clientPublicKey': string;
|
|
@@ -83149,7 +83153,7 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83149
83153
|
*/
|
|
83150
83154
|
getStreamSessionByIdChat: (sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83151
83155
|
/**
|
|
83152
|
-
* 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.
|
|
83156
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
83153
83157
|
* @summary List a stream session\'s viewer connections by session id
|
|
83154
83158
|
* @param {string} sessionId The session identifier
|
|
83155
83159
|
* @param {boolean} [active] Filter by active
|
|
@@ -83185,9 +83189,10 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83185
83189
|
*/
|
|
83186
83190
|
getStreamSessionSubscriptions: (streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83187
83191
|
/**
|
|
83188
|
-
* Returns a paginated list of the accounts
|
|
83189
|
-
* @summary List the people
|
|
83192
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83193
|
+
* @summary List the people who watched a stream session
|
|
83190
83194
|
* @param {string} sessionId The session identifier
|
|
83195
|
+
* @param {boolean} [active] Filter by active
|
|
83191
83196
|
* @param {number} [page] Page number
|
|
83192
83197
|
* @param {number} [pageSize] Number of items per page
|
|
83193
83198
|
* @param {string} [orderBy] Field to order by
|
|
@@ -83195,7 +83200,7 @@ export declare const StreamsSessionsApiAxiosParamCreator: (configuration?: Confi
|
|
|
83195
83200
|
* @param {*} [options] Override http request option.
|
|
83196
83201
|
* @throws {RequiredError}
|
|
83197
83202
|
*/
|
|
83198
|
-
getStreamSessionViewers: (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83203
|
+
getStreamSessionViewers: (sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83199
83204
|
/**
|
|
83200
83205
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83201
83206
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -83299,7 +83304,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83299
83304
|
*/
|
|
83300
83305
|
getStreamSessionByIdChat(sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdChat200Response>>;
|
|
83301
83306
|
/**
|
|
83302
|
-
* 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.
|
|
83307
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
83303
83308
|
* @summary List a stream session\'s viewer connections by session id
|
|
83304
83309
|
* @param {string} sessionId The session identifier
|
|
83305
83310
|
* @param {boolean} [active] Filter by active
|
|
@@ -83335,9 +83340,10 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83335
83340
|
*/
|
|
83336
83341
|
getStreamSessionSubscriptions(streamId: string, sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionByIdSubscriptions200Response>>;
|
|
83337
83342
|
/**
|
|
83338
|
-
* Returns a paginated list of the accounts
|
|
83339
|
-
* @summary List the people
|
|
83343
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83344
|
+
* @summary List the people who watched a stream session
|
|
83340
83345
|
* @param {string} sessionId The session identifier
|
|
83346
|
+
* @param {boolean} [active] Filter by active
|
|
83341
83347
|
* @param {number} [page] Page number
|
|
83342
83348
|
* @param {number} [pageSize] Number of items per page
|
|
83343
83349
|
* @param {string} [orderBy] Field to order by
|
|
@@ -83345,7 +83351,7 @@ export declare const StreamsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
83345
83351
|
* @param {*} [options] Override http request option.
|
|
83346
83352
|
* @throws {RequiredError}
|
|
83347
83353
|
*/
|
|
83348
|
-
getStreamSessionViewers(sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
|
|
83354
|
+
getStreamSessionViewers(sessionId: string, active?: boolean, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStreamSessionViewers200Response>>;
|
|
83349
83355
|
/**
|
|
83350
83356
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
83351
83357
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -83438,7 +83444,7 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83438
83444
|
*/
|
|
83439
83445
|
getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdChat200Response>;
|
|
83440
83446
|
/**
|
|
83441
|
-
* 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.
|
|
83447
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
83442
83448
|
* @summary List a stream session\'s viewer connections by session id
|
|
83443
83449
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
83444
83450
|
* @param {*} [options] Override http request option.
|
|
@@ -83462,8 +83468,8 @@ export declare const StreamsSessionsApiFactory: (configuration?: Configuration,
|
|
|
83462
83468
|
*/
|
|
83463
83469
|
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response>;
|
|
83464
83470
|
/**
|
|
83465
|
-
* Returns a paginated list of the accounts
|
|
83466
|
-
* @summary List the people
|
|
83471
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83472
|
+
* @summary List the people who watched a stream session
|
|
83467
83473
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
83468
83474
|
* @param {*} [options] Override http request option.
|
|
83469
83475
|
* @throws {RequiredError}
|
|
@@ -83685,6 +83691,10 @@ export interface StreamsSessionsApiGetStreamSessionViewersRequest {
|
|
|
83685
83691
|
* The session identifier
|
|
83686
83692
|
*/
|
|
83687
83693
|
readonly sessionId: string;
|
|
83694
|
+
/**
|
|
83695
|
+
* Filter by active
|
|
83696
|
+
*/
|
|
83697
|
+
readonly active?: boolean;
|
|
83688
83698
|
/**
|
|
83689
83699
|
* Page number
|
|
83690
83700
|
*/
|
|
@@ -83810,7 +83820,7 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
83810
83820
|
*/
|
|
83811
83821
|
getStreamSessionByIdChat(requestParameters: StreamsSessionsApiGetStreamSessionByIdChatRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdChat200Response, any, {}, any>>;
|
|
83812
83822
|
/**
|
|
83813
|
-
* 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.
|
|
83823
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
83814
83824
|
* @summary List a stream session\'s viewer connections by session id
|
|
83815
83825
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
83816
83826
|
* @param {*} [options] Override http request option.
|
|
@@ -83834,8 +83844,8 @@ export declare class StreamsSessionsApi extends BaseAPI {
|
|
|
83834
83844
|
*/
|
|
83835
83845
|
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStreamSessionByIdSubscriptions200Response, any, {}, any>>;
|
|
83836
83846
|
/**
|
|
83837
|
-
* Returns a paginated list of the accounts
|
|
83838
|
-
* @summary List the people
|
|
83847
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
83848
|
+
* @summary List the people who watched a stream session
|
|
83839
83849
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
83840
83850
|
* @param {*} [options] Override http request option.
|
|
83841
83851
|
* @throws {RequiredError}
|
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:
|
|
7
|
+
* The version of the OpenAPI document: 14.1.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -107074,7 +107074,7 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107074
107074
|
};
|
|
107075
107075
|
}),
|
|
107076
107076
|
/**
|
|
107077
|
-
* 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.
|
|
107077
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
107078
107078
|
* @summary List a stream session\'s viewer connections by session id
|
|
107079
107079
|
* @param {string} sessionId The session identifier
|
|
107080
107080
|
* @param {boolean} [active] Filter by active
|
|
@@ -107224,9 +107224,10 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107224
107224
|
};
|
|
107225
107225
|
}),
|
|
107226
107226
|
/**
|
|
107227
|
-
* Returns a paginated list of the accounts
|
|
107228
|
-
* @summary List the people
|
|
107227
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
107228
|
+
* @summary List the people who watched a stream session
|
|
107229
107229
|
* @param {string} sessionId The session identifier
|
|
107230
|
+
* @param {boolean} [active] Filter by active
|
|
107230
107231
|
* @param {number} [page] Page number
|
|
107231
107232
|
* @param {number} [pageSize] Number of items per page
|
|
107232
107233
|
* @param {string} [orderBy] Field to order by
|
|
@@ -107234,7 +107235,7 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107234
107235
|
* @param {*} [options] Override http request option.
|
|
107235
107236
|
* @throws {RequiredError}
|
|
107236
107237
|
*/
|
|
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
|
+
getStreamSessionViewers: (sessionId_1, active_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [sessionId_1, active_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (sessionId, active, page, pageSize, orderBy, search, options = {}) {
|
|
107238
107239
|
// verify required parameter 'sessionId' is not null or undefined
|
|
107239
107240
|
assertParamExists('getStreamSessionViewers', 'sessionId', sessionId);
|
|
107240
107241
|
const localVarPath = `/streams/sessions/{sessionId}/viewers`
|
|
@@ -107252,6 +107253,9 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
107252
107253
|
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
107253
107254
|
// authentication OrganizationId required
|
|
107254
107255
|
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
107256
|
+
if (active !== undefined) {
|
|
107257
|
+
localVarQueryParameter['active'] = active;
|
|
107258
|
+
}
|
|
107255
107259
|
if (page !== undefined) {
|
|
107256
107260
|
localVarQueryParameter['page'] = page;
|
|
107257
107261
|
}
|
|
@@ -107514,7 +107518,7 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
107514
107518
|
});
|
|
107515
107519
|
},
|
|
107516
107520
|
/**
|
|
107517
|
-
* 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.
|
|
107521
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
107518
107522
|
* @summary List a stream session\'s viewer connections by session id
|
|
107519
107523
|
* @param {string} sessionId The session identifier
|
|
107520
107524
|
* @param {boolean} [active] Filter by active
|
|
@@ -107574,9 +107578,10 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
107574
107578
|
});
|
|
107575
107579
|
},
|
|
107576
107580
|
/**
|
|
107577
|
-
* Returns a paginated list of the accounts
|
|
107578
|
-
* @summary List the people
|
|
107581
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
107582
|
+
* @summary List the people who watched a stream session
|
|
107579
107583
|
* @param {string} sessionId The session identifier
|
|
107584
|
+
* @param {boolean} [active] Filter by active
|
|
107580
107585
|
* @param {number} [page] Page number
|
|
107581
107586
|
* @param {number} [pageSize] Number of items per page
|
|
107582
107587
|
* @param {string} [orderBy] Field to order by
|
|
@@ -107584,10 +107589,10 @@ export const StreamsSessionsApiFp = function (configuration) {
|
|
|
107584
107589
|
* @param {*} [options] Override http request option.
|
|
107585
107590
|
* @throws {RequiredError}
|
|
107586
107591
|
*/
|
|
107587
|
-
getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options) {
|
|
107592
|
+
getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options) {
|
|
107588
107593
|
return __awaiter(this, void 0, void 0, function* () {
|
|
107589
107594
|
var _a, _b, _c;
|
|
107590
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options);
|
|
107595
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options);
|
|
107591
107596
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
107592
107597
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionViewers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
107593
107598
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -107720,7 +107725,7 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
107720
107725
|
return localVarFp.getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
107721
107726
|
},
|
|
107722
107727
|
/**
|
|
107723
|
-
* 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.
|
|
107728
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
107724
107729
|
* @summary List a stream session\'s viewer connections by session id
|
|
107725
107730
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
107726
107731
|
* @param {*} [options] Override http request option.
|
|
@@ -107750,14 +107755,14 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
|
|
|
107750
107755
|
return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107751
107756
|
},
|
|
107752
107757
|
/**
|
|
107753
|
-
* Returns a paginated list of the accounts
|
|
107754
|
-
* @summary List the people
|
|
107758
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
107759
|
+
* @summary List the people who watched a stream session
|
|
107755
107760
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
107756
107761
|
* @param {*} [options] Override http request option.
|
|
107757
107762
|
* @throws {RequiredError}
|
|
107758
107763
|
*/
|
|
107759
107764
|
getStreamSessionViewers(requestParameters, options) {
|
|
107760
|
-
return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107765
|
+
return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
107761
107766
|
},
|
|
107762
107767
|
/**
|
|
107763
107768
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
@@ -107866,7 +107871,7 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
107866
107871
|
return StreamsSessionsApiFp(this.configuration).getStreamSessionByIdChat(requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
107867
107872
|
}
|
|
107868
107873
|
/**
|
|
107869
|
-
* 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.
|
|
107874
|
+
* 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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
107870
107875
|
* @summary List a stream session\'s viewer connections by session id
|
|
107871
107876
|
* @param {StreamsSessionsApiGetStreamSessionByIdSubscriptionsRequest} requestParameters Request parameters.
|
|
107872
107877
|
* @param {*} [options] Override http request option.
|
|
@@ -107896,14 +107901,14 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
107896
107901
|
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));
|
|
107897
107902
|
}
|
|
107898
107903
|
/**
|
|
107899
|
-
* Returns a paginated list of the accounts
|
|
107900
|
-
* @summary List the people
|
|
107904
|
+
* Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
107905
|
+
* @summary List the people who watched a stream session
|
|
107901
107906
|
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
107902
107907
|
* @param {*} [options] Override http request option.
|
|
107903
107908
|
* @throws {RequiredError}
|
|
107904
107909
|
*/
|
|
107905
107910
|
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));
|
|
107911
|
+
return StreamsSessionsApiFp(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
107907
107912
|
}
|
|
107908
107913
|
/**
|
|
107909
107914
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
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:
|
|
5
|
+
* The version of the OpenAPI document: 14.1.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:
|
|
7
|
+
* The version of the OpenAPI document: 14.1.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:
|
|
5
|
+
* The version of the OpenAPI document: 14.1.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:
|
|
7
|
+
* The version of the OpenAPI document: 14.1.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:
|
|
5
|
+
* The version of the OpenAPI document: 14.1.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:
|
|
6
|
+
* The version of the OpenAPI document: 14.1.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -7,8 +7,12 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**accountId** | **string** | | [default to undefined]
|
|
9
9
|
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
10
|
+
**active** | **boolean** | | [default to undefined]
|
|
10
11
|
**activeConnections** | **number** | | [default to undefined]
|
|
12
|
+
**connections** | **number** | | [default to undefined]
|
|
11
13
|
**connectedAt** | **string** | | [default to undefined]
|
|
14
|
+
**disconnectedAt** | **string** | | [default to undefined]
|
|
15
|
+
**duration** | **number** | | [default to undefined]
|
|
12
16
|
|
|
13
17
|
## Example
|
|
14
18
|
|
|
@@ -18,8 +22,12 @@ import { StreamSessionViewer } from '@connectedxm/admin-sdk';
|
|
|
18
22
|
const instance: StreamSessionViewer = {
|
|
19
23
|
accountId,
|
|
20
24
|
account,
|
|
25
|
+
active,
|
|
21
26
|
activeConnections,
|
|
27
|
+
connections,
|
|
22
28
|
connectedAt,
|
|
29
|
+
disconnectedAt,
|
|
30
|
+
duration,
|
|
23
31
|
};
|
|
24
32
|
```
|
|
25
33
|
|
|
@@ -15,7 +15,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
15
15
|
|[**getStreamSessionByIdSubscriptions**](#getstreamsessionbyidsubscriptions) | **GET** /streams/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections by session id|
|
|
16
16
|
|[**getStreamSessionChat**](#getstreamsessionchat) | **GET** /streams/{streamId}/sessions/{sessionId}/chat | List a stream session\'s chat messages|
|
|
17
17
|
|[**getStreamSessionSubscriptions**](#getstreamsessionsubscriptions) | **GET** /streams/{streamId}/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections|
|
|
18
|
-
|[**getStreamSessionViewers**](#getstreamsessionviewers) | **GET** /streams/sessions/{sessionId}/viewers | List the people
|
|
18
|
+
|[**getStreamSessionViewers**](#getstreamsessionviewers) | **GET** /streams/sessions/{sessionId}/viewers | List the people who watched a stream session|
|
|
19
19
|
|[**getStreamSessions**](#getstreamsessions) | **GET** /streams/{streamId}/sessions | List a stream\'s broadcast sessions|
|
|
20
20
|
|[**updateStreamSession**](#updatestreamsession) | **PUT** /streams/sessions/{sessionId} | Update a stream session|
|
|
21
21
|
|
|
@@ -463,7 +463,7 @@ const { status, data } = await apiInstance.getStreamSessionByIdChat(
|
|
|
463
463
|
# **getStreamSessionByIdSubscriptions**
|
|
464
464
|
> GetStreamSessionByIdSubscriptions200Response getStreamSessionByIdSubscriptions()
|
|
465
465
|
|
|
466
|
-
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.
|
|
466
|
+
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, and searchable by the account\'s name, username, email, internal ref or id; requires read permission on streams.
|
|
467
467
|
|
|
468
468
|
### Example
|
|
469
469
|
|
|
@@ -652,7 +652,7 @@ const { status, data } = await apiInstance.getStreamSessionSubscriptions(
|
|
|
652
652
|
# **getStreamSessionViewers**
|
|
653
653
|
> GetStreamSessionViewers200Response getStreamSessionViewers()
|
|
654
654
|
|
|
655
|
-
Returns a paginated list of the accounts
|
|
655
|
+
Returns a paginated list of the accounts that watched the given stream session, one row per account: whether it is still watching, its active and total connection counts, first connect, last disconnect (null while watching) and watch time in milliseconds with overlapping connections counted once. active=true (the default) returns only people still watching, active=false only people who left; search matches the account\'s name, username, email, internal ref or id; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
|
|
656
656
|
|
|
657
657
|
### Example
|
|
658
658
|
|
|
@@ -666,6 +666,7 @@ const configuration = new Configuration();
|
|
|
666
666
|
const apiInstance = new StreamsSessionsApi(configuration);
|
|
667
667
|
|
|
668
668
|
let sessionId: string; //The session identifier (default to undefined)
|
|
669
|
+
let active: boolean; //Filter by active (optional) (default to undefined)
|
|
669
670
|
let page: number; //Page number (optional) (default to 1)
|
|
670
671
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
671
672
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
@@ -673,6 +674,7 @@ let search: string; //Search query (optional) (default to undefined)
|
|
|
673
674
|
|
|
674
675
|
const { status, data } = await apiInstance.getStreamSessionViewers(
|
|
675
676
|
sessionId,
|
|
677
|
+
active,
|
|
676
678
|
page,
|
|
677
679
|
pageSize,
|
|
678
680
|
orderBy,
|
|
@@ -685,6 +687,7 @@ const { status, data } = await apiInstance.getStreamSessionViewers(
|
|
|
685
687
|
|Name | Type | Description | Notes|
|
|
686
688
|
|------------- | ------------- | ------------- | -------------|
|
|
687
689
|
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
690
|
+
| **active** | [**boolean**] | Filter by active | (optional) defaults to undefined|
|
|
688
691
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
689
692
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
690
693
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|