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