@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/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
-