@connectedxm/admin-sdk 13.7.0 → 14.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 13.7.0
7
+ * The version of the OpenAPI document: 14.0.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -106795,6 +106795,44 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
106795
106795
  options: localVarRequestOptions,
106796
106796
  };
106797
106797
  }),
106798
+ /**
106799
+ * Permanently deletes a chat message (messageId) from the given stream session (sessionId), whether the session is active or ended and whether or not its stream input still exists; requires the read and update permissions on streams.
106800
+ * @summary Delete a stream session chat message
106801
+ * @param {string} sessionId The session identifier
106802
+ * @param {string} messageId The message identifier
106803
+ * @param {*} [options] Override http request option.
106804
+ * @throws {RequiredError}
106805
+ */
106806
+ deleteStreamSessionChatMessage: (sessionId_1, messageId_1, ...args_1) => __awaiter(this, [sessionId_1, messageId_1, ...args_1], void 0, function* (sessionId, messageId, options = {}) {
106807
+ // verify required parameter 'sessionId' is not null or undefined
106808
+ assertParamExists('deleteStreamSessionChatMessage', 'sessionId', sessionId);
106809
+ // verify required parameter 'messageId' is not null or undefined
106810
+ assertParamExists('deleteStreamSessionChatMessage', 'messageId', messageId);
106811
+ const localVarPath = `/streams/sessions/{sessionId}/chat/{messageId}`
106812
+ .replace('{sessionId}', encodeURIComponent(String(sessionId)))
106813
+ .replace('{messageId}', encodeURIComponent(String(messageId)));
106814
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
106815
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
106816
+ let baseOptions;
106817
+ if (configuration) {
106818
+ baseOptions = configuration.baseOptions;
106819
+ }
106820
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
106821
+ const localVarHeaderParameter = {};
106822
+ const localVarQueryParameter = {};
106823
+ // authentication ApiKeyAuth required
106824
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
106825
+ // authentication OrganizationId required
106826
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
106827
+ localVarHeaderParameter['Accept'] = 'application/json';
106828
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
106829
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
106830
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
106831
+ return {
106832
+ url: toPathString(localVarUrlObj),
106833
+ options: localVarRequestOptions,
106834
+ };
106835
+ }),
106798
106836
  /**
106799
106837
  * Queues an asynchronous export job for the given stream session (sessionId), emailing the requesting user a download when the export completes; requires the read permission on streams.
106800
106838
  * @summary Request an export of a stream session
@@ -107186,9 +107224,10 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
107186
107224
  };
107187
107225
  }),
107188
107226
  /**
107189
- * 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.
107190
- * @summary List the people watching a stream session
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; 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
107191
107229
  * @param {string} sessionId The session identifier
107230
+ * @param {boolean} [active] Filter by active
107192
107231
  * @param {number} [page] Page number
107193
107232
  * @param {number} [pageSize] Number of items per page
107194
107233
  * @param {string} [orderBy] Field to order by
@@ -107196,7 +107235,7 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
107196
107235
  * @param {*} [options] Override http request option.
107197
107236
  * @throws {RequiredError}
107198
107237
  */
107199
- 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 = {}) {
107200
107239
  // verify required parameter 'sessionId' is not null or undefined
107201
107240
  assertParamExists('getStreamSessionViewers', 'sessionId', sessionId);
107202
107241
  const localVarPath = `/streams/sessions/{sessionId}/viewers`
@@ -107214,6 +107253,9 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
107214
107253
  yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
107215
107254
  // authentication OrganizationId required
107216
107255
  yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
107256
+ if (active !== undefined) {
107257
+ localVarQueryParameter['active'] = active;
107258
+ }
107217
107259
  if (page !== undefined) {
107218
107260
  localVarQueryParameter['page'] = page;
107219
107261
  }
@@ -107353,6 +107395,23 @@ export const StreamsSessionsApiFp = function (configuration) {
107353
107395
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
107354
107396
  });
107355
107397
  },
107398
+ /**
107399
+ * 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.
107400
+ * @summary Delete a stream session chat message
107401
+ * @param {string} sessionId The session identifier
107402
+ * @param {string} messageId The message identifier
107403
+ * @param {*} [options] Override http request option.
107404
+ * @throws {RequiredError}
107405
+ */
107406
+ deleteStreamSessionChatMessage(sessionId, messageId, options) {
107407
+ return __awaiter(this, void 0, void 0, function* () {
107408
+ var _a, _b, _c;
107409
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteStreamSessionChatMessage(sessionId, messageId, options);
107410
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
107411
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.deleteStreamSessionChatMessage']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
107412
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
107413
+ });
107414
+ },
107356
107415
  /**
107357
107416
  * 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.
107358
107417
  * @summary Request an export of a stream session
@@ -107519,9 +107578,10 @@ export const StreamsSessionsApiFp = function (configuration) {
107519
107578
  });
107520
107579
  },
107521
107580
  /**
107522
- * 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.
107523
- * @summary List the people watching a stream session
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; 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
107524
107583
  * @param {string} sessionId The session identifier
107584
+ * @param {boolean} [active] Filter by active
107525
107585
  * @param {number} [page] Page number
107526
107586
  * @param {number} [pageSize] Number of items per page
107527
107587
  * @param {string} [orderBy] Field to order by
@@ -107529,10 +107589,10 @@ export const StreamsSessionsApiFp = function (configuration) {
107529
107589
  * @param {*} [options] Override http request option.
107530
107590
  * @throws {RequiredError}
107531
107591
  */
107532
- getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options) {
107592
+ getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options) {
107533
107593
  return __awaiter(this, void 0, void 0, function* () {
107534
107594
  var _a, _b, _c;
107535
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options);
107595
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, active, page, pageSize, orderBy, search, options);
107536
107596
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
107537
107597
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionViewers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
107538
107598
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -107594,6 +107654,16 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
107594
107654
  closeStreamSession(requestParameters, options) {
107595
107655
  return localVarFp.closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(axios, basePath));
107596
107656
  },
107657
+ /**
107658
+ * 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.
107659
+ * @summary Delete a stream session chat message
107660
+ * @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
107661
+ * @param {*} [options] Override http request option.
107662
+ * @throws {RequiredError}
107663
+ */
107664
+ deleteStreamSessionChatMessage(requestParameters, options) {
107665
+ return localVarFp.deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(axios, basePath));
107666
+ },
107597
107667
  /**
107598
107668
  * 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.
107599
107669
  * @summary Request an export of a stream session
@@ -107685,14 +107755,14 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
107685
107755
  return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
107686
107756
  },
107687
107757
  /**
107688
- * 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.
107689
- * @summary List the people watching a stream session
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; 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
107690
107760
  * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
107691
107761
  * @param {*} [options] Override http request option.
107692
107762
  * @throws {RequiredError}
107693
107763
  */
107694
107764
  getStreamSessionViewers(requestParameters, options) {
107695
- 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));
107696
107766
  },
107697
107767
  /**
107698
107768
  * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
@@ -107730,6 +107800,16 @@ export class StreamsSessionsApi extends BaseAPI {
107730
107800
  closeStreamSession(requestParameters, options) {
107731
107801
  return StreamsSessionsApiFp(this.configuration).closeStreamSession(requestParameters.streamId, requestParameters.sessionId, options).then((request) => request(this.axios, this.basePath));
107732
107802
  }
107803
+ /**
107804
+ * 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.
107805
+ * @summary Delete a stream session chat message
107806
+ * @param {StreamsSessionsApiDeleteStreamSessionChatMessageRequest} requestParameters Request parameters.
107807
+ * @param {*} [options] Override http request option.
107808
+ * @throws {RequiredError}
107809
+ */
107810
+ deleteStreamSessionChatMessage(requestParameters, options) {
107811
+ return StreamsSessionsApiFp(this.configuration).deleteStreamSessionChatMessage(requestParameters.sessionId, requestParameters.messageId, options).then((request) => request(this.axios, this.basePath));
107812
+ }
107733
107813
  /**
107734
107814
  * 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.
107735
107815
  * @summary Request an export of a stream session
@@ -107821,14 +107901,14 @@ export class StreamsSessionsApi extends BaseAPI {
107821
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));
107822
107902
  }
107823
107903
  /**
107824
- * 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.
107825
- * @summary List the people watching a stream session
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; 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
107826
107906
  * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
107827
107907
  * @param {*} [options] Override http request option.
107828
107908
  * @throws {RequiredError}
107829
107909
  */
107830
107910
  getStreamSessionViewers(requestParameters, options) {
107831
- 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));
107832
107912
  }
107833
107913
  /**
107834
107914
  * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
@@ -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.7.0
5
+ * The version of the OpenAPI document: 14.0.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 13.7.0
7
+ * The version of the OpenAPI document: 14.0.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.7.0
5
+ * The version of the OpenAPI document: 14.0.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.0
7
+ * The version of the OpenAPI document: 14.0.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.7.0
5
+ * The version of the OpenAPI document: 14.0.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.7.0
6
+ * The version of the OpenAPI document: 14.0.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
 
@@ -5,6 +5,7 @@ All URIs are relative to *https://admin-api.connected.dev*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**closeStreamSession**](#closestreamsession) | **PUT** /streams/{streamId}/sessions/{sessionId}/close | Close an active stream session|
8
+ |[**deleteStreamSessionChatMessage**](#deletestreamsessionchatmessage) | **DELETE** /streams/sessions/{sessionId}/chat/{messageId} | Delete a stream session chat message|
8
9
  |[**exportStreamSession**](#exportstreamsession) | **POST** /streams/{streamId}/sessions/{sessionId}/export | Request an export of a stream session|
9
10
  |[**exportStreamSessionById**](#exportstreamsessionbyid) | **POST** /streams/sessions/{sessionId}/export | Request an export of a stream session by session id|
10
11
  |[**getAllStreamSessions**](#getallstreamsessions) | **GET** /streams/sessions | List stream sessions across all stream inputs|
@@ -14,7 +15,7 @@ All URIs are relative to *https://admin-api.connected.dev*
14
15
  |[**getStreamSessionByIdSubscriptions**](#getstreamsessionbyidsubscriptions) | **GET** /streams/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections by session id|
15
16
  |[**getStreamSessionChat**](#getstreamsessionchat) | **GET** /streams/{streamId}/sessions/{sessionId}/chat | List a stream session\'s chat messages|
16
17
  |[**getStreamSessionSubscriptions**](#getstreamsessionsubscriptions) | **GET** /streams/{streamId}/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections|
17
- |[**getStreamSessionViewers**](#getstreamsessionviewers) | **GET** /streams/sessions/{sessionId}/viewers | List the people watching a stream session|
18
+ |[**getStreamSessionViewers**](#getstreamsessionviewers) | **GET** /streams/sessions/{sessionId}/viewers | List the people who watched a stream session|
18
19
  |[**getStreamSessions**](#getstreamsessions) | **GET** /streams/{streamId}/sessions | List a stream\'s broadcast sessions|
19
20
  |[**updateStreamSession**](#updatestreamsession) | **PUT** /streams/sessions/{sessionId} | Update a stream session|
20
21
 
@@ -51,6 +52,60 @@ const { status, data } = await apiInstance.closeStreamSession(
51
52
  | **sessionId** | [**string**] | The session identifier | defaults to undefined|
52
53
 
53
54
 
55
+ ### Return type
56
+
57
+ **CreateAccountInvitations200Response**
58
+
59
+ ### Authorization
60
+
61
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: Not defined
66
+ - **Accept**: application/json
67
+
68
+
69
+ ### HTTP response details
70
+ | Status code | Description | Response headers |
71
+ |-------------|-------------|------------------|
72
+ |**200** | Successful response | - |
73
+
74
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
75
+
76
+ # **deleteStreamSessionChatMessage**
77
+ > CreateAccountInvitations200Response deleteStreamSessionChatMessage()
78
+
79
+ 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.
80
+
81
+ ### Example
82
+
83
+ ```typescript
84
+ import {
85
+ StreamsSessionsApi,
86
+ Configuration
87
+ } from '@connectedxm/admin-sdk';
88
+
89
+ const configuration = new Configuration();
90
+ const apiInstance = new StreamsSessionsApi(configuration);
91
+
92
+ let sessionId: string; //The session identifier (default to undefined)
93
+ let messageId: string; //The message identifier (default to undefined)
94
+
95
+ const { status, data } = await apiInstance.deleteStreamSessionChatMessage(
96
+ sessionId,
97
+ messageId
98
+ );
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ |Name | Type | Description | Notes|
104
+ |------------- | ------------- | ------------- | -------------|
105
+ | **sessionId** | [**string**] | The session identifier | defaults to undefined|
106
+ | **messageId** | [**string**] | The message identifier | defaults to undefined|
107
+
108
+
54
109
  ### Return type
55
110
 
56
111
  **CreateAccountInvitations200Response**
@@ -597,7 +652,7 @@ const { status, data } = await apiInstance.getStreamSessionSubscriptions(
597
652
  # **getStreamSessionViewers**
598
653
  > GetStreamSessionViewers200Response getStreamSessionViewers()
599
654
 
600
- 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.
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; the count is people, where the subscriptions list counts connections. Requires read permission on streams.
601
656
 
602
657
  ### Example
603
658
 
@@ -611,6 +666,7 @@ const configuration = new Configuration();
611
666
  const apiInstance = new StreamsSessionsApi(configuration);
612
667
 
613
668
  let sessionId: string; //The session identifier (default to undefined)
669
+ let active: boolean; //Filter by active (optional) (default to undefined)
614
670
  let page: number; //Page number (optional) (default to 1)
615
671
  let pageSize: number; //Number of items per page (optional) (default to 25)
616
672
  let orderBy: string; //Field to order by (optional) (default to undefined)
@@ -618,6 +674,7 @@ let search: string; //Search query (optional) (default to undefined)
618
674
 
619
675
  const { status, data } = await apiInstance.getStreamSessionViewers(
620
676
  sessionId,
677
+ active,
621
678
  page,
622
679
  pageSize,
623
680
  orderBy,
@@ -630,6 +687,7 @@ const { status, data } = await apiInstance.getStreamSessionViewers(
630
687
  |Name | Type | Description | Notes|
631
688
  |------------- | ------------- | ------------- | -------------|
632
689
  | **sessionId** | [**string**] | The session identifier | defaults to undefined|
690
+ | **active** | [**boolean**] | Filter by active | (optional) defaults to undefined|
633
691
  | **page** | [**number**] | Page number | (optional) defaults to 1|
634
692
  | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
635
693
  | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "13.7.0",
3
+ "version": "14.0.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {