@connectedxm/admin-sdk 13.5.0 → 13.7.0

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2010,6 +2010,10 @@ export var GetStreamSessionByIdSubscriptions200ResponseStatusEnum;
 (function (GetStreamSessionByIdSubscriptions200ResponseStatusEnum) {
     GetStreamSessionByIdSubscriptions200ResponseStatusEnum["Ok"] = "ok";
 })(GetStreamSessionByIdSubscriptions200ResponseStatusEnum || (GetStreamSessionByIdSubscriptions200ResponseStatusEnum = {}));
+export var GetStreamSessionViewers200ResponseStatusEnum;
+(function (GetStreamSessionViewers200ResponseStatusEnum) {
+    GetStreamSessionViewers200ResponseStatusEnum["Ok"] = "ok";
+})(GetStreamSessionViewers200ResponseStatusEnum || (GetStreamSessionViewers200ResponseStatusEnum = {}));
 export var GetStreamVideos200ResponseStatusEnum;
 (function (GetStreamVideos200ResponseStatusEnum) {
     GetStreamVideos200ResponseStatusEnum["Ok"] = "ok";
@@ -107181,6 +107185,56 @@ export const StreamsSessionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * 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.
+         * @summary List the people watching a stream session
+         * @param {string} sessionId The session identifier
+         * @param {number} [page] Page number
+         * @param {number} [pageSize] Number of items per page
+         * @param {string} [orderBy] Field to order by
+         * @param {string} [search] Search query
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        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 = {}) {
+            // verify required parameter 'sessionId' is not null or undefined
+            assertParamExists('getStreamSessionViewers', 'sessionId', sessionId);
+            const localVarPath = `/streams/sessions/{sessionId}/viewers`
+                .replace('{sessionId}', encodeURIComponent(String(sessionId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
+            // authentication OrganizationId required
+            yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+            if (orderBy !== undefined) {
+                localVarQueryParameter['orderBy'] = orderBy;
+            }
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
          * @summary List a stream\'s broadcast sessions
@@ -107464,6 +107518,26 @@ export const StreamsSessionsApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * 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.
+         * @summary List the people watching a stream session
+         * @param {string} sessionId The session identifier
+         * @param {number} [page] Page number
+         * @param {number} [pageSize] Number of items per page
+         * @param {string} [orderBy] Field to order by
+         * @param {string} [search] Search query
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getStreamSessionViewers(sessionId, page, pageSize, orderBy, search, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StreamsSessionsApi.getStreamSessionViewers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
          * @summary List a stream\'s broadcast sessions
@@ -107610,6 +107684,16 @@ export const StreamsSessionsApiFactory = function (configuration, basePath, axio
         getStreamSessionSubscriptions(requestParameters, options) {
             return localVarFp.getStreamSessionSubscriptions(requestParameters.streamId, requestParameters.sessionId, requestParameters.active, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary List the people watching a stream session
+         * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getStreamSessionViewers(requestParameters, options) {
+            return localVarFp.getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
+        },
         /**
          * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
          * @summary List a stream\'s broadcast sessions
@@ -107736,6 +107820,16 @@ export class StreamsSessionsApi extends BaseAPI {
     getStreamSessionSubscriptions(requestParameters, options) {
         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));
     }
+    /**
+     * 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.
+     * @summary List the people watching a stream session
+     * @param {StreamsSessionsApiGetStreamSessionViewersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getStreamSessionViewers(requestParameters, options) {
+        return StreamsSessionsApiFp(this.configuration).getStreamSessionViewers(requestParameters.sessionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Returns a paginated list of broadcast sessions for the given stream input, filterable by session status; requires read permission on streams.
      * @summary List a stream\'s broadcast sessions

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 13.5.0
+ * The version of the OpenAPI document: 13.7.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/GetStreamSessionViewers200Response.md

@@ -0,0 +1,26 @@
+# GetStreamSessionViewers200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<StreamSessionViewer>**](StreamSessionViewer.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetStreamSessionViewers200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetStreamSessionViewers200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StreamSessionViewer.md

@@ -0,0 +1,26 @@
+# StreamSessionViewer
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accountId** | **string** |  | [default to undefined]
+**account** | [**BaseAccount**](BaseAccount.md) |  | [default to undefined]
+**activeConnections** | **number** |  | [default to undefined]
+**connectedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { StreamSessionViewer } from '@connectedxm/admin-sdk';
+
+const instance: StreamSessionViewer = {
+    accountId,
+    account,
+    activeConnections,
+    connectedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StreamsSessionsApi.md

@@ -14,6 +14,7 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**getStreamSessionByIdSubscriptions**](#getstreamsessionbyidsubscriptions) | **GET** /streams/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections by session id|
 |[**getStreamSessionChat**](#getstreamsessionchat) | **GET** /streams/{streamId}/sessions/{sessionId}/chat | List a stream session\'s chat messages|
 |[**getStreamSessionSubscriptions**](#getstreamsessionsubscriptions) | **GET** /streams/{streamId}/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections|
+|[**getStreamSessionViewers**](#getstreamsessionviewers) | **GET** /streams/sessions/{sessionId}/viewers | List the people watching a stream session|
 |[**getStreamSessions**](#getstreamsessions) | **GET** /streams/{streamId}/sessions | List a stream\'s broadcast sessions|
 |[**updateStreamSession**](#updatestreamsession) | **PUT** /streams/sessions/{sessionId} | Update a stream session|
 
@@ -586,6 +587,69 @@ const { status, data } = await apiInstance.getStreamSessionSubscriptions(
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getStreamSessionViewers**
+> GetStreamSessionViewers200Response getStreamSessionViewers()
+
+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.
+
+### Example
+
+```typescript
+import {
+    StreamsSessionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new StreamsSessionsApi(configuration);
+
+let sessionId: string; //The session identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getStreamSessionViewers(
+    sessionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | [**string**] | The session identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetStreamSessionViewers200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "13.5.0",
+  "version": "13.7.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {