@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.
Files changed (47) hide show
  1. package/.openapi-generator/FILES +7 -26
  2. package/AdminApi.ts +3 -9
  3. package/README.md +9 -39
  4. package/api.ts +150 -1782
  5. package/dist/AdminApi.d.ts +2 -4
  6. package/dist/AdminApi.js +1 -3
  7. package/dist/api.d.ts +97 -946
  8. package/dist/api.js +131 -1311
  9. package/dist/esm/AdminApi.d.ts +2 -4
  10. package/dist/esm/AdminApi.js +2 -4
  11. package/dist/esm/api.d.ts +97 -946
  12. package/dist/esm/api.js +102 -1273
  13. package/docs/BaseThread.md +0 -2
  14. package/docs/BaseThreadMessage.md +4 -2
  15. package/docs/EventsApi.md +0 -64
  16. package/docs/{GetThreadCircles200Response.md → GetThreadAccounts200Response.md} +4 -4
  17. package/docs/GroupsApi.md +0 -64
  18. package/docs/Thread.md +4 -2
  19. package/docs/{ThreadMember.md → ThreadAccount.md} +9 -5
  20. package/docs/{ThreadMemberUpdateInputs.md → ThreadAccountUpdateInputs.md} +5 -3
  21. package/docs/{ThreadCircleCreateInputs.md → ThreadAllOfCount.md} +5 -5
  22. package/docs/ThreadCreateInputs.md +2 -6
  23. package/docs/ThreadMessage.md +6 -2
  24. package/docs/{BaseThreadMember.md → ThreadMessageRead.md} +9 -11
  25. package/docs/{ThreadsMembersApi.md → ThreadsAccountsApi.md} +31 -40
  26. package/docs/ThreadsApi.md +0 -3
  27. package/docs/{UpdateThreadMember200Response.md → UpdateThreadAccount200Response.md} +4 -4
  28. package/package.json +1 -1
  29. package/docs/BaseThreadCircle.md +0 -28
  30. package/docs/BaseThreadCircleAccount.md +0 -24
  31. package/docs/CreateThreadCircle200Response.md +0 -24
  32. package/docs/CreateThreadCircleAccount200Response.md +0 -24
  33. package/docs/GetThreadCircleAccounts200Response.md +0 -26
  34. package/docs/GetThreadMembers200Response.md +0 -26
  35. package/docs/ThreadCircle.md +0 -28
  36. package/docs/ThreadCircleAccount.md +0 -24
  37. package/docs/ThreadCircleAccountCreateInputs.md +0 -22
  38. package/docs/ThreadCircleAccountRole.md +0 -12
  39. package/docs/ThreadCircleAccountUpdateInputs.md +0 -20
  40. package/docs/ThreadCircleType.md +0 -10
  41. package/docs/ThreadCircleUpdateInputs.md +0 -20
  42. package/docs/ThreadInvitation.md +0 -42
  43. package/docs/ThreadInvitationStatus.md +0 -10
  44. package/docs/ThreadMemberRole.md +0 -10
  45. package/docs/ThreadType.md +0 -14
  46. package/docs/ThreadsCirclesAccountsApi.md +0 -299
  47. package/docs/ThreadsCirclesApi.md +0 -348
package/docs/BaseThreadCircle.md DELETED
@@ -1,28 +0,0 @@
1
- # BaseThreadCircle
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | | [default to undefined]
9
- **name** | **string** | | [default to undefined]
10
- **createdAt** | **string** | | [default to undefined]
11
- **updatedAt** | **string** | | [default to undefined]
12
- **type** | [**ThreadCircleType**](ThreadCircleType.md) | | [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { BaseThreadCircle } from '@connectedxm/admin-sdk';
18
-
19
- const instance: BaseThreadCircle = {
20
- id,
21
- name,
22
- createdAt,
23
- updatedAt,
24
- type,
25
- };
26
- ```
27
-
28
- [[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/BaseThreadCircleAccount.md DELETED
@@ -1,24 +0,0 @@
1
- # BaseThreadCircleAccount
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **accountId** | **string** | | [default to undefined]
9
- **role** | [**ThreadCircleAccountRole**](ThreadCircleAccountRole.md) | | [default to undefined]
10
- **account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { BaseThreadCircleAccount } from '@connectedxm/admin-sdk';
16
-
17
- const instance: BaseThreadCircleAccount = {
18
- accountId,
19
- role,
20
- account,
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/CreateThreadCircle200Response.md DELETED
@@ -1,24 +0,0 @@
1
- # CreateThreadCircle200Response
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** | [**ThreadCircle**](ThreadCircle.md) | | [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { CreateThreadCircle200Response } from '@connectedxm/admin-sdk';
16
-
17
- const instance: CreateThreadCircle200Response = {
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/CreateThreadCircleAccount200Response.md DELETED
@@ -1,24 +0,0 @@
1
- # CreateThreadCircleAccount200Response
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** | [**ThreadCircleAccount**](ThreadCircleAccount.md) | | [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { CreateThreadCircleAccount200Response } from '@connectedxm/admin-sdk';
16
-
17
- const instance: CreateThreadCircleAccount200Response = {
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/GetThreadCircleAccounts200Response.md DELETED
@@ -1,26 +0,0 @@
1
- # GetThreadCircleAccounts200Response
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<ThreadCircleAccount>**](ThreadCircleAccount.md) | | [default to undefined]
11
- **count** | **number** | | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { GetThreadCircleAccounts200Response } from '@connectedxm/admin-sdk';
17
-
18
- const instance: GetThreadCircleAccounts200Response = {
19
- status,
20
- message,
21
- data,
22
- count,
23
- };
24
- ```
25
-
26
- [[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/GetThreadMembers200Response.md DELETED
@@ -1,26 +0,0 @@
1
- # GetThreadMembers200Response
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<ThreadMember>**](ThreadMember.md) | | [default to undefined]
11
- **count** | **number** | | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { GetThreadMembers200Response } from '@connectedxm/admin-sdk';
17
-
18
- const instance: GetThreadMembers200Response = {
19
- status,
20
- message,
21
- data,
22
- count,
23
- };
24
- ```
25
-
26
- [[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/ThreadCircle.md DELETED
@@ -1,28 +0,0 @@
1
- # ThreadCircle
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | | [default to undefined]
9
- **name** | **string** | | [default to undefined]
10
- **createdAt** | **string** | | [default to undefined]
11
- **updatedAt** | **string** | | [default to undefined]
12
- **type** | [**ThreadCircleType**](ThreadCircleType.md) | | [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { ThreadCircle } from '@connectedxm/admin-sdk';
18
-
19
- const instance: ThreadCircle = {
20
- id,
21
- name,
22
- createdAt,
23
- updatedAt,
24
- type,
25
- };
26
- ```
27
-
28
- [[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/ThreadCircleAccount.md DELETED
@@ -1,24 +0,0 @@
1
- # ThreadCircleAccount
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **accountId** | **string** | | [default to undefined]
9
- **role** | [**ThreadCircleAccountRole**](ThreadCircleAccountRole.md) | | [default to undefined]
10
- **account** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { ThreadCircleAccount } from '@connectedxm/admin-sdk';
16
-
17
- const instance: ThreadCircleAccount = {
18
- accountId,
19
- role,
20
- account,
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/ThreadCircleAccountCreateInputs.md DELETED
@@ -1,22 +0,0 @@
1
- # ThreadCircleAccountCreateInputs
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **accountId** | **string** | | [default to undefined]
9
- **role** | [**ThreadCircleAccountRole**](ThreadCircleAccountRole.md) | | [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { ThreadCircleAccountCreateInputs } from '@connectedxm/admin-sdk';
15
-
16
- const instance: ThreadCircleAccountCreateInputs = {
17
- accountId,
18
- role,
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)
package/docs/ThreadCircleAccountRole.md DELETED
@@ -1,12 +0,0 @@
1
- # ThreadCircleAccountRole
2
-
3
-
4
- ## Enum
5
-
6
- * `Member` (value: `'member'`)
7
-
8
- * `Manager` (value: `'manager'`)
9
-
10
- * `Invited` (value: `'invited'`)
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)
package/docs/ThreadCircleAccountUpdateInputs.md DELETED
@@ -1,20 +0,0 @@
1
- # ThreadCircleAccountUpdateInputs
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **role** | [**ThreadCircleAccountRole**](ThreadCircleAccountRole.md) | | [optional] [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { ThreadCircleAccountUpdateInputs } from '@connectedxm/admin-sdk';
14
-
15
- const instance: ThreadCircleAccountUpdateInputs = {
16
- role,
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)
package/docs/ThreadCircleType.md DELETED
@@ -1,10 +0,0 @@
1
- # ThreadCircleType
2
-
3
-
4
- ## Enum
5
-
6
- * `Private` (value: `'private'`)
7
-
8
- * `Direct` (value: `'direct'`)
9
-
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)
package/docs/ThreadCircleUpdateInputs.md DELETED
@@ -1,20 +0,0 @@
1
- # ThreadCircleUpdateInputs
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **name** | **string** | | [optional] [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { ThreadCircleUpdateInputs } from '@connectedxm/admin-sdk';
14
-
15
- const instance: ThreadCircleUpdateInputs = {
16
- name,
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)
package/docs/ThreadInvitation.md DELETED
@@ -1,42 +0,0 @@
1
- # ThreadInvitation
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | | [default to undefined]
9
- **organizationId** | **string** | | [default to undefined]
10
- **threadId** | **string** | | [default to undefined]
11
- **thread** | [**BaseThread**](BaseThread.md) | | [default to undefined]
12
- **status** | [**ThreadInvitationStatus**](ThreadInvitationStatus.md) | | [default to undefined]
13
- **role** | [**ThreadMemberRole**](ThreadMemberRole.md) | | [default to undefined]
14
- **invitedById** | **string** | | [default to undefined]
15
- **invitedBy** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
16
- **invitedId** | **string** | | [default to undefined]
17
- **invited** | [**BaseAccount**](BaseAccount.md) | | [default to undefined]
18
- **createdAt** | **string** | | [default to undefined]
19
- **updatedAt** | **string** | | [default to undefined]
20
-
21
- ## Example
22
-
23
- ```typescript
24
- import { ThreadInvitation } from '@connectedxm/admin-sdk';
25
-
26
- const instance: ThreadInvitation = {
27
- id,
28
- organizationId,
29
- threadId,
30
- thread,
31
- status,
32
- role,
33
- invitedById,
34
- invitedBy,
35
- invitedId,
36
- invited,
37
- createdAt,
38
- updatedAt,
39
- };
40
- ```
41
-
42
- [[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/ThreadInvitationStatus.md DELETED
@@ -1,10 +0,0 @@
1
- # ThreadInvitationStatus
2
-
3
-
4
- ## Enum
5
-
6
- * `Invited` (value: `'invited'`)
7
-
8
- * `Rejected` (value: `'rejected'`)
9
-
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)
package/docs/ThreadMemberRole.md DELETED
@@ -1,10 +0,0 @@
1
- # ThreadMemberRole
2
-
3
-
4
- ## Enum
5
-
6
- * `Member` (value: `'member'`)
7
-
8
- * `Moderator` (value: `'moderator'`)
9
-
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)
package/docs/ThreadType.md DELETED
@@ -1,14 +0,0 @@
1
- # ThreadType
2
-
3
-
4
- ## Enum
5
-
6
- * `Circle` (value: `'circle'`)
7
-
8
- * `Group` (value: `'group'`)
9
-
10
- * `Event` (value: `'event'`)
11
-
12
- * `Stream` (value: `'stream'`)
13
-
14
- [[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/ThreadsCirclesAccountsApi.md DELETED
@@ -1,299 +0,0 @@
1
- # ThreadsCirclesAccountsApi
2
-
3
- All URIs are relative to *https://admin-api.connected.dev*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**createThreadCircleAccount**](#createthreadcircleaccount) | **POST** /threads/circles/{circleId}/accounts | Create Thread Circle Account|
8
- |[**deleteThreadCircleAccount**](#deletethreadcircleaccount) | **DELETE** /threads/circles/{circleId}/accounts/{accountId} | Delete Thread Circle Account|
9
- |[**getThreadCircleAccount**](#getthreadcircleaccount) | **GET** /threads/circles/{circleId}/accounts/{accountId} | Get Thread Circle Account|
10
- |[**getThreadCircleAccounts**](#getthreadcircleaccounts) | **GET** /threads/circles/{circleId}/accounts | Get Thread Circle Accounts|
11
- |[**updateThreadCircleAccount**](#updatethreadcircleaccount) | **PUT** /threads/circles/{circleId}/accounts/{accountId} | Update Thread Circle Account|
12
-
13
- # **createThreadCircleAccount**
14
- > CreateThreadCircleAccount200Response createThreadCircleAccount(threadCircleAccountCreateInputs)
15
-
16
- Create Thread Circle Account endpoint
17
-
18
- ### Example
19
-
20
- ```typescript
21
- import {
22
- ThreadsCirclesAccountsApi,
23
- Configuration,
24
- ThreadCircleAccountCreateInputs
25
- } from '@connectedxm/admin-sdk';
26
-
27
- const configuration = new Configuration();
28
- const apiInstance = new ThreadsCirclesAccountsApi(configuration);
29
-
30
- let circleId: string; //The circle identifier (default to undefined)
31
- let threadCircleAccountCreateInputs: ThreadCircleAccountCreateInputs; //
32
-
33
- const { status, data } = await apiInstance.createThreadCircleAccount(
34
- circleId,
35
- threadCircleAccountCreateInputs
36
- );
37
- ```
38
-
39
- ### Parameters
40
-
41
- |Name | Type | Description | Notes|
42
- |------------- | ------------- | ------------- | -------------|
43
- | **threadCircleAccountCreateInputs** | **ThreadCircleAccountCreateInputs**| | |
44
- | **circleId** | [**string**] | The circle identifier | defaults to undefined|
45
-
46
-
47
- ### Return type
48
-
49
- **CreateThreadCircleAccount200Response**
50
-
51
- ### Authorization
52
-
53
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
54
-
55
- ### HTTP request headers
56
-
57
- - **Content-Type**: application/json
58
- - **Accept**: application/json
59
-
60
-
61
- ### HTTP response details
62
- | Status code | Description | Response headers |
63
- |-------------|-------------|------------------|
64
- |**200** | Successful response | - |
65
-
66
- [[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)
67
-
68
- # **deleteThreadCircleAccount**
69
- > CreateAccountInvitations200Response deleteThreadCircleAccount()
70
-
71
- Delete Thread Circle Account endpoint
72
-
73
- ### Example
74
-
75
- ```typescript
76
- import {
77
- ThreadsCirclesAccountsApi,
78
- Configuration
79
- } from '@connectedxm/admin-sdk';
80
-
81
- const configuration = new Configuration();
82
- const apiInstance = new ThreadsCirclesAccountsApi(configuration);
83
-
84
- let circleId: string; //The circle identifier (default to undefined)
85
- let accountId: string; //The account identifier (default to undefined)
86
-
87
- const { status, data } = await apiInstance.deleteThreadCircleAccount(
88
- circleId,
89
- accountId
90
- );
91
- ```
92
-
93
- ### Parameters
94
-
95
- |Name | Type | Description | Notes|
96
- |------------- | ------------- | ------------- | -------------|
97
- | **circleId** | [**string**] | The circle identifier | defaults to undefined|
98
- | **accountId** | [**string**] | The account identifier | defaults to undefined|
99
-
100
-
101
- ### Return type
102
-
103
- **CreateAccountInvitations200Response**
104
-
105
- ### Authorization
106
-
107
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
108
-
109
- ### HTTP request headers
110
-
111
- - **Content-Type**: Not defined
112
- - **Accept**: application/json
113
-
114
-
115
- ### HTTP response details
116
- | Status code | Description | Response headers |
117
- |-------------|-------------|------------------|
118
- |**200** | Successful response | - |
119
-
120
- [[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)
121
-
122
- # **getThreadCircleAccount**
123
- > CreateThreadCircleAccount200Response getThreadCircleAccount()
124
-
125
- Get Thread Circle Account endpoint
126
-
127
- ### Example
128
-
129
- ```typescript
130
- import {
131
- ThreadsCirclesAccountsApi,
132
- Configuration
133
- } from '@connectedxm/admin-sdk';
134
-
135
- const configuration = new Configuration();
136
- const apiInstance = new ThreadsCirclesAccountsApi(configuration);
137
-
138
- let circleId: string; //The circle identifier (default to undefined)
139
- let accountId: string; //The account identifier (default to undefined)
140
-
141
- const { status, data } = await apiInstance.getThreadCircleAccount(
142
- circleId,
143
- accountId
144
- );
145
- ```
146
-
147
- ### Parameters
148
-
149
- |Name | Type | Description | Notes|
150
- |------------- | ------------- | ------------- | -------------|
151
- | **circleId** | [**string**] | The circle identifier | defaults to undefined|
152
- | **accountId** | [**string**] | The account identifier | defaults to undefined|
153
-
154
-
155
- ### Return type
156
-
157
- **CreateThreadCircleAccount200Response**
158
-
159
- ### Authorization
160
-
161
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
162
-
163
- ### HTTP request headers
164
-
165
- - **Content-Type**: Not defined
166
- - **Accept**: application/json
167
-
168
-
169
- ### HTTP response details
170
- | Status code | Description | Response headers |
171
- |-------------|-------------|------------------|
172
- |**200** | Successful response | - |
173
-
174
- [[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)
175
-
176
- # **getThreadCircleAccounts**
177
- > GetThreadCircleAccounts200Response getThreadCircleAccounts()
178
-
179
- Get Thread Circle Accounts endpoint
180
-
181
- ### Example
182
-
183
- ```typescript
184
- import {
185
- ThreadsCirclesAccountsApi,
186
- Configuration
187
- } from '@connectedxm/admin-sdk';
188
-
189
- const configuration = new Configuration();
190
- const apiInstance = new ThreadsCirclesAccountsApi(configuration);
191
-
192
- let circleId: string; //The circle identifier (default to undefined)
193
- let role: ThreadCircleAccountRole; //Filter by role (optional) (default to undefined)
194
- let page: number; //Page number (optional) (default to 1)
195
- let pageSize: number; //Number of items per page (optional) (default to 25)
196
- let orderBy: string; //Field to order by (optional) (default to undefined)
197
- let search: string; //Search query (optional) (default to undefined)
198
-
199
- const { status, data } = await apiInstance.getThreadCircleAccounts(
200
- circleId,
201
- role,
202
- page,
203
- pageSize,
204
- orderBy,
205
- search
206
- );
207
- ```
208
-
209
- ### Parameters
210
-
211
- |Name | Type | Description | Notes|
212
- |------------- | ------------- | ------------- | -------------|
213
- | **circleId** | [**string**] | The circle identifier | defaults to undefined|
214
- | **role** | **ThreadCircleAccountRole** | Filter by role | (optional) defaults to undefined|
215
- | **page** | [**number**] | Page number | (optional) defaults to 1|
216
- | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
217
- | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
218
- | **search** | [**string**] | Search query | (optional) defaults to undefined|
219
-
220
-
221
- ### Return type
222
-
223
- **GetThreadCircleAccounts200Response**
224
-
225
- ### Authorization
226
-
227
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
228
-
229
- ### HTTP request headers
230
-
231
- - **Content-Type**: Not defined
232
- - **Accept**: application/json
233
-
234
-
235
- ### HTTP response details
236
- | Status code | Description | Response headers |
237
- |-------------|-------------|------------------|
238
- |**200** | Successful response | - |
239
-
240
- [[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)
241
-
242
- # **updateThreadCircleAccount**
243
- > CreateThreadCircleAccount200Response updateThreadCircleAccount(threadCircleAccountUpdateInputs)
244
-
245
- Update Thread Circle Account endpoint
246
-
247
- ### Example
248
-
249
- ```typescript
250
- import {
251
- ThreadsCirclesAccountsApi,
252
- Configuration,
253
- ThreadCircleAccountUpdateInputs
254
- } from '@connectedxm/admin-sdk';
255
-
256
- const configuration = new Configuration();
257
- const apiInstance = new ThreadsCirclesAccountsApi(configuration);
258
-
259
- let circleId: string; //The circle identifier (default to undefined)
260
- let accountId: string; //The account identifier (default to undefined)
261
- let threadCircleAccountUpdateInputs: ThreadCircleAccountUpdateInputs; //
262
-
263
- const { status, data } = await apiInstance.updateThreadCircleAccount(
264
- circleId,
265
- accountId,
266
- threadCircleAccountUpdateInputs
267
- );
268
- ```
269
-
270
- ### Parameters
271
-
272
- |Name | Type | Description | Notes|
273
- |------------- | ------------- | ------------- | -------------|
274
- | **threadCircleAccountUpdateInputs** | **ThreadCircleAccountUpdateInputs**| | |
275
- | **circleId** | [**string**] | The circle identifier | defaults to undefined|
276
- | **accountId** | [**string**] | The account identifier | defaults to undefined|
277
-
278
-
279
- ### Return type
280
-
281
- **CreateThreadCircleAccount200Response**
282
-
283
- ### Authorization
284
-
285
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
286
-
287
- ### HTTP request headers
288
-
289
- - **Content-Type**: application/json
290
- - **Accept**: application/json
291
-
292
-
293
- ### HTTP response details
294
- | Status code | Description | Response headers |
295
- |-------------|-------------|------------------|
296
- |**200** | Successful response | - |
297
-
298
- [[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)
299
-