@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/.openapi-generator/FILES
CHANGED
|
@@ -1124,6 +1124,7 @@ docs/GetStreamInputs200Response.md
|
|
|
1124
1124
|
docs/GetStreamSessionById200Response.md
|
|
1125
1125
|
docs/GetStreamSessionByIdChat200Response.md
|
|
1126
1126
|
docs/GetStreamSessionByIdSubscriptions200Response.md
|
|
1127
|
+
docs/GetStreamSessionViewers200Response.md
|
|
1127
1128
|
docs/GetStreamVideos200Response.md
|
|
1128
1129
|
docs/GetSupportTicketActivity200Response.md
|
|
1129
1130
|
docs/GetSupportTicketMessages200Response.md
|
|
@@ -1559,6 +1560,7 @@ docs/StreamSessionChatMessage.md
|
|
|
1559
1560
|
docs/StreamSessionStatus.md
|
|
1560
1561
|
docs/StreamSessionSubscription.md
|
|
1561
1562
|
docs/StreamSessionUpdateInputs.md
|
|
1563
|
+
docs/StreamSessionViewer.md
|
|
1562
1564
|
docs/StreamsApi.md
|
|
1563
1565
|
docs/StreamsOutputsApi.md
|
|
1564
1566
|
docs/StreamsSessionsApi.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@13.
|
|
1
|
+
## @connectedxm/admin-sdk@13.8.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@13.
|
|
39
|
+
npm install @connectedxm/admin-sdk@13.8.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: 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).
|
|
@@ -10954,6 +10954,17 @@ export enum GetStreamSessionByIdSubscriptions200ResponseStatusEnum {
|
|
|
10954
10954
|
Ok = 'ok'
|
|
10955
10955
|
}
|
|
10956
10956
|
|
|
10957
|
+
export interface GetStreamSessionViewers200Response {
|
|
10958
|
+
'status': GetStreamSessionViewers200ResponseStatusEnum;
|
|
10959
|
+
'message': string;
|
|
10960
|
+
'data': Array<StreamSessionViewer>;
|
|
10961
|
+
'count'?: number;
|
|
10962
|
+
}
|
|
10963
|
+
|
|
10964
|
+
export enum GetStreamSessionViewers200ResponseStatusEnum {
|
|
10965
|
+
Ok = 'ok'
|
|
10966
|
+
}
|
|
10967
|
+
|
|
10957
10968
|
export interface GetStreamVideos200Response {
|
|
10958
10969
|
'status': GetStreamVideos200ResponseStatusEnum;
|
|
10959
10970
|
'message': string;
|
|
@@ -15153,6 +15164,12 @@ export interface StreamSessionUpdateInputs {
|
|
|
15153
15164
|
'eventId'?: string | null;
|
|
15154
15165
|
'eventSessionId'?: string | null;
|
|
15155
15166
|
}
|
|
15167
|
+
export interface StreamSessionViewer {
|
|
15168
|
+
'accountId': string | null;
|
|
15169
|
+
'account': BaseAccount | null;
|
|
15170
|
+
'activeConnections': number;
|
|
15171
|
+
'connectedAt': string;
|
|
15172
|
+
}
|
|
15156
15173
|
export interface StripeActivationFormParams {
|
|
15157
15174
|
'clientPublicKey': string;
|
|
15158
15175
|
'clientSecret': string;
|
|
@@ -151881,6 +151898,50 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
151881
151898
|
options: localVarRequestOptions,
|
|
151882
151899
|
};
|
|
151883
151900
|
},
|
|
151901
|
+
/**
|
|
151902
|
+
* 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.
|
|
151903
|
+
* @summary Delete a stream session chat message
|
|
151904
|
+
* @param {string} sessionId The session identifier
|
|
151905
|
+
* @param {string} messageId The message identifier
|
|
151906
|
+
* @param {*} [options] Override http request option.
|
|
151907
|
+
* @throws {RequiredError}
|
|
151908
|
+
*/
|
|
151909
|
+
deleteStreamSessionChatMessage: async (sessionId: string, messageId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
151910
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
151911
|
+
assertParamExists('deleteStreamSessionChatMessage', 'sessionId', sessionId)
|
|
151912
|
+
// verify required parameter 'messageId' is not null or undefined
|
|
151913
|
+
assertParamExists('deleteStreamSessionChatMessage', 'messageId', messageId)
|
|
151914
|
+
const localVarPath = `/streams/sessions/{sessionId}/chat/{messageId}`
|
|
151915
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)))
|
|
151916
|
+
.replace('{messageId}', encodeURIComponent(String(messageId)));
|
|
151917
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
151918
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
151919
|
+
let baseOptions;
|
|
151920
|
+
if (configuration) {
|
|
151921
|
+
baseOptions = configuration.baseOptions;
|
|
151922
|
+
}
|
|
151923
|
+
|
|
151924
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
151925
|
+
const localVarHeaderParameter = {} as any;
|
|
151926
|
+
const localVarQueryParameter = {} as any;
|
|
151927
|
+
|
|
151928
|
+
// authentication ApiKeyAuth required
|
|
151929
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
151930
|
+
|
|
151931
|
+
// authentication OrganizationId required
|
|
151932
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
151933
|
+
|
|
151934
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
151935
|
+
|
|
151936
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
151937
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
151938
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
151939
|
+
|
|
151940
|
+
return {
|
|
151941
|
+
url: toPathString(localVarUrlObj),
|
|
151942
|
+
options: localVarRequestOptions,
|
|
151943
|
+
};
|
|
151944
|
+
},
|
|
151884
151945
|
/**
|
|
151885
151946
|
* 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.
|
|
151886
151947
|
* @summary Request an export of a stream session
|
|
@@ -152343,6 +152404,66 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration?: Con
|
|
|
152343
152404
|
options: localVarRequestOptions,
|
|
152344
152405
|
};
|
|
152345
152406
|
},
|
|
152407
|
+
/**
|
|
152408
|
+
* 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.
|
|
152409
|
+
* @summary List the people watching a stream session
|
|
152410
|
+
* @param {string} sessionId The session identifier
|
|
152411
|
+
* @param {number} [page] Page number
|
|
152412
|
+
* @param {number} [pageSize] Number of items per page
|
|
152413
|
+
* @param {string} [orderBy] Field to order by
|
|
152414
|
+
* @param {string} [search] Search query
|
|
152415
|
+
* @param {*} [options] Override http request option.
|
|
152416
|
+
* @throws {RequiredError}
|
|
152417
|
+
*/
|
|
152418
|
+
getStreamSessionViewers: async (sessionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
152419
|
+
// verify required parameter 'sessionId' is not null or undefined
|
|
152420
|
+
assertParamExists('getStreamSessionViewers', 'sessionId', sessionId)
|
|
152421
|
+
const localVarPath = `/streams/sessions/{sessionId}/viewers`
|
|
152422
|
+
.replace('{sessionId}', encodeURIComponent(String(sessionId)));
|
|
152423
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
152424
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152425
|
+
let baseOptions;
|
|
152426
|
+
if (configuration) {
|
|
152427
|
+
baseOptions = configuration.baseOptions;
|
|
152428
|
+
}
|
|
152429
|
+
|
|
152430
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
152431
|
+
const localVarHeaderParameter = {} as any;
|
|
152432
|
+
const localVarQueryParameter = {} as any;
|
|
152433
|
+
|
|
152434
|
+
// authentication ApiKeyAuth required
|
|
152435
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
152436
|
+
|
|
152437
|
+
// authentication OrganizationId required
|
|
152438
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
152439
|
+
|
|
152440
|
+
if (page !== undefined) {
|
|
152441
|
+
localVarQueryParameter['page'] = page;
|
|
152442
|
+
}
|
|
152443
|
+
|
|
152444
|
+
if (pageSize !== undefined) {
|
|
152445
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
152446
|
+
}
|
|
152447
|
+
|
|
152448
|
+
if (orderBy !== undefined) {
|
|
152449
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
152450
|
+
}
|
|
152451
|
+
|
|
152452
|
+
if (search !== undefined) {
|
|
152453
|
+
localVarQueryParameter['search'] = search;
|
|
152454
|
+
}
|
|
152455
|
+
|
|
152456
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
152457
|
+
|
|
152458
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
152459
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
152460
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
152461
|
+
|
|
152462
|
+
return {
|
|
152463
|
+
url: toPathString(localVarUrlObj),
|
|
152464
|
+
options: localVarRequestOptions,
|
|
152465
|
+
};
|
|
152466
|
+
},
|
|
152346
152467
|
/**
|
|
152347
152468
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
152348
152469
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -152476,6 +152597,20 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
152476
152597
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.closeStreamSession']?.[localVarOperationServerIndex]?.url;
|
|
152477
152598
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152478
152599
|
},
|
|
152600
|
+
/**
|
|
152601
|
+
* 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.
|
|
152602
|
+
* @summary Delete a stream session chat message
|
|
152603
|
+
* @param {string} sessionId The session identifier
|
|
152604
|
+
* @param {string} messageId The message identifier
|
|
152605
|
+
* @param {*} [options] Override http request option.
|
|
152606
|
+
* @throws {RequiredError}
|
|
152607
|
+
*/
|
|
152608
|
+
async deleteStreamSessionChatMessage(sessionId: string, messageId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
|
|
152609
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStreamSessionChatMessage(sessionId, messageId, options);
|
|
152610
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152611
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.deleteStreamSessionChatMessage']?.[localVarOperationServerIndex]?.url;
|
|
152612
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152613
|
+
},
|
|
152479
152614
|
/**
|
|
152480
152615
|
* 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.
|
|
152481
152616
|
* @summary Request an export of a stream session
|
|
@@ -152614,6 +152749,23 @@ export const StreamsSessionsApiFp = function(configuration?: Configuration) {
|
|
|
152614
152749
|
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionSubscriptions']?.[localVarOperationServerIndex]?.url;
|
|
152615
152750
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152616
152751
|
},
|
|
152752
|
+
/**
|
|
152753
|
+
* 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.
|
|
152754
|
+
* @summary List the people watching a stream session
|
|
152755
|
+
* @param {string} sessionId The session identifier
|
|
152756
|
+
* @param {number} [page] Page number
|
|
152757
|
+
* @param {number} [pageSize] Number of items per page
|
|
152758
|
+
* @param {string} [orderBy] Field to order by
|
|
152759
|
+
* @param {string} [search] Search query
|
|
152760
|
+
* @param {*} [options] Override http request option.
|
|
152761
|
+
* @throws {RequiredError}
|
|
152762
|
+
*/
|
|
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);
|
|
152765
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
152766
|
+
const localVarOperationServerBasePath = operationServerMap['StreamsSessionsApi.getStreamSessionViewers']?.[localVarOperationServerIndex]?.url;
|
|
152767
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
152768
|
+
},
|
|
152617
152769
|
/**
|
|
152618
152770
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
152619
152771
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -152665,6 +152817,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
152665
152817
|
closeStreamSession(requestParameters: StreamsSessionsApiCloseStreamSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
152666
152818
|
return localVarFp.closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
|
|
152667
152819
|
},
|
|
152820
|
+
/**
|
|
152821
|
+
* 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.
|
|
152822
|
+
* @summary Delete a stream session chat message
|
|
152823
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
152824
|
+
* @param {*} [options] Override http request option.
|
|
152825
|
+
* @throws {RequiredError}
|
|
152826
|
+
*/
|
|
152827
|
+
deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
|
|
152828
|
+
return localVarFp.deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(axios, basePath));
|
|
152829
|
+
},
|
|
152668
152830
|
/**
|
|
152669
152831
|
* 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.
|
|
152670
152832
|
* @summary Request an export of a stream session
|
|
@@ -152755,6 +152917,16 @@ export const StreamsSessionsApiFactory = function (configuration?: Configuration
|
|
|
152755
152917
|
getStreamSessionSubscriptions(requestParameters: StreamsSessionsApiGetStreamSessionSubscriptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetStreamSessionByIdSubscriptions200Response> {
|
|
152756
152918
|
return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
152757
152919
|
},
|
|
152920
|
+
/**
|
|
152921
|
+
* 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.
|
|
152922
|
+
* @summary List the people watching a stream session
|
|
152923
|
+
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
152924
|
+
* @param {*} [options] Override http request option.
|
|
152925
|
+
* @throws {RequiredError}
|
|
152926
|
+
*/
|
|
152927
|
+
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));
|
|
152929
|
+
},
|
|
152758
152930
|
/**
|
|
152759
152931
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
152760
152932
|
* @summary List a stream\'s broadcast sessions
|
|
@@ -152793,6 +152965,21 @@ export interface StreamsSessionsApiCloseStreamSessionRequest {
|
|
|
152793
152965
|
readonly sessionId: string
|
|
152794
152966
|
}
|
|
152795
152967
|
|
|
152968
|
+
/**
|
|
152969
|
+
* Request parameters for deleteStreamSessionChatMessage operation in StreamsSessionsApi.
|
|
152970
|
+
*/
|
|
152971
|
+
export interface StreamsSessionsApiDeleteStreamSessionChatMessageRequest {
|
|
152972
|
+
/**
|
|
152973
|
+
* The session identifier
|
|
152974
|
+
*/
|
|
152975
|
+
readonly sessionId: string
|
|
152976
|
+
|
|
152977
|
+
/**
|
|
152978
|
+
* The message identifier
|
|
152979
|
+
*/
|
|
152980
|
+
readonly messageId: string
|
|
152981
|
+
}
|
|
152982
|
+
|
|
152796
152983
|
/**
|
|
152797
152984
|
* Request parameters for exportStreamSession operation in StreamsSessionsApi.
|
|
152798
152985
|
*/
|
|
@@ -152988,6 +153175,36 @@ export interface StreamsSessionsApiGetStreamSessionSubscriptionsRequest {
|
|
|
152988
153175
|
readonly search?: string
|
|
152989
153176
|
}
|
|
152990
153177
|
|
|
153178
|
+
/**
|
|
153179
|
+
* Request parameters for getStreamSessionViewers operation in StreamsSessionsApi.
|
|
153180
|
+
*/
|
|
153181
|
+
export interface StreamsSessionsApiGetStreamSessionViewersRequest {
|
|
153182
|
+
/**
|
|
153183
|
+
* The session identifier
|
|
153184
|
+
*/
|
|
153185
|
+
readonly sessionId: string
|
|
153186
|
+
|
|
153187
|
+
/**
|
|
153188
|
+
* Page number
|
|
153189
|
+
*/
|
|
153190
|
+
readonly page?: number
|
|
153191
|
+
|
|
153192
|
+
/**
|
|
153193
|
+
* Number of items per page
|
|
153194
|
+
*/
|
|
153195
|
+
readonly pageSize?: number
|
|
153196
|
+
|
|
153197
|
+
/**
|
|
153198
|
+
* Field to order by
|
|
153199
|
+
*/
|
|
153200
|
+
readonly orderBy?: string
|
|
153201
|
+
|
|
153202
|
+
/**
|
|
153203
|
+
* Search query
|
|
153204
|
+
*/
|
|
153205
|
+
readonly search?: string
|
|
153206
|
+
}
|
|
153207
|
+
|
|
152991
153208
|
/**
|
|
152992
153209
|
* Request parameters for getStreamSessions operation in StreamsSessionsApi.
|
|
152993
153210
|
*/
|
|
@@ -153050,6 +153267,17 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
153050
153267
|
return StreamsSessionsApiFp(this.configuration).closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
|
|
153051
153268
|
}
|
|
153052
153269
|
|
|
153270
|
+
/**
|
|
153271
|
+
* 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.
|
|
153272
|
+
* @summary Delete a stream session chat message
|
|
153273
|
+
* @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
|
|
153274
|
+
* @param {*} [options] Override http request option.
|
|
153275
|
+
* @throws {RequiredError}
|
|
153276
|
+
*/
|
|
153277
|
+
public deleteStreamSessionChatMessage(requestParameters: StreamsSessionsApiDeleteStreamSessionChatMessageRequest, options?: RawAxiosRequestConfig) {
|
|
153278
|
+
return StreamsSessionsApiFp(this.configuration).deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(this.axios, this.basePath));
|
|
153279
|
+
}
|
|
153280
|
+
|
|
153053
153281
|
/**
|
|
153054
153282
|
* 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.
|
|
153055
153283
|
* @summary Request an export of a stream session
|
|
@@ -153149,6 +153377,17 @@ export class StreamsSessionsApi extends BaseAPI {
|
|
|
153149
153377
|
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));
|
|
153150
153378
|
}
|
|
153151
153379
|
|
|
153380
|
+
/**
|
|
153381
|
+
* 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.
|
|
153382
|
+
* @summary List the people watching a stream session
|
|
153383
|
+
* @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
|
|
153384
|
+
* @param {*} [options] Override http request option.
|
|
153385
|
+
* @throws {RequiredError}
|
|
153386
|
+
*/
|
|
153387
|
+
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));
|
|
153389
|
+
}
|
|
153390
|
+
|
|
153152
153391
|
/**
|
|
153153
153392
|
* Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
|
|
153154
153393
|
* @summary List a stream\'s broadcast sessions
|
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: 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/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: 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/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: 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).
|
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: 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
|