@connectedxm/admin-sdk 6.33.1 → 7.0.1
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 +9 -39
- package/api.ts +150 -1782
- package/dist/AdminApi.d.ts +2 -4
- package/dist/AdminApi.js +1 -3
- package/dist/api.d.ts +97 -946
- package/dist/api.js +131 -1311
- package/dist/esm/AdminApi.d.ts +2 -4
- package/dist/esm/AdminApi.js +2 -4
- package/dist/esm/api.d.ts +97 -946
- package/dist/esm/api.js +102 -1273
- package/docs/BaseThread.md +0 -2
- package/docs/BaseThreadMessage.md +4 -2
- package/docs/EventsApi.md +0 -64
- package/docs/{GetThreadCircles200Response.md → GetThreadAccounts200Response.md} +4 -4
- 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/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/ThreadCircleType.md +0 -10
- 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
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/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
|
|-------------|-------------|------------------|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# GetThreadAccounts200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,15 +7,15 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**status** | **string** | | [default to undefined]
|
|
9
9
|
**message** | **string** | | [default to undefined]
|
|
10
|
-
**data** | [**Array<
|
|
10
|
+
**data** | [**Array<ThreadAccount>**](ThreadAccount.md) | | [default to undefined]
|
|
11
11
|
**count** | **number** | | [optional] [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { GetThreadAccounts200Response } from '@connectedxm/admin-sdk';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
18
|
+
const instance: GetThreadAccounts200Response = {
|
|
19
19
|
status,
|
|
20
20
|
message,
|
|
21
21
|
data,
|
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
|
|
|
@@ -1,41 +1,35 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ThreadsAccountsApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://admin-api.connected.dev*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteThreadAccount**](#deletethreadaccount) | **DELETE** /threads/{threadId}/accounts/{accountId} | Delete Thread Account|
|
|
7
8
|
|[**getThreadAccounts**](#getthreadaccounts) | **GET** /threads/{threadId}/accounts | Get Thread Accounts|
|
|
8
|
-
|[**
|
|
9
|
-
|[**updateThreadMember**](#updatethreadmember) | **PUT** /threads/{threadId}/members/{accountId} | Update Thread Member|
|
|
9
|
+
|[**updateThreadAccount**](#updatethreadaccount) | **PUT** /threads/{threadId}/accounts/{accountId} | Update Thread Account|
|
|
10
10
|
|
|
11
|
-
# **
|
|
12
|
-
>
|
|
11
|
+
# **deleteThreadAccount**
|
|
12
|
+
> CreateAccountInvitations200Response deleteThreadAccount()
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Delete Thread Account endpoint
|
|
15
15
|
|
|
16
16
|
### Example
|
|
17
17
|
|
|
18
18
|
```typescript
|
|
19
19
|
import {
|
|
20
|
-
|
|
20
|
+
ThreadsAccountsApi,
|
|
21
21
|
Configuration
|
|
22
22
|
} from '@connectedxm/admin-sdk';
|
|
23
23
|
|
|
24
24
|
const configuration = new Configuration();
|
|
25
|
-
const apiInstance = new
|
|
25
|
+
const apiInstance = new ThreadsAccountsApi(configuration);
|
|
26
26
|
|
|
27
27
|
let threadId: string; //The thread identifier (default to undefined)
|
|
28
|
-
let
|
|
29
|
-
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
30
|
-
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
31
|
-
let search: string; //Search query (optional) (default to undefined)
|
|
28
|
+
let accountId: string; //The account identifier (default to undefined)
|
|
32
29
|
|
|
33
|
-
const { status, data } = await apiInstance.
|
|
30
|
+
const { status, data } = await apiInstance.deleteThreadAccount(
|
|
34
31
|
threadId,
|
|
35
|
-
|
|
36
|
-
pageSize,
|
|
37
|
-
orderBy,
|
|
38
|
-
search
|
|
32
|
+
accountId
|
|
39
33
|
);
|
|
40
34
|
```
|
|
41
35
|
|
|
@@ -44,15 +38,12 @@ const { status, data } = await apiInstance.getThreadAccounts(
|
|
|
44
38
|
|Name | Type | Description | Notes|
|
|
45
39
|
|------------- | ------------- | ------------- | -------------|
|
|
46
40
|
| **threadId** | [**string**] | The thread identifier | defaults to undefined|
|
|
47
|
-
| **
|
|
48
|
-
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
49
|
-
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
50
|
-
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
41
|
+
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
51
42
|
|
|
52
43
|
|
|
53
44
|
### Return type
|
|
54
45
|
|
|
55
|
-
**
|
|
46
|
+
**CreateAccountInvitations200Response**
|
|
56
47
|
|
|
57
48
|
### Authorization
|
|
58
49
|
|
|
@@ -71,21 +62,21 @@ const { status, data } = await apiInstance.getThreadAccounts(
|
|
|
71
62
|
|
|
72
63
|
[[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)
|
|
73
64
|
|
|
74
|
-
# **
|
|
75
|
-
>
|
|
65
|
+
# **getThreadAccounts**
|
|
66
|
+
> GetThreadAccounts200Response getThreadAccounts()
|
|
76
67
|
|
|
77
|
-
Get Thread
|
|
68
|
+
Get Thread Accounts endpoint
|
|
78
69
|
|
|
79
70
|
### Example
|
|
80
71
|
|
|
81
72
|
```typescript
|
|
82
73
|
import {
|
|
83
|
-
|
|
74
|
+
ThreadsAccountsApi,
|
|
84
75
|
Configuration
|
|
85
76
|
} from '@connectedxm/admin-sdk';
|
|
86
77
|
|
|
87
78
|
const configuration = new Configuration();
|
|
88
|
-
const apiInstance = new
|
|
79
|
+
const apiInstance = new ThreadsAccountsApi(configuration);
|
|
89
80
|
|
|
90
81
|
let threadId: string; //The thread identifier (default to undefined)
|
|
91
82
|
let page: number; //Page number (optional) (default to 1)
|
|
@@ -93,7 +84,7 @@ let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
|
93
84
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
94
85
|
let search: string; //Search query (optional) (default to undefined)
|
|
95
86
|
|
|
96
|
-
const { status, data } = await apiInstance.
|
|
87
|
+
const { status, data } = await apiInstance.getThreadAccounts(
|
|
97
88
|
threadId,
|
|
98
89
|
page,
|
|
99
90
|
pageSize,
|
|
@@ -115,7 +106,7 @@ const { status, data } = await apiInstance.getThreadMembers(
|
|
|
115
106
|
|
|
116
107
|
### Return type
|
|
117
108
|
|
|
118
|
-
**
|
|
109
|
+
**GetThreadAccounts200Response**
|
|
119
110
|
|
|
120
111
|
### Authorization
|
|
121
112
|
|
|
@@ -134,31 +125,31 @@ const { status, data } = await apiInstance.getThreadMembers(
|
|
|
134
125
|
|
|
135
126
|
[[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)
|
|
136
127
|
|
|
137
|
-
# **
|
|
138
|
-
>
|
|
128
|
+
# **updateThreadAccount**
|
|
129
|
+
> UpdateThreadAccount200Response updateThreadAccount(threadAccountUpdateInputs)
|
|
139
130
|
|
|
140
|
-
Update Thread
|
|
131
|
+
Update Thread Account endpoint
|
|
141
132
|
|
|
142
133
|
### Example
|
|
143
134
|
|
|
144
135
|
```typescript
|
|
145
136
|
import {
|
|
146
|
-
|
|
137
|
+
ThreadsAccountsApi,
|
|
147
138
|
Configuration,
|
|
148
|
-
|
|
139
|
+
ThreadAccountUpdateInputs
|
|
149
140
|
} from '@connectedxm/admin-sdk';
|
|
150
141
|
|
|
151
142
|
const configuration = new Configuration();
|
|
152
|
-
const apiInstance = new
|
|
143
|
+
const apiInstance = new ThreadsAccountsApi(configuration);
|
|
153
144
|
|
|
154
145
|
let threadId: string; //The thread identifier (default to undefined)
|
|
155
146
|
let accountId: string; //The account identifier (default to undefined)
|
|
156
|
-
let
|
|
147
|
+
let threadAccountUpdateInputs: ThreadAccountUpdateInputs; //
|
|
157
148
|
|
|
158
|
-
const { status, data } = await apiInstance.
|
|
149
|
+
const { status, data } = await apiInstance.updateThreadAccount(
|
|
159
150
|
threadId,
|
|
160
151
|
accountId,
|
|
161
|
-
|
|
152
|
+
threadAccountUpdateInputs
|
|
162
153
|
);
|
|
163
154
|
```
|
|
164
155
|
|
|
@@ -166,14 +157,14 @@ const { status, data } = await apiInstance.updateThreadMember(
|
|
|
166
157
|
|
|
167
158
|
|Name | Type | Description | Notes|
|
|
168
159
|
|------------- | ------------- | ------------- | -------------|
|
|
169
|
-
| **
|
|
160
|
+
| **threadAccountUpdateInputs** | **ThreadAccountUpdateInputs**| | |
|
|
170
161
|
| **threadId** | [**string**] | The thread identifier | defaults to undefined|
|
|
171
162
|
| **accountId** | [**string**] | The account identifier | defaults to undefined|
|
|
172
163
|
|
|
173
164
|
|
|
174
165
|
### Return type
|
|
175
166
|
|
|
176
|
-
**
|
|
167
|
+
**UpdateThreadAccount200Response**
|
|
177
168
|
|
|
178
169
|
### Authorization
|
|
179
170
|
|
package/docs/ThreadsApi.md
CHANGED
|
@@ -180,14 +180,12 @@ import {
|
|
|
180
180
|
const configuration = new Configuration();
|
|
181
181
|
const apiInstance = new ThreadsApi(configuration);
|
|
182
182
|
|
|
183
|
-
let type: ThreadType; //Filter by type (optional) (default to undefined)
|
|
184
183
|
let page: number; //Page number (optional) (default to 1)
|
|
185
184
|
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
186
185
|
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
187
186
|
let search: string; //Search query (optional) (default to undefined)
|
|
188
187
|
|
|
189
188
|
const { status, data } = await apiInstance.getThreads(
|
|
190
|
-
type,
|
|
191
189
|
page,
|
|
192
190
|
pageSize,
|
|
193
191
|
orderBy,
|
|
@@ -199,7 +197,6 @@ const { status, data } = await apiInstance.getThreads(
|
|
|
199
197
|
|
|
200
198
|
|Name | Type | Description | Notes|
|
|
201
199
|
|------------- | ------------- | ------------- | -------------|
|
|
202
|
-
| **type** | **ThreadType** | Filter by type | (optional) defaults to undefined|
|
|
203
200
|
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
204
201
|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
205
202
|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# UpdateThreadAccount200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -7,14 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**status** | **string** | | [default to undefined]
|
|
9
9
|
**message** | **string** | | [default to undefined]
|
|
10
|
-
**data** | [**
|
|
10
|
+
**data** | [**ThreadAccount**](ThreadAccount.md) | | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { UpdateThreadAccount200Response } from '@connectedxm/admin-sdk';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: UpdateThreadAccount200Response = {
|
|
18
18
|
status,
|
|
19
19
|
message,
|
|
20
20
|
data,
|