@connectedxm/admin-sdk 16.0.0 → 16.2.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 -1
- package/README.md +2 -2
- package/api.ts +114 -12
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +64 -11
- package/dist/api.js +86 -11
- 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 +64 -11
- package/dist/esm/api.js +82 -7
- 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/BaseSurveyQuestion.md +0 -2
- package/docs/GetStreamSessionByIdReactions200Response.md +24 -0
- package/docs/StreamSession.md +2 -2
- package/docs/StreamSessionChatMessage.md +2 -0
- package/docs/StreamSessionRecentReaction.md +22 -0
- package/docs/StreamsSessionsApi.md +55 -0
- package/docs/SurveyQuestion.md +0 -2
- package/package.json +1 -1
- package/docs/StreamReaction.md +0 -12
|
@@ -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: 16.
|
|
6
|
+
* The version of the OpenAPI document: 16.2.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -25,7 +25,6 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**validationMessage** | **string** | | [default to undefined]
|
|
26
26
|
**locationOption** | [**LocationQuestionOption**](LocationQuestionOption.md) | | [default to undefined]
|
|
27
27
|
**sortOrder** | **number** | | [default to undefined]
|
|
28
|
-
**featured** | **boolean** | | [default to undefined]
|
|
29
28
|
**choices** | [**Array<BaseSurveyQuestionChoice>**](BaseSurveyQuestionChoice.md) | | [default to undefined]
|
|
30
29
|
|
|
31
30
|
## Example
|
|
@@ -54,7 +53,6 @@ const instance: BaseSurveyQuestion = {
|
|
|
54
53
|
validationMessage,
|
|
55
54
|
locationOption,
|
|
56
55
|
sortOrder,
|
|
57
|
-
featured,
|
|
58
56
|
choices,
|
|
59
57
|
};
|
|
60
58
|
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetStreamSessionByIdReactions200Response
|
|
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<StreamSessionRecentReaction>**](StreamSessionRecentReaction.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetStreamSessionByIdReactions200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetStreamSessionByIdReactions200Response = {
|
|
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)
|
package/docs/StreamSession.md
CHANGED
|
@@ -23,7 +23,7 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**event** | [**BaseEvent**](BaseEvent.md) | | [default to undefined]
|
|
24
24
|
**eventSession** | [**BaseEventSession**](BaseEventSession.md) | | [default to undefined]
|
|
25
25
|
**organization** | [**BaseOrganization**](BaseOrganization.md) | | [default to undefined]
|
|
26
|
-
**
|
|
26
|
+
**watching** | **number** | | [optional] [default to undefined]
|
|
27
27
|
|
|
28
28
|
## Example
|
|
29
29
|
|
|
@@ -49,7 +49,7 @@ const instance: StreamSession = {
|
|
|
49
49
|
event,
|
|
50
50
|
eventSession,
|
|
51
51
|
organization,
|
|
52
|
-
|
|
52
|
+
watching,
|
|
53
53
|
};
|
|
54
54
|
```
|
|
55
55
|
|
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**videoTime** | **number** | | [default to undefined]
|
|
17
17
|
**videoId** | **string** | | [default to undefined]
|
|
18
18
|
**role** | **string** | | [default to undefined]
|
|
19
|
+
**imageUri** | **string** | | [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -34,6 +35,7 @@ const instance: StreamSessionChatMessage = {
|
|
|
34
35
|
videoTime,
|
|
35
36
|
videoId,
|
|
36
37
|
role,
|
|
38
|
+
imageUri,
|
|
37
39
|
};
|
|
38
40
|
```
|
|
39
41
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# StreamSessionRecentReaction
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**at** | **number** | | [default to undefined]
|
|
9
|
+
**reactions** | **{ [key: string]: any; }** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { StreamSessionRecentReaction } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: StreamSessionRecentReaction = {
|
|
17
|
+
at,
|
|
18
|
+
reactions,
|
|
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)
|
|
@@ -13,6 +13,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
13
13
|
|[**getStreamSession**](#getstreamsession) | **GET** /streams/{streamId}/sessions/{sessionId} | Get a single stream session|
|
|
14
14
|
|[**getStreamSessionById**](#getstreamsessionbyid) | **GET** /streams/sessions/{sessionId} | Get a stream session by id|
|
|
15
15
|
|[**getStreamSessionByIdChat**](#getstreamsessionbyidchat) | **GET** /streams/sessions/{sessionId}/chat | List a stream session\'s chat messages by session id|
|
|
16
|
+
|[**getStreamSessionByIdReactions**](#getstreamsessionbyidreactions) | **GET** /streams/sessions/{sessionId}/reactions | List a stream session\'s recent reactions by session id|
|
|
16
17
|
|[**getStreamSessionByIdSubscriptions**](#getstreamsessionbyidsubscriptions) | **GET** /streams/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections by session id|
|
|
17
18
|
|[**getStreamSessionChat**](#getstreamsessionchat) | **GET** /streams/{streamId}/sessions/{sessionId}/chat | List a stream session\'s chat messages|
|
|
18
19
|
|[**getStreamSessionSubscriptions**](#getstreamsessionsubscriptions) | **GET** /streams/{streamId}/sessions/{sessionId}/subscriptions | List a stream session\'s viewer connections|
|
|
@@ -509,6 +510,60 @@ const { status, data } = await apiInstance.getStreamSessionByIdChat(
|
|
|
509
510
|
- **Accept**: application/json
|
|
510
511
|
|
|
511
512
|
|
|
513
|
+
### HTTP response details
|
|
514
|
+
| Status code | Description | Response headers |
|
|
515
|
+
|-------------|-------------|------------------|
|
|
516
|
+
|**200** | Successful response | - |
|
|
517
|
+
|
|
518
|
+
[[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)
|
|
519
|
+
|
|
520
|
+
# **getStreamSessionByIdReactions**
|
|
521
|
+
> GetStreamSessionByIdReactions200Response getStreamSessionByIdReactions()
|
|
522
|
+
|
|
523
|
+
Returns the reaction counts each one-second tick sent viewers after since (ms), oldest first, from the last minute only; reactions are not kept beyond that. For animating reactions live; requires read permission on streams.
|
|
524
|
+
|
|
525
|
+
### Example
|
|
526
|
+
|
|
527
|
+
```typescript
|
|
528
|
+
import {
|
|
529
|
+
StreamsSessionsApi,
|
|
530
|
+
Configuration
|
|
531
|
+
} from '@connectedxm/admin-sdk';
|
|
532
|
+
|
|
533
|
+
const configuration = new Configuration();
|
|
534
|
+
const apiInstance = new StreamsSessionsApi(configuration);
|
|
535
|
+
|
|
536
|
+
let sessionId: string; //The session identifier (default to undefined)
|
|
537
|
+
let since: number; //Filter by since (default to undefined)
|
|
538
|
+
|
|
539
|
+
const { status, data } = await apiInstance.getStreamSessionByIdReactions(
|
|
540
|
+
sessionId,
|
|
541
|
+
since
|
|
542
|
+
);
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
### Parameters
|
|
546
|
+
|
|
547
|
+
|Name | Type | Description | Notes|
|
|
548
|
+
|------------- | ------------- | ------------- | -------------|
|
|
549
|
+
| **sessionId** | [**string**] | The session identifier | defaults to undefined|
|
|
550
|
+
| **since** | [**number**] | Filter by since | defaults to undefined|
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
### Return type
|
|
554
|
+
|
|
555
|
+
**GetStreamSessionByIdReactions200Response**
|
|
556
|
+
|
|
557
|
+
### Authorization
|
|
558
|
+
|
|
559
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
560
|
+
|
|
561
|
+
### HTTP request headers
|
|
562
|
+
|
|
563
|
+
- **Content-Type**: Not defined
|
|
564
|
+
- **Accept**: application/json
|
|
565
|
+
|
|
566
|
+
|
|
512
567
|
### HTTP response details
|
|
513
568
|
| Status code | Description | Response headers |
|
|
514
569
|
|-------------|-------------|------------------|
|
package/docs/SurveyQuestion.md
CHANGED
|
@@ -25,7 +25,6 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**validationMessage** | **string** | | [default to undefined]
|
|
26
26
|
**locationOption** | [**LocationQuestionOption**](LocationQuestionOption.md) | | [default to undefined]
|
|
27
27
|
**sortOrder** | **number** | | [default to undefined]
|
|
28
|
-
**featured** | **boolean** | | [default to undefined]
|
|
29
28
|
**choices** | [**Array<BaseSurveyQuestionChoice>**](BaseSurveyQuestionChoice.md) | | [default to undefined]
|
|
30
29
|
**sections** | [**Array<BaseSurveySectionQuestion>**](BaseSurveySectionQuestion.md) | | [default to undefined]
|
|
31
30
|
**subQuestionOf** | [**Array<SurveyQuestionChoiceSubQuestion>**](SurveyQuestionChoiceSubQuestion.md) | | [default to undefined]
|
|
@@ -61,7 +60,6 @@ const instance: SurveyQuestion = {
|
|
|
61
60
|
validationMessage,
|
|
62
61
|
locationOption,
|
|
63
62
|
sortOrder,
|
|
64
|
-
featured,
|
|
65
63
|
choices,
|
|
66
64
|
sections,
|
|
67
65
|
subQuestionOf,
|
package/package.json
CHANGED
package/docs/StreamReaction.md
DELETED
|
@@ -1,12 +0,0 @@
|
|
|
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)
|