@connectedxm/admin-sdk 15.5.0 → 15.7.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.
@@ -17,6 +17,8 @@ Name | Type | Description | Notes
17
17
  **locale** | **string** | | [default to undefined]
18
18
  **webRTC** | **boolean** | | [default to undefined]
19
19
  **webRTCPlaybackUrl** | **string** | | [default to undefined]
20
+ **dvrEnabled** | **boolean** | | [default to undefined]
21
+ **connected** | **boolean** | | [default to undefined]
20
22
 
21
23
  ## Example
22
24
 
@@ -36,6 +38,8 @@ const instance: BaseStreamInput = {
36
38
  locale,
37
39
  webRTC,
38
40
  webRTCPlaybackUrl,
41
+ dvrEnabled,
42
+ connected,
39
43
  };
40
44
  ```
41
45
 
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **eventId** | **string** | | [default to undefined]
13
13
  **eventSessionId** | **string** | | [default to undefined]
14
14
  **status** | [**StreamSessionStatus**](StreamSessionStatus.md) | | [default to undefined]
15
+ **slowModeSeconds** | **number** | | [default to undefined]
15
16
  **startedAt** | **string** | | [default to undefined]
16
17
  **endedAt** | **string** | | [default to undefined]
17
18
  **createdAt** | **string** | | [default to undefined]
@@ -30,6 +31,7 @@ const instance: BaseStreamSession = {
30
31
  eventId,
31
32
  eventSessionId,
32
33
  status,
34
+ slowModeSeconds,
33
35
  startedAt,
34
36
  endedAt,
35
37
  createdAt,
@@ -0,0 +1,24 @@
1
+ # CreateStreamSessionChatMessage200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **status** | **string** | | [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+ **data** | [**StreamSessionChatMessage**](StreamSessionChatMessage.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CreateStreamSessionChatMessage200Response } from '@connectedxm/admin-sdk';
16
+
17
+ const instance: CreateStreamSessionChatMessage200Response = {
18
+ status,
19
+ message,
20
+ data,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # ReorderTiers200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **status** | **string** | | [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+ **data** | [**Array<Tier>**](Tier.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ReorderTiers200Response } from '@connectedxm/admin-sdk';
16
+
17
+ const instance: ReorderTiers200Response = {
18
+ status,
19
+ message,
20
+ data,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # ReorderTiersRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **tierIds** | **Array<string>** | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ReorderTiersRequest } from '@connectedxm/admin-sdk';
14
+
15
+ const instance: ReorderTiersRequest = {
16
+ tierIds,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -17,6 +17,8 @@ Name | Type | Description | Notes
17
17
  **locale** | **string** | | [default to undefined]
18
18
  **webRTC** | **boolean** | | [default to undefined]
19
19
  **webRTCPlaybackUrl** | **string** | | [default to undefined]
20
+ **dvrEnabled** | **boolean** | | [default to undefined]
21
+ **connected** | **boolean** | | [default to undefined]
20
22
  **event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
21
23
  **session** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
22
24
  **group** | [**BaseGroup**](BaseGroup.md) | | [default to undefined]
@@ -46,6 +48,8 @@ const instance: StreamInput = {
46
48
  locale,
47
49
  webRTC,
48
50
  webRTCPlaybackUrl,
51
+ dvrEnabled,
52
+ connected,
49
53
  event,
50
54
  session,
51
55
  group,
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
18
18
  **_public** | **boolean** | | [optional] [default to undefined]
19
19
  **locale** | **string** | | [optional] [default to undefined]
20
20
  **webRTC** | **boolean** | | [optional] [default to undefined]
21
+ **dvrEnabled** | **boolean** | | [optional] [default to undefined]
21
22
 
22
23
  ## Example
23
24
 
@@ -38,6 +39,7 @@ const instance: StreamInputCreateInputs = {
38
39
  _public,
39
40
  locale,
40
41
  webRTC,
42
+ dvrEnabled,
41
43
  };
42
44
  ```
43
45
 
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
18
18
  **_public** | **boolean** | | [optional] [default to undefined]
19
19
  **locale** | **string** | | [optional] [default to undefined]
20
20
  **webRTC** | **boolean** | | [optional] [default to undefined]
21
+ **dvrEnabled** | **boolean** | | [optional] [default to undefined]
21
22
 
22
23
  ## Example
23
24
 
@@ -38,6 +39,7 @@ const instance: StreamInputUpdateInputs = {
38
39
  _public,
39
40
  locale,
40
41
  webRTC,
42
+ dvrEnabled,
41
43
  };
42
44
  ```
43
45
 
@@ -0,0 +1,12 @@
1
+ # StreamReaction
2
+
3
+
4
+ ## Enum
5
+
6
+ * `Love` (value: `'love'`)
7
+
8
+ * `Applause` (value: `'applause'`)
9
+
10
+ * `Agree` (value: `'agree'`)
11
+
12
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
  **eventId** | **string** | | [default to undefined]
13
13
  **eventSessionId** | **string** | | [default to undefined]
14
14
  **status** | [**StreamSessionStatus**](StreamSessionStatus.md) | | [default to undefined]
15
+ **slowModeSeconds** | **number** | | [default to undefined]
15
16
  **startedAt** | **string** | | [default to undefined]
16
17
  **endedAt** | **string** | | [default to undefined]
17
18
  **createdAt** | **string** | | [default to undefined]
@@ -20,6 +21,7 @@ Name | Type | Description | Notes
20
21
  **event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
21
22
  **eventSession** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
22
23
  **organization** | [**BaseOrganization**](BaseOrganization.md) | | [default to undefined]
24
+ **reactions** | **{ [key: string]: any; }** | | [optional] [default to undefined]
23
25
 
24
26
  ## Example
25
27
 
@@ -34,6 +36,7 @@ const instance: StreamSession = {
34
36
  eventId,
35
37
  eventSessionId,
36
38
  status,
39
+ slowModeSeconds,
37
40
  startedAt,
38
41
  endedAt,
39
42
  createdAt,
@@ -42,6 +45,7 @@ const instance: StreamSession = {
42
45
  event,
43
46
  eventSession,
44
47
  organization,
48
+ reactions,
45
49
  };
46
50
  ```
47
51
 
@@ -13,6 +13,9 @@ Name | Type | Description | Notes
13
13
  **connectionId** | **string** | | [default to undefined]
14
14
  **message** | **string** | | [default to undefined]
15
15
  **timestamp** | **number** | | [default to undefined]
16
+ **videoTime** | **number** | | [default to undefined]
17
+ **videoId** | **string** | | [default to undefined]
18
+ **role** | **string** | | [default to undefined]
16
19
 
17
20
  ## Example
18
21
 
@@ -28,6 +31,9 @@ const instance: StreamSessionChatMessage = {
28
31
  connectionId,
29
32
  message,
30
33
  timestamp,
34
+ videoTime,
35
+ videoId,
36
+ role,
31
37
  };
32
38
  ```
33
39
 
@@ -0,0 +1,22 @@
1
+ # StreamSessionChatMessageCreateInputs
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **message** | **string** | | [default to undefined]
9
+ **name** | **string** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { StreamSessionChatMessageCreateInputs } from '@connectedxm/admin-sdk';
15
+
16
+ const instance: StreamSessionChatMessageCreateInputs = {
17
+ message,
18
+ name,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **name** | **string** | | [optional] [default to undefined]
9
9
  **eventId** | **string** | | [optional] [default to undefined]
10
10
  **eventSessionId** | **string** | | [optional] [default to undefined]
11
+ **slowModeSeconds** | **number** | | [optional] [default to undefined]
11
12
 
12
13
  ## Example
13
14
 
@@ -18,6 +19,7 @@ const instance: StreamSessionUpdateInputs = {
18
19
  name,
19
20
  eventId,
20
21
  eventSessionId,
22
+ slowModeSeconds,
21
23
  };
22
24
  ```
23
25
 
@@ -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
+ |[**createStreamSessionChatMessage**](#createstreamsessionchatmessage) | **POST** /streams/sessions/{sessionId}/chat | Post a chat message as the host|
8
9
  |[**deleteStreamSessionChatMessage**](#deletestreamsessionchatmessage) | **DELETE** /streams/sessions/{sessionId}/chat/{messageId} | Delete a stream session chat message|
9
10
  |[**exportStreamSession**](#exportstreamsession) | **POST** /streams/{streamId}/sessions/{sessionId}/export | Request an export of a stream session|
10
11
  |[**exportStreamSessionById**](#exportstreamsessionbyid) | **POST** /streams/sessions/{sessionId}/export | Request an export of a stream session by session id|
@@ -66,6 +67,61 @@ const { status, data } = await apiInstance.closeStreamSession(
66
67
  - **Accept**: application/json
67
68
 
68
69
 
70
+ ### HTTP response details
71
+ | Status code | Description | Response headers |
72
+ |-------------|-------------|------------------|
73
+ |**200** | Successful response | - |
74
+
75
+ [[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)
76
+
77
+ # **createStreamSessionChatMessage**
78
+ > CreateStreamSessionChatMessage200Response createStreamSessionChatMessage(streamSessionChatMessageCreateInputs)
79
+
80
+ Posts a chat message to an active stream session (sessionId) as the host, under the organization\'s name unless a name is given. Viewers see it with a host badge, and slow mode doesn\'t apply; requires the read and update permissions on streams.
81
+
82
+ ### Example
83
+
84
+ ```typescript
85
+ import {
86
+ StreamsSessionsApi,
87
+ Configuration,
88
+ StreamSessionChatMessageCreateInputs
89
+ } from '@connectedxm/admin-sdk';
90
+
91
+ const configuration = new Configuration();
92
+ const apiInstance = new StreamsSessionsApi(configuration);
93
+
94
+ let sessionId: string; //The session identifier (default to undefined)
95
+ let streamSessionChatMessageCreateInputs: StreamSessionChatMessageCreateInputs; //
96
+
97
+ const { status, data } = await apiInstance.createStreamSessionChatMessage(
98
+ sessionId,
99
+ streamSessionChatMessageCreateInputs
100
+ );
101
+ ```
102
+
103
+ ### Parameters
104
+
105
+ |Name | Type | Description | Notes|
106
+ |------------- | ------------- | ------------- | -------------|
107
+ | **streamSessionChatMessageCreateInputs** | **StreamSessionChatMessageCreateInputs**| | |
108
+ | **sessionId** | [**string**] | The session identifier | defaults to undefined|
109
+
110
+
111
+ ### Return type
112
+
113
+ **CreateStreamSessionChatMessage200Response**
114
+
115
+ ### Authorization
116
+
117
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
118
+
119
+ ### HTTP request headers
120
+
121
+ - **Content-Type**: application/json
122
+ - **Accept**: application/json
123
+
124
+
69
125
  ### HTTP response details
70
126
  | Status code | Description | Response headers |
71
127
  |-------------|-------------|------------------|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **name** | **string** | | [default to undefined]
9
9
  **slug** | **string** | | [optional] [default to undefined]
10
10
  **iconName** | **string** | | [optional] [default to undefined]
11
- **priority** | **number** | | [optional] [default to undefined]
11
+ **priority** | **number** | Ignored: new tiers are always added last. Use ReorderTiers to change the order. | [optional] [default to undefined]
12
12
  **description** | **string** | | [optional] [default to undefined]
13
13
  **imageId** | **string** | | [optional] [default to undefined]
14
14
  **color** | **string** | | [optional] [default to undefined]
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
8
8
  **name** | **string** | | [optional] [default to undefined]
9
9
  **slug** | **string** | | [optional] [default to undefined]
10
10
  **iconName** | **string** | | [optional] [default to undefined]
11
- **priority** | **number** | | [optional] [default to undefined]
11
+ **priority** | **number** | Use ReorderTiers to change the order of tiers. | [optional] [default to undefined]
12
12
  **description** | **string** | | [optional] [default to undefined]
13
13
  **imageId** | **string** | | [optional] [default to undefined]
14
14
  **color** | **string** | | [optional] [default to undefined]
package/docs/TiersApi.md CHANGED
@@ -13,6 +13,7 @@ All URIs are relative to *https://admin-api.connected.dev*
13
13
  |[**getTierImports**](#gettierimports) | **GET** /tiers/{tierId}/imports | List account tier imports|
14
14
  |[**getTiers**](#gettiers) | **GET** /tiers | List account tiers|
15
15
  |[**removeTierAccounts**](#removetieraccounts) | **DELETE** /tiers/{tierId}/accounts | Remove all accounts from a tier|
16
+ |[**reorderTiers**](#reordertiers) | **PUT** /tiers/reorder | Reorder account tiers|
16
17
  |[**updateTier**](#updatetier) | **PUT** /tiers/{tierId} | Update an account tier|
17
18
 
18
19
  # **createTier**
@@ -528,6 +529,58 @@ const { status, data } = await apiInstance.removeTierAccounts(
528
529
  - **Accept**: application/json
529
530
 
530
531
 
532
+ ### HTTP response details
533
+ | Status code | Description | Response headers |
534
+ |-------------|-------------|------------------|
535
+ |**200** | Successful response | - |
536
+
537
+ [[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)
538
+
539
+ # **reorderTiers**
540
+ > ReorderTiers200Response reorderTiers(reorderTiersRequest)
541
+
542
+ Sets the priority of every account tier in the organization from a complete, ordered array of tier IDs (archived and internal tiers included); any missing or unknown tier ID rejects the request, and update permission on tiers is required.
543
+
544
+ ### Example
545
+
546
+ ```typescript
547
+ import {
548
+ TiersApi,
549
+ Configuration,
550
+ ReorderTiersRequest
551
+ } from '@connectedxm/admin-sdk';
552
+
553
+ const configuration = new Configuration();
554
+ const apiInstance = new TiersApi(configuration);
555
+
556
+ let reorderTiersRequest: ReorderTiersRequest; //
557
+
558
+ const { status, data } = await apiInstance.reorderTiers(
559
+ reorderTiersRequest
560
+ );
561
+ ```
562
+
563
+ ### Parameters
564
+
565
+ |Name | Type | Description | Notes|
566
+ |------------- | ------------- | ------------- | -------------|
567
+ | **reorderTiersRequest** | **ReorderTiersRequest**| | |
568
+
569
+
570
+ ### Return type
571
+
572
+ **ReorderTiers200Response**
573
+
574
+ ### Authorization
575
+
576
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
577
+
578
+ ### HTTP request headers
579
+
580
+ - **Content-Type**: application/json
581
+ - **Accept**: application/json
582
+
583
+
531
584
  ### HTTP response details
532
585
  | Status code | Description | Response headers |
533
586
  |-------------|-------------|------------------|
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "15.5.0",
3
+ "version": "15.7.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {