@connectedxm/admin-sdk 16.13.0 → 16.15.0

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: 16.13.0
+ * The version of the OpenAPI document: 16.15.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: 16.13.0
+ * The version of the OpenAPI document: 16.15.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: 16.13.0
+ * The version of the OpenAPI document: 16.15.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: 16.13.0
+ * The version of the OpenAPI document: 16.15.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: 16.13.0
+ * The version of the OpenAPI document: 16.15.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: 16.13.0
+ * The version of the OpenAPI document: 16.15.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/BaseReplay.md

@@ -0,0 +1,38 @@
+# BaseReplay
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**videoId** | **string** |  | [default to undefined]
+**sessionId** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+**groupId** | **string** |  | [default to undefined]
+**session** | [**BaseReplaySession**](BaseReplaySession.md) |  | [default to undefined]
+**event** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**group** | [**VideoAllOfStream**](VideoAllOfStream.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseReplay } from '@connectedxm/admin-sdk';
+
+const instance: BaseReplay = {
+    id,
+    videoId,
+    sessionId,
+    eventId,
+    groupId,
+    session,
+    event,
+    group,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/BaseReplaySession.md

@@ -0,0 +1,24 @@
+# BaseReplaySession
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**eventId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BaseReplaySession } from '@connectedxm/admin-sdk';
+
+const instance: BaseReplaySession = {
+    id,
+    name,
+    eventId,
+};
+```
+
+[[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/BaseStreamInput.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **webRTC** | **boolean** |  | [default to undefined]
 **webRTCPlaybackUrl** | **string** |  | [default to undefined]
 **dvrEnabled** | **boolean** |  | [default to undefined]
+**allowReplays** | **boolean** |  | [default to undefined]
 **connected** | **boolean** |  | [default to undefined]
 
 ## Example
@@ -39,6 +40,7 @@ const instance: BaseStreamInput = {
     webRTC,
     webRTCPlaybackUrl,
     dvrEnabled,
+    allowReplays,
     connected,
 };
 ```

package/docs/BaseVideo.md

@@ -15,6 +15,8 @@ Name | Type | Description | Notes
 **previewUrl** | **string** |  | [default to undefined]
 **readyToStream** | **boolean** |  | [default to undefined]
 **duration** | **number** |  | [default to undefined]
+**streamId** | **string** |  | [default to undefined]
+**streamSessionId** | **string** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 
 ## Example
@@ -33,6 +35,8 @@ const instance: BaseVideo = {
     previewUrl,
     readyToStream,
     duration,
+    streamId,
+    streamSessionId,
     createdAt,
 };
 ```

package/docs/ChannelsInterestsApi.md

@@ -0,0 +1,364 @@
+# ChannelsInterestsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addChannelContentInterest**](#addchannelcontentinterest) | **POST** /channels/{channelId}/contents/{contentId}/interests/{interestId} | Add an interest to a content item|
+|[**addChannelInterest**](#addchannelinterest) | **POST** /channels/{channelId}/interests/{interestId} | Add an interest to a channel|
+|[**getChannelContentInterests**](#getchannelcontentinterests) | **GET** /channels/{channelId}/contents/{contentId}/interests | List a content item\'s interests|
+|[**getChannelInterests**](#getchannelinterests) | **GET** /channels/{channelId}/interests | List a channel\'s interests|
+|[**removeChannelContentInterest**](#removechannelcontentinterest) | **DELETE** /channels/{channelId}/contents/{contentId}/interests/{interestId} | Remove an interest from a content item|
+|[**removeChannelInterest**](#removechannelinterest) | **DELETE** /channels/{channelId}/interests/{interestId} | Remove an interest from a channel|
+
+# **addChannelContentInterest**
+> CreateChannelContent200Response addChannelContentInterest()
+
+Associates an existing interest with a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.addChannelContentInterest(
+    channelId,
+    contentId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateChannelContent200Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **addChannelInterest**
+> CreateChannel200Response addChannelInterest()
+
+Associates an existing interest with a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.addChannelInterest(
+    channelId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateChannel200Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **getChannelContentInterests**
+> GetAccountInterests200Response getChannelContentInterests()
+
+Returns a paginated list of interest tags associated with the given content item, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels, contents and interests.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content 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.getChannelContentInterests(
+    channelId,
+    contentId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content 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
+
+**GetAccountInterests200Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **getChannelInterests**
+> GetAccountInterests200Response getChannelInterests()
+
+Returns a paginated list of interest tags associated with the given channel, optionally filtered by a search term on the interest name and sorted via orderBy; requires \"read\" permission on channels and interests.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel 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.getChannelInterests(
+    channelId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel 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
+
+**GetAccountInterests200Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **removeChannelContentInterest**
+> CreateChannelContent200Response removeChannelContentInterest()
+
+Removes an interest from a content item within a channel, requiring read permission on channels and update permission on both contents and interests; the content\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let contentId: string; //The content identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeChannelContentInterest(
+    channelId,
+    contentId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **contentId** | [**string**] | The content identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateChannelContent200Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **removeChannelInterest**
+> CreateChannel200Response removeChannelInterest()
+
+Removes an interest from a channel, requiring update permission on both channels and interests; the channel\'s cached data is refreshed and its interests list and the interest\'s cached detail and lists are invalidated.
+
+### Example
+
+```typescript
+import {
+    ChannelsInterestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ChannelsInterestsApi(configuration);
+
+let channelId: string; //The channel identifier (default to undefined)
+let interestId: string; //The interest identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeChannelInterest(
+    channelId,
+    interestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **channelId** | [**string**] | The channel identifier | defaults to undefined|
+| **interestId** | [**string**] | The interest identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateChannel200Response**
+
+### 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 |
+|-------------|-------------|------------------|
+|**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)
+

package/docs/CreateReplay200Response.md

@@ -0,0 +1,24 @@
+# CreateReplay200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Replay**](Replay.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateReplay200Response } from '@connectedxm/admin-sdk';
+
+const instance: CreateReplay200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/EventSession.md

@@ -48,6 +48,8 @@ Name | Type | Description | Notes
 **allowedTiers** | [**Array<BaseTier>**](BaseTier.md) |  | [default to undefined]
 **continuousScanning** | **boolean** |  | [default to undefined]
 **scanType** | [**OnSiteScanType**](OnSiteScanType.md) |  | [default to undefined]
+**livestreamed** | **boolean** |  | [default to undefined]
+**_count** | [**EventSessionAllOfCount**](EventSessionAllOfCount.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -98,6 +100,8 @@ const instance: EventSession = {
     allowedTiers,
     continuousScanning,
     scanType,
+    livestreamed,
+    _count,
 };
 ```
 

package/docs/EventSessionAllOfCount.md

@@ -0,0 +1,20 @@
+# EventSessionAllOfCount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**replays** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { EventSessionAllOfCount } from '@connectedxm/admin-sdk';
+
+const instance: EventSessionAllOfCount = {
+    replays,
+};
+```
+
+[[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/EventSessionCreateInputs.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **featured** | **boolean** |  | [optional] [default to undefined]
 **sortOrder** | **number** |  | [optional] [default to undefined]
 **registrationEnabled** | **boolean** |  | [optional] [default to undefined]
+**livestreamed** | **boolean** |  | [optional] [default to undefined]
 **onsiteRegistration** | **boolean** |  | [optional] [default to undefined]
 **skipOnsiteValidations** | **boolean** |  | [optional] [default to undefined]
 **allowQuickRegister** | **boolean** |  | [optional] [default to undefined]
@@ -55,6 +56,7 @@ const instance: EventSessionCreateInputs = {
     featured,
     sortOrder,
     registrationEnabled,
+    livestreamed,
     onsiteRegistration,
     skipOnsiteValidations,
     allowQuickRegister,

package/docs/EventSessionUpdateInputs.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **featured** | **boolean** |  | [optional] [default to undefined]
 **sortOrder** | **number** |  | [optional] [default to undefined]
 **registrationEnabled** | **boolean** |  | [optional] [default to undefined]
+**livestreamed** | **boolean** |  | [optional] [default to undefined]
 **onsiteRegistration** | **boolean** |  | [optional] [default to undefined]
 **skipOnsiteValidations** | **boolean** |  | [optional] [default to undefined]
 **allowQuickRegister** | **boolean** |  | [optional] [default to undefined]
@@ -55,6 +56,7 @@ const instance: EventSessionUpdateInputs = {
     featured,
     sortOrder,
     registrationEnabled,
+    livestreamed,
     onsiteRegistration,
     skipOnsiteValidations,
     allowQuickRegister,