@orangefox-recovery/foxinternalclient 5.2.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/.openapi-generator/FILES +63 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +155 -0
- package/api.ts +5275 -0
- package/base.ts +86 -0
- package/common.ts +150 -0
- package/configuration.ts +115 -0
- package/dist/api.d.ts +3508 -0
- package/dist/api.js +3078 -0
- package/dist/base.d.ts +66 -0
- package/dist/base.js +65 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +161 -0
- package/dist/configuration.d.ts +91 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +3508 -0
- package/dist/esm/api.js +3051 -0
- package/dist/esm/base.d.ts +66 -0
- package/dist/esm/base.js +60 -0
- package/dist/esm/common.d.ts +65 -0
- package/dist/esm/common.js +149 -0
- package/dist/esm/configuration.d.ts +91 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/docs/BodyChangePasswordProfileChangePasswordPost.md +22 -0
- package/docs/BuildStatusEnum.md +18 -0
- package/docs/BuildTaskResponse.md +36 -0
- package/docs/BuildTaskShortResponse.md +32 -0
- package/docs/DeviceApi.md +253 -0
- package/docs/DeviceInternalResponse.md +48 -0
- package/docs/DeviceResponse.md +44 -0
- package/docs/DeviceStatsResponse.md +24 -0
- package/docs/DeviceUpdateBody.md +30 -0
- package/docs/FFStatusEnum.md +12 -0
- package/docs/FFStatusResponse.md +20 -0
- package/docs/FoxFactoryApi.md +375 -0
- package/docs/GitlabApi.md +62 -0
- package/docs/GlobalStatsAggregationModel.md +26 -0
- package/docs/HTTPValidationError.md +20 -0
- package/docs/InternalApi.md +961 -0
- package/docs/ListResponseReleaseResponse.md +22 -0
- package/docs/ListResponseShortDeviceResponse.md +22 -0
- package/docs/ListResponseShortReleaseResponse.md +22 -0
- package/docs/ListResponseStr.md +22 -0
- package/docs/ListResponseUserShortResponse.md +22 -0
- package/docs/LogListResponse.md +26 -0
- package/docs/LogResponse.md +36 -0
- package/docs/MaintainerShortModel.md +26 -0
- package/docs/NewBuildTaskBody.md +28 -0
- package/docs/NewDeviceBody.md +26 -0
- package/docs/RecoveryImgResponse.md +22 -0
- package/docs/ReleaseApi.md +292 -0
- package/docs/ReleaseGroupsResponse.md +20 -0
- package/docs/ReleaseInternalResponse.md +62 -0
- package/docs/ReleaseInternalResponsePropValue.md +18 -0
- package/docs/ReleaseResponse.md +56 -0
- package/docs/ReleaseStatsResponse.md +24 -0
- package/docs/ReleaseType.md +12 -0
- package/docs/ReleaseUpdateBody.md +26 -0
- package/docs/ReleasesSort.md +10 -0
- package/docs/ResponseGetReleases.md +22 -0
- package/docs/ShortDeviceResponse.md +38 -0
- package/docs/ShortReleaseResponse.md +44 -0
- package/docs/StatsApi.md +53 -0
- package/docs/TaskUpdateBody.md +22 -0
- package/docs/TokenResponse.md +22 -0
- package/docs/UserGitlab.md +20 -0
- package/docs/UserInternalResponse.md +38 -0
- package/docs/UserMail.md +20 -0
- package/docs/UserShortResponse.md +26 -0
- package/docs/UserTelegram.md +20 -0
- package/docs/UserUpdateBody.md +28 -0
- package/docs/ValidationError.md +24 -0
- package/docs/ValidationErrorLocInner.md +18 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +41 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,961 @@
|
|
|
1
|
+
# InternalApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.orangefox.download*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**changePasswordProfileChangePasswordPost**](#changepasswordprofilechangepasswordpost) | **POST** /profile/change_password | Change Password|
|
|
8
|
+
|[**delReleaseInternalReleasesReleaseIdDelete**](#delreleaseinternalreleasesreleaseiddelete) | **DELETE** /internal/releases/{release_id} | Del Release|
|
|
9
|
+
|[**deleteUserInternalUsersUserIdDelete**](#deleteuserinternalusersuseriddelete) | **DELETE** /internal/users/{user_id} | Delete User|
|
|
10
|
+
|[**editReleaseInternalReleasesReleaseIdPut**](#editreleaseinternalreleasesreleaseidput) | **PUT** /internal/releases/{release_id} | Edit Release|
|
|
11
|
+
|[**getDeviceInfoInternalDevicesDeviceIdGet**](#getdeviceinfointernaldevicesdeviceidget) | **GET** /internal/devices/{device_id} | Get Device Info|
|
|
12
|
+
|[**getLogsInternalLogsGet**](#getlogsinternallogsget) | **GET** /internal/logs/ | Get Logs|
|
|
13
|
+
|[**getReleaseInfoInternalReleasesReleaseIdGet**](#getreleaseinfointernalreleasesreleaseidget) | **GET** /internal/releases/{release_id} | Get Release Info|
|
|
14
|
+
|[**getReleaseZipInternalReleasesReleaseIdDlGet**](#getreleasezipinternalreleasesreleaseiddlget) | **GET** /internal/releases/{release_id}/dl | Get Release Zip|
|
|
15
|
+
|[**getUserByIdInternalUsersUserIdGet**](#getuserbyidinternalusersuseridget) | **GET** /internal/users/{user_id} | Get User By Id|
|
|
16
|
+
|[**listUsersInternalUsersGet**](#listusersinternalusersget) | **GET** /internal/users/ | List Users|
|
|
17
|
+
|[**loginOauthAuthLoginPost**](#loginoauthauthloginpost) | **POST** /auth/login | Login Oauth|
|
|
18
|
+
|[**logoutAuthLogoutPost**](#logoutauthlogoutpost) | **POST** /auth/logout | Logout|
|
|
19
|
+
|[**newDeviceInternalDevicesPost**](#newdeviceinternaldevicespost) | **POST** /internal/devices/ | New Device|
|
|
20
|
+
|[**newReleaseInternalReleasesPost**](#newreleaseinternalreleasespost) | **POST** /internal/releases/ | New Release|
|
|
21
|
+
|[**renewAuthRenewPost**](#renewauthrenewpost) | **POST** /auth/renew | Renew|
|
|
22
|
+
|[**updateDeviceInternalDevicesDeviceIdPut**](#updatedeviceinternaldevicesdeviceidput) | **PUT** /internal/devices/{device_id} | Update Device|
|
|
23
|
+
|[**updateUserInternalUsersUserIdPut**](#updateuserinternalusersuseridput) | **PUT** /internal/users/{user_id} | Update User|
|
|
24
|
+
|
|
25
|
+
# **changePasswordProfileChangePasswordPost**
|
|
26
|
+
> boolean changePasswordProfileChangePasswordPost(bodyChangePasswordProfileChangePasswordPost)
|
|
27
|
+
|
|
28
|
+
Change the password for a user.
|
|
29
|
+
|
|
30
|
+
### Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import {
|
|
34
|
+
InternalApi,
|
|
35
|
+
Configuration,
|
|
36
|
+
BodyChangePasswordProfileChangePasswordPost
|
|
37
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
38
|
+
|
|
39
|
+
const configuration = new Configuration();
|
|
40
|
+
const apiInstance = new InternalApi(configuration);
|
|
41
|
+
|
|
42
|
+
let bodyChangePasswordProfileChangePasswordPost: BodyChangePasswordProfileChangePasswordPost; //
|
|
43
|
+
|
|
44
|
+
const { status, data } = await apiInstance.changePasswordProfileChangePasswordPost(
|
|
45
|
+
bodyChangePasswordProfileChangePasswordPost
|
|
46
|
+
);
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Parameters
|
|
50
|
+
|
|
51
|
+
|Name | Type | Description | Notes|
|
|
52
|
+
|------------- | ------------- | ------------- | -------------|
|
|
53
|
+
| **bodyChangePasswordProfileChangePasswordPost** | **BodyChangePasswordProfileChangePasswordPost**| | |
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### Return type
|
|
57
|
+
|
|
58
|
+
**boolean**
|
|
59
|
+
|
|
60
|
+
### Authorization
|
|
61
|
+
|
|
62
|
+
No authorization required
|
|
63
|
+
|
|
64
|
+
### HTTP request headers
|
|
65
|
+
|
|
66
|
+
- **Content-Type**: application/json
|
|
67
|
+
- **Accept**: application/json
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
### HTTP response details
|
|
71
|
+
| Status code | Description | Response headers |
|
|
72
|
+
|-------------|-------------|------------------|
|
|
73
|
+
|**200** | Successful Response | - |
|
|
74
|
+
|**422** | Validation Error | - |
|
|
75
|
+
|
|
76
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
77
|
+
|
|
78
|
+
# **delReleaseInternalReleasesReleaseIdDelete**
|
|
79
|
+
> boolean delReleaseInternalReleasesReleaseIdDelete()
|
|
80
|
+
|
|
81
|
+
Delete release
|
|
82
|
+
|
|
83
|
+
### Example
|
|
84
|
+
|
|
85
|
+
```typescript
|
|
86
|
+
import {
|
|
87
|
+
InternalApi,
|
|
88
|
+
Configuration
|
|
89
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
90
|
+
|
|
91
|
+
const configuration = new Configuration();
|
|
92
|
+
const apiInstance = new InternalApi(configuration);
|
|
93
|
+
|
|
94
|
+
let releaseId: any; // (default to undefined)
|
|
95
|
+
|
|
96
|
+
const { status, data } = await apiInstance.delReleaseInternalReleasesReleaseIdDelete(
|
|
97
|
+
releaseId
|
|
98
|
+
);
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Parameters
|
|
102
|
+
|
|
103
|
+
|Name | Type | Description | Notes|
|
|
104
|
+
|------------- | ------------- | ------------- | -------------|
|
|
105
|
+
| **releaseId** | **any** | | defaults to undefined|
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
**boolean**
|
|
111
|
+
|
|
112
|
+
### Authorization
|
|
113
|
+
|
|
114
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
115
|
+
|
|
116
|
+
### HTTP request headers
|
|
117
|
+
|
|
118
|
+
- **Content-Type**: Not defined
|
|
119
|
+
- **Accept**: application/json
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### HTTP response details
|
|
123
|
+
| Status code | Description | Response headers |
|
|
124
|
+
|-------------|-------------|------------------|
|
|
125
|
+
|**200** | Successful Response | - |
|
|
126
|
+
|**422** | Validation Error | - |
|
|
127
|
+
|
|
128
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
129
|
+
|
|
130
|
+
# **deleteUserInternalUsersUserIdDelete**
|
|
131
|
+
> boolean deleteUserInternalUsersUserIdDelete()
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
### Example
|
|
135
|
+
|
|
136
|
+
```typescript
|
|
137
|
+
import {
|
|
138
|
+
InternalApi,
|
|
139
|
+
Configuration
|
|
140
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
141
|
+
|
|
142
|
+
const configuration = new Configuration();
|
|
143
|
+
const apiInstance = new InternalApi(configuration);
|
|
144
|
+
|
|
145
|
+
let userId: any; // (default to undefined)
|
|
146
|
+
|
|
147
|
+
const { status, data } = await apiInstance.deleteUserInternalUsersUserIdDelete(
|
|
148
|
+
userId
|
|
149
|
+
);
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### Parameters
|
|
153
|
+
|
|
154
|
+
|Name | Type | Description | Notes|
|
|
155
|
+
|------------- | ------------- | ------------- | -------------|
|
|
156
|
+
| **userId** | **any** | | defaults to undefined|
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
### Return type
|
|
160
|
+
|
|
161
|
+
**boolean**
|
|
162
|
+
|
|
163
|
+
### Authorization
|
|
164
|
+
|
|
165
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
166
|
+
|
|
167
|
+
### HTTP request headers
|
|
168
|
+
|
|
169
|
+
- **Content-Type**: Not defined
|
|
170
|
+
- **Accept**: application/json
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
### HTTP response details
|
|
174
|
+
| Status code | Description | Response headers |
|
|
175
|
+
|-------------|-------------|------------------|
|
|
176
|
+
|**200** | Successful Response | - |
|
|
177
|
+
|**422** | Validation Error | - |
|
|
178
|
+
|
|
179
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
180
|
+
|
|
181
|
+
# **editReleaseInternalReleasesReleaseIdPut**
|
|
182
|
+
> boolean editReleaseInternalReleasesReleaseIdPut(releaseUpdateBody)
|
|
183
|
+
|
|
184
|
+
Edit Release information
|
|
185
|
+
|
|
186
|
+
### Example
|
|
187
|
+
|
|
188
|
+
```typescript
|
|
189
|
+
import {
|
|
190
|
+
InternalApi,
|
|
191
|
+
Configuration,
|
|
192
|
+
ReleaseUpdateBody
|
|
193
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
194
|
+
|
|
195
|
+
const configuration = new Configuration();
|
|
196
|
+
const apiInstance = new InternalApi(configuration);
|
|
197
|
+
|
|
198
|
+
let releaseId: any; // (default to undefined)
|
|
199
|
+
let releaseUpdateBody: ReleaseUpdateBody; //
|
|
200
|
+
|
|
201
|
+
const { status, data } = await apiInstance.editReleaseInternalReleasesReleaseIdPut(
|
|
202
|
+
releaseId,
|
|
203
|
+
releaseUpdateBody
|
|
204
|
+
);
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Parameters
|
|
208
|
+
|
|
209
|
+
|Name | Type | Description | Notes|
|
|
210
|
+
|------------- | ------------- | ------------- | -------------|
|
|
211
|
+
| **releaseUpdateBody** | **ReleaseUpdateBody**| | |
|
|
212
|
+
| **releaseId** | **any** | | defaults to undefined|
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
### Return type
|
|
216
|
+
|
|
217
|
+
**boolean**
|
|
218
|
+
|
|
219
|
+
### Authorization
|
|
220
|
+
|
|
221
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
222
|
+
|
|
223
|
+
### HTTP request headers
|
|
224
|
+
|
|
225
|
+
- **Content-Type**: application/json
|
|
226
|
+
- **Accept**: application/json
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
### HTTP response details
|
|
230
|
+
| Status code | Description | Response headers |
|
|
231
|
+
|-------------|-------------|------------------|
|
|
232
|
+
|**200** | Successful Response | - |
|
|
233
|
+
|**422** | Validation Error | - |
|
|
234
|
+
|
|
235
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
236
|
+
|
|
237
|
+
# **getDeviceInfoInternalDevicesDeviceIdGet**
|
|
238
|
+
> DeviceInternalResponse getDeviceInfoInternalDevicesDeviceIdGet()
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
### Example
|
|
242
|
+
|
|
243
|
+
```typescript
|
|
244
|
+
import {
|
|
245
|
+
InternalApi,
|
|
246
|
+
Configuration
|
|
247
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
248
|
+
|
|
249
|
+
const configuration = new Configuration();
|
|
250
|
+
const apiInstance = new InternalApi(configuration);
|
|
251
|
+
|
|
252
|
+
let deviceId: any; // (default to undefined)
|
|
253
|
+
|
|
254
|
+
const { status, data } = await apiInstance.getDeviceInfoInternalDevicesDeviceIdGet(
|
|
255
|
+
deviceId
|
|
256
|
+
);
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### Parameters
|
|
260
|
+
|
|
261
|
+
|Name | Type | Description | Notes|
|
|
262
|
+
|------------- | ------------- | ------------- | -------------|
|
|
263
|
+
| **deviceId** | **any** | | defaults to undefined|
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
### Return type
|
|
267
|
+
|
|
268
|
+
**DeviceInternalResponse**
|
|
269
|
+
|
|
270
|
+
### Authorization
|
|
271
|
+
|
|
272
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
273
|
+
|
|
274
|
+
### HTTP request headers
|
|
275
|
+
|
|
276
|
+
- **Content-Type**: Not defined
|
|
277
|
+
- **Accept**: application/json
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
### HTTP response details
|
|
281
|
+
| Status code | Description | Response headers |
|
|
282
|
+
|-------------|-------------|------------------|
|
|
283
|
+
|**200** | Successful Response | - |
|
|
284
|
+
|**422** | Validation Error | - |
|
|
285
|
+
|
|
286
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
287
|
+
|
|
288
|
+
# **getLogsInternalLogsGet**
|
|
289
|
+
> LogListResponse getLogsInternalLogsGet()
|
|
290
|
+
|
|
291
|
+
Get a paginated list of logs with optional filtering.
|
|
292
|
+
|
|
293
|
+
### Example
|
|
294
|
+
|
|
295
|
+
```typescript
|
|
296
|
+
import {
|
|
297
|
+
InternalApi,
|
|
298
|
+
Configuration,
|
|
299
|
+
,
|
|
300
|
+
,
|
|
301
|
+
|
|
302
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
303
|
+
|
|
304
|
+
const configuration = new Configuration();
|
|
305
|
+
const apiInstance = new InternalApi(configuration);
|
|
306
|
+
|
|
307
|
+
let page: number; // (optional) (default to 1)
|
|
308
|
+
let perPage: number; // (optional) (default to 20)
|
|
309
|
+
let deviceId: ; // (optional) (default to undefined)
|
|
310
|
+
let releaseId: ; // (optional) (default to undefined)
|
|
311
|
+
let userId: ; // (optional) (default to undefined)
|
|
312
|
+
let hideVerbose: boolean; // (optional) (default to undefined)
|
|
313
|
+
|
|
314
|
+
const { status, data } = await apiInstance.getLogsInternalLogsGet(
|
|
315
|
+
page,
|
|
316
|
+
perPage,
|
|
317
|
+
deviceId,
|
|
318
|
+
releaseId,
|
|
319
|
+
userId,
|
|
320
|
+
hideVerbose
|
|
321
|
+
);
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
### Parameters
|
|
325
|
+
|
|
326
|
+
|Name | Type | Description | Notes|
|
|
327
|
+
|------------- | ------------- | ------------- | -------------|
|
|
328
|
+
| **page** | [**number**] | | (optional) defaults to 1|
|
|
329
|
+
| **perPage** | [**number**] | | (optional) defaults to 20|
|
|
330
|
+
| **deviceId** | **** | | (optional) defaults to undefined|
|
|
331
|
+
| **releaseId** | **** | | (optional) defaults to undefined|
|
|
332
|
+
| **userId** | **** | | (optional) defaults to undefined|
|
|
333
|
+
| **hideVerbose** | [**boolean**] | | (optional) defaults to undefined|
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
### Return type
|
|
337
|
+
|
|
338
|
+
**LogListResponse**
|
|
339
|
+
|
|
340
|
+
### Authorization
|
|
341
|
+
|
|
342
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
343
|
+
|
|
344
|
+
### HTTP request headers
|
|
345
|
+
|
|
346
|
+
- **Content-Type**: Not defined
|
|
347
|
+
- **Accept**: application/json
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
### HTTP response details
|
|
351
|
+
| Status code | Description | Response headers |
|
|
352
|
+
|-------------|-------------|------------------|
|
|
353
|
+
|**200** | Successful Response | - |
|
|
354
|
+
|**422** | Validation Error | - |
|
|
355
|
+
|
|
356
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
357
|
+
|
|
358
|
+
# **getReleaseInfoInternalReleasesReleaseIdGet**
|
|
359
|
+
> ReleaseInternalResponse getReleaseInfoInternalReleasesReleaseIdGet()
|
|
360
|
+
|
|
361
|
+
Get release information
|
|
362
|
+
|
|
363
|
+
### Example
|
|
364
|
+
|
|
365
|
+
```typescript
|
|
366
|
+
import {
|
|
367
|
+
InternalApi,
|
|
368
|
+
Configuration
|
|
369
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
370
|
+
|
|
371
|
+
const configuration = new Configuration();
|
|
372
|
+
const apiInstance = new InternalApi(configuration);
|
|
373
|
+
|
|
374
|
+
let releaseId: any; // (default to undefined)
|
|
375
|
+
|
|
376
|
+
const { status, data } = await apiInstance.getReleaseInfoInternalReleasesReleaseIdGet(
|
|
377
|
+
releaseId
|
|
378
|
+
);
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
### Parameters
|
|
382
|
+
|
|
383
|
+
|Name | Type | Description | Notes|
|
|
384
|
+
|------------- | ------------- | ------------- | -------------|
|
|
385
|
+
| **releaseId** | **any** | | defaults to undefined|
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
### Return type
|
|
389
|
+
|
|
390
|
+
**ReleaseInternalResponse**
|
|
391
|
+
|
|
392
|
+
### Authorization
|
|
393
|
+
|
|
394
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
395
|
+
|
|
396
|
+
### HTTP request headers
|
|
397
|
+
|
|
398
|
+
- **Content-Type**: Not defined
|
|
399
|
+
- **Accept**: application/json
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
### HTTP response details
|
|
403
|
+
| Status code | Description | Response headers |
|
|
404
|
+
|-------------|-------------|------------------|
|
|
405
|
+
|**200** | Successful Response | - |
|
|
406
|
+
|**422** | Validation Error | - |
|
|
407
|
+
|
|
408
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
409
|
+
|
|
410
|
+
# **getReleaseZipInternalReleasesReleaseIdDlGet**
|
|
411
|
+
> boolean getReleaseZipInternalReleasesReleaseIdDlGet()
|
|
412
|
+
|
|
413
|
+
Download release ZIP directly
|
|
414
|
+
|
|
415
|
+
### Example
|
|
416
|
+
|
|
417
|
+
```typescript
|
|
418
|
+
import {
|
|
419
|
+
InternalApi,
|
|
420
|
+
Configuration
|
|
421
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
422
|
+
|
|
423
|
+
const configuration = new Configuration();
|
|
424
|
+
const apiInstance = new InternalApi(configuration);
|
|
425
|
+
|
|
426
|
+
let releaseId: any; // (default to undefined)
|
|
427
|
+
|
|
428
|
+
const { status, data } = await apiInstance.getReleaseZipInternalReleasesReleaseIdDlGet(
|
|
429
|
+
releaseId
|
|
430
|
+
);
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
### Parameters
|
|
434
|
+
|
|
435
|
+
|Name | Type | Description | Notes|
|
|
436
|
+
|------------- | ------------- | ------------- | -------------|
|
|
437
|
+
| **releaseId** | **any** | | defaults to undefined|
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
### Return type
|
|
441
|
+
|
|
442
|
+
**boolean**
|
|
443
|
+
|
|
444
|
+
### Authorization
|
|
445
|
+
|
|
446
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
447
|
+
|
|
448
|
+
### HTTP request headers
|
|
449
|
+
|
|
450
|
+
- **Content-Type**: Not defined
|
|
451
|
+
- **Accept**: application/json
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
### HTTP response details
|
|
455
|
+
| Status code | Description | Response headers |
|
|
456
|
+
|-------------|-------------|------------------|
|
|
457
|
+
|**200** | Successful Response | - |
|
|
458
|
+
|**422** | Validation Error | - |
|
|
459
|
+
|
|
460
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
461
|
+
|
|
462
|
+
# **getUserByIdInternalUsersUserIdGet**
|
|
463
|
+
> UserInternalResponse getUserByIdInternalUsersUserIdGet()
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
### Example
|
|
467
|
+
|
|
468
|
+
```typescript
|
|
469
|
+
import {
|
|
470
|
+
InternalApi,
|
|
471
|
+
Configuration
|
|
472
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
473
|
+
|
|
474
|
+
const configuration = new Configuration();
|
|
475
|
+
const apiInstance = new InternalApi(configuration);
|
|
476
|
+
|
|
477
|
+
let userId: string; // (default to undefined)
|
|
478
|
+
|
|
479
|
+
const { status, data } = await apiInstance.getUserByIdInternalUsersUserIdGet(
|
|
480
|
+
userId
|
|
481
|
+
);
|
|
482
|
+
```
|
|
483
|
+
|
|
484
|
+
### Parameters
|
|
485
|
+
|
|
486
|
+
|Name | Type | Description | Notes|
|
|
487
|
+
|------------- | ------------- | ------------- | -------------|
|
|
488
|
+
| **userId** | [**string**] | | defaults to undefined|
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
### Return type
|
|
492
|
+
|
|
493
|
+
**UserInternalResponse**
|
|
494
|
+
|
|
495
|
+
### Authorization
|
|
496
|
+
|
|
497
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
498
|
+
|
|
499
|
+
### HTTP request headers
|
|
500
|
+
|
|
501
|
+
- **Content-Type**: Not defined
|
|
502
|
+
- **Accept**: application/json
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
### HTTP response details
|
|
506
|
+
| Status code | Description | Response headers |
|
|
507
|
+
|-------------|-------------|------------------|
|
|
508
|
+
|**200** | Successful Response | - |
|
|
509
|
+
|**422** | Validation Error | - |
|
|
510
|
+
|
|
511
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
512
|
+
|
|
513
|
+
# **listUsersInternalUsersGet**
|
|
514
|
+
> ListResponseUserShortResponse listUsersInternalUsersGet()
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
### Example
|
|
518
|
+
|
|
519
|
+
```typescript
|
|
520
|
+
import {
|
|
521
|
+
InternalApi,
|
|
522
|
+
Configuration
|
|
523
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
524
|
+
|
|
525
|
+
const configuration = new Configuration();
|
|
526
|
+
const apiInstance = new InternalApi(configuration);
|
|
527
|
+
|
|
528
|
+
const { status, data } = await apiInstance.listUsersInternalUsersGet();
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
### Parameters
|
|
532
|
+
This endpoint does not have any parameters.
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
### Return type
|
|
536
|
+
|
|
537
|
+
**ListResponseUserShortResponse**
|
|
538
|
+
|
|
539
|
+
### Authorization
|
|
540
|
+
|
|
541
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
542
|
+
|
|
543
|
+
### HTTP request headers
|
|
544
|
+
|
|
545
|
+
- **Content-Type**: Not defined
|
|
546
|
+
- **Accept**: application/json
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
### HTTP response details
|
|
550
|
+
| Status code | Description | Response headers |
|
|
551
|
+
|-------------|-------------|------------------|
|
|
552
|
+
|**200** | Successful Response | - |
|
|
553
|
+
|
|
554
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
555
|
+
|
|
556
|
+
# **loginOauthAuthLoginPost**
|
|
557
|
+
> TokenResponse loginOauthAuthLoginPost()
|
|
558
|
+
|
|
559
|
+
OAuth2 compatible token login, get an access token for future requests
|
|
560
|
+
|
|
561
|
+
### Example
|
|
562
|
+
|
|
563
|
+
```typescript
|
|
564
|
+
import {
|
|
565
|
+
InternalApi,
|
|
566
|
+
Configuration
|
|
567
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
568
|
+
|
|
569
|
+
const configuration = new Configuration();
|
|
570
|
+
const apiInstance = new InternalApi(configuration);
|
|
571
|
+
|
|
572
|
+
let username: string; // (default to undefined)
|
|
573
|
+
let password: string; // (default to undefined)
|
|
574
|
+
let minTime: number; // (optional) (default to 0.3)
|
|
575
|
+
let maxTime: number; // (optional) (default to 1)
|
|
576
|
+
let grantType: string; // (optional) (default to undefined)
|
|
577
|
+
let scope: string; // (optional) (default to '')
|
|
578
|
+
let clientId: string; // (optional) (default to undefined)
|
|
579
|
+
let clientSecret: string; // (optional) (default to undefined)
|
|
580
|
+
|
|
581
|
+
const { status, data } = await apiInstance.loginOauthAuthLoginPost(
|
|
582
|
+
username,
|
|
583
|
+
password,
|
|
584
|
+
minTime,
|
|
585
|
+
maxTime,
|
|
586
|
+
grantType,
|
|
587
|
+
scope,
|
|
588
|
+
clientId,
|
|
589
|
+
clientSecret
|
|
590
|
+
);
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
### Parameters
|
|
594
|
+
|
|
595
|
+
|Name | Type | Description | Notes|
|
|
596
|
+
|------------- | ------------- | ------------- | -------------|
|
|
597
|
+
| **username** | [**string**] | | defaults to undefined|
|
|
598
|
+
| **password** | [**string**] | | defaults to undefined|
|
|
599
|
+
| **minTime** | [**number**] | | (optional) defaults to 0.3|
|
|
600
|
+
| **maxTime** | [**number**] | | (optional) defaults to 1|
|
|
601
|
+
| **grantType** | [**string**] | | (optional) defaults to undefined|
|
|
602
|
+
| **scope** | [**string**] | | (optional) defaults to ''|
|
|
603
|
+
| **clientId** | [**string**] | | (optional) defaults to undefined|
|
|
604
|
+
| **clientSecret** | [**string**] | | (optional) defaults to undefined|
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
### Return type
|
|
608
|
+
|
|
609
|
+
**TokenResponse**
|
|
610
|
+
|
|
611
|
+
### Authorization
|
|
612
|
+
|
|
613
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
614
|
+
|
|
615
|
+
### HTTP request headers
|
|
616
|
+
|
|
617
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
618
|
+
- **Accept**: application/json
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
### HTTP response details
|
|
622
|
+
| Status code | Description | Response headers |
|
|
623
|
+
|-------------|-------------|------------------|
|
|
624
|
+
|**200** | Successful Response | - |
|
|
625
|
+
|**422** | Validation Error | - |
|
|
626
|
+
|
|
627
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
628
|
+
|
|
629
|
+
# **logoutAuthLogoutPost**
|
|
630
|
+
> any logoutAuthLogoutPost(body)
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
### Example
|
|
634
|
+
|
|
635
|
+
```typescript
|
|
636
|
+
import {
|
|
637
|
+
InternalApi,
|
|
638
|
+
Configuration
|
|
639
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
640
|
+
|
|
641
|
+
const configuration = new Configuration();
|
|
642
|
+
const apiInstance = new InternalApi(configuration);
|
|
643
|
+
|
|
644
|
+
let body: string; //
|
|
645
|
+
|
|
646
|
+
const { status, data } = await apiInstance.logoutAuthLogoutPost(
|
|
647
|
+
body
|
|
648
|
+
);
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### Parameters
|
|
652
|
+
|
|
653
|
+
|Name | Type | Description | Notes|
|
|
654
|
+
|------------- | ------------- | ------------- | -------------|
|
|
655
|
+
| **body** | **string**| | |
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
### Return type
|
|
659
|
+
|
|
660
|
+
**any**
|
|
661
|
+
|
|
662
|
+
### Authorization
|
|
663
|
+
|
|
664
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
665
|
+
|
|
666
|
+
### HTTP request headers
|
|
667
|
+
|
|
668
|
+
- **Content-Type**: application/json
|
|
669
|
+
- **Accept**: application/json
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
### HTTP response details
|
|
673
|
+
| Status code | Description | Response headers |
|
|
674
|
+
|-------------|-------------|------------------|
|
|
675
|
+
|**200** | Successful Response | - |
|
|
676
|
+
|**422** | Validation Error | - |
|
|
677
|
+
|
|
678
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
679
|
+
|
|
680
|
+
# **newDeviceInternalDevicesPost**
|
|
681
|
+
> string newDeviceInternalDevicesPost(newDeviceBody)
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
### Example
|
|
685
|
+
|
|
686
|
+
```typescript
|
|
687
|
+
import {
|
|
688
|
+
InternalApi,
|
|
689
|
+
Configuration,
|
|
690
|
+
NewDeviceBody
|
|
691
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
692
|
+
|
|
693
|
+
const configuration = new Configuration();
|
|
694
|
+
const apiInstance = new InternalApi(configuration);
|
|
695
|
+
|
|
696
|
+
let newDeviceBody: NewDeviceBody; //
|
|
697
|
+
|
|
698
|
+
const { status, data } = await apiInstance.newDeviceInternalDevicesPost(
|
|
699
|
+
newDeviceBody
|
|
700
|
+
);
|
|
701
|
+
```
|
|
702
|
+
|
|
703
|
+
### Parameters
|
|
704
|
+
|
|
705
|
+
|Name | Type | Description | Notes|
|
|
706
|
+
|------------- | ------------- | ------------- | -------------|
|
|
707
|
+
| **newDeviceBody** | **NewDeviceBody**| | |
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
### Return type
|
|
711
|
+
|
|
712
|
+
**string**
|
|
713
|
+
|
|
714
|
+
### Authorization
|
|
715
|
+
|
|
716
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
717
|
+
|
|
718
|
+
### HTTP request headers
|
|
719
|
+
|
|
720
|
+
- **Content-Type**: application/json
|
|
721
|
+
- **Accept**: application/json
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
### HTTP response details
|
|
725
|
+
| Status code | Description | Response headers |
|
|
726
|
+
|-------------|-------------|------------------|
|
|
727
|
+
|**200** | Successful Response | - |
|
|
728
|
+
|**422** | Validation Error | - |
|
|
729
|
+
|
|
730
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
731
|
+
|
|
732
|
+
# **newReleaseInternalReleasesPost**
|
|
733
|
+
> ReleaseResponse newReleaseInternalReleasesPost()
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
### Example
|
|
737
|
+
|
|
738
|
+
```typescript
|
|
739
|
+
import {
|
|
740
|
+
InternalApi,
|
|
741
|
+
Configuration
|
|
742
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
743
|
+
|
|
744
|
+
const configuration = new Configuration();
|
|
745
|
+
const apiInstance = new InternalApi(configuration);
|
|
746
|
+
|
|
747
|
+
let deviceId: any; // (default to undefined)
|
|
748
|
+
let releaseZip: File; // (default to undefined)
|
|
749
|
+
let md5: string; // (default to undefined)
|
|
750
|
+
let changelog: Array<string>; // (default to undefined)
|
|
751
|
+
let bugs: Array<string>; // (optional) (default to undefined)
|
|
752
|
+
let notes: string; // (optional) (default to undefined)
|
|
753
|
+
let force: boolean; // (optional) (default to false)
|
|
754
|
+
|
|
755
|
+
const { status, data } = await apiInstance.newReleaseInternalReleasesPost(
|
|
756
|
+
deviceId,
|
|
757
|
+
releaseZip,
|
|
758
|
+
md5,
|
|
759
|
+
changelog,
|
|
760
|
+
bugs,
|
|
761
|
+
notes,
|
|
762
|
+
force
|
|
763
|
+
);
|
|
764
|
+
```
|
|
765
|
+
|
|
766
|
+
### Parameters
|
|
767
|
+
|
|
768
|
+
|Name | Type | Description | Notes|
|
|
769
|
+
|------------- | ------------- | ------------- | -------------|
|
|
770
|
+
| **deviceId** | **any** | | defaults to undefined|
|
|
771
|
+
| **releaseZip** | [**File**] | | defaults to undefined|
|
|
772
|
+
| **md5** | [**string**] | | defaults to undefined|
|
|
773
|
+
| **changelog** | **Array<string>** | | defaults to undefined|
|
|
774
|
+
| **bugs** | **Array<string>** | | (optional) defaults to undefined|
|
|
775
|
+
| **notes** | [**string**] | | (optional) defaults to undefined|
|
|
776
|
+
| **force** | [**boolean**] | | (optional) defaults to false|
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
### Return type
|
|
780
|
+
|
|
781
|
+
**ReleaseResponse**
|
|
782
|
+
|
|
783
|
+
### Authorization
|
|
784
|
+
|
|
785
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
786
|
+
|
|
787
|
+
### HTTP request headers
|
|
788
|
+
|
|
789
|
+
- **Content-Type**: multipart/form-data
|
|
790
|
+
- **Accept**: application/json
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
### HTTP response details
|
|
794
|
+
| Status code | Description | Response headers |
|
|
795
|
+
|-------------|-------------|------------------|
|
|
796
|
+
|**200** | Successful Response | - |
|
|
797
|
+
|**422** | Validation Error | - |
|
|
798
|
+
|
|
799
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
800
|
+
|
|
801
|
+
# **renewAuthRenewPost**
|
|
802
|
+
> string renewAuthRenewPost(body)
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
### Example
|
|
806
|
+
|
|
807
|
+
```typescript
|
|
808
|
+
import {
|
|
809
|
+
InternalApi,
|
|
810
|
+
Configuration
|
|
811
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
812
|
+
|
|
813
|
+
const configuration = new Configuration();
|
|
814
|
+
const apiInstance = new InternalApi(configuration);
|
|
815
|
+
|
|
816
|
+
let body: string; //
|
|
817
|
+
|
|
818
|
+
const { status, data } = await apiInstance.renewAuthRenewPost(
|
|
819
|
+
body
|
|
820
|
+
);
|
|
821
|
+
```
|
|
822
|
+
|
|
823
|
+
### Parameters
|
|
824
|
+
|
|
825
|
+
|Name | Type | Description | Notes|
|
|
826
|
+
|------------- | ------------- | ------------- | -------------|
|
|
827
|
+
| **body** | **string**| | |
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
### Return type
|
|
831
|
+
|
|
832
|
+
**string**
|
|
833
|
+
|
|
834
|
+
### Authorization
|
|
835
|
+
|
|
836
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
837
|
+
|
|
838
|
+
### HTTP request headers
|
|
839
|
+
|
|
840
|
+
- **Content-Type**: application/json
|
|
841
|
+
- **Accept**: application/json
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
### HTTP response details
|
|
845
|
+
| Status code | Description | Response headers |
|
|
846
|
+
|-------------|-------------|------------------|
|
|
847
|
+
|**200** | Successful Response | - |
|
|
848
|
+
|**422** | Validation Error | - |
|
|
849
|
+
|
|
850
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
851
|
+
|
|
852
|
+
# **updateDeviceInternalDevicesDeviceIdPut**
|
|
853
|
+
> boolean updateDeviceInternalDevicesDeviceIdPut(deviceUpdateBody)
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
### Example
|
|
857
|
+
|
|
858
|
+
```typescript
|
|
859
|
+
import {
|
|
860
|
+
InternalApi,
|
|
861
|
+
Configuration,
|
|
862
|
+
DeviceUpdateBody
|
|
863
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
864
|
+
|
|
865
|
+
const configuration = new Configuration();
|
|
866
|
+
const apiInstance = new InternalApi(configuration);
|
|
867
|
+
|
|
868
|
+
let deviceId: any; // (default to undefined)
|
|
869
|
+
let deviceUpdateBody: DeviceUpdateBody; //
|
|
870
|
+
|
|
871
|
+
const { status, data } = await apiInstance.updateDeviceInternalDevicesDeviceIdPut(
|
|
872
|
+
deviceId,
|
|
873
|
+
deviceUpdateBody
|
|
874
|
+
);
|
|
875
|
+
```
|
|
876
|
+
|
|
877
|
+
### Parameters
|
|
878
|
+
|
|
879
|
+
|Name | Type | Description | Notes|
|
|
880
|
+
|------------- | ------------- | ------------- | -------------|
|
|
881
|
+
| **deviceUpdateBody** | **DeviceUpdateBody**| | |
|
|
882
|
+
| **deviceId** | **any** | | defaults to undefined|
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
### Return type
|
|
886
|
+
|
|
887
|
+
**boolean**
|
|
888
|
+
|
|
889
|
+
### Authorization
|
|
890
|
+
|
|
891
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
892
|
+
|
|
893
|
+
### HTTP request headers
|
|
894
|
+
|
|
895
|
+
- **Content-Type**: application/json
|
|
896
|
+
- **Accept**: application/json
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
### HTTP response details
|
|
900
|
+
| Status code | Description | Response headers |
|
|
901
|
+
|-------------|-------------|------------------|
|
|
902
|
+
|**200** | Successful Response | - |
|
|
903
|
+
|**422** | Validation Error | - |
|
|
904
|
+
|
|
905
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
906
|
+
|
|
907
|
+
# **updateUserInternalUsersUserIdPut**
|
|
908
|
+
> boolean updateUserInternalUsersUserIdPut(userUpdateBody)
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
### Example
|
|
912
|
+
|
|
913
|
+
```typescript
|
|
914
|
+
import {
|
|
915
|
+
InternalApi,
|
|
916
|
+
Configuration,
|
|
917
|
+
UserUpdateBody
|
|
918
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
919
|
+
|
|
920
|
+
const configuration = new Configuration();
|
|
921
|
+
const apiInstance = new InternalApi(configuration);
|
|
922
|
+
|
|
923
|
+
let userId: any; // (default to undefined)
|
|
924
|
+
let userUpdateBody: UserUpdateBody; //
|
|
925
|
+
|
|
926
|
+
const { status, data } = await apiInstance.updateUserInternalUsersUserIdPut(
|
|
927
|
+
userId,
|
|
928
|
+
userUpdateBody
|
|
929
|
+
);
|
|
930
|
+
```
|
|
931
|
+
|
|
932
|
+
### Parameters
|
|
933
|
+
|
|
934
|
+
|Name | Type | Description | Notes|
|
|
935
|
+
|------------- | ------------- | ------------- | -------------|
|
|
936
|
+
| **userUpdateBody** | **UserUpdateBody**| | |
|
|
937
|
+
| **userId** | **any** | | defaults to undefined|
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
### Return type
|
|
941
|
+
|
|
942
|
+
**boolean**
|
|
943
|
+
|
|
944
|
+
### Authorization
|
|
945
|
+
|
|
946
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
947
|
+
|
|
948
|
+
### HTTP request headers
|
|
949
|
+
|
|
950
|
+
- **Content-Type**: application/json
|
|
951
|
+
- **Accept**: application/json
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
### HTTP response details
|
|
955
|
+
| Status code | Description | Response headers |
|
|
956
|
+
|-------------|-------------|------------------|
|
|
957
|
+
|**200** | Successful Response | - |
|
|
958
|
+
|**422** | Validation Error | - |
|
|
959
|
+
|
|
960
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
961
|
+
|