@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.
Files changed (52) hide show
  1. package/.openapi-generator/FILES +7 -26
  2. package/AdminApi.ts +3 -9
  3. package/README.md +10 -39
  4. package/api.ts +239 -1777
  5. package/dist/AdminApi.d.ts +2 -4
  6. package/dist/AdminApi.js +1 -3
  7. package/dist/api.d.ts +148 -951
  8. package/dist/api.js +204 -1308
  9. package/dist/esm/AdminApi.d.ts +2 -4
  10. package/dist/esm/AdminApi.js +2 -4
  11. package/dist/esm/api.d.ts +148 -951
  12. package/dist/esm/api.js +175 -1270
  13. package/docs/BaseEventActivation.md +2 -0
  14. package/docs/BaseThread.md +0 -2
  15. package/docs/BaseThreadMessage.md +4 -2
  16. package/docs/EventActivation.md +2 -0
  17. package/docs/EventActivationCreateInputs.md +2 -0
  18. package/docs/{ThreadCircleType.md → EventActivationRewardType.md} +3 -3
  19. package/docs/EventActivationUpdateInputs.md +2 -0
  20. package/docs/EventsActivationsSessionsApi.md +55 -0
  21. package/docs/EventsApi.md +0 -64
  22. package/docs/GroupsApi.md +0 -64
  23. package/docs/Thread.md +4 -2
  24. package/docs/{ThreadMember.md → ThreadAccount.md} +9 -5
  25. package/docs/{ThreadMemberUpdateInputs.md → ThreadAccountUpdateInputs.md} +5 -3
  26. package/docs/{ThreadCircleCreateInputs.md → ThreadAllOfCount.md} +5 -5
  27. package/docs/ThreadCreateInputs.md +2 -6
  28. package/docs/ThreadMessage.md +6 -2
  29. package/docs/{BaseThreadMember.md → ThreadMessageRead.md} +9 -11
  30. package/docs/{ThreadsMembersApi.md → ThreadsAccountsApi.md} +31 -40
  31. package/docs/ThreadsApi.md +0 -3
  32. package/docs/{UpdateThreadMember200Response.md → UpdateThreadAccount200Response.md} +4 -4
  33. package/package.json +1 -1
  34. package/docs/BaseThreadCircle.md +0 -28
  35. package/docs/BaseThreadCircleAccount.md +0 -24
  36. package/docs/CreateThreadCircle200Response.md +0 -24
  37. package/docs/CreateThreadCircleAccount200Response.md +0 -24
  38. package/docs/GetThreadCircleAccounts200Response.md +0 -26
  39. package/docs/GetThreadCircles200Response.md +0 -26
  40. package/docs/GetThreadMembers200Response.md +0 -26
  41. package/docs/ThreadCircle.md +0 -28
  42. package/docs/ThreadCircleAccount.md +0 -24
  43. package/docs/ThreadCircleAccountCreateInputs.md +0 -22
  44. package/docs/ThreadCircleAccountRole.md +0 -12
  45. package/docs/ThreadCircleAccountUpdateInputs.md +0 -20
  46. package/docs/ThreadCircleUpdateInputs.md +0 -20
  47. package/docs/ThreadInvitation.md +0 -42
  48. package/docs/ThreadInvitationStatus.md +0 -10
  49. package/docs/ThreadMemberRole.md +0 -10
  50. package/docs/ThreadType.md +0 -14
  51. package/docs/ThreadsCirclesAccountsApi.md +0 -299
  52. package/docs/ThreadsCirclesApi.md +0 -348
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
-
package/docs/ThreadsCirclesApi.md DELETED
@@ -1,348 +0,0 @@
1
- # ThreadsCirclesApi
2
-
3
- All URIs are relative to *https://admin-api.connected.dev*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**createThreadCircle**](#createthreadcircle) | **POST** /threads/circles | Create Thread Circle|
8
- |[**deleteThreadCircle**](#deletethreadcircle) | **DELETE** /threads/circles/{circleId} | Delete Thread Circle|
9
- |[**getThreadCircle**](#getthreadcircle) | **GET** /threads/circles/{circleId} | Get Thread Circle|
10
- |[**getThreadCircleThreads**](#getthreadcirclethreads) | **GET** /threads/circles/{circleId}/threads | Get Thread Circle Threads|
11
- |[**getThreadCircles**](#getthreadcircles) | **GET** /threads/circles | Get Thread Circles|
12
- |[**updateThreadCircle**](#updatethreadcircle) | **PUT** /threads/circles/{circleId} | Update Thread Circle|
13
-
14
- # **createThreadCircle**
15
- > CreateThreadCircle200Response createThreadCircle(threadCircleCreateInputs)
16
-
17
- Create Thread Circle endpoint
18
-
19
- ### Example
20
-
21
- ```typescript
22
- import {
23
- ThreadsCirclesApi,
24
- Configuration,
25
- ThreadCircleCreateInputs
26
- } from '@connectedxm/admin-sdk';
27
-
28
- const configuration = new Configuration();
29
- const apiInstance = new ThreadsCirclesApi(configuration);
30
-
31
- let threadCircleCreateInputs: ThreadCircleCreateInputs; //
32
-
33
- const { status, data } = await apiInstance.createThreadCircle(
34
- threadCircleCreateInputs
35
- );
36
- ```
37
-
38
- ### Parameters
39
-
40
- |Name | Type | Description | Notes|
41
- |------------- | ------------- | ------------- | -------------|
42
- | **threadCircleCreateInputs** | **ThreadCircleCreateInputs**| | |
43
-
44
-
45
- ### Return type
46
-
47
- **CreateThreadCircle200Response**
48
-
49
- ### Authorization
50
-
51
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
52
-
53
- ### HTTP request headers
54
-
55
- - **Content-Type**: application/json
56
- - **Accept**: application/json
57
-
58
-
59
- ### HTTP response details
60
- | Status code | Description | Response headers |
61
- |-------------|-------------|------------------|
62
- |**200** | Successful response | - |
63
-
64
- [[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)
65
-
66
- # **deleteThreadCircle**
67
- > CreateAccountInvitations200Response deleteThreadCircle()
68
-
69
- Delete Thread Circle endpoint
70
-
71
- ### Example
72
-
73
- ```typescript
74
- import {
75
- ThreadsCirclesApi,
76
- Configuration
77
- } from '@connectedxm/admin-sdk';
78
-
79
- const configuration = new Configuration();
80
- const apiInstance = new ThreadsCirclesApi(configuration);
81
-
82
- let circleId: string; //The circle identifier (default to undefined)
83
-
84
- const { status, data } = await apiInstance.deleteThreadCircle(
85
- circleId
86
- );
87
- ```
88
-
89
- ### Parameters
90
-
91
- |Name | Type | Description | Notes|
92
- |------------- | ------------- | ------------- | -------------|
93
- | **circleId** | [**string**] | The circle identifier | defaults to undefined|
94
-
95
-
96
- ### Return type
97
-
98
- **CreateAccountInvitations200Response**
99
-
100
- ### Authorization
101
-
102
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
103
-
104
- ### HTTP request headers
105
-
106
- - **Content-Type**: Not defined
107
- - **Accept**: application/json
108
-
109
-
110
- ### HTTP response details
111
- | Status code | Description | Response headers |
112
- |-------------|-------------|------------------|
113
- |**200** | Successful response | - |
114
-
115
- [[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)
116
-
117
- # **getThreadCircle**
118
- > CreateThreadCircle200Response getThreadCircle()
119
-
120
- Get Thread Circle endpoint
121
-
122
- ### Example
123
-
124
- ```typescript
125
- import {
126
- ThreadsCirclesApi,
127
- Configuration
128
- } from '@connectedxm/admin-sdk';
129
-
130
- const configuration = new Configuration();
131
- const apiInstance = new ThreadsCirclesApi(configuration);
132
-
133
- let circleId: string; //The circle identifier (default to undefined)
134
-
135
- const { status, data } = await apiInstance.getThreadCircle(
136
- circleId
137
- );
138
- ```
139
-
140
- ### Parameters
141
-
142
- |Name | Type | Description | Notes|
143
- |------------- | ------------- | ------------- | -------------|
144
- | **circleId** | [**string**] | The circle identifier | defaults to undefined|
145
-
146
-
147
- ### Return type
148
-
149
- **CreateThreadCircle200Response**
150
-
151
- ### Authorization
152
-
153
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
154
-
155
- ### HTTP request headers
156
-
157
- - **Content-Type**: Not defined
158
- - **Accept**: application/json
159
-
160
-
161
- ### HTTP response details
162
- | Status code | Description | Response headers |
163
- |-------------|-------------|------------------|
164
- |**200** | Successful response | - |
165
-
166
- [[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)
167
-
168
- # **getThreadCircleThreads**
169
- > GetAccountThreads200Response getThreadCircleThreads()
170
-
171
- Get Thread Circle Threads endpoint
172
-
173
- ### Example
174
-
175
- ```typescript
176
- import {
177
- ThreadsCirclesApi,
178
- Configuration
179
- } from '@connectedxm/admin-sdk';
180
-
181
- const configuration = new Configuration();
182
- const apiInstance = new ThreadsCirclesApi(configuration);
183
-
184
- let circleId: string; //The circle identifier (default to undefined)
185
- let page: number; //Page number (optional) (default to 1)
186
- let pageSize: number; //Number of items per page (optional) (default to 25)
187
- let orderBy: string; //Field to order by (optional) (default to undefined)
188
- let search: string; //Search query (optional) (default to undefined)
189
-
190
- const { status, data } = await apiInstance.getThreadCircleThreads(
191
- circleId,
192
- page,
193
- pageSize,
194
- orderBy,
195
- search
196
- );
197
- ```
198
-
199
- ### Parameters
200
-
201
- |Name | Type | Description | Notes|
202
- |------------- | ------------- | ------------- | -------------|
203
- | **circleId** | [**string**] | The circle identifier | defaults to undefined|
204
- | **page** | [**number**] | Page number | (optional) defaults to 1|
205
- | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
206
- | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
207
- | **search** | [**string**] | Search query | (optional) defaults to undefined|
208
-
209
-
210
- ### Return type
211
-
212
- **GetAccountThreads200Response**
213
-
214
- ### Authorization
215
-
216
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
217
-
218
- ### HTTP request headers
219
-
220
- - **Content-Type**: Not defined
221
- - **Accept**: application/json
222
-
223
-
224
- ### HTTP response details
225
- | Status code | Description | Response headers |
226
- |-------------|-------------|------------------|
227
- |**200** | Successful response | - |
228
-
229
- [[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)
230
-
231
- # **getThreadCircles**
232
- > GetThreadCircles200Response getThreadCircles()
233
-
234
- Get Thread Circles endpoint
235
-
236
- ### Example
237
-
238
- ```typescript
239
- import {
240
- ThreadsCirclesApi,
241
- Configuration
242
- } from '@connectedxm/admin-sdk';
243
-
244
- const configuration = new Configuration();
245
- const apiInstance = new ThreadsCirclesApi(configuration);
246
-
247
- let type: ThreadCircleType; //Filter by type (default to undefined)
248
- let page: number; //Page number (optional) (default to 1)
249
- let pageSize: number; //Number of items per page (optional) (default to 25)
250
- let orderBy: string; //Field to order by (optional) (default to undefined)
251
- let search: string; //Search query (optional) (default to undefined)
252
-
253
- const { status, data } = await apiInstance.getThreadCircles(
254
- type,
255
- page,
256
- pageSize,
257
- orderBy,
258
- search
259
- );
260
- ```
261
-
262
- ### Parameters
263
-
264
- |Name | Type | Description | Notes|
265
- |------------- | ------------- | ------------- | -------------|
266
- | **type** | **ThreadCircleType** | Filter by type | defaults to undefined|
267
- | **page** | [**number**] | Page number | (optional) defaults to 1|
268
- | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
269
- | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
270
- | **search** | [**string**] | Search query | (optional) defaults to undefined|
271
-
272
-
273
- ### Return type
274
-
275
- **GetThreadCircles200Response**
276
-
277
- ### Authorization
278
-
279
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
280
-
281
- ### HTTP request headers
282
-
283
- - **Content-Type**: Not defined
284
- - **Accept**: application/json
285
-
286
-
287
- ### HTTP response details
288
- | Status code | Description | Response headers |
289
- |-------------|-------------|------------------|
290
- |**200** | Successful response | - |
291
-
292
- [[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)
293
-
294
- # **updateThreadCircle**
295
- > CreateThreadCircle200Response updateThreadCircle(threadCircleUpdateInputs)
296
-
297
- Update Thread Circle endpoint
298
-
299
- ### Example
300
-
301
- ```typescript
302
- import {
303
- ThreadsCirclesApi,
304
- Configuration,
305
- ThreadCircleUpdateInputs
306
- } from '@connectedxm/admin-sdk';
307
-
308
- const configuration = new Configuration();
309
- const apiInstance = new ThreadsCirclesApi(configuration);
310
-
311
- let circleId: string; //The circle identifier (default to undefined)
312
- let threadCircleUpdateInputs: ThreadCircleUpdateInputs; //
313
-
314
- const { status, data } = await apiInstance.updateThreadCircle(
315
- circleId,
316
- threadCircleUpdateInputs
317
- );
318
- ```
319
-
320
- ### Parameters
321
-
322
- |Name | Type | Description | Notes|
323
- |------------- | ------------- | ------------- | -------------|
324
- | **threadCircleUpdateInputs** | **ThreadCircleUpdateInputs**| | |
325
- | **circleId** | [**string**] | The circle identifier | defaults to undefined|
326
-
327
-
328
- ### Return type
329
-
330
- **CreateThreadCircle200Response**
331
-
332
- ### Authorization
333
-
334
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
335
-
336
- ### HTTP request headers
337
-
338
- - **Content-Type**: application/json
339
- - **Accept**: application/json
340
-
341
-
342
- ### HTTP response details
343
- | Status code | Description | Response headers |
344
- |-------------|-------------|------------------|
345
- |**200** | Successful response | - |
346
-
347
- [[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)
348
-