@orangefox-recovery/foxinternalclient 5.2.8 → 5.3.2
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 +54 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +199 -28
- package/dist/apis/DeviceApi.d.ts +1 -1
- package/dist/apis/DeviceApi.js +10 -5
- package/dist/apis/FoxFactoryApi.d.ts +1 -1
- package/dist/apis/FoxFactoryApi.js +27 -11
- package/dist/apis/GitlabApi.d.ts +1 -1
- package/dist/apis/GitlabApi.js +4 -2
- package/dist/apis/InternalApi.d.ts +48 -1
- package/dist/apis/InternalApi.js +135 -20
- package/dist/apis/PasteApi.d.ts +1 -1
- package/dist/apis/PasteApi.js +6 -3
- package/dist/apis/ReleaseApi.d.ts +1 -1
- package/dist/apis/ReleaseApi.js +11 -5
- package/dist/apis/StatsApi.d.ts +1 -1
- package/dist/apis/StatsApi.js +3 -2
- package/dist/esm/apis/DeviceApi.d.ts +1 -1
- package/dist/esm/apis/DeviceApi.js +10 -5
- package/dist/esm/apis/FoxFactoryApi.d.ts +1 -1
- package/dist/esm/apis/FoxFactoryApi.js +27 -11
- package/dist/esm/apis/GitlabApi.d.ts +1 -1
- package/dist/esm/apis/GitlabApi.js +4 -2
- package/dist/esm/apis/InternalApi.d.ts +48 -1
- package/dist/esm/apis/InternalApi.js +135 -20
- package/dist/esm/apis/PasteApi.d.ts +1 -1
- package/dist/esm/apis/PasteApi.js +6 -3
- package/dist/esm/apis/ReleaseApi.d.ts +1 -1
- package/dist/esm/apis/ReleaseApi.js +11 -5
- package/dist/esm/apis/StatsApi.d.ts +1 -1
- package/dist/esm/apis/StatsApi.js +3 -2
- package/dist/esm/models/BodyChangePasswordProfileChangePasswordPost.d.ts +1 -1
- package/dist/esm/models/BodyChangePasswordProfileChangePasswordPost.js +1 -1
- package/dist/esm/models/BuildStatusEnum.d.ts +1 -1
- package/dist/esm/models/BuildStatusEnum.js +1 -1
- package/dist/esm/models/BuildTaskResponse.d.ts +1 -1
- package/dist/esm/models/BuildTaskResponse.js +3 -3
- package/dist/esm/models/BuildTaskShortResponse.d.ts +1 -1
- package/dist/esm/models/BuildTaskShortResponse.js +3 -3
- package/dist/esm/models/DeviceInternalResponse.d.ts +13 -1
- package/dist/esm/models/DeviceInternalResponse.js +5 -1
- package/dist/esm/models/DeviceResponse.d.ts +13 -1
- package/dist/esm/models/DeviceResponse.js +5 -1
- package/dist/esm/models/DeviceStatsResponse.d.ts +1 -1
- package/dist/esm/models/DeviceStatsResponse.js +1 -1
- package/dist/esm/models/DeviceUpdateBody.d.ts +1 -1
- package/dist/esm/models/DeviceUpdateBody.js +1 -1
- package/dist/esm/models/FFStatusEnum.d.ts +1 -1
- package/dist/esm/models/FFStatusEnum.js +1 -1
- package/dist/esm/models/FFStatusResponse.d.ts +1 -1
- package/dist/esm/models/FFStatusResponse.js +1 -1
- package/dist/esm/models/GlobalStatsAggregationModel.d.ts +1 -1
- package/dist/esm/models/GlobalStatsAggregationModel.js +1 -1
- package/dist/esm/models/HTTPValidationError.d.ts +1 -1
- package/dist/esm/models/HTTPValidationError.js +1 -1
- package/dist/esm/models/ListResponseBuildTaskShortResponse.d.ts +1 -1
- package/dist/esm/models/ListResponseBuildTaskShortResponse.js +1 -1
- package/dist/esm/models/ListResponseReleaseResponse.d.ts +1 -1
- package/dist/esm/models/ListResponseReleaseResponse.js +1 -1
- package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +1 -1
- package/dist/esm/models/ListResponseShortDeviceResponse.js +1 -1
- package/dist/esm/models/ListResponseShortReleaseResponse.d.ts +1 -1
- package/dist/esm/models/ListResponseShortReleaseResponse.js +1 -1
- package/dist/esm/models/ListResponseStr.d.ts +1 -1
- package/dist/esm/models/ListResponseStr.js +1 -1
- package/dist/esm/models/ListResponseUserShortResponse.d.ts +1 -1
- package/dist/esm/models/ListResponseUserShortResponse.js +1 -1
- package/dist/esm/models/LogListResponse.d.ts +1 -1
- package/dist/esm/models/LogListResponse.js +1 -1
- package/dist/esm/models/LogResponse.d.ts +1 -1
- package/dist/esm/models/LogResponse.js +2 -2
- package/dist/esm/models/MaintainerShortModel.d.ts +1 -1
- package/dist/esm/models/MaintainerShortModel.js +1 -1
- package/dist/esm/models/NewBuildTaskBody.d.ts +1 -1
- package/dist/esm/models/NewBuildTaskBody.js +1 -1
- package/dist/esm/models/NewDeviceBody.d.ts +1 -1
- package/dist/esm/models/NewDeviceBody.js +1 -1
- package/dist/esm/models/PasteInput.d.ts +2 -20
- package/dist/esm/models/PasteInput.js +1 -9
- package/dist/esm/models/PasteOutput.d.ts +9 -9
- package/dist/esm/models/PasteOutput.js +10 -8
- package/dist/esm/models/RecoveryImgResponse.d.ts +1 -1
- package/dist/esm/models/RecoveryImgResponse.js +1 -1
- package/dist/esm/models/ReleaseGroupsResponse.d.ts +1 -1
- package/dist/esm/models/ReleaseGroupsResponse.js +1 -1
- package/dist/esm/models/ReleaseInternalResponse.d.ts +14 -2
- package/dist/esm/models/ReleaseInternalResponse.js +7 -1
- package/dist/esm/models/ReleaseInternalResponsePropValue.d.ts +1 -1
- package/dist/esm/models/ReleaseInternalResponsePropValue.js +1 -1
- package/dist/esm/models/ReleaseResponse.d.ts +14 -2
- package/dist/esm/models/ReleaseResponse.js +7 -1
- package/dist/esm/models/ReleaseStatsResponse.d.ts +1 -1
- package/dist/esm/models/ReleaseStatsResponse.js +1 -1
- package/dist/esm/models/ReleaseType.d.ts +1 -1
- package/dist/esm/models/ReleaseType.js +1 -1
- package/dist/esm/models/ReleaseUpdateBody.d.ts +1 -1
- package/dist/esm/models/ReleaseUpdateBody.js +1 -1
- package/dist/esm/models/ReleasesSort.d.ts +1 -1
- package/dist/esm/models/ReleasesSort.js +1 -1
- package/dist/esm/models/ResponseGetReleases.d.ts +1 -1
- package/dist/esm/models/ResponseGetReleases.js +1 -1
- package/dist/esm/models/ShortDeviceResponse.d.ts +13 -1
- package/dist/esm/models/ShortDeviceResponse.js +5 -1
- package/dist/esm/models/ShortReleaseResponse.d.ts +14 -2
- package/dist/esm/models/ShortReleaseResponse.js +7 -1
- package/dist/esm/models/TaskUpdateBody.d.ts +1 -1
- package/dist/esm/models/TaskUpdateBody.js +1 -1
- package/dist/esm/models/TokenResponse.d.ts +1 -1
- package/dist/esm/models/TokenResponse.js +1 -1
- package/dist/esm/models/UserGitlab.d.ts +1 -1
- package/dist/esm/models/UserGitlab.js +1 -1
- package/dist/esm/models/UserInternalResponse.d.ts +1 -1
- package/dist/esm/models/UserInternalResponse.js +1 -1
- package/dist/esm/models/UserMail.d.ts +1 -1
- package/dist/esm/models/UserMail.js +1 -1
- package/dist/esm/models/UserShortResponse.d.ts +1 -1
- package/dist/esm/models/UserShortResponse.js +1 -1
- package/dist/esm/models/UserTelegram.d.ts +1 -1
- package/dist/esm/models/UserTelegram.js +1 -1
- package/dist/esm/models/UserUpdateBody.d.ts +1 -1
- package/dist/esm/models/UserUpdateBody.js +1 -1
- package/dist/esm/models/ValidationError.d.ts +1 -1
- package/dist/esm/models/ValidationError.js +1 -1
- package/dist/esm/models/ValidationErrorLocInner.d.ts +1 -1
- package/dist/esm/models/ValidationErrorLocInner.js +1 -1
- package/dist/esm/runtime.d.ts +1 -1
- package/dist/esm/runtime.js +1 -1
- package/dist/models/BodyChangePasswordProfileChangePasswordPost.d.ts +1 -1
- package/dist/models/BodyChangePasswordProfileChangePasswordPost.js +1 -1
- package/dist/models/BuildStatusEnum.d.ts +1 -1
- package/dist/models/BuildStatusEnum.js +1 -1
- package/dist/models/BuildTaskResponse.d.ts +1 -1
- package/dist/models/BuildTaskResponse.js +3 -3
- package/dist/models/BuildTaskShortResponse.d.ts +1 -1
- package/dist/models/BuildTaskShortResponse.js +3 -3
- package/dist/models/DeviceInternalResponse.d.ts +13 -1
- package/dist/models/DeviceInternalResponse.js +5 -1
- package/dist/models/DeviceResponse.d.ts +13 -1
- package/dist/models/DeviceResponse.js +5 -1
- package/dist/models/DeviceStatsResponse.d.ts +1 -1
- package/dist/models/DeviceStatsResponse.js +1 -1
- package/dist/models/DeviceUpdateBody.d.ts +1 -1
- package/dist/models/DeviceUpdateBody.js +1 -1
- package/dist/models/FFStatusEnum.d.ts +1 -1
- package/dist/models/FFStatusEnum.js +1 -1
- package/dist/models/FFStatusResponse.d.ts +1 -1
- package/dist/models/FFStatusResponse.js +1 -1
- package/dist/models/GlobalStatsAggregationModel.d.ts +1 -1
- package/dist/models/GlobalStatsAggregationModel.js +1 -1
- package/dist/models/HTTPValidationError.d.ts +1 -1
- package/dist/models/HTTPValidationError.js +1 -1
- package/dist/models/ListResponseBuildTaskShortResponse.d.ts +1 -1
- package/dist/models/ListResponseBuildTaskShortResponse.js +1 -1
- package/dist/models/ListResponseReleaseResponse.d.ts +1 -1
- package/dist/models/ListResponseReleaseResponse.js +1 -1
- package/dist/models/ListResponseShortDeviceResponse.d.ts +1 -1
- package/dist/models/ListResponseShortDeviceResponse.js +1 -1
- package/dist/models/ListResponseShortReleaseResponse.d.ts +1 -1
- package/dist/models/ListResponseShortReleaseResponse.js +1 -1
- package/dist/models/ListResponseStr.d.ts +1 -1
- package/dist/models/ListResponseStr.js +1 -1
- package/dist/models/ListResponseUserShortResponse.d.ts +1 -1
- package/dist/models/ListResponseUserShortResponse.js +1 -1
- package/dist/models/LogListResponse.d.ts +1 -1
- package/dist/models/LogListResponse.js +1 -1
- package/dist/models/LogResponse.d.ts +1 -1
- package/dist/models/LogResponse.js +2 -2
- package/dist/models/MaintainerShortModel.d.ts +1 -1
- package/dist/models/MaintainerShortModel.js +1 -1
- package/dist/models/NewBuildTaskBody.d.ts +1 -1
- package/dist/models/NewBuildTaskBody.js +1 -1
- package/dist/models/NewDeviceBody.d.ts +1 -1
- package/dist/models/NewDeviceBody.js +1 -1
- package/dist/models/PasteInput.d.ts +2 -20
- package/dist/models/PasteInput.js +1 -9
- package/dist/models/PasteOutput.d.ts +9 -9
- package/dist/models/PasteOutput.js +10 -8
- package/dist/models/RecoveryImgResponse.d.ts +1 -1
- package/dist/models/RecoveryImgResponse.js +1 -1
- package/dist/models/ReleaseGroupsResponse.d.ts +1 -1
- package/dist/models/ReleaseGroupsResponse.js +1 -1
- package/dist/models/ReleaseInternalResponse.d.ts +14 -2
- package/dist/models/ReleaseInternalResponse.js +7 -1
- package/dist/models/ReleaseInternalResponsePropValue.d.ts +1 -1
- package/dist/models/ReleaseInternalResponsePropValue.js +1 -1
- package/dist/models/ReleaseResponse.d.ts +14 -2
- package/dist/models/ReleaseResponse.js +7 -1
- package/dist/models/ReleaseStatsResponse.d.ts +1 -1
- package/dist/models/ReleaseStatsResponse.js +1 -1
- package/dist/models/ReleaseType.d.ts +1 -1
- package/dist/models/ReleaseType.js +1 -1
- package/dist/models/ReleaseUpdateBody.d.ts +1 -1
- package/dist/models/ReleaseUpdateBody.js +1 -1
- package/dist/models/ReleasesSort.d.ts +1 -1
- package/dist/models/ReleasesSort.js +1 -1
- package/dist/models/ResponseGetReleases.d.ts +1 -1
- package/dist/models/ResponseGetReleases.js +1 -1
- package/dist/models/ShortDeviceResponse.d.ts +13 -1
- package/dist/models/ShortDeviceResponse.js +5 -1
- package/dist/models/ShortReleaseResponse.d.ts +14 -2
- package/dist/models/ShortReleaseResponse.js +7 -1
- package/dist/models/TaskUpdateBody.d.ts +1 -1
- package/dist/models/TaskUpdateBody.js +1 -1
- package/dist/models/TokenResponse.d.ts +1 -1
- package/dist/models/TokenResponse.js +1 -1
- package/dist/models/UserGitlab.d.ts +1 -1
- package/dist/models/UserGitlab.js +1 -1
- package/dist/models/UserInternalResponse.d.ts +1 -1
- package/dist/models/UserInternalResponse.js +1 -1
- package/dist/models/UserMail.d.ts +1 -1
- package/dist/models/UserMail.js +1 -1
- package/dist/models/UserShortResponse.d.ts +1 -1
- package/dist/models/UserShortResponse.js +1 -1
- package/dist/models/UserTelegram.d.ts +1 -1
- package/dist/models/UserTelegram.js +1 -1
- package/dist/models/UserUpdateBody.d.ts +1 -1
- package/dist/models/UserUpdateBody.js +1 -1
- package/dist/models/ValidationError.d.ts +1 -1
- package/dist/models/ValidationError.js +1 -1
- package/dist/models/ValidationErrorLocInner.d.ts +1 -1
- package/dist/models/ValidationErrorLocInner.js +1 -1
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/docs/BodyChangePasswordProfileChangePasswordPost.md +36 -0
- package/docs/BuildStatusEnum.md +32 -0
- package/docs/BuildTaskResponse.md +56 -0
- package/docs/BuildTaskShortResponse.md +52 -0
- package/docs/DeviceApi.md +315 -0
- package/docs/DeviceInternalResponse.md +64 -0
- package/docs/DeviceResponse.md +60 -0
- package/docs/DeviceStatsResponse.md +38 -0
- package/docs/DeviceUpdateBody.md +44 -0
- package/docs/FFStatusEnum.md +32 -0
- package/docs/FFStatusResponse.md +34 -0
- package/docs/FoxFactoryApi.md +758 -0
- package/docs/GitlabApi.md +78 -0
- package/docs/GlobalStatsAggregationModel.md +40 -0
- package/docs/HTTPValidationError.md +34 -0
- package/docs/InternalApi.md +1608 -0
- package/docs/ListResponseBuildTaskShortResponse.md +36 -0
- package/docs/ListResponseReleaseResponse.md +36 -0
- package/docs/ListResponseShortDeviceResponse.md +36 -0
- package/docs/ListResponseShortReleaseResponse.md +36 -0
- package/docs/ListResponseStr.md +36 -0
- package/docs/ListResponseUserShortResponse.md +36 -0
- package/docs/LogListResponse.md +40 -0
- package/docs/LogResponse.md +50 -0
- package/docs/MaintainerShortModel.md +38 -0
- package/docs/NewBuildTaskBody.md +42 -0
- package/docs/NewDeviceBody.md +40 -0
- package/docs/PasteApi.md +149 -0
- package/docs/PasteInput.md +34 -0
- package/docs/PasteOutput.md +40 -0
- package/docs/RecoveryImgResponse.md +36 -0
- package/docs/ReleaseApi.md +354 -0
- package/docs/ReleaseGroupsResponse.md +34 -0
- package/docs/ReleaseInternalResponse.md +78 -0
- package/docs/ReleaseInternalResponsePropValue.md +32 -0
- package/docs/ReleaseResponse.md +72 -0
- package/docs/ReleaseStatsResponse.md +38 -0
- package/docs/ReleaseType.md +32 -0
- package/docs/ReleaseUpdateBody.md +40 -0
- package/docs/ReleasesSort.md +32 -0
- package/docs/ResponseGetReleases.md +36 -0
- package/docs/ShortDeviceResponse.md +54 -0
- package/docs/ShortReleaseResponse.md +60 -0
- package/docs/StatsApi.md +69 -0
- package/docs/TaskUpdateBody.md +36 -0
- package/docs/TokenResponse.md +36 -0
- package/docs/UserGitlab.md +34 -0
- package/docs/UserInternalResponse.md +52 -0
- package/docs/UserMail.md +34 -0
- package/docs/UserShortResponse.md +40 -0
- package/docs/UserTelegram.md +34 -0
- package/docs/UserUpdateBody.md +42 -0
- package/docs/ValidationError.md +38 -0
- package/docs/ValidationErrorLocInner.md +32 -0
- package/package.json +5 -2
- package/src/apis/DeviceApi.ts +18 -5
- package/src/apis/FoxFactoryApi.ts +47 -11
- package/src/apis/GitlabApi.ts +6 -2
- package/src/apis/InternalApi.ts +220 -20
- package/src/apis/PasteApi.ts +10 -3
- package/src/apis/ReleaseApi.ts +19 -5
- package/src/apis/StatsApi.ts +5 -2
- package/src/models/BodyChangePasswordProfileChangePasswordPost.ts +1 -1
- package/src/models/BuildStatusEnum.ts +1 -1
- package/src/models/BuildTaskResponse.ts +3 -3
- package/src/models/BuildTaskShortResponse.ts +3 -3
- package/src/models/DeviceInternalResponse.ts +17 -1
- package/src/models/DeviceResponse.ts +17 -1
- package/src/models/DeviceStatsResponse.ts +1 -1
- package/src/models/DeviceUpdateBody.ts +1 -1
- package/src/models/FFStatusEnum.ts +1 -1
- package/src/models/FFStatusResponse.ts +1 -1
- package/src/models/GlobalStatsAggregationModel.ts +1 -1
- package/src/models/HTTPValidationError.ts +1 -1
- package/src/models/ListResponseBuildTaskShortResponse.ts +1 -1
- package/src/models/ListResponseReleaseResponse.ts +1 -1
- package/src/models/ListResponseShortDeviceResponse.ts +1 -1
- package/src/models/ListResponseShortReleaseResponse.ts +1 -1
- package/src/models/ListResponseStr.ts +1 -1
- package/src/models/ListResponseUserShortResponse.ts +1 -1
- package/src/models/LogListResponse.ts +1 -1
- package/src/models/LogResponse.ts +2 -2
- package/src/models/MaintainerShortModel.ts +1 -1
- package/src/models/NewBuildTaskBody.ts +1 -1
- package/src/models/NewDeviceBody.ts +1 -1
- package/src/models/PasteInput.ts +2 -27
- package/src/models/PasteOutput.ts +17 -16
- package/src/models/RecoveryImgResponse.ts +1 -1
- package/src/models/ReleaseGroupsResponse.ts +1 -1
- package/src/models/ReleaseInternalResponse.ts +19 -2
- package/src/models/ReleaseInternalResponsePropValue.ts +1 -1
- package/src/models/ReleaseResponse.ts +19 -2
- package/src/models/ReleaseStatsResponse.ts +1 -1
- package/src/models/ReleaseType.ts +1 -1
- package/src/models/ReleaseUpdateBody.ts +1 -1
- package/src/models/ReleasesSort.ts +1 -1
- package/src/models/ResponseGetReleases.ts +1 -1
- package/src/models/ShortDeviceResponse.ts +17 -1
- package/src/models/ShortReleaseResponse.ts +19 -2
- package/src/models/TaskUpdateBody.ts +1 -1
- package/src/models/TokenResponse.ts +1 -1
- package/src/models/UserGitlab.ts +1 -1
- package/src/models/UserInternalResponse.ts +1 -1
- package/src/models/UserMail.ts +1 -1
- package/src/models/UserShortResponse.ts +1 -1
- package/src/models/UserTelegram.ts +1 -1
- package/src/models/UserUpdateBody.ts +1 -1
- package/src/models/ValidationError.ts +1 -1
- package/src/models/ValidationErrorLocInner.ts +1 -1
- package/src/runtime.ts +1 -1
|
@@ -0,0 +1,1608 @@
|
|
|
1
|
+
# InternalApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.orangefox.download*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**changePasswordProfileChangePasswordPost**](InternalApi.md#changepasswordprofilechangepasswordpost) | **POST** /profile/change_password | Change Password |
|
|
8
|
+
| [**delReleaseInternalReleasesReleaseIdDelete**](InternalApi.md#delreleaseinternalreleasesreleaseiddelete) | **DELETE** /internal/releases/{release_id} | Del Release |
|
|
9
|
+
| [**deleteDeviceInternalDevicesDeviceIdDelete**](InternalApi.md#deletedeviceinternaldevicesdeviceiddelete) | **DELETE** /internal/devices/{device_id} | Delete Device |
|
|
10
|
+
| [**deletePasteInternalPastePasteIdDelete**](InternalApi.md#deletepasteinternalpastepasteiddelete) | **DELETE** /internal/paste/{paste_id} | Delete Paste |
|
|
11
|
+
| [**deleteUserInternalUsersUserIdDelete**](InternalApi.md#deleteuserinternalusersuseriddelete) | **DELETE** /internal/users/{user_id} | Delete User |
|
|
12
|
+
| [**editReleaseInternalReleasesReleaseIdPut**](InternalApi.md#editreleaseinternalreleasesreleaseidput) | **PUT** /internal/releases/{release_id} | Edit Release |
|
|
13
|
+
| [**getDeviceInfoInternalDevicesDeviceIdGet**](InternalApi.md#getdeviceinfointernaldevicesdeviceidget) | **GET** /internal/devices/{device_id} | Get Device Info |
|
|
14
|
+
| [**getLogsInternalLogsGet**](InternalApi.md#getlogsinternallogsget) | **GET** /internal/logs/ | Get Logs |
|
|
15
|
+
| [**getReleaseInfoInternalReleasesReleaseIdGet**](InternalApi.md#getreleaseinfointernalreleasesreleaseidget) | **GET** /internal/releases/{release_id} | Get Release Info |
|
|
16
|
+
| [**getReleaseZipInternalReleasesReleaseIdDlGet**](InternalApi.md#getreleasezipinternalreleasesreleaseiddlget) | **GET** /internal/releases/{release_id}/dl | Get Release Zip |
|
|
17
|
+
| [**getUserByIdInternalUsersUserIdGet**](InternalApi.md#getuserbyidinternalusersuseridget) | **GET** /internal/users/{user_id} | Get User By Id |
|
|
18
|
+
| [**listPastesInternalPasteGet**](InternalApi.md#listpastesinternalpasteget) | **GET** /internal/paste/ | List Pastes |
|
|
19
|
+
| [**listUsersInternalUsersGet**](InternalApi.md#listusersinternalusersget) | **GET** /internal/users/ | List Users |
|
|
20
|
+
| [**loginOauthAuthLoginPost**](InternalApi.md#loginoauthauthloginpost) | **POST** /auth/login | Login Oauth |
|
|
21
|
+
| [**logoutAuthLogoutPost**](InternalApi.md#logoutauthlogoutpost) | **POST** /auth/logout | Logout |
|
|
22
|
+
| [**newDeviceInternalDevicesPost**](InternalApi.md#newdeviceinternaldevicespost) | **POST** /internal/devices/ | New Device |
|
|
23
|
+
| [**newReleaseInternalReleasesPost**](InternalApi.md#newreleaseinternalreleasespost) | **POST** /internal/releases/ | New Release |
|
|
24
|
+
| [**renewAuthRenewPost**](InternalApi.md#renewauthrenewpost) | **POST** /auth/renew | Renew |
|
|
25
|
+
| [**updateDeviceInternalDevicesDeviceIdPut**](InternalApi.md#updatedeviceinternaldevicesdeviceidput) | **PUT** /internal/devices/{device_id} | Update Device |
|
|
26
|
+
| [**updatePasteInternalPastePasteIdPut**](InternalApi.md#updatepasteinternalpastepasteidput) | **PUT** /internal/paste/{paste_id} | Update Paste |
|
|
27
|
+
| [**updateUserInternalUsersUserIdPut**](InternalApi.md#updateuserinternalusersuseridput) | **PUT** /internal/users/{user_id} | Update User |
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## changePasswordProfileChangePasswordPost
|
|
32
|
+
|
|
33
|
+
> boolean changePasswordProfileChangePasswordPost(bodyChangePasswordProfileChangePasswordPost)
|
|
34
|
+
|
|
35
|
+
Change Password
|
|
36
|
+
|
|
37
|
+
Change the password for a user.
|
|
38
|
+
|
|
39
|
+
### Example
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
import {
|
|
43
|
+
Configuration,
|
|
44
|
+
InternalApi,
|
|
45
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
46
|
+
import type { ChangePasswordProfileChangePasswordPostRequest } from '@orangefox-recovery/foxinternalclient';
|
|
47
|
+
|
|
48
|
+
async function example() {
|
|
49
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
50
|
+
const api = new InternalApi();
|
|
51
|
+
|
|
52
|
+
const body = {
|
|
53
|
+
// BodyChangePasswordProfileChangePasswordPost
|
|
54
|
+
bodyChangePasswordProfileChangePasswordPost: ...,
|
|
55
|
+
} satisfies ChangePasswordProfileChangePasswordPostRequest;
|
|
56
|
+
|
|
57
|
+
try {
|
|
58
|
+
const data = await api.changePasswordProfileChangePasswordPost(body);
|
|
59
|
+
console.log(data);
|
|
60
|
+
} catch (error) {
|
|
61
|
+
console.error(error);
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// Run the test
|
|
66
|
+
example().catch(console.error);
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Parameters
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
| Name | Type | Description | Notes |
|
|
73
|
+
|------------- | ------------- | ------------- | -------------|
|
|
74
|
+
| **bodyChangePasswordProfileChangePasswordPost** | [BodyChangePasswordProfileChangePasswordPost](BodyChangePasswordProfileChangePasswordPost.md) | | |
|
|
75
|
+
|
|
76
|
+
### Return type
|
|
77
|
+
|
|
78
|
+
**boolean**
|
|
79
|
+
|
|
80
|
+
### Authorization
|
|
81
|
+
|
|
82
|
+
No authorization required
|
|
83
|
+
|
|
84
|
+
### HTTP request headers
|
|
85
|
+
|
|
86
|
+
- **Content-Type**: `application/json`
|
|
87
|
+
- **Accept**: `application/json`
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
### HTTP response details
|
|
91
|
+
| Status code | Description | Response headers |
|
|
92
|
+
|-------------|-------------|------------------|
|
|
93
|
+
| **200** | Successful Response | - |
|
|
94
|
+
| **422** | Validation Error | - |
|
|
95
|
+
|
|
96
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
## delReleaseInternalReleasesReleaseIdDelete
|
|
100
|
+
|
|
101
|
+
> boolean delReleaseInternalReleasesReleaseIdDelete(releaseId)
|
|
102
|
+
|
|
103
|
+
Del Release
|
|
104
|
+
|
|
105
|
+
Delete release
|
|
106
|
+
|
|
107
|
+
### Example
|
|
108
|
+
|
|
109
|
+
```ts
|
|
110
|
+
import {
|
|
111
|
+
Configuration,
|
|
112
|
+
InternalApi,
|
|
113
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
114
|
+
import type { DelReleaseInternalReleasesReleaseIdDeleteRequest } from '@orangefox-recovery/foxinternalclient';
|
|
115
|
+
|
|
116
|
+
async function example() {
|
|
117
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
118
|
+
const config = new Configuration({
|
|
119
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
120
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
121
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
122
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
123
|
+
});
|
|
124
|
+
const api = new InternalApi(config);
|
|
125
|
+
|
|
126
|
+
const body = {
|
|
127
|
+
// string
|
|
128
|
+
releaseId: releaseId_example,
|
|
129
|
+
} satisfies DelReleaseInternalReleasesReleaseIdDeleteRequest;
|
|
130
|
+
|
|
131
|
+
try {
|
|
132
|
+
const data = await api.delReleaseInternalReleasesReleaseIdDelete(body);
|
|
133
|
+
console.log(data);
|
|
134
|
+
} catch (error) {
|
|
135
|
+
console.error(error);
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
// Run the test
|
|
140
|
+
example().catch(console.error);
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
| Name | Type | Description | Notes |
|
|
147
|
+
|------------- | ------------- | ------------- | -------------|
|
|
148
|
+
| **releaseId** | `string` | | [Defaults to `undefined`] |
|
|
149
|
+
|
|
150
|
+
### Return type
|
|
151
|
+
|
|
152
|
+
**boolean**
|
|
153
|
+
|
|
154
|
+
### Authorization
|
|
155
|
+
|
|
156
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
157
|
+
|
|
158
|
+
### HTTP request headers
|
|
159
|
+
|
|
160
|
+
- **Content-Type**: Not defined
|
|
161
|
+
- **Accept**: `application/json`
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
### HTTP response details
|
|
165
|
+
| Status code | Description | Response headers |
|
|
166
|
+
|-------------|-------------|------------------|
|
|
167
|
+
| **200** | Successful Response | - |
|
|
168
|
+
| **422** | Validation Error | - |
|
|
169
|
+
|
|
170
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
## deleteDeviceInternalDevicesDeviceIdDelete
|
|
174
|
+
|
|
175
|
+
> boolean deleteDeviceInternalDevicesDeviceIdDelete(deviceId)
|
|
176
|
+
|
|
177
|
+
Delete Device
|
|
178
|
+
|
|
179
|
+
### Example
|
|
180
|
+
|
|
181
|
+
```ts
|
|
182
|
+
import {
|
|
183
|
+
Configuration,
|
|
184
|
+
InternalApi,
|
|
185
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
186
|
+
import type { DeleteDeviceInternalDevicesDeviceIdDeleteRequest } from '@orangefox-recovery/foxinternalclient';
|
|
187
|
+
|
|
188
|
+
async function example() {
|
|
189
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
190
|
+
const config = new Configuration({
|
|
191
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
192
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
193
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
194
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
195
|
+
});
|
|
196
|
+
const api = new InternalApi(config);
|
|
197
|
+
|
|
198
|
+
const body = {
|
|
199
|
+
// string
|
|
200
|
+
deviceId: deviceId_example,
|
|
201
|
+
} satisfies DeleteDeviceInternalDevicesDeviceIdDeleteRequest;
|
|
202
|
+
|
|
203
|
+
try {
|
|
204
|
+
const data = await api.deleteDeviceInternalDevicesDeviceIdDelete(body);
|
|
205
|
+
console.log(data);
|
|
206
|
+
} catch (error) {
|
|
207
|
+
console.error(error);
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
// Run the test
|
|
212
|
+
example().catch(console.error);
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Parameters
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
| Name | Type | Description | Notes |
|
|
219
|
+
|------------- | ------------- | ------------- | -------------|
|
|
220
|
+
| **deviceId** | `string` | | [Defaults to `undefined`] |
|
|
221
|
+
|
|
222
|
+
### Return type
|
|
223
|
+
|
|
224
|
+
**boolean**
|
|
225
|
+
|
|
226
|
+
### Authorization
|
|
227
|
+
|
|
228
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
229
|
+
|
|
230
|
+
### HTTP request headers
|
|
231
|
+
|
|
232
|
+
- **Content-Type**: Not defined
|
|
233
|
+
- **Accept**: `application/json`
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
### HTTP response details
|
|
237
|
+
| Status code | Description | Response headers |
|
|
238
|
+
|-------------|-------------|------------------|
|
|
239
|
+
| **200** | Successful Response | - |
|
|
240
|
+
| **422** | Validation Error | - |
|
|
241
|
+
|
|
242
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
## deletePasteInternalPastePasteIdDelete
|
|
246
|
+
|
|
247
|
+
> deletePasteInternalPastePasteIdDelete(pasteId)
|
|
248
|
+
|
|
249
|
+
Delete Paste
|
|
250
|
+
|
|
251
|
+
Delete a paste by ID. Requires admin permissions.
|
|
252
|
+
|
|
253
|
+
### Example
|
|
254
|
+
|
|
255
|
+
```ts
|
|
256
|
+
import {
|
|
257
|
+
Configuration,
|
|
258
|
+
InternalApi,
|
|
259
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
260
|
+
import type { DeletePasteInternalPastePasteIdDeleteRequest } from '@orangefox-recovery/foxinternalclient';
|
|
261
|
+
|
|
262
|
+
async function example() {
|
|
263
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
264
|
+
const config = new Configuration({
|
|
265
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
266
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
267
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
268
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
269
|
+
});
|
|
270
|
+
const api = new InternalApi(config);
|
|
271
|
+
|
|
272
|
+
const body = {
|
|
273
|
+
// string
|
|
274
|
+
pasteId: pasteId_example,
|
|
275
|
+
} satisfies DeletePasteInternalPastePasteIdDeleteRequest;
|
|
276
|
+
|
|
277
|
+
try {
|
|
278
|
+
const data = await api.deletePasteInternalPastePasteIdDelete(body);
|
|
279
|
+
console.log(data);
|
|
280
|
+
} catch (error) {
|
|
281
|
+
console.error(error);
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
// Run the test
|
|
286
|
+
example().catch(console.error);
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### Parameters
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
| Name | Type | Description | Notes |
|
|
293
|
+
|------------- | ------------- | ------------- | -------------|
|
|
294
|
+
| **pasteId** | `string` | | [Defaults to `undefined`] |
|
|
295
|
+
|
|
296
|
+
### Return type
|
|
297
|
+
|
|
298
|
+
`void` (Empty response body)
|
|
299
|
+
|
|
300
|
+
### Authorization
|
|
301
|
+
|
|
302
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
303
|
+
|
|
304
|
+
### HTTP request headers
|
|
305
|
+
|
|
306
|
+
- **Content-Type**: Not defined
|
|
307
|
+
- **Accept**: `application/json`
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
### HTTP response details
|
|
311
|
+
| Status code | Description | Response headers |
|
|
312
|
+
|-------------|-------------|------------------|
|
|
313
|
+
| **204** | Successful Response | - |
|
|
314
|
+
| **404** | Item not found | - |
|
|
315
|
+
| **429** | Too many requests | - |
|
|
316
|
+
| **422** | Validation Error | - |
|
|
317
|
+
|
|
318
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
## deleteUserInternalUsersUserIdDelete
|
|
322
|
+
|
|
323
|
+
> boolean deleteUserInternalUsersUserIdDelete(userId)
|
|
324
|
+
|
|
325
|
+
Delete User
|
|
326
|
+
|
|
327
|
+
### Example
|
|
328
|
+
|
|
329
|
+
```ts
|
|
330
|
+
import {
|
|
331
|
+
Configuration,
|
|
332
|
+
InternalApi,
|
|
333
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
334
|
+
import type { DeleteUserInternalUsersUserIdDeleteRequest } from '@orangefox-recovery/foxinternalclient';
|
|
335
|
+
|
|
336
|
+
async function example() {
|
|
337
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
338
|
+
const config = new Configuration({
|
|
339
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
340
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
341
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
342
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
343
|
+
});
|
|
344
|
+
const api = new InternalApi(config);
|
|
345
|
+
|
|
346
|
+
const body = {
|
|
347
|
+
// string
|
|
348
|
+
userId: userId_example,
|
|
349
|
+
} satisfies DeleteUserInternalUsersUserIdDeleteRequest;
|
|
350
|
+
|
|
351
|
+
try {
|
|
352
|
+
const data = await api.deleteUserInternalUsersUserIdDelete(body);
|
|
353
|
+
console.log(data);
|
|
354
|
+
} catch (error) {
|
|
355
|
+
console.error(error);
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
// Run the test
|
|
360
|
+
example().catch(console.error);
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
### Parameters
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
| Name | Type | Description | Notes |
|
|
367
|
+
|------------- | ------------- | ------------- | -------------|
|
|
368
|
+
| **userId** | `string` | | [Defaults to `undefined`] |
|
|
369
|
+
|
|
370
|
+
### Return type
|
|
371
|
+
|
|
372
|
+
**boolean**
|
|
373
|
+
|
|
374
|
+
### Authorization
|
|
375
|
+
|
|
376
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
377
|
+
|
|
378
|
+
### HTTP request headers
|
|
379
|
+
|
|
380
|
+
- **Content-Type**: Not defined
|
|
381
|
+
- **Accept**: `application/json`
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
### HTTP response details
|
|
385
|
+
| Status code | Description | Response headers |
|
|
386
|
+
|-------------|-------------|------------------|
|
|
387
|
+
| **200** | Successful Response | - |
|
|
388
|
+
| **422** | Validation Error | - |
|
|
389
|
+
|
|
390
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
## editReleaseInternalReleasesReleaseIdPut
|
|
394
|
+
|
|
395
|
+
> boolean editReleaseInternalReleasesReleaseIdPut(releaseId, releaseUpdateBody)
|
|
396
|
+
|
|
397
|
+
Edit Release
|
|
398
|
+
|
|
399
|
+
Edit Release information
|
|
400
|
+
|
|
401
|
+
### Example
|
|
402
|
+
|
|
403
|
+
```ts
|
|
404
|
+
import {
|
|
405
|
+
Configuration,
|
|
406
|
+
InternalApi,
|
|
407
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
408
|
+
import type { EditReleaseInternalReleasesReleaseIdPutRequest } from '@orangefox-recovery/foxinternalclient';
|
|
409
|
+
|
|
410
|
+
async function example() {
|
|
411
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
412
|
+
const config = new Configuration({
|
|
413
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
414
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
415
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
416
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
417
|
+
});
|
|
418
|
+
const api = new InternalApi(config);
|
|
419
|
+
|
|
420
|
+
const body = {
|
|
421
|
+
// string
|
|
422
|
+
releaseId: releaseId_example,
|
|
423
|
+
// ReleaseUpdateBody
|
|
424
|
+
releaseUpdateBody: ...,
|
|
425
|
+
} satisfies EditReleaseInternalReleasesReleaseIdPutRequest;
|
|
426
|
+
|
|
427
|
+
try {
|
|
428
|
+
const data = await api.editReleaseInternalReleasesReleaseIdPut(body);
|
|
429
|
+
console.log(data);
|
|
430
|
+
} catch (error) {
|
|
431
|
+
console.error(error);
|
|
432
|
+
}
|
|
433
|
+
}
|
|
434
|
+
|
|
435
|
+
// Run the test
|
|
436
|
+
example().catch(console.error);
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
### Parameters
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
| Name | Type | Description | Notes |
|
|
443
|
+
|------------- | ------------- | ------------- | -------------|
|
|
444
|
+
| **releaseId** | `string` | | [Defaults to `undefined`] |
|
|
445
|
+
| **releaseUpdateBody** | [ReleaseUpdateBody](ReleaseUpdateBody.md) | | |
|
|
446
|
+
|
|
447
|
+
### Return type
|
|
448
|
+
|
|
449
|
+
**boolean**
|
|
450
|
+
|
|
451
|
+
### Authorization
|
|
452
|
+
|
|
453
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
454
|
+
|
|
455
|
+
### HTTP request headers
|
|
456
|
+
|
|
457
|
+
- **Content-Type**: `application/json`
|
|
458
|
+
- **Accept**: `application/json`
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
### HTTP response details
|
|
462
|
+
| Status code | Description | Response headers |
|
|
463
|
+
|-------------|-------------|------------------|
|
|
464
|
+
| **200** | Successful Response | - |
|
|
465
|
+
| **422** | Validation Error | - |
|
|
466
|
+
|
|
467
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
## getDeviceInfoInternalDevicesDeviceIdGet
|
|
471
|
+
|
|
472
|
+
> DeviceInternalResponse getDeviceInfoInternalDevicesDeviceIdGet(deviceId)
|
|
473
|
+
|
|
474
|
+
Get Device Info
|
|
475
|
+
|
|
476
|
+
### Example
|
|
477
|
+
|
|
478
|
+
```ts
|
|
479
|
+
import {
|
|
480
|
+
Configuration,
|
|
481
|
+
InternalApi,
|
|
482
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
483
|
+
import type { GetDeviceInfoInternalDevicesDeviceIdGetRequest } from '@orangefox-recovery/foxinternalclient';
|
|
484
|
+
|
|
485
|
+
async function example() {
|
|
486
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
487
|
+
const config = new Configuration({
|
|
488
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
489
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
490
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
491
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
492
|
+
});
|
|
493
|
+
const api = new InternalApi(config);
|
|
494
|
+
|
|
495
|
+
const body = {
|
|
496
|
+
// string
|
|
497
|
+
deviceId: deviceId_example,
|
|
498
|
+
} satisfies GetDeviceInfoInternalDevicesDeviceIdGetRequest;
|
|
499
|
+
|
|
500
|
+
try {
|
|
501
|
+
const data = await api.getDeviceInfoInternalDevicesDeviceIdGet(body);
|
|
502
|
+
console.log(data);
|
|
503
|
+
} catch (error) {
|
|
504
|
+
console.error(error);
|
|
505
|
+
}
|
|
506
|
+
}
|
|
507
|
+
|
|
508
|
+
// Run the test
|
|
509
|
+
example().catch(console.error);
|
|
510
|
+
```
|
|
511
|
+
|
|
512
|
+
### Parameters
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
| Name | Type | Description | Notes |
|
|
516
|
+
|------------- | ------------- | ------------- | -------------|
|
|
517
|
+
| **deviceId** | `string` | | [Defaults to `undefined`] |
|
|
518
|
+
|
|
519
|
+
### Return type
|
|
520
|
+
|
|
521
|
+
[**DeviceInternalResponse**](DeviceInternalResponse.md)
|
|
522
|
+
|
|
523
|
+
### Authorization
|
|
524
|
+
|
|
525
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
526
|
+
|
|
527
|
+
### HTTP request headers
|
|
528
|
+
|
|
529
|
+
- **Content-Type**: Not defined
|
|
530
|
+
- **Accept**: `application/json`
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
### HTTP response details
|
|
534
|
+
| Status code | Description | Response headers |
|
|
535
|
+
|-------------|-------------|------------------|
|
|
536
|
+
| **200** | Successful Response | - |
|
|
537
|
+
| **422** | Validation Error | - |
|
|
538
|
+
|
|
539
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
## getLogsInternalLogsGet
|
|
543
|
+
|
|
544
|
+
> LogListResponse getLogsInternalLogsGet(page, perPage, deviceId, releaseId, userId, hideVerbose)
|
|
545
|
+
|
|
546
|
+
Get Logs
|
|
547
|
+
|
|
548
|
+
Get a paginated list of logs with optional filtering.
|
|
549
|
+
|
|
550
|
+
### Example
|
|
551
|
+
|
|
552
|
+
```ts
|
|
553
|
+
import {
|
|
554
|
+
Configuration,
|
|
555
|
+
InternalApi,
|
|
556
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
557
|
+
import type { GetLogsInternalLogsGetRequest } from '@orangefox-recovery/foxinternalclient';
|
|
558
|
+
|
|
559
|
+
async function example() {
|
|
560
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
561
|
+
const config = new Configuration({
|
|
562
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
563
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
564
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
565
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
566
|
+
});
|
|
567
|
+
const api = new InternalApi(config);
|
|
568
|
+
|
|
569
|
+
const body = {
|
|
570
|
+
// number (optional)
|
|
571
|
+
page: 56,
|
|
572
|
+
// number (optional)
|
|
573
|
+
perPage: 56,
|
|
574
|
+
// string (optional)
|
|
575
|
+
deviceId: deviceId_example,
|
|
576
|
+
// string (optional)
|
|
577
|
+
releaseId: releaseId_example,
|
|
578
|
+
// string (optional)
|
|
579
|
+
userId: userId_example,
|
|
580
|
+
// boolean (optional)
|
|
581
|
+
hideVerbose: true,
|
|
582
|
+
} satisfies GetLogsInternalLogsGetRequest;
|
|
583
|
+
|
|
584
|
+
try {
|
|
585
|
+
const data = await api.getLogsInternalLogsGet(body);
|
|
586
|
+
console.log(data);
|
|
587
|
+
} catch (error) {
|
|
588
|
+
console.error(error);
|
|
589
|
+
}
|
|
590
|
+
}
|
|
591
|
+
|
|
592
|
+
// Run the test
|
|
593
|
+
example().catch(console.error);
|
|
594
|
+
```
|
|
595
|
+
|
|
596
|
+
### Parameters
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
| Name | Type | Description | Notes |
|
|
600
|
+
|------------- | ------------- | ------------- | -------------|
|
|
601
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
602
|
+
| **perPage** | `number` | | [Optional] [Defaults to `20`] |
|
|
603
|
+
| **deviceId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
604
|
+
| **releaseId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
605
|
+
| **userId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
606
|
+
| **hideVerbose** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
607
|
+
|
|
608
|
+
### Return type
|
|
609
|
+
|
|
610
|
+
[**LogListResponse**](LogListResponse.md)
|
|
611
|
+
|
|
612
|
+
### Authorization
|
|
613
|
+
|
|
614
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
615
|
+
|
|
616
|
+
### HTTP request headers
|
|
617
|
+
|
|
618
|
+
- **Content-Type**: Not defined
|
|
619
|
+
- **Accept**: `application/json`
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
### HTTP response details
|
|
623
|
+
| Status code | Description | Response headers |
|
|
624
|
+
|-------------|-------------|------------------|
|
|
625
|
+
| **200** | Successful Response | - |
|
|
626
|
+
| **422** | Validation Error | - |
|
|
627
|
+
|
|
628
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
## getReleaseInfoInternalReleasesReleaseIdGet
|
|
632
|
+
|
|
633
|
+
> ReleaseInternalResponse getReleaseInfoInternalReleasesReleaseIdGet(releaseId)
|
|
634
|
+
|
|
635
|
+
Get Release Info
|
|
636
|
+
|
|
637
|
+
Get release information
|
|
638
|
+
|
|
639
|
+
### Example
|
|
640
|
+
|
|
641
|
+
```ts
|
|
642
|
+
import {
|
|
643
|
+
Configuration,
|
|
644
|
+
InternalApi,
|
|
645
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
646
|
+
import type { GetReleaseInfoInternalReleasesReleaseIdGetRequest } from '@orangefox-recovery/foxinternalclient';
|
|
647
|
+
|
|
648
|
+
async function example() {
|
|
649
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
650
|
+
const config = new Configuration({
|
|
651
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
652
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
653
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
654
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
655
|
+
});
|
|
656
|
+
const api = new InternalApi(config);
|
|
657
|
+
|
|
658
|
+
const body = {
|
|
659
|
+
// string
|
|
660
|
+
releaseId: releaseId_example,
|
|
661
|
+
} satisfies GetReleaseInfoInternalReleasesReleaseIdGetRequest;
|
|
662
|
+
|
|
663
|
+
try {
|
|
664
|
+
const data = await api.getReleaseInfoInternalReleasesReleaseIdGet(body);
|
|
665
|
+
console.log(data);
|
|
666
|
+
} catch (error) {
|
|
667
|
+
console.error(error);
|
|
668
|
+
}
|
|
669
|
+
}
|
|
670
|
+
|
|
671
|
+
// Run the test
|
|
672
|
+
example().catch(console.error);
|
|
673
|
+
```
|
|
674
|
+
|
|
675
|
+
### Parameters
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
| Name | Type | Description | Notes |
|
|
679
|
+
|------------- | ------------- | ------------- | -------------|
|
|
680
|
+
| **releaseId** | `string` | | [Defaults to `undefined`] |
|
|
681
|
+
|
|
682
|
+
### Return type
|
|
683
|
+
|
|
684
|
+
[**ReleaseInternalResponse**](ReleaseInternalResponse.md)
|
|
685
|
+
|
|
686
|
+
### Authorization
|
|
687
|
+
|
|
688
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
689
|
+
|
|
690
|
+
### HTTP request headers
|
|
691
|
+
|
|
692
|
+
- **Content-Type**: Not defined
|
|
693
|
+
- **Accept**: `application/json`
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
### HTTP response details
|
|
697
|
+
| Status code | Description | Response headers |
|
|
698
|
+
|-------------|-------------|------------------|
|
|
699
|
+
| **200** | Successful Response | - |
|
|
700
|
+
| **422** | Validation Error | - |
|
|
701
|
+
|
|
702
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
## getReleaseZipInternalReleasesReleaseIdDlGet
|
|
706
|
+
|
|
707
|
+
> boolean getReleaseZipInternalReleasesReleaseIdDlGet(releaseId)
|
|
708
|
+
|
|
709
|
+
Get Release Zip
|
|
710
|
+
|
|
711
|
+
Download release ZIP directly
|
|
712
|
+
|
|
713
|
+
### Example
|
|
714
|
+
|
|
715
|
+
```ts
|
|
716
|
+
import {
|
|
717
|
+
Configuration,
|
|
718
|
+
InternalApi,
|
|
719
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
720
|
+
import type { GetReleaseZipInternalReleasesReleaseIdDlGetRequest } from '@orangefox-recovery/foxinternalclient';
|
|
721
|
+
|
|
722
|
+
async function example() {
|
|
723
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
724
|
+
const config = new Configuration({
|
|
725
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
726
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
727
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
728
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
729
|
+
});
|
|
730
|
+
const api = new InternalApi(config);
|
|
731
|
+
|
|
732
|
+
const body = {
|
|
733
|
+
// string
|
|
734
|
+
releaseId: releaseId_example,
|
|
735
|
+
} satisfies GetReleaseZipInternalReleasesReleaseIdDlGetRequest;
|
|
736
|
+
|
|
737
|
+
try {
|
|
738
|
+
const data = await api.getReleaseZipInternalReleasesReleaseIdDlGet(body);
|
|
739
|
+
console.log(data);
|
|
740
|
+
} catch (error) {
|
|
741
|
+
console.error(error);
|
|
742
|
+
}
|
|
743
|
+
}
|
|
744
|
+
|
|
745
|
+
// Run the test
|
|
746
|
+
example().catch(console.error);
|
|
747
|
+
```
|
|
748
|
+
|
|
749
|
+
### Parameters
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
| Name | Type | Description | Notes |
|
|
753
|
+
|------------- | ------------- | ------------- | -------------|
|
|
754
|
+
| **releaseId** | `string` | | [Defaults to `undefined`] |
|
|
755
|
+
|
|
756
|
+
### Return type
|
|
757
|
+
|
|
758
|
+
**boolean**
|
|
759
|
+
|
|
760
|
+
### Authorization
|
|
761
|
+
|
|
762
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
763
|
+
|
|
764
|
+
### HTTP request headers
|
|
765
|
+
|
|
766
|
+
- **Content-Type**: Not defined
|
|
767
|
+
- **Accept**: `application/json`
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
### HTTP response details
|
|
771
|
+
| Status code | Description | Response headers |
|
|
772
|
+
|-------------|-------------|------------------|
|
|
773
|
+
| **200** | Successful Response | - |
|
|
774
|
+
| **422** | Validation Error | - |
|
|
775
|
+
|
|
776
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
## getUserByIdInternalUsersUserIdGet
|
|
780
|
+
|
|
781
|
+
> UserInternalResponse getUserByIdInternalUsersUserIdGet(userId)
|
|
782
|
+
|
|
783
|
+
Get User By Id
|
|
784
|
+
|
|
785
|
+
### Example
|
|
786
|
+
|
|
787
|
+
```ts
|
|
788
|
+
import {
|
|
789
|
+
Configuration,
|
|
790
|
+
InternalApi,
|
|
791
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
792
|
+
import type { GetUserByIdInternalUsersUserIdGetRequest } from '@orangefox-recovery/foxinternalclient';
|
|
793
|
+
|
|
794
|
+
async function example() {
|
|
795
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
796
|
+
const config = new Configuration({
|
|
797
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
798
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
799
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
800
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
801
|
+
});
|
|
802
|
+
const api = new InternalApi(config);
|
|
803
|
+
|
|
804
|
+
const body = {
|
|
805
|
+
// string
|
|
806
|
+
userId: userId_example,
|
|
807
|
+
} satisfies GetUserByIdInternalUsersUserIdGetRequest;
|
|
808
|
+
|
|
809
|
+
try {
|
|
810
|
+
const data = await api.getUserByIdInternalUsersUserIdGet(body);
|
|
811
|
+
console.log(data);
|
|
812
|
+
} catch (error) {
|
|
813
|
+
console.error(error);
|
|
814
|
+
}
|
|
815
|
+
}
|
|
816
|
+
|
|
817
|
+
// Run the test
|
|
818
|
+
example().catch(console.error);
|
|
819
|
+
```
|
|
820
|
+
|
|
821
|
+
### Parameters
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
| Name | Type | Description | Notes |
|
|
825
|
+
|------------- | ------------- | ------------- | -------------|
|
|
826
|
+
| **userId** | `string` | | [Defaults to `undefined`] |
|
|
827
|
+
|
|
828
|
+
### Return type
|
|
829
|
+
|
|
830
|
+
[**UserInternalResponse**](UserInternalResponse.md)
|
|
831
|
+
|
|
832
|
+
### Authorization
|
|
833
|
+
|
|
834
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
835
|
+
|
|
836
|
+
### HTTP request headers
|
|
837
|
+
|
|
838
|
+
- **Content-Type**: Not defined
|
|
839
|
+
- **Accept**: `application/json`
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
### HTTP response details
|
|
843
|
+
| Status code | Description | Response headers |
|
|
844
|
+
|-------------|-------------|------------------|
|
|
845
|
+
| **200** | Successful Response | - |
|
|
846
|
+
| **422** | Validation Error | - |
|
|
847
|
+
|
|
848
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
## listPastesInternalPasteGet
|
|
852
|
+
|
|
853
|
+
> Array<PasteOutput> listPastesInternalPasteGet()
|
|
854
|
+
|
|
855
|
+
List Pastes
|
|
856
|
+
|
|
857
|
+
List all pastes. Requires admin permissions.
|
|
858
|
+
|
|
859
|
+
### Example
|
|
860
|
+
|
|
861
|
+
```ts
|
|
862
|
+
import {
|
|
863
|
+
Configuration,
|
|
864
|
+
InternalApi,
|
|
865
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
866
|
+
import type { ListPastesInternalPasteGetRequest } from '@orangefox-recovery/foxinternalclient';
|
|
867
|
+
|
|
868
|
+
async function example() {
|
|
869
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
870
|
+
const config = new Configuration({
|
|
871
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
872
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
873
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
874
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
875
|
+
});
|
|
876
|
+
const api = new InternalApi(config);
|
|
877
|
+
|
|
878
|
+
try {
|
|
879
|
+
const data = await api.listPastesInternalPasteGet();
|
|
880
|
+
console.log(data);
|
|
881
|
+
} catch (error) {
|
|
882
|
+
console.error(error);
|
|
883
|
+
}
|
|
884
|
+
}
|
|
885
|
+
|
|
886
|
+
// Run the test
|
|
887
|
+
example().catch(console.error);
|
|
888
|
+
```
|
|
889
|
+
|
|
890
|
+
### Parameters
|
|
891
|
+
|
|
892
|
+
This endpoint does not need any parameter.
|
|
893
|
+
|
|
894
|
+
### Return type
|
|
895
|
+
|
|
896
|
+
[**Array<PasteOutput>**](PasteOutput.md)
|
|
897
|
+
|
|
898
|
+
### Authorization
|
|
899
|
+
|
|
900
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
901
|
+
|
|
902
|
+
### HTTP request headers
|
|
903
|
+
|
|
904
|
+
- **Content-Type**: Not defined
|
|
905
|
+
- **Accept**: `application/json`
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
### HTTP response details
|
|
909
|
+
| Status code | Description | Response headers |
|
|
910
|
+
|-------------|-------------|------------------|
|
|
911
|
+
| **200** | Successful Response | - |
|
|
912
|
+
| **429** | Too many requests | - |
|
|
913
|
+
|
|
914
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
## listUsersInternalUsersGet
|
|
918
|
+
|
|
919
|
+
> ListResponseUserShortResponse listUsersInternalUsersGet()
|
|
920
|
+
|
|
921
|
+
List Users
|
|
922
|
+
|
|
923
|
+
### Example
|
|
924
|
+
|
|
925
|
+
```ts
|
|
926
|
+
import {
|
|
927
|
+
Configuration,
|
|
928
|
+
InternalApi,
|
|
929
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
930
|
+
import type { ListUsersInternalUsersGetRequest } from '@orangefox-recovery/foxinternalclient';
|
|
931
|
+
|
|
932
|
+
async function example() {
|
|
933
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
934
|
+
const config = new Configuration({
|
|
935
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
936
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
937
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
938
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
939
|
+
});
|
|
940
|
+
const api = new InternalApi(config);
|
|
941
|
+
|
|
942
|
+
try {
|
|
943
|
+
const data = await api.listUsersInternalUsersGet();
|
|
944
|
+
console.log(data);
|
|
945
|
+
} catch (error) {
|
|
946
|
+
console.error(error);
|
|
947
|
+
}
|
|
948
|
+
}
|
|
949
|
+
|
|
950
|
+
// Run the test
|
|
951
|
+
example().catch(console.error);
|
|
952
|
+
```
|
|
953
|
+
|
|
954
|
+
### Parameters
|
|
955
|
+
|
|
956
|
+
This endpoint does not need any parameter.
|
|
957
|
+
|
|
958
|
+
### Return type
|
|
959
|
+
|
|
960
|
+
[**ListResponseUserShortResponse**](ListResponseUserShortResponse.md)
|
|
961
|
+
|
|
962
|
+
### Authorization
|
|
963
|
+
|
|
964
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
965
|
+
|
|
966
|
+
### HTTP request headers
|
|
967
|
+
|
|
968
|
+
- **Content-Type**: Not defined
|
|
969
|
+
- **Accept**: `application/json`
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
### HTTP response details
|
|
973
|
+
| Status code | Description | Response headers |
|
|
974
|
+
|-------------|-------------|------------------|
|
|
975
|
+
| **200** | Successful Response | - |
|
|
976
|
+
|
|
977
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
## loginOauthAuthLoginPost
|
|
981
|
+
|
|
982
|
+
> TokenResponse loginOauthAuthLoginPost(username, password, minTime, maxTime, grantType, scope, clientId, clientSecret)
|
|
983
|
+
|
|
984
|
+
Login Oauth
|
|
985
|
+
|
|
986
|
+
OAuth2 compatible token login, get an access token for future requests
|
|
987
|
+
|
|
988
|
+
### Example
|
|
989
|
+
|
|
990
|
+
```ts
|
|
991
|
+
import {
|
|
992
|
+
Configuration,
|
|
993
|
+
InternalApi,
|
|
994
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
995
|
+
import type { LoginOauthAuthLoginPostRequest } from '@orangefox-recovery/foxinternalclient';
|
|
996
|
+
|
|
997
|
+
async function example() {
|
|
998
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
999
|
+
const config = new Configuration({
|
|
1000
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1001
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1002
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1003
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1004
|
+
});
|
|
1005
|
+
const api = new InternalApi(config);
|
|
1006
|
+
|
|
1007
|
+
const body = {
|
|
1008
|
+
// string
|
|
1009
|
+
username: username_example,
|
|
1010
|
+
// string
|
|
1011
|
+
password: password_example,
|
|
1012
|
+
// number (optional)
|
|
1013
|
+
minTime: 8.14,
|
|
1014
|
+
// number (optional)
|
|
1015
|
+
maxTime: 8.14,
|
|
1016
|
+
// string (optional)
|
|
1017
|
+
grantType: grantType_example,
|
|
1018
|
+
// string (optional)
|
|
1019
|
+
scope: scope_example,
|
|
1020
|
+
// string (optional)
|
|
1021
|
+
clientId: clientId_example,
|
|
1022
|
+
// string (optional)
|
|
1023
|
+
clientSecret: clientSecret_example,
|
|
1024
|
+
} satisfies LoginOauthAuthLoginPostRequest;
|
|
1025
|
+
|
|
1026
|
+
try {
|
|
1027
|
+
const data = await api.loginOauthAuthLoginPost(body);
|
|
1028
|
+
console.log(data);
|
|
1029
|
+
} catch (error) {
|
|
1030
|
+
console.error(error);
|
|
1031
|
+
}
|
|
1032
|
+
}
|
|
1033
|
+
|
|
1034
|
+
// Run the test
|
|
1035
|
+
example().catch(console.error);
|
|
1036
|
+
```
|
|
1037
|
+
|
|
1038
|
+
### Parameters
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
| Name | Type | Description | Notes |
|
|
1042
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1043
|
+
| **username** | `string` | | [Defaults to `undefined`] |
|
|
1044
|
+
| **password** | `string` | | [Defaults to `undefined`] |
|
|
1045
|
+
| **minTime** | `number` | | [Optional] [Defaults to `0.3`] |
|
|
1046
|
+
| **maxTime** | `number` | | [Optional] [Defaults to `1`] |
|
|
1047
|
+
| **grantType** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1048
|
+
| **scope** | `string` | | [Optional] [Defaults to `''`] |
|
|
1049
|
+
| **clientId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1050
|
+
| **clientSecret** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1051
|
+
|
|
1052
|
+
### Return type
|
|
1053
|
+
|
|
1054
|
+
[**TokenResponse**](TokenResponse.md)
|
|
1055
|
+
|
|
1056
|
+
### Authorization
|
|
1057
|
+
|
|
1058
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
1059
|
+
|
|
1060
|
+
### HTTP request headers
|
|
1061
|
+
|
|
1062
|
+
- **Content-Type**: `application/x-www-form-urlencoded`
|
|
1063
|
+
- **Accept**: `application/json`
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
### HTTP response details
|
|
1067
|
+
| Status code | Description | Response headers |
|
|
1068
|
+
|-------------|-------------|------------------|
|
|
1069
|
+
| **200** | Successful Response | - |
|
|
1070
|
+
| **422** | Validation Error | - |
|
|
1071
|
+
|
|
1072
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
## logoutAuthLogoutPost
|
|
1076
|
+
|
|
1077
|
+
> any logoutAuthLogoutPost(body)
|
|
1078
|
+
|
|
1079
|
+
Logout
|
|
1080
|
+
|
|
1081
|
+
### Example
|
|
1082
|
+
|
|
1083
|
+
```ts
|
|
1084
|
+
import {
|
|
1085
|
+
Configuration,
|
|
1086
|
+
InternalApi,
|
|
1087
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
1088
|
+
import type { LogoutAuthLogoutPostRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1089
|
+
|
|
1090
|
+
async function example() {
|
|
1091
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1092
|
+
const config = new Configuration({
|
|
1093
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1094
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1095
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1096
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1097
|
+
});
|
|
1098
|
+
const api = new InternalApi(config);
|
|
1099
|
+
|
|
1100
|
+
const body = {
|
|
1101
|
+
// string
|
|
1102
|
+
body: body_example,
|
|
1103
|
+
} satisfies LogoutAuthLogoutPostRequest;
|
|
1104
|
+
|
|
1105
|
+
try {
|
|
1106
|
+
const data = await api.logoutAuthLogoutPost(body);
|
|
1107
|
+
console.log(data);
|
|
1108
|
+
} catch (error) {
|
|
1109
|
+
console.error(error);
|
|
1110
|
+
}
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
// Run the test
|
|
1114
|
+
example().catch(console.error);
|
|
1115
|
+
```
|
|
1116
|
+
|
|
1117
|
+
### Parameters
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
| Name | Type | Description | Notes |
|
|
1121
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1122
|
+
| **body** | `string` | | |
|
|
1123
|
+
|
|
1124
|
+
### Return type
|
|
1125
|
+
|
|
1126
|
+
**any**
|
|
1127
|
+
|
|
1128
|
+
### Authorization
|
|
1129
|
+
|
|
1130
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
1131
|
+
|
|
1132
|
+
### HTTP request headers
|
|
1133
|
+
|
|
1134
|
+
- **Content-Type**: `application/json`
|
|
1135
|
+
- **Accept**: `application/json`
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
### HTTP response details
|
|
1139
|
+
| Status code | Description | Response headers |
|
|
1140
|
+
|-------------|-------------|------------------|
|
|
1141
|
+
| **200** | Successful Response | - |
|
|
1142
|
+
| **422** | Validation Error | - |
|
|
1143
|
+
|
|
1144
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
## newDeviceInternalDevicesPost
|
|
1148
|
+
|
|
1149
|
+
> string newDeviceInternalDevicesPost(newDeviceBody)
|
|
1150
|
+
|
|
1151
|
+
New Device
|
|
1152
|
+
|
|
1153
|
+
### Example
|
|
1154
|
+
|
|
1155
|
+
```ts
|
|
1156
|
+
import {
|
|
1157
|
+
Configuration,
|
|
1158
|
+
InternalApi,
|
|
1159
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
1160
|
+
import type { NewDeviceInternalDevicesPostRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1161
|
+
|
|
1162
|
+
async function example() {
|
|
1163
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1164
|
+
const config = new Configuration({
|
|
1165
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1166
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1167
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1168
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1169
|
+
});
|
|
1170
|
+
const api = new InternalApi(config);
|
|
1171
|
+
|
|
1172
|
+
const body = {
|
|
1173
|
+
// NewDeviceBody
|
|
1174
|
+
newDeviceBody: ...,
|
|
1175
|
+
} satisfies NewDeviceInternalDevicesPostRequest;
|
|
1176
|
+
|
|
1177
|
+
try {
|
|
1178
|
+
const data = await api.newDeviceInternalDevicesPost(body);
|
|
1179
|
+
console.log(data);
|
|
1180
|
+
} catch (error) {
|
|
1181
|
+
console.error(error);
|
|
1182
|
+
}
|
|
1183
|
+
}
|
|
1184
|
+
|
|
1185
|
+
// Run the test
|
|
1186
|
+
example().catch(console.error);
|
|
1187
|
+
```
|
|
1188
|
+
|
|
1189
|
+
### Parameters
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
| Name | Type | Description | Notes |
|
|
1193
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1194
|
+
| **newDeviceBody** | [NewDeviceBody](NewDeviceBody.md) | | |
|
|
1195
|
+
|
|
1196
|
+
### Return type
|
|
1197
|
+
|
|
1198
|
+
**string**
|
|
1199
|
+
|
|
1200
|
+
### Authorization
|
|
1201
|
+
|
|
1202
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
1203
|
+
|
|
1204
|
+
### HTTP request headers
|
|
1205
|
+
|
|
1206
|
+
- **Content-Type**: `application/json`
|
|
1207
|
+
- **Accept**: `application/json`
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
### HTTP response details
|
|
1211
|
+
| Status code | Description | Response headers |
|
|
1212
|
+
|-------------|-------------|------------------|
|
|
1213
|
+
| **200** | Successful Response | - |
|
|
1214
|
+
| **422** | Validation Error | - |
|
|
1215
|
+
|
|
1216
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
## newReleaseInternalReleasesPost
|
|
1220
|
+
|
|
1221
|
+
> ReleaseResponse newReleaseInternalReleasesPost(deviceId, releaseZip, md5, changelog, bugs, notes, force)
|
|
1222
|
+
|
|
1223
|
+
New Release
|
|
1224
|
+
|
|
1225
|
+
### Example
|
|
1226
|
+
|
|
1227
|
+
```ts
|
|
1228
|
+
import {
|
|
1229
|
+
Configuration,
|
|
1230
|
+
InternalApi,
|
|
1231
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
1232
|
+
import type { NewReleaseInternalReleasesPostRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1233
|
+
|
|
1234
|
+
async function example() {
|
|
1235
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1236
|
+
const config = new Configuration({
|
|
1237
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1238
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1239
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1240
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1241
|
+
});
|
|
1242
|
+
const api = new InternalApi(config);
|
|
1243
|
+
|
|
1244
|
+
const body = {
|
|
1245
|
+
// string
|
|
1246
|
+
deviceId: deviceId_example,
|
|
1247
|
+
// Blob
|
|
1248
|
+
releaseZip: BINARY_DATA_HERE,
|
|
1249
|
+
// string
|
|
1250
|
+
md5: md5_example,
|
|
1251
|
+
// Array<string>
|
|
1252
|
+
changelog: ...,
|
|
1253
|
+
// Array<string> (optional)
|
|
1254
|
+
bugs: ...,
|
|
1255
|
+
// string (optional)
|
|
1256
|
+
notes: notes_example,
|
|
1257
|
+
// boolean (optional)
|
|
1258
|
+
force: true,
|
|
1259
|
+
} satisfies NewReleaseInternalReleasesPostRequest;
|
|
1260
|
+
|
|
1261
|
+
try {
|
|
1262
|
+
const data = await api.newReleaseInternalReleasesPost(body);
|
|
1263
|
+
console.log(data);
|
|
1264
|
+
} catch (error) {
|
|
1265
|
+
console.error(error);
|
|
1266
|
+
}
|
|
1267
|
+
}
|
|
1268
|
+
|
|
1269
|
+
// Run the test
|
|
1270
|
+
example().catch(console.error);
|
|
1271
|
+
```
|
|
1272
|
+
|
|
1273
|
+
### Parameters
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
| Name | Type | Description | Notes |
|
|
1277
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1278
|
+
| **deviceId** | `string` | | [Defaults to `undefined`] |
|
|
1279
|
+
| **releaseZip** | `Blob` | | [Defaults to `undefined`] |
|
|
1280
|
+
| **md5** | `string` | | [Defaults to `undefined`] |
|
|
1281
|
+
| **changelog** | `Array<string>` | | |
|
|
1282
|
+
| **bugs** | `Array<string>` | | [Optional] |
|
|
1283
|
+
| **notes** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1284
|
+
| **force** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
1285
|
+
|
|
1286
|
+
### Return type
|
|
1287
|
+
|
|
1288
|
+
[**ReleaseResponse**](ReleaseResponse.md)
|
|
1289
|
+
|
|
1290
|
+
### Authorization
|
|
1291
|
+
|
|
1292
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
1293
|
+
|
|
1294
|
+
### HTTP request headers
|
|
1295
|
+
|
|
1296
|
+
- **Content-Type**: `multipart/form-data`
|
|
1297
|
+
- **Accept**: `application/json`
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
### HTTP response details
|
|
1301
|
+
| Status code | Description | Response headers |
|
|
1302
|
+
|-------------|-------------|------------------|
|
|
1303
|
+
| **200** | Successful Response | - |
|
|
1304
|
+
| **422** | Validation Error | - |
|
|
1305
|
+
|
|
1306
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
## renewAuthRenewPost
|
|
1310
|
+
|
|
1311
|
+
> string renewAuthRenewPost(body)
|
|
1312
|
+
|
|
1313
|
+
Renew
|
|
1314
|
+
|
|
1315
|
+
### Example
|
|
1316
|
+
|
|
1317
|
+
```ts
|
|
1318
|
+
import {
|
|
1319
|
+
Configuration,
|
|
1320
|
+
InternalApi,
|
|
1321
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
1322
|
+
import type { RenewAuthRenewPostRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1323
|
+
|
|
1324
|
+
async function example() {
|
|
1325
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1326
|
+
const config = new Configuration({
|
|
1327
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1328
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1329
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1330
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1331
|
+
});
|
|
1332
|
+
const api = new InternalApi(config);
|
|
1333
|
+
|
|
1334
|
+
const body = {
|
|
1335
|
+
// string
|
|
1336
|
+
body: body_example,
|
|
1337
|
+
} satisfies RenewAuthRenewPostRequest;
|
|
1338
|
+
|
|
1339
|
+
try {
|
|
1340
|
+
const data = await api.renewAuthRenewPost(body);
|
|
1341
|
+
console.log(data);
|
|
1342
|
+
} catch (error) {
|
|
1343
|
+
console.error(error);
|
|
1344
|
+
}
|
|
1345
|
+
}
|
|
1346
|
+
|
|
1347
|
+
// Run the test
|
|
1348
|
+
example().catch(console.error);
|
|
1349
|
+
```
|
|
1350
|
+
|
|
1351
|
+
### Parameters
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
| Name | Type | Description | Notes |
|
|
1355
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1356
|
+
| **body** | `string` | | |
|
|
1357
|
+
|
|
1358
|
+
### Return type
|
|
1359
|
+
|
|
1360
|
+
**string**
|
|
1361
|
+
|
|
1362
|
+
### Authorization
|
|
1363
|
+
|
|
1364
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
1365
|
+
|
|
1366
|
+
### HTTP request headers
|
|
1367
|
+
|
|
1368
|
+
- **Content-Type**: `application/json`
|
|
1369
|
+
- **Accept**: `application/json`
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
### HTTP response details
|
|
1373
|
+
| Status code | Description | Response headers |
|
|
1374
|
+
|-------------|-------------|------------------|
|
|
1375
|
+
| **200** | Successful Response | - |
|
|
1376
|
+
| **422** | Validation Error | - |
|
|
1377
|
+
|
|
1378
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
## updateDeviceInternalDevicesDeviceIdPut
|
|
1382
|
+
|
|
1383
|
+
> boolean updateDeviceInternalDevicesDeviceIdPut(deviceId, deviceUpdateBody)
|
|
1384
|
+
|
|
1385
|
+
Update Device
|
|
1386
|
+
|
|
1387
|
+
### Example
|
|
1388
|
+
|
|
1389
|
+
```ts
|
|
1390
|
+
import {
|
|
1391
|
+
Configuration,
|
|
1392
|
+
InternalApi,
|
|
1393
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
1394
|
+
import type { UpdateDeviceInternalDevicesDeviceIdPutRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1395
|
+
|
|
1396
|
+
async function example() {
|
|
1397
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1398
|
+
const config = new Configuration({
|
|
1399
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1400
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1401
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1402
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1403
|
+
});
|
|
1404
|
+
const api = new InternalApi(config);
|
|
1405
|
+
|
|
1406
|
+
const body = {
|
|
1407
|
+
// string
|
|
1408
|
+
deviceId: deviceId_example,
|
|
1409
|
+
// DeviceUpdateBody
|
|
1410
|
+
deviceUpdateBody: ...,
|
|
1411
|
+
} satisfies UpdateDeviceInternalDevicesDeviceIdPutRequest;
|
|
1412
|
+
|
|
1413
|
+
try {
|
|
1414
|
+
const data = await api.updateDeviceInternalDevicesDeviceIdPut(body);
|
|
1415
|
+
console.log(data);
|
|
1416
|
+
} catch (error) {
|
|
1417
|
+
console.error(error);
|
|
1418
|
+
}
|
|
1419
|
+
}
|
|
1420
|
+
|
|
1421
|
+
// Run the test
|
|
1422
|
+
example().catch(console.error);
|
|
1423
|
+
```
|
|
1424
|
+
|
|
1425
|
+
### Parameters
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
| Name | Type | Description | Notes |
|
|
1429
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1430
|
+
| **deviceId** | `string` | | [Defaults to `undefined`] |
|
|
1431
|
+
| **deviceUpdateBody** | [DeviceUpdateBody](DeviceUpdateBody.md) | | |
|
|
1432
|
+
|
|
1433
|
+
### Return type
|
|
1434
|
+
|
|
1435
|
+
**boolean**
|
|
1436
|
+
|
|
1437
|
+
### Authorization
|
|
1438
|
+
|
|
1439
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
1440
|
+
|
|
1441
|
+
### HTTP request headers
|
|
1442
|
+
|
|
1443
|
+
- **Content-Type**: `application/json`
|
|
1444
|
+
- **Accept**: `application/json`
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
### HTTP response details
|
|
1448
|
+
| Status code | Description | Response headers |
|
|
1449
|
+
|-------------|-------------|------------------|
|
|
1450
|
+
| **200** | Successful Response | - |
|
|
1451
|
+
| **422** | Validation Error | - |
|
|
1452
|
+
|
|
1453
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
## updatePasteInternalPastePasteIdPut
|
|
1457
|
+
|
|
1458
|
+
> PasteOutput updatePasteInternalPastePasteIdPut(pasteId, pasteInput)
|
|
1459
|
+
|
|
1460
|
+
Update Paste
|
|
1461
|
+
|
|
1462
|
+
Update a paste by ID. Requires admin permissions.
|
|
1463
|
+
|
|
1464
|
+
### Example
|
|
1465
|
+
|
|
1466
|
+
```ts
|
|
1467
|
+
import {
|
|
1468
|
+
Configuration,
|
|
1469
|
+
InternalApi,
|
|
1470
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
1471
|
+
import type { UpdatePasteInternalPastePasteIdPutRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1472
|
+
|
|
1473
|
+
async function example() {
|
|
1474
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1475
|
+
const config = new Configuration({
|
|
1476
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1477
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1478
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1479
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1480
|
+
});
|
|
1481
|
+
const api = new InternalApi(config);
|
|
1482
|
+
|
|
1483
|
+
const body = {
|
|
1484
|
+
// string
|
|
1485
|
+
pasteId: pasteId_example,
|
|
1486
|
+
// PasteInput
|
|
1487
|
+
pasteInput: ...,
|
|
1488
|
+
} satisfies UpdatePasteInternalPastePasteIdPutRequest;
|
|
1489
|
+
|
|
1490
|
+
try {
|
|
1491
|
+
const data = await api.updatePasteInternalPastePasteIdPut(body);
|
|
1492
|
+
console.log(data);
|
|
1493
|
+
} catch (error) {
|
|
1494
|
+
console.error(error);
|
|
1495
|
+
}
|
|
1496
|
+
}
|
|
1497
|
+
|
|
1498
|
+
// Run the test
|
|
1499
|
+
example().catch(console.error);
|
|
1500
|
+
```
|
|
1501
|
+
|
|
1502
|
+
### Parameters
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
| Name | Type | Description | Notes |
|
|
1506
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1507
|
+
| **pasteId** | `string` | | [Defaults to `undefined`] |
|
|
1508
|
+
| **pasteInput** | [PasteInput](PasteInput.md) | | |
|
|
1509
|
+
|
|
1510
|
+
### Return type
|
|
1511
|
+
|
|
1512
|
+
[**PasteOutput**](PasteOutput.md)
|
|
1513
|
+
|
|
1514
|
+
### Authorization
|
|
1515
|
+
|
|
1516
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
1517
|
+
|
|
1518
|
+
### HTTP request headers
|
|
1519
|
+
|
|
1520
|
+
- **Content-Type**: `application/json`
|
|
1521
|
+
- **Accept**: `application/json`
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
### HTTP response details
|
|
1525
|
+
| Status code | Description | Response headers |
|
|
1526
|
+
|-------------|-------------|------------------|
|
|
1527
|
+
| **200** | Successful Response | - |
|
|
1528
|
+
| **404** | Item not found | - |
|
|
1529
|
+
| **429** | Too many requests | - |
|
|
1530
|
+
| **422** | Validation Error | - |
|
|
1531
|
+
|
|
1532
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
## updateUserInternalUsersUserIdPut
|
|
1536
|
+
|
|
1537
|
+
> boolean updateUserInternalUsersUserIdPut(userId, userUpdateBody)
|
|
1538
|
+
|
|
1539
|
+
Update User
|
|
1540
|
+
|
|
1541
|
+
### Example
|
|
1542
|
+
|
|
1543
|
+
```ts
|
|
1544
|
+
import {
|
|
1545
|
+
Configuration,
|
|
1546
|
+
InternalApi,
|
|
1547
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
1548
|
+
import type { UpdateUserInternalUsersUserIdPutRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1549
|
+
|
|
1550
|
+
async function example() {
|
|
1551
|
+
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1552
|
+
const config = new Configuration({
|
|
1553
|
+
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1554
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1555
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1556
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1557
|
+
});
|
|
1558
|
+
const api = new InternalApi(config);
|
|
1559
|
+
|
|
1560
|
+
const body = {
|
|
1561
|
+
// string
|
|
1562
|
+
userId: userId_example,
|
|
1563
|
+
// UserUpdateBody
|
|
1564
|
+
userUpdateBody: ...,
|
|
1565
|
+
} satisfies UpdateUserInternalUsersUserIdPutRequest;
|
|
1566
|
+
|
|
1567
|
+
try {
|
|
1568
|
+
const data = await api.updateUserInternalUsersUserIdPut(body);
|
|
1569
|
+
console.log(data);
|
|
1570
|
+
} catch (error) {
|
|
1571
|
+
console.error(error);
|
|
1572
|
+
}
|
|
1573
|
+
}
|
|
1574
|
+
|
|
1575
|
+
// Run the test
|
|
1576
|
+
example().catch(console.error);
|
|
1577
|
+
```
|
|
1578
|
+
|
|
1579
|
+
### Parameters
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
| Name | Type | Description | Notes |
|
|
1583
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1584
|
+
| **userId** | `string` | | [Defaults to `undefined`] |
|
|
1585
|
+
| **userUpdateBody** | [UserUpdateBody](UserUpdateBody.md) | | |
|
|
1586
|
+
|
|
1587
|
+
### Return type
|
|
1588
|
+
|
|
1589
|
+
**boolean**
|
|
1590
|
+
|
|
1591
|
+
### Authorization
|
|
1592
|
+
|
|
1593
|
+
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
1594
|
+
|
|
1595
|
+
### HTTP request headers
|
|
1596
|
+
|
|
1597
|
+
- **Content-Type**: `application/json`
|
|
1598
|
+
- **Accept**: `application/json`
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
### HTTP response details
|
|
1602
|
+
| Status code | Description | Response headers |
|
|
1603
|
+
|-------------|-------------|------------------|
|
|
1604
|
+
| **200** | Successful Response | - |
|
|
1605
|
+
| **422** | Validation Error | - |
|
|
1606
|
+
|
|
1607
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1608
|
+
|