bmlt-server-client 1.3.3 → 1.3.5

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 (176) hide show
  1. package/.github/workflows/release.yml +4 -4
  2. package/.openapi-generator/FILES +38 -0
  3. package/.openapi-generator/VERSION +1 -1
  4. package/Makefile +1 -0
  5. package/README.md +167 -28
  6. package/dist/apis/RootServerApi.js +892 -1534
  7. package/dist/esm/apis/RootServerApi.d.ts +425 -0
  8. package/dist/esm/apis/RootServerApi.js +1185 -0
  9. package/dist/esm/apis/index.d.ts +1 -0
  10. package/dist/esm/apis/index.js +3 -0
  11. package/dist/esm/index.d.ts +3 -0
  12. package/dist/esm/index.js +5 -0
  13. package/dist/esm/models/AuthenticationError.d.ts +32 -0
  14. package/dist/esm/models/AuthenticationError.js +43 -0
  15. package/dist/esm/models/AuthorizationError.d.ts +32 -0
  16. package/dist/esm/models/AuthorizationError.js +43 -0
  17. package/dist/esm/models/ConflictError.d.ts +32 -0
  18. package/dist/esm/models/ConflictError.js +43 -0
  19. package/dist/esm/models/ErrorTest.d.ts +44 -0
  20. package/dist/esm/models/ErrorTest.js +45 -0
  21. package/dist/esm/models/Format.d.ts +51 -0
  22. package/dist/esm/models/Format.js +56 -0
  23. package/dist/esm/models/FormatBase.d.ts +45 -0
  24. package/dist/esm/models/FormatBase.js +46 -0
  25. package/dist/esm/models/FormatCreate.d.ts +45 -0
  26. package/dist/esm/models/FormatCreate.js +48 -0
  27. package/dist/esm/models/FormatPartialUpdate.d.ts +45 -0
  28. package/dist/esm/models/FormatPartialUpdate.js +46 -0
  29. package/dist/esm/models/FormatTranslation.d.ts +50 -0
  30. package/dist/esm/models/FormatTranslation.js +55 -0
  31. package/dist/esm/models/FormatUpdate.d.ts +45 -0
  32. package/dist/esm/models/FormatUpdate.js +48 -0
  33. package/dist/esm/models/Meeting.d.ts +256 -0
  34. package/dist/esm/models/Meeting.js +145 -0
  35. package/dist/esm/models/MeetingBase.d.ts +250 -0
  36. package/dist/esm/models/MeetingBase.js +113 -0
  37. package/dist/esm/models/MeetingChangeResource.d.ts +50 -0
  38. package/dist/esm/models/MeetingChangeResource.js +47 -0
  39. package/dist/esm/models/MeetingCreate.d.ts +250 -0
  40. package/dist/esm/models/MeetingCreate.js +133 -0
  41. package/dist/esm/models/MeetingPartialUpdate.d.ts +250 -0
  42. package/dist/esm/models/MeetingPartialUpdate.js +113 -0
  43. package/dist/esm/models/MeetingUpdate.d.ts +250 -0
  44. package/dist/esm/models/MeetingUpdate.js +133 -0
  45. package/dist/esm/models/NotFoundError.d.ts +32 -0
  46. package/dist/esm/models/NotFoundError.js +43 -0
  47. package/dist/esm/models/RootServer.d.ts +69 -0
  48. package/dist/esm/models/RootServer.js +64 -0
  49. package/dist/esm/models/RootServerBase.d.ts +63 -0
  50. package/dist/esm/models/RootServerBase.js +52 -0
  51. package/dist/esm/models/RootServerBaseStatistics.d.ts +40 -0
  52. package/dist/esm/models/RootServerBaseStatistics.js +49 -0
  53. package/dist/esm/models/RootServerBaseStatisticsMeetings.d.ts +56 -0
  54. package/dist/esm/models/RootServerBaseStatisticsMeetings.js +59 -0
  55. package/dist/esm/models/RootServerBaseStatisticsServiceBodies.d.ts +50 -0
  56. package/dist/esm/models/RootServerBaseStatisticsServiceBodies.js +55 -0
  57. package/dist/esm/models/ServerError.d.ts +32 -0
  58. package/dist/esm/models/ServerError.js +43 -0
  59. package/dist/esm/models/ServiceBody.d.ts +92 -0
  60. package/dist/esm/models/ServiceBody.js +83 -0
  61. package/dist/esm/models/ServiceBodyBase.d.ts +86 -0
  62. package/dist/esm/models/ServiceBodyBase.js +59 -0
  63. package/dist/esm/models/ServiceBodyCreate.d.ts +86 -0
  64. package/dist/esm/models/ServiceBodyCreate.js +71 -0
  65. package/dist/esm/models/ServiceBodyPartialUpdate.d.ts +86 -0
  66. package/dist/esm/models/ServiceBodyPartialUpdate.js +59 -0
  67. package/dist/esm/models/ServiceBodyUpdate.d.ts +86 -0
  68. package/dist/esm/models/ServiceBodyUpdate.js +71 -0
  69. package/dist/esm/models/Token.d.ts +50 -0
  70. package/dist/esm/models/Token.js +55 -0
  71. package/dist/esm/models/TokenCredentials.d.ts +38 -0
  72. package/dist/esm/models/TokenCredentials.js +47 -0
  73. package/dist/esm/models/User.d.ts +74 -0
  74. package/dist/esm/models/User.js +69 -0
  75. package/dist/esm/models/UserBase.d.ts +62 -0
  76. package/dist/esm/models/UserBase.js +51 -0
  77. package/dist/esm/models/UserCreate.d.ts +68 -0
  78. package/dist/esm/models/UserCreate.js +61 -0
  79. package/dist/esm/models/UserPartialUpdate.d.ts +68 -0
  80. package/dist/esm/models/UserPartialUpdate.js +53 -0
  81. package/dist/esm/models/UserUpdate.d.ts +68 -0
  82. package/dist/esm/models/UserUpdate.js +59 -0
  83. package/dist/esm/models/ValidationError.d.ts +40 -0
  84. package/dist/esm/models/ValidationError.js +47 -0
  85. package/dist/esm/models/index.d.ts +36 -0
  86. package/dist/esm/models/index.js +38 -0
  87. package/dist/esm/runtime.d.ts +184 -0
  88. package/dist/esm/runtime.js +334 -0
  89. package/dist/models/AuthenticationError.js +6 -8
  90. package/dist/models/AuthorizationError.js +6 -8
  91. package/dist/models/ConflictError.js +6 -8
  92. package/dist/models/ErrorTest.js +6 -8
  93. package/dist/models/Format.js +7 -9
  94. package/dist/models/FormatBase.js +7 -9
  95. package/dist/models/FormatCreate.js +7 -9
  96. package/dist/models/FormatPartialUpdate.js +7 -9
  97. package/dist/models/FormatTranslation.js +6 -8
  98. package/dist/models/FormatUpdate.js +7 -9
  99. package/dist/models/Meeting.js +6 -8
  100. package/dist/models/MeetingBase.js +6 -8
  101. package/dist/models/MeetingChangeResource.js +6 -8
  102. package/dist/models/MeetingCreate.js +6 -8
  103. package/dist/models/MeetingPartialUpdate.js +6 -8
  104. package/dist/models/MeetingUpdate.js +6 -8
  105. package/dist/models/NotFoundError.js +6 -8
  106. package/dist/models/RootServer.js +8 -10
  107. package/dist/models/RootServerBase.js +8 -10
  108. package/dist/models/RootServerBaseStatistics.js +8 -10
  109. package/dist/models/RootServerBaseStatisticsMeetings.js +6 -8
  110. package/dist/models/RootServerBaseStatisticsServiceBodies.js +6 -8
  111. package/dist/models/ServerError.js +6 -8
  112. package/dist/models/ServiceBody.js +6 -8
  113. package/dist/models/ServiceBodyBase.js +6 -8
  114. package/dist/models/ServiceBodyCreate.js +6 -8
  115. package/dist/models/ServiceBodyPartialUpdate.js +6 -8
  116. package/dist/models/ServiceBodyUpdate.js +6 -8
  117. package/dist/models/Token.js +6 -8
  118. package/dist/models/TokenCredentials.js +6 -8
  119. package/dist/models/User.d.ts +6 -0
  120. package/dist/models/User.js +8 -8
  121. package/dist/models/UserBase.js +6 -8
  122. package/dist/models/UserCreate.js +6 -8
  123. package/dist/models/UserPartialUpdate.js +6 -8
  124. package/dist/models/UserUpdate.js +6 -8
  125. package/dist/models/ValidationError.js +6 -8
  126. package/dist/runtime.d.ts +9 -9
  127. package/dist/runtime.js +226 -440
  128. package/docs/AuthenticationError.md +34 -0
  129. package/docs/AuthorizationError.md +34 -0
  130. package/docs/ConflictError.md +34 -0
  131. package/docs/ErrorTest.md +38 -0
  132. package/docs/Format.md +40 -0
  133. package/docs/FormatBase.md +38 -0
  134. package/docs/FormatCreate.md +38 -0
  135. package/docs/FormatPartialUpdate.md +38 -0
  136. package/docs/FormatTranslation.md +40 -0
  137. package/docs/FormatUpdate.md +38 -0
  138. package/docs/Meeting.md +108 -0
  139. package/docs/MeetingBase.md +106 -0
  140. package/docs/MeetingChangeResource.md +40 -0
  141. package/docs/MeetingCreate.md +106 -0
  142. package/docs/MeetingPartialUpdate.md +106 -0
  143. package/docs/MeetingUpdate.md +106 -0
  144. package/docs/NotFoundError.md +34 -0
  145. package/docs/RootServer.md +46 -0
  146. package/docs/RootServerApi.md +2373 -0
  147. package/docs/RootServerBase.md +44 -0
  148. package/docs/RootServerBaseStatistics.md +36 -0
  149. package/docs/RootServerBaseStatisticsMeetings.md +42 -0
  150. package/docs/RootServerBaseStatisticsServiceBodies.md +40 -0
  151. package/docs/ServerError.md +34 -0
  152. package/docs/ServiceBody.md +54 -0
  153. package/docs/ServiceBodyBase.md +52 -0
  154. package/docs/ServiceBodyCreate.md +52 -0
  155. package/docs/ServiceBodyPartialUpdate.md +52 -0
  156. package/docs/ServiceBodyUpdate.md +52 -0
  157. package/docs/Token.md +40 -0
  158. package/docs/TokenCredentials.md +36 -0
  159. package/docs/User.md +48 -0
  160. package/docs/UserBase.md +44 -0
  161. package/docs/UserCreate.md +46 -0
  162. package/docs/UserPartialUpdate.md +46 -0
  163. package/docs/UserUpdate.md +46 -0
  164. package/docs/ValidationError.md +36 -0
  165. package/openapi.json +1 -1
  166. package/package.json +5 -3
  167. package/src/apis/RootServerApi.ts +146 -32
  168. package/src/models/RootServer.ts +1 -1
  169. package/src/models/RootServerBase.ts +1 -1
  170. package/src/models/User.ts +8 -0
  171. package/tsconfig.esm.json +7 -0
  172. package/tsconfig.json +1 -5
  173. package/.idea/bmlt-server-typescript-client.iml +0 -9
  174. package/.idea/misc.xml +0 -6
  175. package/.idea/modules.xml +0 -8
  176. package/.idea/vcs.xml +0 -6
@@ -0,0 +1,2373 @@
1
+ # RootServerApi
2
+
3
+ All URIs are relative to *http://localhost:8000/main_server*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**authLogout**](RootServerApi.md#authlogout) | **POST** /api/v1/auth/logout | Revokes a token |
8
+ | [**authRefresh**](RootServerApi.md#authrefresh) | **POST** /api/v1/auth/refresh | Revokes and issues a new token |
9
+ | [**authToken**](RootServerApi.md#authtoken) | **POST** /api/v1/auth/token | Creates a token |
10
+ | [**createErrorTest**](RootServerApi.md#createerrortest) | **POST** /api/v1/errortest | Tests some errors |
11
+ | [**createFormat**](RootServerApi.md#createformat) | **POST** /api/v1/formats | Creates a format |
12
+ | [**createMeeting**](RootServerApi.md#createmeeting) | **POST** /api/v1/meetings | Creates a meeting |
13
+ | [**createServiceBody**](RootServerApi.md#createservicebody) | **POST** /api/v1/servicebodies | Creates a service body |
14
+ | [**createUser**](RootServerApi.md#createuser) | **POST** /api/v1/users | Creates a user |
15
+ | [**deleteFormat**](RootServerApi.md#deleteformat) | **DELETE** /api/v1/formats/{formatId} | Deletes a format |
16
+ | [**deleteMeeting**](RootServerApi.md#deletemeeting) | **DELETE** /api/v1/meetings/{meetingId} | Deletes a meeting |
17
+ | [**deleteServiceBody**](RootServerApi.md#deleteservicebody) | **DELETE** /api/v1/servicebodies/{serviceBodyId} | Deletes a service body |
18
+ | [**deleteUser**](RootServerApi.md#deleteuser) | **DELETE** /api/v1/users/{userId} | Deletes a user |
19
+ | [**getFormat**](RootServerApi.md#getformat) | **GET** /api/v1/formats/{formatId} | Retrieves a format |
20
+ | [**getFormats**](RootServerApi.md#getformats) | **GET** /api/v1/formats | Retrieves formats |
21
+ | [**getLaravelLog**](RootServerApi.md#getlaravellog) | **GET** /api/v1/logs/laravel | Retrieves laravel log |
22
+ | [**getMeeting**](RootServerApi.md#getmeeting) | **GET** /api/v1/meetings/{meetingId} | Retrieves a meeting |
23
+ | [**getMeetingChanges**](RootServerApi.md#getmeetingchanges) | **GET** /api/v1/meetings/{meetingId}/changes | Retrieve changes for a meeting |
24
+ | [**getMeetings**](RootServerApi.md#getmeetings) | **GET** /api/v1/meetings | Retrieves meetings |
25
+ | [**getRootServer**](RootServerApi.md#getrootserver) | **GET** /api/v1/rootservers/{rootServerId} | Retrieves a root server |
26
+ | [**getRootServers**](RootServerApi.md#getrootservers) | **GET** /api/v1/rootservers | Retrieves root servers |
27
+ | [**getServiceBodies**](RootServerApi.md#getservicebodies) | **GET** /api/v1/servicebodies | Retrieves service bodies |
28
+ | [**getServiceBody**](RootServerApi.md#getservicebody) | **GET** /api/v1/servicebodies/{serviceBodyId} | Retrieves a service body |
29
+ | [**getUser**](RootServerApi.md#getuser) | **GET** /api/v1/users/{userId} | Retrieves a single user |
30
+ | [**getUsers**](RootServerApi.md#getusers) | **GET** /api/v1/users | Retrieves users |
31
+ | [**partialUpdateUser**](RootServerApi.md#partialupdateuser) | **PATCH** /api/v1/users/{userId} | Patches a user |
32
+ | [**patchFormat**](RootServerApi.md#patchformat) | **PATCH** /api/v1/formats/{formatId} | Patches a format |
33
+ | [**patchMeeting**](RootServerApi.md#patchmeeting) | **PATCH** /api/v1/meetings/{meetingId} | Patches a meeting |
34
+ | [**patchServiceBody**](RootServerApi.md#patchservicebody) | **PATCH** /api/v1/servicebodies/{serviceBodyId} | Patches a service body |
35
+ | [**updateFormat**](RootServerApi.md#updateformat) | **PUT** /api/v1/formats/{formatId} | Updates a format |
36
+ | [**updateMeeting**](RootServerApi.md#updatemeeting) | **PUT** /api/v1/meetings/{meetingId} | Updates a meeting |
37
+ | [**updateServiceBody**](RootServerApi.md#updateservicebody) | **PUT** /api/v1/servicebodies/{serviceBodyId} | Updates a Service Body |
38
+ | [**updateUser**](RootServerApi.md#updateuser) | **PUT** /api/v1/users/{userId} | Update single user |
39
+
40
+
41
+
42
+ ## authLogout
43
+
44
+ > authLogout()
45
+
46
+ Revokes a token
47
+
48
+ Revoke token and logout.
49
+
50
+ ### Example
51
+
52
+ ```ts
53
+ import {
54
+ Configuration,
55
+ RootServerApi,
56
+ } from 'bmlt-server-client';
57
+ import type { AuthLogoutRequest } from 'bmlt-server-client';
58
+
59
+ async function example() {
60
+ console.log("🚀 Testing bmlt-server-client SDK...");
61
+ const config = new Configuration({
62
+ // To configure OAuth2 access token for authorization: bmltToken password
63
+ accessToken: "YOUR ACCESS TOKEN",
64
+ });
65
+ const api = new RootServerApi(config);
66
+
67
+ try {
68
+ const data = await api.authLogout();
69
+ console.log(data);
70
+ } catch (error) {
71
+ console.error(error);
72
+ }
73
+ }
74
+
75
+ // Run the test
76
+ example().catch(console.error);
77
+ ```
78
+
79
+ ### Parameters
80
+
81
+ This endpoint does not need any parameter.
82
+
83
+ ### Return type
84
+
85
+ `void` (Empty response body)
86
+
87
+ ### Authorization
88
+
89
+ [bmltToken password](../README.md#bmltToken-password)
90
+
91
+ ### HTTP request headers
92
+
93
+ - **Content-Type**: Not defined
94
+ - **Accept**: `application/json`
95
+
96
+
97
+ ### HTTP response details
98
+ | Status code | Description | Response headers |
99
+ |-------------|-------------|------------------|
100
+ | **200** | Returns when token was logged out. | - |
101
+ | **401** | Returns when request is unauthenticated. | - |
102
+
103
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
104
+
105
+
106
+ ## authRefresh
107
+
108
+ > Token authRefresh()
109
+
110
+ Revokes and issues a new token
111
+
112
+ Refresh token.
113
+
114
+ ### Example
115
+
116
+ ```ts
117
+ import {
118
+ Configuration,
119
+ RootServerApi,
120
+ } from 'bmlt-server-client';
121
+ import type { AuthRefreshRequest } from 'bmlt-server-client';
122
+
123
+ async function example() {
124
+ console.log("🚀 Testing bmlt-server-client SDK...");
125
+ const config = new Configuration({
126
+ // To configure OAuth2 access token for authorization: bmltToken password
127
+ accessToken: "YOUR ACCESS TOKEN",
128
+ });
129
+ const api = new RootServerApi(config);
130
+
131
+ try {
132
+ const data = await api.authRefresh();
133
+ console.log(data);
134
+ } catch (error) {
135
+ console.error(error);
136
+ }
137
+ }
138
+
139
+ // Run the test
140
+ example().catch(console.error);
141
+ ```
142
+
143
+ ### Parameters
144
+
145
+ This endpoint does not need any parameter.
146
+
147
+ ### Return type
148
+
149
+ [**Token**](Token.md)
150
+
151
+ ### Authorization
152
+
153
+ [bmltToken password](../README.md#bmltToken-password)
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** | Returns when refresh is successful. | - |
165
+ | **401** | Returns when request is unauthenticated. | - |
166
+
167
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
168
+
169
+
170
+ ## authToken
171
+
172
+ > Token authToken(tokenCredentials)
173
+
174
+ Creates a token
175
+
176
+ Exchange credentials for a new token
177
+
178
+ ### Example
179
+
180
+ ```ts
181
+ import {
182
+ Configuration,
183
+ RootServerApi,
184
+ } from 'bmlt-server-client';
185
+ import type { AuthTokenRequest } from 'bmlt-server-client';
186
+
187
+ async function example() {
188
+ console.log("🚀 Testing bmlt-server-client SDK...");
189
+ const api = new RootServerApi();
190
+
191
+ const body = {
192
+ // TokenCredentials | User credentials
193
+ tokenCredentials: ...,
194
+ } satisfies AuthTokenRequest;
195
+
196
+ try {
197
+ const data = await api.authToken(body);
198
+ console.log(data);
199
+ } catch (error) {
200
+ console.error(error);
201
+ }
202
+ }
203
+
204
+ // Run the test
205
+ example().catch(console.error);
206
+ ```
207
+
208
+ ### Parameters
209
+
210
+
211
+ | Name | Type | Description | Notes |
212
+ |------------- | ------------- | ------------- | -------------|
213
+ | **tokenCredentials** | [TokenCredentials](TokenCredentials.md) | User credentials | |
214
+
215
+ ### Return type
216
+
217
+ [**Token**](Token.md)
218
+
219
+ ### Authorization
220
+
221
+ No authorization required
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: `application/json`
226
+ - **Accept**: `application/json`
227
+
228
+
229
+ ### HTTP response details
230
+ | Status code | Description | Response headers |
231
+ |-------------|-------------|------------------|
232
+ | **200** | Returns when POST is successful. | - |
233
+ | **401** | Returns when credentials are incorrect. | - |
234
+ | **403** | Returns when unauthorized. | - |
235
+ | **422** | Validation error. | - |
236
+
237
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
238
+
239
+
240
+ ## createErrorTest
241
+
242
+ > ErrorTest createErrorTest(errorTest)
243
+
244
+ Tests some errors
245
+
246
+ Tests some errors.
247
+
248
+ ### Example
249
+
250
+ ```ts
251
+ import {
252
+ Configuration,
253
+ RootServerApi,
254
+ } from 'bmlt-server-client';
255
+ import type { CreateErrorTestRequest } from 'bmlt-server-client';
256
+
257
+ async function example() {
258
+ console.log("🚀 Testing bmlt-server-client SDK...");
259
+ const config = new Configuration({
260
+ // To configure OAuth2 access token for authorization: bmltToken password
261
+ accessToken: "YOUR ACCESS TOKEN",
262
+ });
263
+ const api = new RootServerApi(config);
264
+
265
+ const body = {
266
+ // ErrorTest | Pass in error test object.
267
+ errorTest: ...,
268
+ } satisfies CreateErrorTestRequest;
269
+
270
+ try {
271
+ const data = await api.createErrorTest(body);
272
+ console.log(data);
273
+ } catch (error) {
274
+ console.error(error);
275
+ }
276
+ }
277
+
278
+ // Run the test
279
+ example().catch(console.error);
280
+ ```
281
+
282
+ ### Parameters
283
+
284
+
285
+ | Name | Type | Description | Notes |
286
+ |------------- | ------------- | ------------- | -------------|
287
+ | **errorTest** | [ErrorTest](ErrorTest.md) | Pass in error test object. | |
288
+
289
+ ### Return type
290
+
291
+ [**ErrorTest**](ErrorTest.md)
292
+
293
+ ### Authorization
294
+
295
+ [bmltToken password](../README.md#bmltToken-password)
296
+
297
+ ### HTTP request headers
298
+
299
+ - **Content-Type**: `application/json`
300
+ - **Accept**: `application/json`
301
+
302
+
303
+ ### HTTP response details
304
+ | Status code | Description | Response headers |
305
+ |-------------|-------------|------------------|
306
+ | **201** | Returns when POST is successful. | - |
307
+ | **401** | Returns when user is not authenticated. | - |
308
+ | **422** | Validation error. | - |
309
+ | **500** | Server error. | - |
310
+
311
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
312
+
313
+
314
+ ## createFormat
315
+
316
+ > Format createFormat(formatCreate)
317
+
318
+ Creates a format
319
+
320
+ Creates a format.
321
+
322
+ ### Example
323
+
324
+ ```ts
325
+ import {
326
+ Configuration,
327
+ RootServerApi,
328
+ } from 'bmlt-server-client';
329
+ import type { CreateFormatRequest } from 'bmlt-server-client';
330
+
331
+ async function example() {
332
+ console.log("🚀 Testing bmlt-server-client SDK...");
333
+ const config = new Configuration({
334
+ // To configure OAuth2 access token for authorization: bmltToken password
335
+ accessToken: "YOUR ACCESS TOKEN",
336
+ });
337
+ const api = new RootServerApi(config);
338
+
339
+ const body = {
340
+ // FormatCreate | Pass in format object
341
+ formatCreate: ...,
342
+ } satisfies CreateFormatRequest;
343
+
344
+ try {
345
+ const data = await api.createFormat(body);
346
+ console.log(data);
347
+ } catch (error) {
348
+ console.error(error);
349
+ }
350
+ }
351
+
352
+ // Run the test
353
+ example().catch(console.error);
354
+ ```
355
+
356
+ ### Parameters
357
+
358
+
359
+ | Name | Type | Description | Notes |
360
+ |------------- | ------------- | ------------- | -------------|
361
+ | **formatCreate** | [FormatCreate](FormatCreate.md) | Pass in format object | |
362
+
363
+ ### Return type
364
+
365
+ [**Format**](Format.md)
366
+
367
+ ### Authorization
368
+
369
+ [bmltToken password](../README.md#bmltToken-password)
370
+
371
+ ### HTTP request headers
372
+
373
+ - **Content-Type**: `application/json`
374
+ - **Accept**: `application/json`
375
+
376
+
377
+ ### HTTP response details
378
+ | Status code | Description | Response headers |
379
+ |-------------|-------------|------------------|
380
+ | **201** | Returns when POST is successful. | - |
381
+ | **401** | Returns when user is not authenticated. | - |
382
+ | **403** | Returns when user is unauthorized to perform action. | - |
383
+ | **404** | Returns when no format exists. | - |
384
+ | **422** | Validation error. | - |
385
+
386
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
387
+
388
+
389
+ ## createMeeting
390
+
391
+ > Meeting createMeeting(meetingCreate)
392
+
393
+ Creates a meeting
394
+
395
+ Creates a meeting.
396
+
397
+ ### Example
398
+
399
+ ```ts
400
+ import {
401
+ Configuration,
402
+ RootServerApi,
403
+ } from 'bmlt-server-client';
404
+ import type { CreateMeetingRequest } from 'bmlt-server-client';
405
+
406
+ async function example() {
407
+ console.log("🚀 Testing bmlt-server-client SDK...");
408
+ const config = new Configuration({
409
+ // To configure OAuth2 access token for authorization: bmltToken password
410
+ accessToken: "YOUR ACCESS TOKEN",
411
+ });
412
+ const api = new RootServerApi(config);
413
+
414
+ const body = {
415
+ // MeetingCreate | Pass in meeting object
416
+ meetingCreate: ...,
417
+ } satisfies CreateMeetingRequest;
418
+
419
+ try {
420
+ const data = await api.createMeeting(body);
421
+ console.log(data);
422
+ } catch (error) {
423
+ console.error(error);
424
+ }
425
+ }
426
+
427
+ // Run the test
428
+ example().catch(console.error);
429
+ ```
430
+
431
+ ### Parameters
432
+
433
+
434
+ | Name | Type | Description | Notes |
435
+ |------------- | ------------- | ------------- | -------------|
436
+ | **meetingCreate** | [MeetingCreate](MeetingCreate.md) | Pass in meeting object | |
437
+
438
+ ### Return type
439
+
440
+ [**Meeting**](Meeting.md)
441
+
442
+ ### Authorization
443
+
444
+ [bmltToken password](../README.md#bmltToken-password)
445
+
446
+ ### HTTP request headers
447
+
448
+ - **Content-Type**: `application/json`
449
+ - **Accept**: `application/json`
450
+
451
+
452
+ ### HTTP response details
453
+ | Status code | Description | Response headers |
454
+ |-------------|-------------|------------------|
455
+ | **201** | Returns when POST is successful. | - |
456
+ | **401** | Returns when user is not authenticated. | - |
457
+ | **403** | Returns when user is unauthorized to perform action. | - |
458
+ | **404** | Returns when no meeting body exists. | - |
459
+ | **422** | Validation error. | - |
460
+
461
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
462
+
463
+
464
+ ## createServiceBody
465
+
466
+ > ServiceBody createServiceBody(serviceBodyCreate)
467
+
468
+ Creates a service body
469
+
470
+ Creates a service body.
471
+
472
+ ### Example
473
+
474
+ ```ts
475
+ import {
476
+ Configuration,
477
+ RootServerApi,
478
+ } from 'bmlt-server-client';
479
+ import type { CreateServiceBodyRequest } from 'bmlt-server-client';
480
+
481
+ async function example() {
482
+ console.log("🚀 Testing bmlt-server-client SDK...");
483
+ const config = new Configuration({
484
+ // To configure OAuth2 access token for authorization: bmltToken password
485
+ accessToken: "YOUR ACCESS TOKEN",
486
+ });
487
+ const api = new RootServerApi(config);
488
+
489
+ const body = {
490
+ // ServiceBodyCreate | Pass in service body object
491
+ serviceBodyCreate: ...,
492
+ } satisfies CreateServiceBodyRequest;
493
+
494
+ try {
495
+ const data = await api.createServiceBody(body);
496
+ console.log(data);
497
+ } catch (error) {
498
+ console.error(error);
499
+ }
500
+ }
501
+
502
+ // Run the test
503
+ example().catch(console.error);
504
+ ```
505
+
506
+ ### Parameters
507
+
508
+
509
+ | Name | Type | Description | Notes |
510
+ |------------- | ------------- | ------------- | -------------|
511
+ | **serviceBodyCreate** | [ServiceBodyCreate](ServiceBodyCreate.md) | Pass in service body object | |
512
+
513
+ ### Return type
514
+
515
+ [**ServiceBody**](ServiceBody.md)
516
+
517
+ ### Authorization
518
+
519
+ [bmltToken password](../README.md#bmltToken-password)
520
+
521
+ ### HTTP request headers
522
+
523
+ - **Content-Type**: `application/json`
524
+ - **Accept**: `application/json`
525
+
526
+
527
+ ### HTTP response details
528
+ | Status code | Description | Response headers |
529
+ |-------------|-------------|------------------|
530
+ | **201** | Returns when POST is successful. | - |
531
+ | **401** | Returns when user is not authenticated. | - |
532
+ | **403** | Returns when user is unauthorized to perform action. | - |
533
+ | **404** | Returns when no service body exists. | - |
534
+ | **422** | Validation error. | - |
535
+
536
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
537
+
538
+
539
+ ## createUser
540
+
541
+ > User createUser(userCreate)
542
+
543
+ Creates a user
544
+
545
+ Creates a user.
546
+
547
+ ### Example
548
+
549
+ ```ts
550
+ import {
551
+ Configuration,
552
+ RootServerApi,
553
+ } from 'bmlt-server-client';
554
+ import type { CreateUserRequest } from 'bmlt-server-client';
555
+
556
+ async function example() {
557
+ console.log("🚀 Testing bmlt-server-client SDK...");
558
+ const config = new Configuration({
559
+ // To configure OAuth2 access token for authorization: bmltToken password
560
+ accessToken: "YOUR ACCESS TOKEN",
561
+ });
562
+ const api = new RootServerApi(config);
563
+
564
+ const body = {
565
+ // UserCreate | Pass in user object
566
+ userCreate: ...,
567
+ } satisfies CreateUserRequest;
568
+
569
+ try {
570
+ const data = await api.createUser(body);
571
+ console.log(data);
572
+ } catch (error) {
573
+ console.error(error);
574
+ }
575
+ }
576
+
577
+ // Run the test
578
+ example().catch(console.error);
579
+ ```
580
+
581
+ ### Parameters
582
+
583
+
584
+ | Name | Type | Description | Notes |
585
+ |------------- | ------------- | ------------- | -------------|
586
+ | **userCreate** | [UserCreate](UserCreate.md) | Pass in user object | |
587
+
588
+ ### Return type
589
+
590
+ [**User**](User.md)
591
+
592
+ ### Authorization
593
+
594
+ [bmltToken password](../README.md#bmltToken-password)
595
+
596
+ ### HTTP request headers
597
+
598
+ - **Content-Type**: `application/json`
599
+ - **Accept**: `application/json`
600
+
601
+
602
+ ### HTTP response details
603
+ | Status code | Description | Response headers |
604
+ |-------------|-------------|------------------|
605
+ | **201** | Returns when POST is successful. | - |
606
+ | **401** | Returns when user is not authenticated. | - |
607
+ | **403** | Returns when user is unauthorized to perform action. | - |
608
+ | **404** | Returns when no user exists. | - |
609
+ | **422** | Validation error. | - |
610
+
611
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
612
+
613
+
614
+ ## deleteFormat
615
+
616
+ > deleteFormat(formatId)
617
+
618
+ Deletes a format
619
+
620
+ Deletes a format by id.
621
+
622
+ ### Example
623
+
624
+ ```ts
625
+ import {
626
+ Configuration,
627
+ RootServerApi,
628
+ } from 'bmlt-server-client';
629
+ import type { DeleteFormatRequest } from 'bmlt-server-client';
630
+
631
+ async function example() {
632
+ console.log("🚀 Testing bmlt-server-client SDK...");
633
+ const config = new Configuration({
634
+ // To configure OAuth2 access token for authorization: bmltToken password
635
+ accessToken: "YOUR ACCESS TOKEN",
636
+ });
637
+ const api = new RootServerApi(config);
638
+
639
+ const body = {
640
+ // number | ID of format
641
+ formatId: 1,
642
+ } satisfies DeleteFormatRequest;
643
+
644
+ try {
645
+ const data = await api.deleteFormat(body);
646
+ console.log(data);
647
+ } catch (error) {
648
+ console.error(error);
649
+ }
650
+ }
651
+
652
+ // Run the test
653
+ example().catch(console.error);
654
+ ```
655
+
656
+ ### Parameters
657
+
658
+
659
+ | Name | Type | Description | Notes |
660
+ |------------- | ------------- | ------------- | -------------|
661
+ | **formatId** | `number` | ID of format | [Defaults to `undefined`] |
662
+
663
+ ### Return type
664
+
665
+ `void` (Empty response body)
666
+
667
+ ### Authorization
668
+
669
+ [bmltToken password](../README.md#bmltToken-password)
670
+
671
+ ### HTTP request headers
672
+
673
+ - **Content-Type**: Not defined
674
+ - **Accept**: `application/json`
675
+
676
+
677
+ ### HTTP response details
678
+ | Status code | Description | Response headers |
679
+ |-------------|-------------|------------------|
680
+ | **204** | Success. | - |
681
+ | **401** | Returns when not authenticated | - |
682
+ | **403** | Returns when unauthorized | - |
683
+ | **404** | Returns when no format exists. | - |
684
+ | **409** | Returns when format has meetings assigned. | - |
685
+ | **422** | Validation error. | - |
686
+
687
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
688
+
689
+
690
+ ## deleteMeeting
691
+
692
+ > deleteMeeting(meetingId)
693
+
694
+ Deletes a meeting
695
+
696
+ Deletes a meeting by id.
697
+
698
+ ### Example
699
+
700
+ ```ts
701
+ import {
702
+ Configuration,
703
+ RootServerApi,
704
+ } from 'bmlt-server-client';
705
+ import type { DeleteMeetingRequest } from 'bmlt-server-client';
706
+
707
+ async function example() {
708
+ console.log("🚀 Testing bmlt-server-client SDK...");
709
+ const config = new Configuration({
710
+ // To configure OAuth2 access token for authorization: bmltToken password
711
+ accessToken: "YOUR ACCESS TOKEN",
712
+ });
713
+ const api = new RootServerApi(config);
714
+
715
+ const body = {
716
+ // number | ID of meeting
717
+ meetingId: 1,
718
+ } satisfies DeleteMeetingRequest;
719
+
720
+ try {
721
+ const data = await api.deleteMeeting(body);
722
+ console.log(data);
723
+ } catch (error) {
724
+ console.error(error);
725
+ }
726
+ }
727
+
728
+ // Run the test
729
+ example().catch(console.error);
730
+ ```
731
+
732
+ ### Parameters
733
+
734
+
735
+ | Name | Type | Description | Notes |
736
+ |------------- | ------------- | ------------- | -------------|
737
+ | **meetingId** | `number` | ID of meeting | [Defaults to `undefined`] |
738
+
739
+ ### Return type
740
+
741
+ `void` (Empty response body)
742
+
743
+ ### Authorization
744
+
745
+ [bmltToken password](../README.md#bmltToken-password)
746
+
747
+ ### HTTP request headers
748
+
749
+ - **Content-Type**: Not defined
750
+ - **Accept**: `application/json`
751
+
752
+
753
+ ### HTTP response details
754
+ | Status code | Description | Response headers |
755
+ |-------------|-------------|------------------|
756
+ | **204** | Success. | - |
757
+ | **401** | Returns when user is not authenticated. | - |
758
+ | **403** | Returns when user is unauthorized to perform action. | - |
759
+ | **404** | Returns when no meeting exists. | - |
760
+
761
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
762
+
763
+
764
+ ## deleteServiceBody
765
+
766
+ > deleteServiceBody(serviceBodyId)
767
+
768
+ Deletes a service body
769
+
770
+ Deletes a service body by id.
771
+
772
+ ### Example
773
+
774
+ ```ts
775
+ import {
776
+ Configuration,
777
+ RootServerApi,
778
+ } from 'bmlt-server-client';
779
+ import type { DeleteServiceBodyRequest } from 'bmlt-server-client';
780
+
781
+ async function example() {
782
+ console.log("🚀 Testing bmlt-server-client SDK...");
783
+ const config = new Configuration({
784
+ // To configure OAuth2 access token for authorization: bmltToken password
785
+ accessToken: "YOUR ACCESS TOKEN",
786
+ });
787
+ const api = new RootServerApi(config);
788
+
789
+ const body = {
790
+ // number | ID of service body
791
+ serviceBodyId: 1,
792
+ } satisfies DeleteServiceBodyRequest;
793
+
794
+ try {
795
+ const data = await api.deleteServiceBody(body);
796
+ console.log(data);
797
+ } catch (error) {
798
+ console.error(error);
799
+ }
800
+ }
801
+
802
+ // Run the test
803
+ example().catch(console.error);
804
+ ```
805
+
806
+ ### Parameters
807
+
808
+
809
+ | Name | Type | Description | Notes |
810
+ |------------- | ------------- | ------------- | -------------|
811
+ | **serviceBodyId** | `number` | ID of service body | [Defaults to `undefined`] |
812
+
813
+ ### Return type
814
+
815
+ `void` (Empty response body)
816
+
817
+ ### Authorization
818
+
819
+ [bmltToken password](../README.md#bmltToken-password)
820
+
821
+ ### HTTP request headers
822
+
823
+ - **Content-Type**: Not defined
824
+ - **Accept**: `application/json`
825
+
826
+
827
+ ### HTTP response details
828
+ | Status code | Description | Response headers |
829
+ |-------------|-------------|------------------|
830
+ | **204** | Success. | - |
831
+ | **401** | Returns when user is not authenticated. | - |
832
+ | **403** | Returns when user is unauthorized to perform action. | - |
833
+ | **404** | Returns when no service body exists. | - |
834
+ | **409** | Returns when service body has children. | - |
835
+
836
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
837
+
838
+
839
+ ## deleteUser
840
+
841
+ > deleteUser(userId)
842
+
843
+ Deletes a user
844
+
845
+ Deletes a user by id
846
+
847
+ ### Example
848
+
849
+ ```ts
850
+ import {
851
+ Configuration,
852
+ RootServerApi,
853
+ } from 'bmlt-server-client';
854
+ import type { DeleteUserRequest } from 'bmlt-server-client';
855
+
856
+ async function example() {
857
+ console.log("🚀 Testing bmlt-server-client SDK...");
858
+ const config = new Configuration({
859
+ // To configure OAuth2 access token for authorization: bmltToken password
860
+ accessToken: "YOUR ACCESS TOKEN",
861
+ });
862
+ const api = new RootServerApi(config);
863
+
864
+ const body = {
865
+ // number | ID of user
866
+ userId: 1,
867
+ } satisfies DeleteUserRequest;
868
+
869
+ try {
870
+ const data = await api.deleteUser(body);
871
+ console.log(data);
872
+ } catch (error) {
873
+ console.error(error);
874
+ }
875
+ }
876
+
877
+ // Run the test
878
+ example().catch(console.error);
879
+ ```
880
+
881
+ ### Parameters
882
+
883
+
884
+ | Name | Type | Description | Notes |
885
+ |------------- | ------------- | ------------- | -------------|
886
+ | **userId** | `number` | ID of user | [Defaults to `undefined`] |
887
+
888
+ ### Return type
889
+
890
+ `void` (Empty response body)
891
+
892
+ ### Authorization
893
+
894
+ [bmltToken password](../README.md#bmltToken-password)
895
+
896
+ ### HTTP request headers
897
+
898
+ - **Content-Type**: Not defined
899
+ - **Accept**: `application/json`
900
+
901
+
902
+ ### HTTP response details
903
+ | Status code | Description | Response headers |
904
+ |-------------|-------------|------------------|
905
+ | **204** | Success. | - |
906
+ | **401** | Returns when not authenticated | - |
907
+ | **403** | Returns when unauthorized | - |
908
+ | **404** | Returns when no user exists. | - |
909
+ | **409** | Returns when user is still referenced by service bodies. | - |
910
+
911
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
912
+
913
+
914
+ ## getFormat
915
+
916
+ > Format getFormat(formatId)
917
+
918
+ Retrieves a format
919
+
920
+ Retrieve a format
921
+
922
+ ### Example
923
+
924
+ ```ts
925
+ import {
926
+ Configuration,
927
+ RootServerApi,
928
+ } from 'bmlt-server-client';
929
+ import type { GetFormatRequest } from 'bmlt-server-client';
930
+
931
+ async function example() {
932
+ console.log("🚀 Testing bmlt-server-client SDK...");
933
+ const config = new Configuration({
934
+ // To configure OAuth2 access token for authorization: bmltToken password
935
+ accessToken: "YOUR ACCESS TOKEN",
936
+ });
937
+ const api = new RootServerApi(config);
938
+
939
+ const body = {
940
+ // number | ID of format
941
+ formatId: 1,
942
+ } satisfies GetFormatRequest;
943
+
944
+ try {
945
+ const data = await api.getFormat(body);
946
+ console.log(data);
947
+ } catch (error) {
948
+ console.error(error);
949
+ }
950
+ }
951
+
952
+ // Run the test
953
+ example().catch(console.error);
954
+ ```
955
+
956
+ ### Parameters
957
+
958
+
959
+ | Name | Type | Description | Notes |
960
+ |------------- | ------------- | ------------- | -------------|
961
+ | **formatId** | `number` | ID of format | [Defaults to `undefined`] |
962
+
963
+ ### Return type
964
+
965
+ [**Format**](Format.md)
966
+
967
+ ### Authorization
968
+
969
+ [bmltToken password](../README.md#bmltToken-password)
970
+
971
+ ### HTTP request headers
972
+
973
+ - **Content-Type**: Not defined
974
+ - **Accept**: `application/json`
975
+
976
+
977
+ ### HTTP response details
978
+ | Status code | Description | Response headers |
979
+ |-------------|-------------|------------------|
980
+ | **200** | Returns when user is authenticated. | - |
981
+ | **401** | Returns when not authenticated. | - |
982
+ | **404** | Returns when no format exists. | - |
983
+
984
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
985
+
986
+
987
+ ## getFormats
988
+
989
+ > Array<Format> getFormats()
990
+
991
+ Retrieves formats
992
+
993
+ Retrieve formats
994
+
995
+ ### Example
996
+
997
+ ```ts
998
+ import {
999
+ Configuration,
1000
+ RootServerApi,
1001
+ } from 'bmlt-server-client';
1002
+ import type { GetFormatsRequest } from 'bmlt-server-client';
1003
+
1004
+ async function example() {
1005
+ console.log("🚀 Testing bmlt-server-client SDK...");
1006
+ const config = new Configuration({
1007
+ // To configure OAuth2 access token for authorization: bmltToken password
1008
+ accessToken: "YOUR ACCESS TOKEN",
1009
+ });
1010
+ const api = new RootServerApi(config);
1011
+
1012
+ try {
1013
+ const data = await api.getFormats();
1014
+ console.log(data);
1015
+ } catch (error) {
1016
+ console.error(error);
1017
+ }
1018
+ }
1019
+
1020
+ // Run the test
1021
+ example().catch(console.error);
1022
+ ```
1023
+
1024
+ ### Parameters
1025
+
1026
+ This endpoint does not need any parameter.
1027
+
1028
+ ### Return type
1029
+
1030
+ [**Array<Format>**](Format.md)
1031
+
1032
+ ### Authorization
1033
+
1034
+ [bmltToken password](../README.md#bmltToken-password)
1035
+
1036
+ ### HTTP request headers
1037
+
1038
+ - **Content-Type**: Not defined
1039
+ - **Accept**: `application/json`
1040
+
1041
+
1042
+ ### HTTP response details
1043
+ | Status code | Description | Response headers |
1044
+ |-------------|-------------|------------------|
1045
+ | **200** | Returns when user is authenticated. | - |
1046
+ | **401** | Returns when not authenticated | - |
1047
+
1048
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1049
+
1050
+
1051
+ ## getLaravelLog
1052
+
1053
+ > Blob getLaravelLog()
1054
+
1055
+ Retrieves laravel log
1056
+
1057
+ Retrieve the laravel log if it exists.
1058
+
1059
+ ### Example
1060
+
1061
+ ```ts
1062
+ import {
1063
+ Configuration,
1064
+ RootServerApi,
1065
+ } from 'bmlt-server-client';
1066
+ import type { GetLaravelLogRequest } from 'bmlt-server-client';
1067
+
1068
+ async function example() {
1069
+ console.log("🚀 Testing bmlt-server-client SDK...");
1070
+ const config = new Configuration({
1071
+ // To configure OAuth2 access token for authorization: bmltToken password
1072
+ accessToken: "YOUR ACCESS TOKEN",
1073
+ });
1074
+ const api = new RootServerApi(config);
1075
+
1076
+ try {
1077
+ const data = await api.getLaravelLog();
1078
+ console.log(data);
1079
+ } catch (error) {
1080
+ console.error(error);
1081
+ }
1082
+ }
1083
+
1084
+ // Run the test
1085
+ example().catch(console.error);
1086
+ ```
1087
+
1088
+ ### Parameters
1089
+
1090
+ This endpoint does not need any parameter.
1091
+
1092
+ ### Return type
1093
+
1094
+ **Blob**
1095
+
1096
+ ### Authorization
1097
+
1098
+ [bmltToken password](../README.md#bmltToken-password)
1099
+
1100
+ ### HTTP request headers
1101
+
1102
+ - **Content-Type**: Not defined
1103
+ - **Accept**: `application/gzip`, `application/json`
1104
+
1105
+
1106
+ ### HTTP response details
1107
+ | Status code | Description | Response headers |
1108
+ |-------------|-------------|------------------|
1109
+ | **200** | Returns when user is authenticated. | - |
1110
+ | **401** | Returns when user is not authenticated. | - |
1111
+ | **403** | Returns when user is unauthorized to perform action. | - |
1112
+ | **404** | Returns when no laravel log file exists. | - |
1113
+
1114
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1115
+
1116
+
1117
+ ## getMeeting
1118
+
1119
+ > Meeting getMeeting(meetingId)
1120
+
1121
+ Retrieves a meeting
1122
+
1123
+ Retrieve a meeting.
1124
+
1125
+ ### Example
1126
+
1127
+ ```ts
1128
+ import {
1129
+ Configuration,
1130
+ RootServerApi,
1131
+ } from 'bmlt-server-client';
1132
+ import type { GetMeetingRequest } from 'bmlt-server-client';
1133
+
1134
+ async function example() {
1135
+ console.log("🚀 Testing bmlt-server-client SDK...");
1136
+ const config = new Configuration({
1137
+ // To configure OAuth2 access token for authorization: bmltToken password
1138
+ accessToken: "YOUR ACCESS TOKEN",
1139
+ });
1140
+ const api = new RootServerApi(config);
1141
+
1142
+ const body = {
1143
+ // number | ID of meeting
1144
+ meetingId: 1,
1145
+ } satisfies GetMeetingRequest;
1146
+
1147
+ try {
1148
+ const data = await api.getMeeting(body);
1149
+ console.log(data);
1150
+ } catch (error) {
1151
+ console.error(error);
1152
+ }
1153
+ }
1154
+
1155
+ // Run the test
1156
+ example().catch(console.error);
1157
+ ```
1158
+
1159
+ ### Parameters
1160
+
1161
+
1162
+ | Name | Type | Description | Notes |
1163
+ |------------- | ------------- | ------------- | -------------|
1164
+ | **meetingId** | `number` | ID of meeting | [Defaults to `undefined`] |
1165
+
1166
+ ### Return type
1167
+
1168
+ [**Meeting**](Meeting.md)
1169
+
1170
+ ### Authorization
1171
+
1172
+ [bmltToken password](../README.md#bmltToken-password)
1173
+
1174
+ ### HTTP request headers
1175
+
1176
+ - **Content-Type**: Not defined
1177
+ - **Accept**: `application/json`
1178
+
1179
+
1180
+ ### HTTP response details
1181
+ | Status code | Description | Response headers |
1182
+ |-------------|-------------|------------------|
1183
+ | **200** | Returns when user is authenticated. | - |
1184
+ | **401** | Returns when user is not authenticated. | - |
1185
+ | **404** | Returns when no meeting exists. | - |
1186
+
1187
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1188
+
1189
+
1190
+ ## getMeetingChanges
1191
+
1192
+ > Array<MeetingChangeResource> getMeetingChanges(meetingId)
1193
+
1194
+ Retrieve changes for a meeting
1195
+
1196
+ Retrieve all changes made to a specific meeting.
1197
+
1198
+ ### Example
1199
+
1200
+ ```ts
1201
+ import {
1202
+ Configuration,
1203
+ RootServerApi,
1204
+ } from 'bmlt-server-client';
1205
+ import type { GetMeetingChangesRequest } from 'bmlt-server-client';
1206
+
1207
+ async function example() {
1208
+ console.log("🚀 Testing bmlt-server-client SDK...");
1209
+ const config = new Configuration({
1210
+ // To configure OAuth2 access token for authorization: bmltToken password
1211
+ accessToken: "YOUR ACCESS TOKEN",
1212
+ });
1213
+ const api = new RootServerApi(config);
1214
+
1215
+ const body = {
1216
+ // number | ID of the meeting
1217
+ meetingId: 1,
1218
+ } satisfies GetMeetingChangesRequest;
1219
+
1220
+ try {
1221
+ const data = await api.getMeetingChanges(body);
1222
+ console.log(data);
1223
+ } catch (error) {
1224
+ console.error(error);
1225
+ }
1226
+ }
1227
+
1228
+ // Run the test
1229
+ example().catch(console.error);
1230
+ ```
1231
+
1232
+ ### Parameters
1233
+
1234
+
1235
+ | Name | Type | Description | Notes |
1236
+ |------------- | ------------- | ------------- | -------------|
1237
+ | **meetingId** | `number` | ID of the meeting | [Defaults to `undefined`] |
1238
+
1239
+ ### Return type
1240
+
1241
+ [**Array<MeetingChangeResource>**](MeetingChangeResource.md)
1242
+
1243
+ ### Authorization
1244
+
1245
+ [bmltToken password](../README.md#bmltToken-password)
1246
+
1247
+ ### HTTP request headers
1248
+
1249
+ - **Content-Type**: Not defined
1250
+ - **Accept**: `application/json`
1251
+
1252
+
1253
+ ### HTTP response details
1254
+ | Status code | Description | Response headers |
1255
+ |-------------|-------------|------------------|
1256
+ | **200** | List of changes for the meeting. | - |
1257
+ | **401** | Unauthorized. | - |
1258
+ | **403** | Returns when unauthorized | - |
1259
+ | **404** | Meeting not found. | - |
1260
+
1261
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1262
+
1263
+
1264
+ ## getMeetings
1265
+
1266
+ > Array<Meeting> getMeetings(meetingIds, days, serviceBodyIds, searchString)
1267
+
1268
+ Retrieves meetings
1269
+
1270
+ Retrieve meetings for authenticated user.
1271
+
1272
+ ### Example
1273
+
1274
+ ```ts
1275
+ import {
1276
+ Configuration,
1277
+ RootServerApi,
1278
+ } from 'bmlt-server-client';
1279
+ import type { GetMeetingsRequest } from 'bmlt-server-client';
1280
+
1281
+ async function example() {
1282
+ console.log("🚀 Testing bmlt-server-client SDK...");
1283
+ const config = new Configuration({
1284
+ // To configure OAuth2 access token for authorization: bmltToken password
1285
+ accessToken: "YOUR ACCESS TOKEN",
1286
+ });
1287
+ const api = new RootServerApi(config);
1288
+
1289
+ const body = {
1290
+ // string | comma delimited meeting ids (optional)
1291
+ meetingIds: 1,2,
1292
+ // string | comma delimited day ids between 0-6 (optional)
1293
+ days: 0,1,
1294
+ // string | comma delimited service body ids (optional)
1295
+ serviceBodyIds: 3,4,
1296
+ // string | string (optional)
1297
+ searchString: Just for Today,
1298
+ } satisfies GetMeetingsRequest;
1299
+
1300
+ try {
1301
+ const data = await api.getMeetings(body);
1302
+ console.log(data);
1303
+ } catch (error) {
1304
+ console.error(error);
1305
+ }
1306
+ }
1307
+
1308
+ // Run the test
1309
+ example().catch(console.error);
1310
+ ```
1311
+
1312
+ ### Parameters
1313
+
1314
+
1315
+ | Name | Type | Description | Notes |
1316
+ |------------- | ------------- | ------------- | -------------|
1317
+ | **meetingIds** | `string` | comma delimited meeting ids | [Optional] [Defaults to `undefined`] |
1318
+ | **days** | `string` | comma delimited day ids between 0-6 | [Optional] [Defaults to `undefined`] |
1319
+ | **serviceBodyIds** | `string` | comma delimited service body ids | [Optional] [Defaults to `undefined`] |
1320
+ | **searchString** | `string` | string | [Optional] [Defaults to `undefined`] |
1321
+
1322
+ ### Return type
1323
+
1324
+ [**Array<Meeting>**](Meeting.md)
1325
+
1326
+ ### Authorization
1327
+
1328
+ [bmltToken password](../README.md#bmltToken-password)
1329
+
1330
+ ### HTTP request headers
1331
+
1332
+ - **Content-Type**: Not defined
1333
+ - **Accept**: `application/json`
1334
+
1335
+
1336
+ ### HTTP response details
1337
+ | Status code | Description | Response headers |
1338
+ |-------------|-------------|------------------|
1339
+ | **200** | List of meetings. | - |
1340
+ | **401** | Returns when user is not authenticated. | - |
1341
+ | **422** | Validation error. | - |
1342
+
1343
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1344
+
1345
+
1346
+ ## getRootServer
1347
+
1348
+ > RootServer getRootServer(rootServerId)
1349
+
1350
+ Retrieves a root server
1351
+
1352
+ Retrieve a single root server id.
1353
+
1354
+ ### Example
1355
+
1356
+ ```ts
1357
+ import {
1358
+ Configuration,
1359
+ RootServerApi,
1360
+ } from 'bmlt-server-client';
1361
+ import type { GetRootServerRequest } from 'bmlt-server-client';
1362
+
1363
+ async function example() {
1364
+ console.log("🚀 Testing bmlt-server-client SDK...");
1365
+ const api = new RootServerApi();
1366
+
1367
+ const body = {
1368
+ // number | ID of root server
1369
+ rootServerId: 1,
1370
+ } satisfies GetRootServerRequest;
1371
+
1372
+ try {
1373
+ const data = await api.getRootServer(body);
1374
+ console.log(data);
1375
+ } catch (error) {
1376
+ console.error(error);
1377
+ }
1378
+ }
1379
+
1380
+ // Run the test
1381
+ example().catch(console.error);
1382
+ ```
1383
+
1384
+ ### Parameters
1385
+
1386
+
1387
+ | Name | Type | Description | Notes |
1388
+ |------------- | ------------- | ------------- | -------------|
1389
+ | **rootServerId** | `number` | ID of root server | [Defaults to `undefined`] |
1390
+
1391
+ ### Return type
1392
+
1393
+ [**RootServer**](RootServer.md)
1394
+
1395
+ ### Authorization
1396
+
1397
+ No authorization required
1398
+
1399
+ ### HTTP request headers
1400
+
1401
+ - **Content-Type**: Not defined
1402
+ - **Accept**: `application/json`
1403
+
1404
+
1405
+ ### HTTP response details
1406
+ | Status code | Description | Response headers |
1407
+ |-------------|-------------|------------------|
1408
+ | **200** | Successful response. | - |
1409
+ | **404** | Returns when no root server exists. | - |
1410
+
1411
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1412
+
1413
+
1414
+ ## getRootServers
1415
+
1416
+ > Array<RootServer> getRootServers()
1417
+
1418
+ Retrieves root servers
1419
+
1420
+ Retrieve root servers.
1421
+
1422
+ ### Example
1423
+
1424
+ ```ts
1425
+ import {
1426
+ Configuration,
1427
+ RootServerApi,
1428
+ } from 'bmlt-server-client';
1429
+ import type { GetRootServersRequest } from 'bmlt-server-client';
1430
+
1431
+ async function example() {
1432
+ console.log("🚀 Testing bmlt-server-client SDK...");
1433
+ const api = new RootServerApi();
1434
+
1435
+ try {
1436
+ const data = await api.getRootServers();
1437
+ console.log(data);
1438
+ } catch (error) {
1439
+ console.error(error);
1440
+ }
1441
+ }
1442
+
1443
+ // Run the test
1444
+ example().catch(console.error);
1445
+ ```
1446
+
1447
+ ### Parameters
1448
+
1449
+ This endpoint does not need any parameter.
1450
+
1451
+ ### Return type
1452
+
1453
+ [**Array<RootServer>**](RootServer.md)
1454
+
1455
+ ### Authorization
1456
+
1457
+ No authorization required
1458
+
1459
+ ### HTTP request headers
1460
+
1461
+ - **Content-Type**: Not defined
1462
+ - **Accept**: `application/json`
1463
+
1464
+
1465
+ ### HTTP response details
1466
+ | Status code | Description | Response headers |
1467
+ |-------------|-------------|------------------|
1468
+ | **200** | Successful response. | - |
1469
+ | **404** | Returns when aggregator mode is disabled. | - |
1470
+
1471
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1472
+
1473
+
1474
+ ## getServiceBodies
1475
+
1476
+ > Array<ServiceBody> getServiceBodies()
1477
+
1478
+ Retrieves service bodies
1479
+
1480
+ Retrieve service bodies for authenticated user.
1481
+
1482
+ ### Example
1483
+
1484
+ ```ts
1485
+ import {
1486
+ Configuration,
1487
+ RootServerApi,
1488
+ } from 'bmlt-server-client';
1489
+ import type { GetServiceBodiesRequest } from 'bmlt-server-client';
1490
+
1491
+ async function example() {
1492
+ console.log("🚀 Testing bmlt-server-client SDK...");
1493
+ const config = new Configuration({
1494
+ // To configure OAuth2 access token for authorization: bmltToken password
1495
+ accessToken: "YOUR ACCESS TOKEN",
1496
+ });
1497
+ const api = new RootServerApi(config);
1498
+
1499
+ try {
1500
+ const data = await api.getServiceBodies();
1501
+ console.log(data);
1502
+ } catch (error) {
1503
+ console.error(error);
1504
+ }
1505
+ }
1506
+
1507
+ // Run the test
1508
+ example().catch(console.error);
1509
+ ```
1510
+
1511
+ ### Parameters
1512
+
1513
+ This endpoint does not need any parameter.
1514
+
1515
+ ### Return type
1516
+
1517
+ [**Array<ServiceBody>**](ServiceBody.md)
1518
+
1519
+ ### Authorization
1520
+
1521
+ [bmltToken password](../README.md#bmltToken-password)
1522
+
1523
+ ### HTTP request headers
1524
+
1525
+ - **Content-Type**: Not defined
1526
+ - **Accept**: `application/json`
1527
+
1528
+
1529
+ ### HTTP response details
1530
+ | Status code | Description | Response headers |
1531
+ |-------------|-------------|------------------|
1532
+ | **200** | Returns when user is authenticated. | - |
1533
+ | **401** | Returns when not authenticated. | - |
1534
+
1535
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1536
+
1537
+
1538
+ ## getServiceBody
1539
+
1540
+ > ServiceBody getServiceBody(serviceBodyId)
1541
+
1542
+ Retrieves a service body
1543
+
1544
+ Retrieve a single service body by id.
1545
+
1546
+ ### Example
1547
+
1548
+ ```ts
1549
+ import {
1550
+ Configuration,
1551
+ RootServerApi,
1552
+ } from 'bmlt-server-client';
1553
+ import type { GetServiceBodyRequest } from 'bmlt-server-client';
1554
+
1555
+ async function example() {
1556
+ console.log("🚀 Testing bmlt-server-client SDK...");
1557
+ const config = new Configuration({
1558
+ // To configure OAuth2 access token for authorization: bmltToken password
1559
+ accessToken: "YOUR ACCESS TOKEN",
1560
+ });
1561
+ const api = new RootServerApi(config);
1562
+
1563
+ const body = {
1564
+ // number | ID of service body
1565
+ serviceBodyId: 1,
1566
+ } satisfies GetServiceBodyRequest;
1567
+
1568
+ try {
1569
+ const data = await api.getServiceBody(body);
1570
+ console.log(data);
1571
+ } catch (error) {
1572
+ console.error(error);
1573
+ }
1574
+ }
1575
+
1576
+ // Run the test
1577
+ example().catch(console.error);
1578
+ ```
1579
+
1580
+ ### Parameters
1581
+
1582
+
1583
+ | Name | Type | Description | Notes |
1584
+ |------------- | ------------- | ------------- | -------------|
1585
+ | **serviceBodyId** | `number` | ID of service body | [Defaults to `undefined`] |
1586
+
1587
+ ### Return type
1588
+
1589
+ [**ServiceBody**](ServiceBody.md)
1590
+
1591
+ ### Authorization
1592
+
1593
+ [bmltToken password](../README.md#bmltToken-password)
1594
+
1595
+ ### HTTP request headers
1596
+
1597
+ - **Content-Type**: Not defined
1598
+ - **Accept**: `application/json`
1599
+
1600
+
1601
+ ### HTTP response details
1602
+ | Status code | Description | Response headers |
1603
+ |-------------|-------------|------------------|
1604
+ | **200** | Returns when user is authenticated. | - |
1605
+ | **401** | Returns when user is not authenticated. | - |
1606
+ | **404** | Returns when no service body exists. | - |
1607
+
1608
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1609
+
1610
+
1611
+ ## getUser
1612
+
1613
+ > User getUser(userId)
1614
+
1615
+ Retrieves a single user
1616
+
1617
+ Retrieve single user.
1618
+
1619
+ ### Example
1620
+
1621
+ ```ts
1622
+ import {
1623
+ Configuration,
1624
+ RootServerApi,
1625
+ } from 'bmlt-server-client';
1626
+ import type { GetUserRequest } from 'bmlt-server-client';
1627
+
1628
+ async function example() {
1629
+ console.log("🚀 Testing bmlt-server-client SDK...");
1630
+ const config = new Configuration({
1631
+ // To configure OAuth2 access token for authorization: bmltToken password
1632
+ accessToken: "YOUR ACCESS TOKEN",
1633
+ });
1634
+ const api = new RootServerApi(config);
1635
+
1636
+ const body = {
1637
+ // number | ID of user
1638
+ userId: 1,
1639
+ } satisfies GetUserRequest;
1640
+
1641
+ try {
1642
+ const data = await api.getUser(body);
1643
+ console.log(data);
1644
+ } catch (error) {
1645
+ console.error(error);
1646
+ }
1647
+ }
1648
+
1649
+ // Run the test
1650
+ example().catch(console.error);
1651
+ ```
1652
+
1653
+ ### Parameters
1654
+
1655
+
1656
+ | Name | Type | Description | Notes |
1657
+ |------------- | ------------- | ------------- | -------------|
1658
+ | **userId** | `number` | ID of user | [Defaults to `undefined`] |
1659
+
1660
+ ### Return type
1661
+
1662
+ [**User**](User.md)
1663
+
1664
+ ### Authorization
1665
+
1666
+ [bmltToken password](../README.md#bmltToken-password)
1667
+
1668
+ ### HTTP request headers
1669
+
1670
+ - **Content-Type**: Not defined
1671
+ - **Accept**: `application/json`
1672
+
1673
+
1674
+ ### HTTP response details
1675
+ | Status code | Description | Response headers |
1676
+ |-------------|-------------|------------------|
1677
+ | **200** | Returns when user is authenticated. | - |
1678
+ | **401** | Returns when not authenticated. | - |
1679
+ | **404** | Returns when no user exists. | - |
1680
+
1681
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1682
+
1683
+
1684
+ ## getUsers
1685
+
1686
+ > Array<User> getUsers()
1687
+
1688
+ Retrieves users
1689
+
1690
+ Retrieve users for authenticated user.
1691
+
1692
+ ### Example
1693
+
1694
+ ```ts
1695
+ import {
1696
+ Configuration,
1697
+ RootServerApi,
1698
+ } from 'bmlt-server-client';
1699
+ import type { GetUsersRequest } from 'bmlt-server-client';
1700
+
1701
+ async function example() {
1702
+ console.log("🚀 Testing bmlt-server-client SDK...");
1703
+ const config = new Configuration({
1704
+ // To configure OAuth2 access token for authorization: bmltToken password
1705
+ accessToken: "YOUR ACCESS TOKEN",
1706
+ });
1707
+ const api = new RootServerApi(config);
1708
+
1709
+ try {
1710
+ const data = await api.getUsers();
1711
+ console.log(data);
1712
+ } catch (error) {
1713
+ console.error(error);
1714
+ }
1715
+ }
1716
+
1717
+ // Run the test
1718
+ example().catch(console.error);
1719
+ ```
1720
+
1721
+ ### Parameters
1722
+
1723
+ This endpoint does not need any parameter.
1724
+
1725
+ ### Return type
1726
+
1727
+ [**Array<User>**](User.md)
1728
+
1729
+ ### Authorization
1730
+
1731
+ [bmltToken password](../README.md#bmltToken-password)
1732
+
1733
+ ### HTTP request headers
1734
+
1735
+ - **Content-Type**: Not defined
1736
+ - **Accept**: `application/json`
1737
+
1738
+
1739
+ ### HTTP response details
1740
+ | Status code | Description | Response headers |
1741
+ |-------------|-------------|------------------|
1742
+ | **200** | Returns when user is authenticated. | - |
1743
+ | **401** | Returns when not authenticated | - |
1744
+
1745
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1746
+
1747
+
1748
+ ## partialUpdateUser
1749
+
1750
+ > partialUpdateUser(userId, userPartialUpdate)
1751
+
1752
+ Patches a user
1753
+
1754
+ Patches a user by id.
1755
+
1756
+ ### Example
1757
+
1758
+ ```ts
1759
+ import {
1760
+ Configuration,
1761
+ RootServerApi,
1762
+ } from 'bmlt-server-client';
1763
+ import type { PartialUpdateUserRequest } from 'bmlt-server-client';
1764
+
1765
+ async function example() {
1766
+ console.log("🚀 Testing bmlt-server-client SDK...");
1767
+ const config = new Configuration({
1768
+ // To configure OAuth2 access token for authorization: bmltToken password
1769
+ accessToken: "YOUR ACCESS TOKEN",
1770
+ });
1771
+ const api = new RootServerApi(config);
1772
+
1773
+ const body = {
1774
+ // number | ID of user
1775
+ userId: 1,
1776
+ // UserPartialUpdate | Pass in fields you want to update.
1777
+ userPartialUpdate: ...,
1778
+ } satisfies PartialUpdateUserRequest;
1779
+
1780
+ try {
1781
+ const data = await api.partialUpdateUser(body);
1782
+ console.log(data);
1783
+ } catch (error) {
1784
+ console.error(error);
1785
+ }
1786
+ }
1787
+
1788
+ // Run the test
1789
+ example().catch(console.error);
1790
+ ```
1791
+
1792
+ ### Parameters
1793
+
1794
+
1795
+ | Name | Type | Description | Notes |
1796
+ |------------- | ------------- | ------------- | -------------|
1797
+ | **userId** | `number` | ID of user | [Defaults to `undefined`] |
1798
+ | **userPartialUpdate** | [UserPartialUpdate](UserPartialUpdate.md) | Pass in fields you want to update. | |
1799
+
1800
+ ### Return type
1801
+
1802
+ `void` (Empty response body)
1803
+
1804
+ ### Authorization
1805
+
1806
+ [bmltToken password](../README.md#bmltToken-password)
1807
+
1808
+ ### HTTP request headers
1809
+
1810
+ - **Content-Type**: `application/json`
1811
+ - **Accept**: `application/json`
1812
+
1813
+
1814
+ ### HTTP response details
1815
+ | Status code | Description | Response headers |
1816
+ |-------------|-------------|------------------|
1817
+ | **204** | Success. | - |
1818
+ | **401** | Returns when not authenticated | - |
1819
+ | **403** | Returns when unauthorized | - |
1820
+ | **404** | Returns when no user exists. | - |
1821
+ | **422** | Validation error. | - |
1822
+
1823
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1824
+
1825
+
1826
+ ## patchFormat
1827
+
1828
+ > patchFormat(formatId, formatPartialUpdate)
1829
+
1830
+ Patches a format
1831
+
1832
+ Patches a single format by id.
1833
+
1834
+ ### Example
1835
+
1836
+ ```ts
1837
+ import {
1838
+ Configuration,
1839
+ RootServerApi,
1840
+ } from 'bmlt-server-client';
1841
+ import type { PatchFormatRequest } from 'bmlt-server-client';
1842
+
1843
+ async function example() {
1844
+ console.log("🚀 Testing bmlt-server-client SDK...");
1845
+ const config = new Configuration({
1846
+ // To configure OAuth2 access token for authorization: bmltToken password
1847
+ accessToken: "YOUR ACCESS TOKEN",
1848
+ });
1849
+ const api = new RootServerApi(config);
1850
+
1851
+ const body = {
1852
+ // number | ID of format
1853
+ formatId: 1,
1854
+ // FormatPartialUpdate | Pass in fields you want to update.
1855
+ formatPartialUpdate: ...,
1856
+ } satisfies PatchFormatRequest;
1857
+
1858
+ try {
1859
+ const data = await api.patchFormat(body);
1860
+ console.log(data);
1861
+ } catch (error) {
1862
+ console.error(error);
1863
+ }
1864
+ }
1865
+
1866
+ // Run the test
1867
+ example().catch(console.error);
1868
+ ```
1869
+
1870
+ ### Parameters
1871
+
1872
+
1873
+ | Name | Type | Description | Notes |
1874
+ |------------- | ------------- | ------------- | -------------|
1875
+ | **formatId** | `number` | ID of format | [Defaults to `undefined`] |
1876
+ | **formatPartialUpdate** | [FormatPartialUpdate](FormatPartialUpdate.md) | Pass in fields you want to update. | |
1877
+
1878
+ ### Return type
1879
+
1880
+ `void` (Empty response body)
1881
+
1882
+ ### Authorization
1883
+
1884
+ [bmltToken password](../README.md#bmltToken-password)
1885
+
1886
+ ### HTTP request headers
1887
+
1888
+ - **Content-Type**: `application/json`
1889
+ - **Accept**: `application/json`
1890
+
1891
+
1892
+ ### HTTP response details
1893
+ | Status code | Description | Response headers |
1894
+ |-------------|-------------|------------------|
1895
+ | **204** | Success. | - |
1896
+ | **401** | Returns when not authenticated | - |
1897
+ | **403** | Returns when unauthorized | - |
1898
+ | **404** | Returns when no format exists. | - |
1899
+ | **422** | Validation error. | - |
1900
+
1901
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1902
+
1903
+
1904
+ ## patchMeeting
1905
+
1906
+ > patchMeeting(meetingId, meetingPartialUpdate, skipVenueTypeLocationValidation)
1907
+
1908
+ Patches a meeting
1909
+
1910
+ Patches a meeting by id
1911
+
1912
+ ### Example
1913
+
1914
+ ```ts
1915
+ import {
1916
+ Configuration,
1917
+ RootServerApi,
1918
+ } from 'bmlt-server-client';
1919
+ import type { PatchMeetingRequest } from 'bmlt-server-client';
1920
+
1921
+ async function example() {
1922
+ console.log("🚀 Testing bmlt-server-client SDK...");
1923
+ const config = new Configuration({
1924
+ // To configure OAuth2 access token for authorization: bmltToken password
1925
+ accessToken: "YOUR ACCESS TOKEN",
1926
+ });
1927
+ const api = new RootServerApi(config);
1928
+
1929
+ const body = {
1930
+ // number | ID of meeting
1931
+ meetingId: 1,
1932
+ // MeetingPartialUpdate | Pass in fields you want to update.
1933
+ meetingPartialUpdate: ...,
1934
+ // boolean | specify true to skip venue type location validation (optional)
1935
+ skipVenueTypeLocationValidation: true,
1936
+ } satisfies PatchMeetingRequest;
1937
+
1938
+ try {
1939
+ const data = await api.patchMeeting(body);
1940
+ console.log(data);
1941
+ } catch (error) {
1942
+ console.error(error);
1943
+ }
1944
+ }
1945
+
1946
+ // Run the test
1947
+ example().catch(console.error);
1948
+ ```
1949
+
1950
+ ### Parameters
1951
+
1952
+
1953
+ | Name | Type | Description | Notes |
1954
+ |------------- | ------------- | ------------- | -------------|
1955
+ | **meetingId** | `number` | ID of meeting | [Defaults to `undefined`] |
1956
+ | **meetingPartialUpdate** | [MeetingPartialUpdate](MeetingPartialUpdate.md) | Pass in fields you want to update. | |
1957
+ | **skipVenueTypeLocationValidation** | `boolean` | specify true to skip venue type location validation | [Optional] [Defaults to `undefined`] |
1958
+
1959
+ ### Return type
1960
+
1961
+ `void` (Empty response body)
1962
+
1963
+ ### Authorization
1964
+
1965
+ [bmltToken password](../README.md#bmltToken-password)
1966
+
1967
+ ### HTTP request headers
1968
+
1969
+ - **Content-Type**: `application/json`
1970
+ - **Accept**: `application/json`
1971
+
1972
+
1973
+ ### HTTP response details
1974
+ | Status code | Description | Response headers |
1975
+ |-------------|-------------|------------------|
1976
+ | **204** | Success. | - |
1977
+ | **401** | Returns when user is not authenticated. | - |
1978
+ | **403** | Returns when user is unauthorized to perform action. | - |
1979
+ | **404** | Returns when no meeting exists. | - |
1980
+ | **422** | Validation error. | - |
1981
+
1982
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1983
+
1984
+
1985
+ ## patchServiceBody
1986
+
1987
+ > patchServiceBody(serviceBodyId, serviceBodyPartialUpdate)
1988
+
1989
+ Patches a service body
1990
+
1991
+ Patches a single service body by id.
1992
+
1993
+ ### Example
1994
+
1995
+ ```ts
1996
+ import {
1997
+ Configuration,
1998
+ RootServerApi,
1999
+ } from 'bmlt-server-client';
2000
+ import type { PatchServiceBodyRequest } from 'bmlt-server-client';
2001
+
2002
+ async function example() {
2003
+ console.log("🚀 Testing bmlt-server-client SDK...");
2004
+ const config = new Configuration({
2005
+ // To configure OAuth2 access token for authorization: bmltToken password
2006
+ accessToken: "YOUR ACCESS TOKEN",
2007
+ });
2008
+ const api = new RootServerApi(config);
2009
+
2010
+ const body = {
2011
+ // number | ID of service body
2012
+ serviceBodyId: 1,
2013
+ // ServiceBodyPartialUpdate | Pass in fields you want to update.
2014
+ serviceBodyPartialUpdate: ...,
2015
+ } satisfies PatchServiceBodyRequest;
2016
+
2017
+ try {
2018
+ const data = await api.patchServiceBody(body);
2019
+ console.log(data);
2020
+ } catch (error) {
2021
+ console.error(error);
2022
+ }
2023
+ }
2024
+
2025
+ // Run the test
2026
+ example().catch(console.error);
2027
+ ```
2028
+
2029
+ ### Parameters
2030
+
2031
+
2032
+ | Name | Type | Description | Notes |
2033
+ |------------- | ------------- | ------------- | -------------|
2034
+ | **serviceBodyId** | `number` | ID of service body | [Defaults to `undefined`] |
2035
+ | **serviceBodyPartialUpdate** | [ServiceBodyPartialUpdate](ServiceBodyPartialUpdate.md) | Pass in fields you want to update. | |
2036
+
2037
+ ### Return type
2038
+
2039
+ `void` (Empty response body)
2040
+
2041
+ ### Authorization
2042
+
2043
+ [bmltToken password](../README.md#bmltToken-password)
2044
+
2045
+ ### HTTP request headers
2046
+
2047
+ - **Content-Type**: `application/json`
2048
+ - **Accept**: `application/json`
2049
+
2050
+
2051
+ ### HTTP response details
2052
+ | Status code | Description | Response headers |
2053
+ |-------------|-------------|------------------|
2054
+ | **204** | Success. | - |
2055
+ | **401** | Returns when user is not authenticated. | - |
2056
+ | **403** | Returns when user is unauthorized to perform action. | - |
2057
+ | **404** | Returns when no service body exists. | - |
2058
+ | **422** | Validation error. | - |
2059
+
2060
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2061
+
2062
+
2063
+ ## updateFormat
2064
+
2065
+ > updateFormat(formatId, formatUpdate)
2066
+
2067
+ Updates a format
2068
+
2069
+ Updates a format.
2070
+
2071
+ ### Example
2072
+
2073
+ ```ts
2074
+ import {
2075
+ Configuration,
2076
+ RootServerApi,
2077
+ } from 'bmlt-server-client';
2078
+ import type { UpdateFormatRequest } from 'bmlt-server-client';
2079
+
2080
+ async function example() {
2081
+ console.log("🚀 Testing bmlt-server-client SDK...");
2082
+ const config = new Configuration({
2083
+ // To configure OAuth2 access token for authorization: bmltToken password
2084
+ accessToken: "YOUR ACCESS TOKEN",
2085
+ });
2086
+ const api = new RootServerApi(config);
2087
+
2088
+ const body = {
2089
+ // number | ID of format
2090
+ formatId: 1,
2091
+ // FormatUpdate | Pass in format object
2092
+ formatUpdate: ...,
2093
+ } satisfies UpdateFormatRequest;
2094
+
2095
+ try {
2096
+ const data = await api.updateFormat(body);
2097
+ console.log(data);
2098
+ } catch (error) {
2099
+ console.error(error);
2100
+ }
2101
+ }
2102
+
2103
+ // Run the test
2104
+ example().catch(console.error);
2105
+ ```
2106
+
2107
+ ### Parameters
2108
+
2109
+
2110
+ | Name | Type | Description | Notes |
2111
+ |------------- | ------------- | ------------- | -------------|
2112
+ | **formatId** | `number` | ID of format | [Defaults to `undefined`] |
2113
+ | **formatUpdate** | [FormatUpdate](FormatUpdate.md) | Pass in format object | |
2114
+
2115
+ ### Return type
2116
+
2117
+ `void` (Empty response body)
2118
+
2119
+ ### Authorization
2120
+
2121
+ [bmltToken password](../README.md#bmltToken-password)
2122
+
2123
+ ### HTTP request headers
2124
+
2125
+ - **Content-Type**: `application/json`
2126
+ - **Accept**: `application/json`
2127
+
2128
+
2129
+ ### HTTP response details
2130
+ | Status code | Description | Response headers |
2131
+ |-------------|-------------|------------------|
2132
+ | **204** | Success. | - |
2133
+ | **401** | Returns when user is not authenticated. | - |
2134
+ | **403** | Returns when user is unauthorized to perform action. | - |
2135
+ | **404** | Returns when no format exists. | - |
2136
+ | **422** | Validation error. | - |
2137
+
2138
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2139
+
2140
+
2141
+ ## updateMeeting
2142
+
2143
+ > updateMeeting(meetingId, meetingUpdate)
2144
+
2145
+ Updates a meeting
2146
+
2147
+ Updates a meeting.
2148
+
2149
+ ### Example
2150
+
2151
+ ```ts
2152
+ import {
2153
+ Configuration,
2154
+ RootServerApi,
2155
+ } from 'bmlt-server-client';
2156
+ import type { UpdateMeetingRequest } from 'bmlt-server-client';
2157
+
2158
+ async function example() {
2159
+ console.log("🚀 Testing bmlt-server-client SDK...");
2160
+ const config = new Configuration({
2161
+ // To configure OAuth2 access token for authorization: bmltToken password
2162
+ accessToken: "YOUR ACCESS TOKEN",
2163
+ });
2164
+ const api = new RootServerApi(config);
2165
+
2166
+ const body = {
2167
+ // number | ID of meeting
2168
+ meetingId: 1,
2169
+ // MeetingUpdate | Pass in meeting object
2170
+ meetingUpdate: ...,
2171
+ } satisfies UpdateMeetingRequest;
2172
+
2173
+ try {
2174
+ const data = await api.updateMeeting(body);
2175
+ console.log(data);
2176
+ } catch (error) {
2177
+ console.error(error);
2178
+ }
2179
+ }
2180
+
2181
+ // Run the test
2182
+ example().catch(console.error);
2183
+ ```
2184
+
2185
+ ### Parameters
2186
+
2187
+
2188
+ | Name | Type | Description | Notes |
2189
+ |------------- | ------------- | ------------- | -------------|
2190
+ | **meetingId** | `number` | ID of meeting | [Defaults to `undefined`] |
2191
+ | **meetingUpdate** | [MeetingUpdate](MeetingUpdate.md) | Pass in meeting object | |
2192
+
2193
+ ### Return type
2194
+
2195
+ `void` (Empty response body)
2196
+
2197
+ ### Authorization
2198
+
2199
+ [bmltToken password](../README.md#bmltToken-password)
2200
+
2201
+ ### HTTP request headers
2202
+
2203
+ - **Content-Type**: `application/json`
2204
+ - **Accept**: `application/json`
2205
+
2206
+
2207
+ ### HTTP response details
2208
+ | Status code | Description | Response headers |
2209
+ |-------------|-------------|------------------|
2210
+ | **204** | Success. | - |
2211
+ | **401** | Returns when user is not authenticated. | - |
2212
+ | **403** | Returns when user is unauthorized to perform action. | - |
2213
+ | **404** | Returns when no meeting exists. | - |
2214
+ | **422** | Validation error. | - |
2215
+
2216
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2217
+
2218
+
2219
+ ## updateServiceBody
2220
+
2221
+ > updateServiceBody(serviceBodyId, serviceBodyUpdate)
2222
+
2223
+ Updates a Service Body
2224
+
2225
+ Updates a single service body.
2226
+
2227
+ ### Example
2228
+
2229
+ ```ts
2230
+ import {
2231
+ Configuration,
2232
+ RootServerApi,
2233
+ } from 'bmlt-server-client';
2234
+ import type { UpdateServiceBodyRequest } from 'bmlt-server-client';
2235
+
2236
+ async function example() {
2237
+ console.log("🚀 Testing bmlt-server-client SDK...");
2238
+ const config = new Configuration({
2239
+ // To configure OAuth2 access token for authorization: bmltToken password
2240
+ accessToken: "YOUR ACCESS TOKEN",
2241
+ });
2242
+ const api = new RootServerApi(config);
2243
+
2244
+ const body = {
2245
+ // number | ID of service body
2246
+ serviceBodyId: 1,
2247
+ // ServiceBodyUpdate | Pass in service body object
2248
+ serviceBodyUpdate: ...,
2249
+ } satisfies UpdateServiceBodyRequest;
2250
+
2251
+ try {
2252
+ const data = await api.updateServiceBody(body);
2253
+ console.log(data);
2254
+ } catch (error) {
2255
+ console.error(error);
2256
+ }
2257
+ }
2258
+
2259
+ // Run the test
2260
+ example().catch(console.error);
2261
+ ```
2262
+
2263
+ ### Parameters
2264
+
2265
+
2266
+ | Name | Type | Description | Notes |
2267
+ |------------- | ------------- | ------------- | -------------|
2268
+ | **serviceBodyId** | `number` | ID of service body | [Defaults to `undefined`] |
2269
+ | **serviceBodyUpdate** | [ServiceBodyUpdate](ServiceBodyUpdate.md) | Pass in service body object | |
2270
+
2271
+ ### Return type
2272
+
2273
+ `void` (Empty response body)
2274
+
2275
+ ### Authorization
2276
+
2277
+ [bmltToken password](../README.md#bmltToken-password)
2278
+
2279
+ ### HTTP request headers
2280
+
2281
+ - **Content-Type**: `application/json`
2282
+ - **Accept**: `application/json`
2283
+
2284
+
2285
+ ### HTTP response details
2286
+ | Status code | Description | Response headers |
2287
+ |-------------|-------------|------------------|
2288
+ | **204** | Success. | - |
2289
+ | **401** | Returns when user is not authenticated. | - |
2290
+ | **403** | Returns when user is unauthorized to perform action. | - |
2291
+ | **404** | Returns when no service body exists. | - |
2292
+ | **422** | Validation error. | - |
2293
+
2294
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2295
+
2296
+
2297
+ ## updateUser
2298
+
2299
+ > updateUser(userId, userUpdate)
2300
+
2301
+ Update single user
2302
+
2303
+ Updates a user.
2304
+
2305
+ ### Example
2306
+
2307
+ ```ts
2308
+ import {
2309
+ Configuration,
2310
+ RootServerApi,
2311
+ } from 'bmlt-server-client';
2312
+ import type { UpdateUserRequest } from 'bmlt-server-client';
2313
+
2314
+ async function example() {
2315
+ console.log("🚀 Testing bmlt-server-client SDK...");
2316
+ const config = new Configuration({
2317
+ // To configure OAuth2 access token for authorization: bmltToken password
2318
+ accessToken: "YOUR ACCESS TOKEN",
2319
+ });
2320
+ const api = new RootServerApi(config);
2321
+
2322
+ const body = {
2323
+ // number | ID of user
2324
+ userId: 1,
2325
+ // UserUpdate | Pass in user object
2326
+ userUpdate: ...,
2327
+ } satisfies UpdateUserRequest;
2328
+
2329
+ try {
2330
+ const data = await api.updateUser(body);
2331
+ console.log(data);
2332
+ } catch (error) {
2333
+ console.error(error);
2334
+ }
2335
+ }
2336
+
2337
+ // Run the test
2338
+ example().catch(console.error);
2339
+ ```
2340
+
2341
+ ### Parameters
2342
+
2343
+
2344
+ | Name | Type | Description | Notes |
2345
+ |------------- | ------------- | ------------- | -------------|
2346
+ | **userId** | `number` | ID of user | [Defaults to `undefined`] |
2347
+ | **userUpdate** | [UserUpdate](UserUpdate.md) | Pass in user object | |
2348
+
2349
+ ### Return type
2350
+
2351
+ `void` (Empty response body)
2352
+
2353
+ ### Authorization
2354
+
2355
+ [bmltToken password](../README.md#bmltToken-password)
2356
+
2357
+ ### HTTP request headers
2358
+
2359
+ - **Content-Type**: `application/json`
2360
+ - **Accept**: `application/json`
2361
+
2362
+
2363
+ ### HTTP response details
2364
+ | Status code | Description | Response headers |
2365
+ |-------------|-------------|------------------|
2366
+ | **204** | Success. | - |
2367
+ | **401** | Returns when user is not authenticated. | - |
2368
+ | **403** | Returns when user is unauthorized to perform action. | - |
2369
+ | **404** | Returns when no user exists. | - |
2370
+ | **422** | Validation error. | - |
2371
+
2372
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2373
+