@connectedxm/admin-sdk 16.16.2 → 17.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 (45) hide show
  1. package/.openapi-generator/FILES +1 -6
  2. package/AdminApi.ts +0 -3
  3. package/README.md +2 -2
  4. package/api.ts +91 -951
  5. package/base.ts +1 -1
  6. package/common.ts +1 -1
  7. package/configuration.ts +1 -1
  8. package/dist/AdminApi.d.ts +1 -2
  9. package/dist/AdminApi.js +0 -1
  10. package/dist/api.d.ts +25 -482
  11. package/dist/api.js +51 -697
  12. package/dist/base.d.ts +1 -1
  13. package/dist/base.js +1 -1
  14. package/dist/common.d.ts +1 -1
  15. package/dist/common.js +1 -1
  16. package/dist/configuration.d.ts +1 -1
  17. package/dist/configuration.js +1 -1
  18. package/dist/esm/AdminApi.d.ts +1 -2
  19. package/dist/esm/AdminApi.js +1 -2
  20. package/dist/esm/api.d.ts +25 -482
  21. package/dist/esm/api.js +27 -669
  22. package/dist/esm/base.d.ts +1 -1
  23. package/dist/esm/base.js +1 -1
  24. package/dist/esm/common.d.ts +1 -1
  25. package/dist/esm/common.js +1 -1
  26. package/dist/esm/configuration.d.ts +1 -1
  27. package/dist/esm/configuration.js +1 -1
  28. package/docs/MeetingCreatableType.md +10 -0
  29. package/docs/MeetingCreateInputs.md +1 -3
  30. package/docs/MeetingUpdateInputs.md +1 -3
  31. package/docs/MeetingsApi.md +2 -106
  32. package/docs/OrganizationModuleSettings.md +0 -4
  33. package/docs/OrganizationModuleSettingsUpdateInputs.md +0 -4
  34. package/docs/OrganizationModulesSettingsApi.md +1 -1
  35. package/docs/StreamInput.md +0 -4
  36. package/docs/StreamInputCreateInputs.md +0 -2
  37. package/docs/StreamInputUpdateInputs.md +0 -2
  38. package/docs/StreamsApi.md +1 -4
  39. package/package.json +1 -1
  40. package/docs/GetLivestream200Response.md +0 -24
  41. package/docs/GetLivestreamSessions200Response.md +0 -26
  42. package/docs/GetLivestreams200Response.md +0 -26
  43. package/docs/Livestream.md +0 -38
  44. package/docs/LivestreamSession.md +0 -36
  45. package/docs/MeetingsLivestreamsApi.md +0 -340
package/docs/MeetingsLivestreamsApi.md DELETED
@@ -1,340 +0,0 @@
1
- # MeetingsLivestreamsApi
2
-
3
- All URIs are relative to *https://admin-api.connected.dev*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**disableLivestream**](#disablelivestream) | **POST** /meetings/livestreams/{livestreamId}/disable | Disable a livestream|
8
- |[**enableLivestream**](#enablelivestream) | **POST** /meetings/livestreams/{livestreamId}/enable | Enable a livestream|
9
- |[**getLivestream**](#getlivestream) | **GET** /meetings/livestreams/{livestreamId} | Get a livestream|
10
- |[**getLivestreamSessions**](#getlivestreamsessions) | **GET** /meetings/livestreams/{livestreamId}/sessions | List a livestream\'s sessions|
11
- |[**getLivestreams**](#getlivestreams) | **GET** /meetings/livestreams | List livestreams|
12
- |[**resetLivestreamStreamKey**](#resetlivestreamstreamkey) | **POST** /meetings/livestreams/{livestreamId}/reset-stream-key | Reset a livestream\'s stream key|
13
-
14
- # **disableLivestream**
15
- > GetLivestream200Response disableLivestream()
16
-
17
- Disables the livestream identified by livestreamId so it can no longer ingest or broadcast, requiring both read and create permissions on meetings.
18
-
19
- ### Example
20
-
21
- ```typescript
22
- import {
23
- MeetingsLivestreamsApi,
24
- Configuration
25
- } from '@connectedxm/admin-sdk';
26
-
27
- const configuration = new Configuration();
28
- const apiInstance = new MeetingsLivestreamsApi(configuration);
29
-
30
- let livestreamId: string; //The livestream identifier (default to undefined)
31
-
32
- const { status, data } = await apiInstance.disableLivestream(
33
- livestreamId
34
- );
35
- ```
36
-
37
- ### Parameters
38
-
39
- |Name | Type | Description | Notes|
40
- |------------- | ------------- | ------------- | -------------|
41
- | **livestreamId** | [**string**] | The livestream identifier | defaults to undefined|
42
-
43
-
44
- ### Return type
45
-
46
- **GetLivestream200Response**
47
-
48
- ### Authorization
49
-
50
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
51
-
52
- ### HTTP request headers
53
-
54
- - **Content-Type**: Not defined
55
- - **Accept**: application/json
56
-
57
-
58
- ### HTTP response details
59
- | Status code | Description | Response headers |
60
- |-------------|-------------|------------------|
61
- |**200** | Successful response | - |
62
-
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)
64
-
65
- # **enableLivestream**
66
- > GetLivestream200Response enableLivestream()
67
-
68
- Enables the livestream identified by livestreamId so it can begin ingesting and broadcasting, requiring both read and create permissions on meetings.
69
-
70
- ### Example
71
-
72
- ```typescript
73
- import {
74
- MeetingsLivestreamsApi,
75
- Configuration
76
- } from '@connectedxm/admin-sdk';
77
-
78
- const configuration = new Configuration();
79
- const apiInstance = new MeetingsLivestreamsApi(configuration);
80
-
81
- let livestreamId: string; //The livestream identifier (default to undefined)
82
-
83
- const { status, data } = await apiInstance.enableLivestream(
84
- livestreamId
85
- );
86
- ```
87
-
88
- ### Parameters
89
-
90
- |Name | Type | Description | Notes|
91
- |------------- | ------------- | ------------- | -------------|
92
- | **livestreamId** | [**string**] | The livestream identifier | defaults to undefined|
93
-
94
-
95
- ### Return type
96
-
97
- **GetLivestream200Response**
98
-
99
- ### Authorization
100
-
101
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
102
-
103
- ### HTTP request headers
104
-
105
- - **Content-Type**: Not defined
106
- - **Accept**: application/json
107
-
108
-
109
- ### HTTP response details
110
- | Status code | Description | Response headers |
111
- |-------------|-------------|------------------|
112
- |**200** | Successful response | - |
113
-
114
- [[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)
115
-
116
- # **getLivestream**
117
- > GetLivestream200Response getLivestream()
118
-
119
- Returns details for a single livestream by ID, including its Cloudflare RealtimeKit status and stream key; requires \"read\" permission on meetings.
120
-
121
- ### Example
122
-
123
- ```typescript
124
- import {
125
- MeetingsLivestreamsApi,
126
- Configuration
127
- } from '@connectedxm/admin-sdk';
128
-
129
- const configuration = new Configuration();
130
- const apiInstance = new MeetingsLivestreamsApi(configuration);
131
-
132
- let livestreamId: string; //The livestream identifier (default to undefined)
133
-
134
- const { status, data } = await apiInstance.getLivestream(
135
- livestreamId
136
- );
137
- ```
138
-
139
- ### Parameters
140
-
141
- |Name | Type | Description | Notes|
142
- |------------- | ------------- | ------------- | -------------|
143
- | **livestreamId** | [**string**] | The livestream identifier | defaults to undefined|
144
-
145
-
146
- ### Return type
147
-
148
- **GetLivestream200Response**
149
-
150
- ### Authorization
151
-
152
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
153
-
154
- ### HTTP request headers
155
-
156
- - **Content-Type**: Not defined
157
- - **Accept**: application/json
158
-
159
-
160
- ### HTTP response details
161
- | Status code | Description | Response headers |
162
- |-------------|-------------|------------------|
163
- |**200** | Successful response | - |
164
-
165
- [[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)
166
-
167
- # **getLivestreamSessions**
168
- > GetLivestreamSessions200Response getLivestreamSessions()
169
-
170
- Returns a paginated list of sessions that occurred on the given livestream, supporting page and pageSize parameters; requires \"read\" permission on meetings.
171
-
172
- ### Example
173
-
174
- ```typescript
175
- import {
176
- MeetingsLivestreamsApi,
177
- Configuration
178
- } from '@connectedxm/admin-sdk';
179
-
180
- const configuration = new Configuration();
181
- const apiInstance = new MeetingsLivestreamsApi(configuration);
182
-
183
- let livestreamId: string; //The livestream identifier (default to undefined)
184
- let page: number; //Page number (optional) (default to 1)
185
- let pageSize: number; //Number of items per page (optional) (default to 25)
186
- let orderBy: string; //Field to order by (optional) (default to undefined)
187
- let search: string; //Search query (optional) (default to undefined)
188
-
189
- const { status, data } = await apiInstance.getLivestreamSessions(
190
- livestreamId,
191
- page,
192
- pageSize,
193
- orderBy,
194
- search
195
- );
196
- ```
197
-
198
- ### Parameters
199
-
200
- |Name | Type | Description | Notes|
201
- |------------- | ------------- | ------------- | -------------|
202
- | **livestreamId** | [**string**] | The livestream identifier | defaults to undefined|
203
- | **page** | [**number**] | Page number | (optional) defaults to 1|
204
- | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
205
- | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
206
- | **search** | [**string**] | Search query | (optional) defaults to undefined|
207
-
208
-
209
- ### Return type
210
-
211
- **GetLivestreamSessions200Response**
212
-
213
- ### Authorization
214
-
215
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
216
-
217
- ### HTTP request headers
218
-
219
- - **Content-Type**: Not defined
220
- - **Accept**: application/json
221
-
222
-
223
- ### HTTP response details
224
- | Status code | Description | Response headers |
225
- |-------------|-------------|------------------|
226
- |**200** | Successful response | - |
227
-
228
- [[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)
229
-
230
- # **getLivestreams**
231
- > GetLivestreams200Response getLivestreams()
232
-
233
- Returns a paginated list of livestreams for the organization\'s meetings app, supporting page, pageSize, orderBy, and search parameters; requires \"read\" permission on meetings.
234
-
235
- ### Example
236
-
237
- ```typescript
238
- import {
239
- MeetingsLivestreamsApi,
240
- Configuration
241
- } from '@connectedxm/admin-sdk';
242
-
243
- const configuration = new Configuration();
244
- const apiInstance = new MeetingsLivestreamsApi(configuration);
245
-
246
- let page: number; //Page number (optional) (default to 1)
247
- let pageSize: number; //Number of items per page (optional) (default to 25)
248
- let orderBy: string; //Field to order by (optional) (default to undefined)
249
- let search: string; //Search query (optional) (default to undefined)
250
-
251
- const { status, data } = await apiInstance.getLivestreams(
252
- page,
253
- pageSize,
254
- orderBy,
255
- search
256
- );
257
- ```
258
-
259
- ### Parameters
260
-
261
- |Name | Type | Description | Notes|
262
- |------------- | ------------- | ------------- | -------------|
263
- | **page** | [**number**] | Page number | (optional) defaults to 1|
264
- | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
265
- | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
266
- | **search** | [**string**] | Search query | (optional) defaults to undefined|
267
-
268
-
269
- ### Return type
270
-
271
- **GetLivestreams200Response**
272
-
273
- ### Authorization
274
-
275
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
276
-
277
- ### HTTP request headers
278
-
279
- - **Content-Type**: Not defined
280
- - **Accept**: application/json
281
-
282
-
283
- ### HTTP response details
284
- | Status code | Description | Response headers |
285
- |-------------|-------------|------------------|
286
- |**200** | Successful response | - |
287
-
288
- [[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)
289
-
290
- # **resetLivestreamStreamKey**
291
- > GetLivestream200Response resetLivestreamStreamKey()
292
-
293
- Rotates the ingest stream key for the livestream identified by livestreamId, invalidating the previous key, and requires both read and create permissions on meetings.
294
-
295
- ### Example
296
-
297
- ```typescript
298
- import {
299
- MeetingsLivestreamsApi,
300
- Configuration
301
- } from '@connectedxm/admin-sdk';
302
-
303
- const configuration = new Configuration();
304
- const apiInstance = new MeetingsLivestreamsApi(configuration);
305
-
306
- let livestreamId: string; //The livestream identifier (default to undefined)
307
-
308
- const { status, data } = await apiInstance.resetLivestreamStreamKey(
309
- livestreamId
310
- );
311
- ```
312
-
313
- ### Parameters
314
-
315
- |Name | Type | Description | Notes|
316
- |------------- | ------------- | ------------- | -------------|
317
- | **livestreamId** | [**string**] | The livestream identifier | defaults to undefined|
318
-
319
-
320
- ### Return type
321
-
322
- **GetLivestream200Response**
323
-
324
- ### Authorization
325
-
326
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
327
-
328
- ### HTTP request headers
329
-
330
- - **Content-Type**: Not defined
331
- - **Accept**: application/json
332
-
333
-
334
- ### HTTP response details
335
- | Status code | Description | Response headers |
336
- |-------------|-------------|------------------|
337
- |**200** | Successful response | - |
338
-
339
- [[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)
340
-