@connectedxm/admin-sdk 6.33.0 → 7.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/.openapi-generator/FILES +7 -26
- package/AdminApi.ts +3 -9
- package/README.md +10 -39
- package/api.ts +239 -1777
- package/dist/AdminApi.d.ts +2 -4
- package/dist/AdminApi.js +1 -3
- package/dist/api.d.ts +148 -951
- package/dist/api.js +204 -1308
- package/dist/esm/AdminApi.d.ts +2 -4
- package/dist/esm/AdminApi.js +2 -4
- package/dist/esm/api.d.ts +148 -951
- package/dist/esm/api.js +175 -1270
- package/docs/BaseEventActivation.md +2 -0
- package/docs/BaseThread.md +0 -2
- package/docs/BaseThreadMessage.md +4 -2
- package/docs/EventActivation.md +2 -0
- package/docs/EventActivationCreateInputs.md +2 -0
- package/docs/{ThreadCircleType.md → EventActivationRewardType.md} +3 -3
- package/docs/EventActivationUpdateInputs.md +2 -0
- package/docs/EventsActivationsSessionsApi.md +55 -0
- package/docs/EventsApi.md +0 -64
- package/docs/GroupsApi.md +0 -64
- package/docs/Thread.md +4 -2
- package/docs/{ThreadMember.md → ThreadAccount.md} +9 -5
- package/docs/{ThreadMemberUpdateInputs.md → ThreadAccountUpdateInputs.md} +5 -3
- package/docs/{ThreadCircleCreateInputs.md → ThreadAllOfCount.md} +5 -5
- package/docs/ThreadCreateInputs.md +2 -6
- package/docs/ThreadMessage.md +6 -2
- package/docs/{BaseThreadMember.md → ThreadMessageRead.md} +9 -11
- package/docs/{ThreadsMembersApi.md → ThreadsAccountsApi.md} +31 -40
- package/docs/ThreadsApi.md +0 -3
- package/docs/{UpdateThreadMember200Response.md → UpdateThreadAccount200Response.md} +4 -4
- package/package.json +1 -1
- package/docs/BaseThreadCircle.md +0 -28
- package/docs/BaseThreadCircleAccount.md +0 -24
- package/docs/CreateThreadCircle200Response.md +0 -24
- package/docs/CreateThreadCircleAccount200Response.md +0 -24
- package/docs/GetThreadCircleAccounts200Response.md +0 -26
- package/docs/GetThreadCircles200Response.md +0 -26
- package/docs/GetThreadMembers200Response.md +0 -26
- package/docs/ThreadCircle.md +0 -28
- package/docs/ThreadCircleAccount.md +0 -24
- package/docs/ThreadCircleAccountCreateInputs.md +0 -22
- package/docs/ThreadCircleAccountRole.md +0 -12
- package/docs/ThreadCircleAccountUpdateInputs.md +0 -20
- package/docs/ThreadCircleUpdateInputs.md +0 -20
- package/docs/ThreadInvitation.md +0 -42
- package/docs/ThreadInvitationStatus.md +0 -10
- package/docs/ThreadMemberRole.md +0 -10
- package/docs/ThreadType.md +0 -14
- package/docs/ThreadsCirclesAccountsApi.md +0 -299
- package/docs/ThreadsCirclesApi.md +0 -348
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**maxPoints** | **number** | | [default to undefined]
|
|
14
14
|
**startAfter** | **string** | | [default to undefined]
|
|
15
15
|
**type** | [**EventActivationType**](EventActivationType.md) | | [default to undefined]
|
|
16
|
+
**rewardType** | [**EventActivationRewardType**](EventActivationRewardType.md) | | [default to undefined]
|
|
16
17
|
**accessLevel** | [**PassTypeAccessLevel**](PassTypeAccessLevel.md) | | [default to undefined]
|
|
17
18
|
**sortOrder** | **number** | | [default to undefined]
|
|
18
19
|
**survey** | [**BaseSurvey**](BaseSurvey.md) | | [default to undefined]
|
|
@@ -33,6 +34,7 @@ const instance: BaseEventActivation = {
|
|
|
33
34
|
maxPoints,
|
|
34
35
|
startAfter,
|
|
35
36
|
type,
|
|
37
|
+
rewardType,
|
|
36
38
|
accessLevel,
|
|
37
39
|
sortOrder,
|
|
38
40
|
survey,
|
package/docs/BaseThread.md
CHANGED
|
@@ -9,7 +9,6 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**subject** | **string** | | [default to undefined]
|
|
10
10
|
**imageId** | **string** | | [default to undefined]
|
|
11
11
|
**image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
12
|
-
**type** | [**ThreadType**](ThreadType.md) | | [default to undefined]
|
|
13
12
|
**lastMessageAt** | **string** | | [default to undefined]
|
|
14
13
|
**lastMessage** | **string** | | [default to undefined]
|
|
15
14
|
**createdAt** | **string** | | [default to undefined]
|
|
@@ -24,7 +23,6 @@ const instance: BaseThread = {
|
|
|
24
23
|
subject,
|
|
25
24
|
imageId,
|
|
26
25
|
image,
|
|
27
|
-
type,
|
|
28
26
|
lastMessageAt,
|
|
29
27
|
lastMessage,
|
|
30
28
|
createdAt,
|
|
@@ -8,10 +8,11 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**body** | **string** | | [default to undefined]
|
|
10
10
|
**accountId** | **string** | | [default to undefined]
|
|
11
|
-
**
|
|
11
|
+
**threadAccount** | [**ThreadAccount**](ThreadAccount.md) | | [default to undefined]
|
|
12
12
|
**createdAt** | **string** | | [default to undefined]
|
|
13
13
|
**editedAt** | **string** | | [default to undefined]
|
|
14
14
|
**sentAt** | **string** | | [default to undefined]
|
|
15
|
+
**deletedAt** | **string** | | [optional] [default to undefined]
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -22,10 +23,11 @@ const instance: BaseThreadMessage = {
|
|
|
22
23
|
id,
|
|
23
24
|
body,
|
|
24
25
|
accountId,
|
|
25
|
-
|
|
26
|
+
threadAccount,
|
|
26
27
|
createdAt,
|
|
27
28
|
editedAt,
|
|
28
29
|
sentAt,
|
|
30
|
+
deletedAt,
|
|
29
31
|
};
|
|
30
32
|
```
|
|
31
33
|
|
package/docs/EventActivation.md
CHANGED
|
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**maxPoints** | **number** | | [default to undefined]
|
|
14
14
|
**startAfter** | **string** | | [default to undefined]
|
|
15
15
|
**type** | [**EventActivationType**](EventActivationType.md) | | [default to undefined]
|
|
16
|
+
**rewardType** | [**EventActivationRewardType**](EventActivationRewardType.md) | | [default to undefined]
|
|
16
17
|
**accessLevel** | [**PassTypeAccessLevel**](PassTypeAccessLevel.md) | | [default to undefined]
|
|
17
18
|
**sortOrder** | **number** | | [default to undefined]
|
|
18
19
|
**survey** | [**BaseSurvey**](BaseSurvey.md) | | [default to undefined]
|
|
@@ -43,6 +44,7 @@ const instance: EventActivation = {
|
|
|
43
44
|
maxPoints,
|
|
44
45
|
startAfter,
|
|
45
46
|
type,
|
|
47
|
+
rewardType,
|
|
46
48
|
accessLevel,
|
|
47
49
|
sortOrder,
|
|
48
50
|
survey,
|
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**maxPoints** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
15
15
|
**startAfter** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**type** | [**EventActivationType**](EventActivationType.md) | | [optional] [default to undefined]
|
|
17
|
+
**rewardType** | [**EventActivationRewardType**](EventActivationRewardType.md) | | [optional] [default to undefined]
|
|
17
18
|
**protectionCode** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
18
19
|
**email** | **boolean** | | [optional] [default to undefined]
|
|
19
20
|
**push** | **boolean** | | [optional] [default to undefined]
|
|
@@ -38,6 +39,7 @@ const instance: EventActivationCreateInputs = {
|
|
|
38
39
|
maxPoints,
|
|
39
40
|
startAfter,
|
|
40
41
|
type,
|
|
42
|
+
rewardType,
|
|
41
43
|
protectionCode,
|
|
42
44
|
email,
|
|
43
45
|
push,
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# EventActivationRewardType
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Enum
|
|
5
5
|
|
|
6
|
-
* `
|
|
6
|
+
* `Max` (value: `'max'`)
|
|
7
7
|
|
|
8
|
-
* `
|
|
8
|
+
* `Input` (value: `'input'`)
|
|
9
9
|
|
|
10
10
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**maxPoints** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
15
15
|
**startAfter** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**type** | [**EventActivationType**](EventActivationType.md) | | [optional] [default to undefined]
|
|
17
|
+
**rewardType** | [**EventActivationRewardType**](EventActivationRewardType.md) | | [optional] [default to undefined]
|
|
17
18
|
**protectionCode** | [**AdvertisementCreateInputsWeight**](AdvertisementCreateInputsWeight.md) | | [optional] [default to undefined]
|
|
18
19
|
**accessLevel** | [**PassTypeAccessLevel**](PassTypeAccessLevel.md) | | [optional] [default to undefined]
|
|
19
20
|
**continuousScanning** | **boolean** | | [optional] [default to undefined]
|
|
@@ -36,6 +37,7 @@ const instance: EventActivationUpdateInputs = {
|
|
|
36
37
|
maxPoints,
|
|
37
38
|
startAfter,
|
|
38
39
|
type,
|
|
40
|
+
rewardType,
|
|
39
41
|
protectionCode,
|
|
40
42
|
accessLevel,
|
|
41
43
|
continuousScanning,
|
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**addEventActivationSession**](#addeventactivationsession) | **POST** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Add Event Activation Session|
|
|
8
8
|
|[**removeEventActivationSession**](#removeeventactivationsession) | **DELETE** /events/{eventId}/activations/{activationId}/sessions/{sessionId} | Remove Event Activation Session|
|
|
9
|
+
|[**removeEventActivationSessions**](#removeeventactivationsessions) | **DELETE** /events/{eventId}/activations/{activationId}/sessions | Remove Event Activation Sessions|
|
|
9
10
|
|
|
10
11
|
# **addEventActivationSession**
|
|
11
12
|
> CreateEventActivation200Response addEventActivationSession()
|
|
@@ -121,3 +122,57 @@ const { status, data } = await apiInstance.removeEventActivationSession(
|
|
|
121
122
|
|
|
122
123
|
[[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)
|
|
123
124
|
|
|
125
|
+
# **removeEventActivationSessions**
|
|
126
|
+
> CreateEventActivation200Response removeEventActivationSessions()
|
|
127
|
+
|
|
128
|
+
Remove Event Activation Sessions endpoint
|
|
129
|
+
|
|
130
|
+
### Example
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
import {
|
|
134
|
+
EventsActivationsSessionsApi,
|
|
135
|
+
Configuration
|
|
136
|
+
} from '@connectedxm/admin-sdk';
|
|
137
|
+
|
|
138
|
+
const configuration = new Configuration();
|
|
139
|
+
const apiInstance = new EventsActivationsSessionsApi(configuration);
|
|
140
|
+
|
|
141
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
142
|
+
let activationId: string; //The activation identifier (default to undefined)
|
|
143
|
+
|
|
144
|
+
const { status, data } = await apiInstance.removeEventActivationSessions(
|
|
145
|
+
eventId,
|
|
146
|
+
activationId
|
|
147
|
+
);
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Parameters
|
|
151
|
+
|
|
152
|
+
|Name | Type | Description | Notes|
|
|
153
|
+
|------------- | ------------- | ------------- | -------------|
|
|
154
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
155
|
+
| **activationId** | [**string**] | The activation identifier | defaults to undefined|
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### Return type
|
|
159
|
+
|
|
160
|
+
**CreateEventActivation200Response**
|
|
161
|
+
|
|
162
|
+
### Authorization
|
|
163
|
+
|
|
164
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
165
|
+
|
|
166
|
+
### HTTP request headers
|
|
167
|
+
|
|
168
|
+
- **Content-Type**: Not defined
|
|
169
|
+
- **Accept**: application/json
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### HTTP response details
|
|
173
|
+
| Status code | Description | Response headers |
|
|
174
|
+
|-------------|-------------|------------------|
|
|
175
|
+
|**200** | Successful response | - |
|
|
176
|
+
|
|
177
|
+
[[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)
|
|
178
|
+
|
package/docs/EventsApi.md
CHANGED
|
@@ -12,7 +12,6 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
12
12
|
|[**getEvent**](#getevent) | **GET** /events/{eventId} | Get Event|
|
|
13
13
|
|[**getEventActivities**](#geteventactivities) | **GET** /events/{eventId}/activities | Get Event Activities|
|
|
14
14
|
|[**getEventPayments**](#geteventpayments) | **GET** /events/{eventId}/payments | Get Event Payments|
|
|
15
|
-
|[**getEventThreads**](#geteventthreads) | **GET** /events/{eventId}/threads | Get Event Threads|
|
|
16
15
|
|[**getEventTiers**](#geteventtiers) | **GET** /events/{eventId}/tiers | Get Event Tiers|
|
|
17
16
|
|[**getEvents**](#getevents) | **GET** /events | Get Events|
|
|
18
17
|
|[**updateEvent**](#updateevent) | **PUT** /events/{eventId} | Update Event|
|
|
@@ -453,69 +452,6 @@ const { status, data } = await apiInstance.getEventPayments(
|
|
|
453
452
|
- **Accept**: application/json
|
|
454
453
|
|
|
455
454
|
|
|
456
|
-
### HTTP response details
|
|
457
|
-
| Status code | Description | Response headers |
|
|
458
|
-
|-------------|-------------|------------------|
|
|
459
|
-
|**200** | Successful response | - |
|
|
460
|
-
|
|
461
|
-
[[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)
|
|
462
|
-
|
|
463
|
-
# **getEventThreads**
|
|
464
|
-
> GetAccountThreads200Response getEventThreads()
|
|
465
|
-
|
|
466
|
-
Get Event Threads endpoint
|
|
467
|
-
|
|
468
|
-
### Example
|
|
469
|
-
|
|
470
|
-
```typescript
|
|
471
|
-
import {
|
|
472
|
-
EventsApi,
|
|
473
|
-
Configuration
|
|
474
|
-
} from '@connectedxm/admin-sdk';
|
|
475
|
-
|
|
476
|
-
const configuration = new Configuration();
|
|
477
|
-
const apiInstance = new EventsApi(configuration);
|
|
478
|
-
|
|
479
|
-
let eventId: string; //The event identifier (default to undefined)
|
|
480
|
-
let page: number; //Page number (optional) (default to 1)
|
|
481
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
482
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
483
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
484
|
-
|
|
485
|
-
const { status, data } = await apiInstance.getEventThreads(
|
|
486
|
-
eventId,
|
|
487
|
-
page,
|
|
488
|
-
pageSize,
|
|
489
|
-
orderBy,
|
|
490
|
-
search
|
|
491
|
-
);
|
|
492
|
-
```
|
|
493
|
-
|
|
494
|
-
### Parameters
|
|
495
|
-
|
|
496
|
-
|Name | Type | Description | Notes|
|
|
497
|
-
|------------- | ------------- | ------------- | -------------|
|
|
498
|
-
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
499
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
500
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
501
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
502
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
### Return type
|
|
506
|
-
|
|
507
|
-
**GetAccountThreads200Response**
|
|
508
|
-
|
|
509
|
-
### Authorization
|
|
510
|
-
|
|
511
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
512
|
-
|
|
513
|
-
### HTTP request headers
|
|
514
|
-
|
|
515
|
-
- **Content-Type**: Not defined
|
|
516
|
-
- **Accept**: application/json
|
|
517
|
-
|
|
518
|
-
|
|
519
455
|
### HTTP response details
|
|
520
456
|
| Status code | Description | Response headers |
|
|
521
457
|
|-------------|-------------|------------------|
|
package/docs/GroupsApi.md
CHANGED
|
@@ -8,7 +8,6 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
8
8
|
|[**deleteGroup**](#deletegroup) | **DELETE** /groups/{groupId} | Delete Group|
|
|
9
9
|
|[**getGroup**](#getgroup) | **GET** /groups/{groupId} | Get Group|
|
|
10
10
|
|[**getGroupActivities**](#getgroupactivities) | **GET** /groups/{groupId}/activities | Get Group Activities|
|
|
11
|
-
|[**getGroupThreads**](#getgroupthreads) | **GET** /groups/{groupId}/threads | Get Group Threads|
|
|
12
11
|
|[**getGroups**](#getgroups) | **GET** /groups | Get Groups|
|
|
13
12
|
|[**updateGroup**](#updategroup) | **PUT** /groups/{groupId} | Update Group|
|
|
14
13
|
|
|
@@ -228,69 +227,6 @@ const { status, data } = await apiInstance.getGroupActivities(
|
|
|
228
227
|
- **Accept**: application/json
|
|
229
228
|
|
|
230
229
|
|
|
231
|
-
### HTTP response details
|
|
232
|
-
| Status code | Description | Response headers |
|
|
233
|
-
|-------------|-------------|------------------|
|
|
234
|
-
|**200** | Successful response | - |
|
|
235
|
-
|
|
236
|
-
[[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)
|
|
237
|
-
|
|
238
|
-
# **getGroupThreads**
|
|
239
|
-
> GetAccountThreads200Response getGroupThreads()
|
|
240
|
-
|
|
241
|
-
Get Group Threads endpoint
|
|
242
|
-
|
|
243
|
-
### Example
|
|
244
|
-
|
|
245
|
-
```typescript
|
|
246
|
-
import {
|
|
247
|
-
GroupsApi,
|
|
248
|
-
Configuration
|
|
249
|
-
} from '@connectedxm/admin-sdk';
|
|
250
|
-
|
|
251
|
-
const configuration = new Configuration();
|
|
252
|
-
const apiInstance = new GroupsApi(configuration);
|
|
253
|
-
|
|
254
|
-
let groupId: string; //The group identifier (default to undefined)
|
|
255
|
-
let page: number; //Page number (optional) (default to 1)
|
|
256
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
257
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
258
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
259
|
-
|
|
260
|
-
const { status, data } = await apiInstance.getGroupThreads(
|
|
261
|
-
groupId,
|
|
262
|
-
page,
|
|
263
|
-
pageSize,
|
|
264
|
-
orderBy,
|
|
265
|
-
search
|
|
266
|
-
);
|
|
267
|
-
```
|
|
268
|
-
|
|
269
|
-
### Parameters
|
|
270
|
-
|
|
271
|
-
|Name | Type | Description | Notes|
|
|
272
|
-
|------------- | ------------- | ------------- | -------------|
|
|
273
|
-
| **groupId** | [**string**] | The group identifier | defaults to undefined|
|
|
274
|
-
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
275
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
276
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
277
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
### Return type
|
|
281
|
-
|
|
282
|
-
**GetAccountThreads200Response**
|
|
283
|
-
|
|
284
|
-
### Authorization
|
|
285
|
-
|
|
286
|
-
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
287
|
-
|
|
288
|
-
### HTTP request headers
|
|
289
|
-
|
|
290
|
-
- **Content-Type**: Not defined
|
|
291
|
-
- **Accept**: application/json
|
|
292
|
-
|
|
293
|
-
|
|
294
230
|
### HTTP response details
|
|
295
231
|
| Status code | Description | Response headers |
|
|
296
232
|
|-------------|-------------|------------------|
|
package/docs/Thread.md
CHANGED
|
@@ -9,10 +9,11 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**subject** | **string** | | [default to undefined]
|
|
10
10
|
**imageId** | **string** | | [default to undefined]
|
|
11
11
|
**image** | [**BaseImage**](BaseImage.md) | | [default to undefined]
|
|
12
|
-
**type** | [**ThreadType**](ThreadType.md) | | [default to undefined]
|
|
13
12
|
**lastMessageAt** | **string** | | [default to undefined]
|
|
14
13
|
**lastMessage** | **string** | | [default to undefined]
|
|
15
14
|
**createdAt** | **string** | | [default to undefined]
|
|
15
|
+
**accounts** | [**Array<ThreadAccount>**](ThreadAccount.md) | | [default to undefined]
|
|
16
|
+
**_count** | [**ThreadAllOfCount**](ThreadAllOfCount.md) | | [optional] [default to undefined]
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -24,10 +25,11 @@ const instance: Thread = {
|
|
|
24
25
|
subject,
|
|
25
26
|
imageId,
|
|
26
27
|
image,
|
|
27
|
-
type,
|
|
28
28
|
lastMessageAt,
|
|
29
29
|
lastMessage,
|
|
30
30
|
createdAt,
|
|
31
|
+
accounts,
|
|
32
|
+
_count,
|
|
31
33
|
};
|
|
32
34
|
```
|
|
33
35
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ThreadAccount
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -6,10 +6,12 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
|
+
**threadId** | **string** | | [default to undefined]
|
|
9
10
|
**accountId** | **string** | | [default to undefined]
|
|
11
|
+
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
10
12
|
**lastReadAt** | **string** | | [default to undefined]
|
|
13
|
+
**typingAt** | **string** | | [default to undefined]
|
|
11
14
|
**notifications** | **boolean** | | [default to undefined]
|
|
12
|
-
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
13
15
|
**blocked** | **boolean** | | [default to undefined]
|
|
14
16
|
**createdAt** | **string** | | [default to undefined]
|
|
15
17
|
**updatedAt** | **string** | | [default to undefined]
|
|
@@ -17,14 +19,16 @@ Name | Type | Description | Notes
|
|
|
17
19
|
## Example
|
|
18
20
|
|
|
19
21
|
```typescript
|
|
20
|
-
import {
|
|
22
|
+
import { ThreadAccount } from '@connectedxm/admin-sdk';
|
|
21
23
|
|
|
22
|
-
const instance:
|
|
24
|
+
const instance: ThreadAccount = {
|
|
23
25
|
id,
|
|
26
|
+
threadId,
|
|
24
27
|
accountId,
|
|
28
|
+
account,
|
|
25
29
|
lastReadAt,
|
|
30
|
+
typingAt,
|
|
26
31
|
notifications,
|
|
27
|
-
account,
|
|
28
32
|
blocked,
|
|
29
33
|
createdAt,
|
|
30
34
|
updatedAt,
|
|
@@ -1,18 +1,20 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ThreadAccountUpdateInputs
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**notifications** | **boolean** | | [optional] [default to undefined]
|
|
8
9
|
**blocked** | **boolean** | | [optional] [default to undefined]
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
12
13
|
```typescript
|
|
13
|
-
import {
|
|
14
|
+
import { ThreadAccountUpdateInputs } from '@connectedxm/admin-sdk';
|
|
14
15
|
|
|
15
|
-
const instance:
|
|
16
|
+
const instance: ThreadAccountUpdateInputs = {
|
|
17
|
+
notifications,
|
|
16
18
|
blocked,
|
|
17
19
|
};
|
|
18
20
|
```
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ThreadAllOfCount
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**messages** | **number** | | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { ThreadAllOfCount } from '@connectedxm/admin-sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
16
|
-
|
|
15
|
+
const instance: ThreadAllOfCount = {
|
|
16
|
+
messages,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|
|
@@ -5,11 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**accountIds** | **Array<string>** | | [default to undefined]
|
|
8
9
|
**subject** | **string** | | [optional] [default to undefined]
|
|
9
10
|
**imageId** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**groupId** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**circleId** | **string** | | [optional] [default to undefined]
|
|
12
|
-
**eventId** | **string** | | [optional] [default to undefined]
|
|
13
11
|
|
|
14
12
|
## Example
|
|
15
13
|
|
|
@@ -17,11 +15,9 @@ Name | Type | Description | Notes
|
|
|
17
15
|
import { ThreadCreateInputs } from '@connectedxm/admin-sdk';
|
|
18
16
|
|
|
19
17
|
const instance: ThreadCreateInputs = {
|
|
18
|
+
accountIds,
|
|
20
19
|
subject,
|
|
21
20
|
imageId,
|
|
22
|
-
groupId,
|
|
23
|
-
circleId,
|
|
24
|
-
eventId,
|
|
25
21
|
};
|
|
26
22
|
```
|
|
27
23
|
|
package/docs/ThreadMessage.md
CHANGED
|
@@ -8,10 +8,11 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**body** | **string** | | [default to undefined]
|
|
10
10
|
**accountId** | **string** | | [default to undefined]
|
|
11
|
-
**
|
|
11
|
+
**threadAccount** | [**ThreadAccount**](ThreadAccount.md) | | [default to undefined]
|
|
12
12
|
**createdAt** | **string** | | [default to undefined]
|
|
13
13
|
**editedAt** | **string** | | [default to undefined]
|
|
14
14
|
**sentAt** | **string** | | [default to undefined]
|
|
15
|
+
**deletedAt** | **string** | | [optional] [default to undefined]
|
|
15
16
|
**type** | [**ThreadMessageType**](ThreadMessageType.md) | | [default to undefined]
|
|
16
17
|
**reactions** | [**Array<ThreadMessageReaction>**](ThreadMessageReaction.md) | | [default to undefined]
|
|
17
18
|
**entities** | [**Array<ThreadMessageEntity>**](ThreadMessageEntity.md) | | [default to undefined]
|
|
@@ -20,6 +21,7 @@ Name | Type | Description | Notes
|
|
|
20
21
|
**files** | [**Array<BaseFile>**](BaseFile.md) | | [default to undefined]
|
|
21
22
|
**images** | [**Array<BaseImage>**](BaseImage.md) | | [default to undefined]
|
|
22
23
|
**videos** | [**Array<BaseVideo>**](BaseVideo.md) | | [default to undefined]
|
|
24
|
+
**reads** | [**Array<ThreadMessageRead>**](ThreadMessageRead.md) | | [optional] [default to undefined]
|
|
23
25
|
|
|
24
26
|
## Example
|
|
25
27
|
|
|
@@ -30,10 +32,11 @@ const instance: ThreadMessage = {
|
|
|
30
32
|
id,
|
|
31
33
|
body,
|
|
32
34
|
accountId,
|
|
33
|
-
|
|
35
|
+
threadAccount,
|
|
34
36
|
createdAt,
|
|
35
37
|
editedAt,
|
|
36
38
|
sentAt,
|
|
39
|
+
deletedAt,
|
|
37
40
|
type,
|
|
38
41
|
reactions,
|
|
39
42
|
entities,
|
|
@@ -42,6 +45,7 @@ const instance: ThreadMessage = {
|
|
|
42
45
|
files,
|
|
43
46
|
images,
|
|
44
47
|
videos,
|
|
48
|
+
reads,
|
|
45
49
|
};
|
|
46
50
|
```
|
|
47
51
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ThreadMessageRead
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -6,24 +6,22 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
|
+
**threadId** | **string** | | [default to undefined]
|
|
10
|
+
**messageId** | **string** | | [default to undefined]
|
|
9
11
|
**accountId** | **string** | | [default to undefined]
|
|
10
|
-
**
|
|
11
|
-
**notifications** | **boolean** | | [default to undefined]
|
|
12
|
-
**account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
|
|
13
|
-
**blocked** | **boolean** | | [default to undefined]
|
|
12
|
+
**readAt** | **string** | | [default to undefined]
|
|
14
13
|
|
|
15
14
|
## Example
|
|
16
15
|
|
|
17
16
|
```typescript
|
|
18
|
-
import {
|
|
17
|
+
import { ThreadMessageRead } from '@connectedxm/admin-sdk';
|
|
19
18
|
|
|
20
|
-
const instance:
|
|
19
|
+
const instance: ThreadMessageRead = {
|
|
21
20
|
id,
|
|
21
|
+
threadId,
|
|
22
|
+
messageId,
|
|
22
23
|
accountId,
|
|
23
|
-
|
|
24
|
-
notifications,
|
|
25
|
-
account,
|
|
26
|
-
blocked,
|
|
24
|
+
readAt,
|
|
27
25
|
};
|
|
28
26
|
```
|
|
29
27
|
|