@orangefox-recovery/foxinternalclient 5.4.0 → 6.0.4
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 +34 -40
- package/README.md +74 -85
- package/dist/apis/DeviceApi.d.ts +89 -107
- package/dist/apis/DeviceApi.js +60 -71
- package/dist/apis/FoxFactoryApi.d.ts +163 -199
- package/dist/apis/FoxFactoryApi.js +122 -233
- package/dist/apis/GitlabApi.d.ts +21 -18
- package/dist/apis/GitlabApi.js +21 -12
- package/dist/apis/InternalApi.d.ts +452 -545
- package/dist/apis/InternalApi.js +413 -650
- package/dist/apis/PasteApi.d.ts +33 -39
- package/dist/apis/PasteApi.js +23 -27
- package/dist/apis/ReleaseApi.d.ts +145 -143
- package/dist/apis/ReleaseApi.js +108 -95
- package/dist/apis/ReportApi.d.ts +64 -0
- package/dist/apis/ReportApi.js +89 -0
- package/dist/apis/StatsApi.d.ts +19 -19
- package/dist/apis/StatsApi.js +14 -14
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/DeviceApi.d.ts +89 -107
- package/dist/esm/apis/DeviceApi.js +61 -72
- package/dist/esm/apis/FoxFactoryApi.d.ts +163 -199
- package/dist/esm/apis/FoxFactoryApi.js +123 -234
- package/dist/esm/apis/GitlabApi.d.ts +21 -18
- package/dist/esm/apis/GitlabApi.js +21 -12
- package/dist/esm/apis/InternalApi.d.ts +452 -545
- package/dist/esm/apis/InternalApi.js +414 -651
- package/dist/esm/apis/PasteApi.d.ts +33 -39
- package/dist/esm/apis/PasteApi.js +24 -28
- package/dist/esm/apis/ReleaseApi.d.ts +145 -143
- package/dist/esm/apis/ReleaseApi.js +109 -96
- package/dist/esm/apis/ReportApi.d.ts +64 -0
- package/dist/esm/apis/ReportApi.js +85 -0
- package/dist/esm/apis/StatsApi.d.ts +19 -19
- package/dist/esm/apis/StatsApi.js +15 -15
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/BuildTaskResponse.d.ts +22 -26
- package/dist/esm/models/BuildTaskResponse.js +30 -24
- package/dist/esm/models/BuildTaskShortResponse.d.ts +19 -21
- package/dist/esm/models/BuildTaskShortResponse.js +27 -23
- package/dist/esm/models/ChangePasswordBody.d.ts +38 -0
- package/dist/esm/models/ChangePasswordBody.js +47 -0
- package/dist/esm/models/DeletePasskeyBody.d.ts +32 -0
- package/dist/esm/models/DeletePasskeyBody.js +43 -0
- package/dist/esm/models/DeviceInternalResponse.d.ts +40 -36
- package/dist/esm/models/DeviceInternalResponse.js +36 -30
- package/dist/esm/models/DeviceResponse.d.ts +33 -29
- package/dist/esm/models/DeviceResponse.js +34 -26
- package/dist/esm/models/DeviceStatsResponse.d.ts +2 -2
- package/dist/esm/models/DeviceStatsResponse.js +2 -2
- package/dist/esm/models/DeviceUpdateBody.d.ts +13 -13
- package/dist/esm/models/DeviceUpdateBody.js +8 -8
- package/dist/esm/models/ErrorResponse.d.ts +32 -0
- package/dist/esm/models/ErrorResponse.js +43 -0
- package/dist/esm/models/FFStatusResponse.d.ts +4 -5
- package/dist/esm/models/FFStatusResponse.js +4 -5
- package/dist/esm/models/GlobalStatsResponse.d.ts +52 -0
- package/dist/esm/models/{GlobalStatsAggregationModel.js → GlobalStatsResponse.js} +14 -14
- package/dist/esm/models/ListResponseBuildTaskShortResponse.d.ts +8 -8
- package/dist/esm/models/ListResponseBuildTaskShortResponse.js +8 -7
- package/dist/esm/models/ListResponseBuildTaskShortResponseDataInner.d.ts +87 -0
- package/dist/esm/models/ListResponseBuildTaskShortResponseDataInner.js +78 -0
- package/dist/esm/models/ListResponsePasteResponse.d.ts +39 -0
- package/dist/esm/models/ListResponsePasteResponse.js +48 -0
- package/dist/esm/models/ListResponsePasteResponseDataInner.d.ts +50 -0
- package/dist/esm/models/ListResponsePasteResponseDataInner.js +53 -0
- package/dist/esm/models/ListResponseReleaseResponse.d.ts +8 -8
- package/dist/esm/models/ListResponseReleaseResponse.js +8 -7
- package/dist/esm/models/ListResponseReleaseResponseDataInner.d.ts +155 -0
- package/dist/esm/models/ListResponseReleaseResponseDataInner.js +114 -0
- package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +8 -8
- package/dist/esm/models/ListResponseShortDeviceResponse.js +8 -7
- package/dist/esm/models/ListResponseShortDeviceResponseDataInner.d.ts +98 -0
- package/dist/esm/models/ListResponseShortDeviceResponseDataInner.js +85 -0
- package/dist/esm/models/ListResponseString.d.ts +38 -0
- package/dist/esm/models/ListResponseString.js +47 -0
- package/dist/esm/models/ListResponseUserShortResponse.d.ts +8 -8
- package/dist/esm/models/ListResponseUserShortResponse.js +8 -7
- package/dist/esm/models/ListResponseUserShortResponseDataInner.d.ts +50 -0
- package/dist/esm/models/ListResponseUserShortResponseDataInner.js +55 -0
- package/dist/esm/models/LogListResponse.d.ts +5 -5
- package/dist/esm/models/LogListResponse.js +6 -6
- package/dist/esm/models/LogResponse.d.ts +15 -17
- package/dist/esm/models/LogResponse.js +16 -16
- package/dist/esm/models/LoginForm.d.ts +38 -0
- package/dist/esm/models/LoginForm.js +47 -0
- package/dist/esm/models/MaintainerShortResponse.d.ts +50 -0
- package/dist/esm/models/MaintainerShortResponse.js +55 -0
- package/dist/esm/models/NewBuildTaskBody.d.ts +13 -8
- package/dist/esm/models/NewBuildTaskBody.js +8 -7
- package/dist/esm/models/NewDeviceBody.d.ts +8 -8
- package/dist/esm/models/NewDeviceBody.js +9 -9
- package/dist/esm/models/NewReportRequest.d.ts +58 -0
- package/dist/esm/models/NewReportRequest.js +55 -0
- package/dist/esm/models/PasskeyCredentialResponse.d.ts +15 -15
- package/dist/esm/models/PasskeyCredentialResponse.js +14 -14
- package/dist/esm/models/PasskeyRegisterOptionsRequest.d.ts +3 -3
- package/dist/esm/models/PasskeyRegisterOptionsRequest.js +2 -2
- package/dist/esm/models/PasskeyVerifyRequest.d.ts +8 -10
- package/dist/esm/models/PasskeyVerifyRequest.js +6 -6
- package/dist/esm/models/PasteInput.d.ts +3 -3
- package/dist/esm/models/PasteInput.js +2 -2
- package/dist/esm/models/PasteResponse.d.ts +50 -0
- package/dist/esm/models/PasteResponse.js +53 -0
- package/dist/esm/models/RecoveryImgResponse.d.ts +6 -6
- package/dist/esm/models/RecoveryImgResponse.js +6 -6
- package/dist/esm/models/ReleaseGroupsResponse.d.ts +2 -2
- package/dist/esm/models/ReleaseGroupsResponse.js +2 -2
- package/dist/esm/models/ReleaseInternalResponse.d.ts +54 -53
- package/dist/esm/models/ReleaseInternalResponse.js +52 -53
- package/dist/esm/models/ReleaseResponse.d.ts +46 -42
- package/dist/esm/models/ReleaseResponse.js +45 -44
- package/dist/esm/models/ReleaseStatsResponse.d.ts +2 -2
- package/dist/esm/models/ReleaseStatsResponse.js +2 -2
- package/dist/esm/models/ReleaseUpdateBody.d.ts +9 -9
- package/dist/esm/models/ReleaseUpdateBody.js +6 -6
- package/dist/esm/models/RenamePasskeyBody.d.ts +3 -3
- package/dist/esm/models/RenamePasskeyBody.js +2 -2
- package/dist/esm/models/ShortDeviceResponse.d.ts +29 -25
- package/dist/esm/models/ShortDeviceResponse.js +26 -18
- package/dist/esm/models/ShortReleaseResponse.d.ts +31 -27
- package/dist/esm/models/ShortReleaseResponse.js +35 -32
- package/dist/esm/models/TaskUpdateBody.d.ts +7 -8
- package/dist/esm/models/TaskUpdateBody.js +4 -5
- package/dist/esm/models/TokenResponse.d.ts +3 -3
- package/dist/esm/models/TokenResponse.js +5 -3
- package/dist/esm/models/UserInternalResponse.d.ts +21 -24
- package/dist/esm/models/UserInternalResponse.js +20 -23
- package/dist/esm/models/UserShortResponse.d.ts +7 -7
- package/dist/esm/models/UserShortResponse.js +9 -9
- package/dist/esm/models/UserUpdateBody.d.ts +9 -9
- package/dist/esm/models/UserUpdateBody.js +8 -8
- package/dist/esm/models/WorkerStatusBody.d.ts +32 -0
- package/dist/esm/models/WorkerStatusBody.js +43 -0
- package/dist/esm/models/index.d.ts +16 -20
- package/dist/esm/models/index.js +16 -20
- package/dist/esm/runtime.d.ts +2 -2
- package/dist/esm/runtime.js +2 -2
- package/dist/models/BuildTaskResponse.d.ts +22 -26
- package/dist/models/BuildTaskResponse.js +30 -24
- package/dist/models/BuildTaskShortResponse.d.ts +19 -21
- package/dist/models/BuildTaskShortResponse.js +27 -23
- package/dist/models/ChangePasswordBody.d.ts +38 -0
- package/dist/models/ChangePasswordBody.js +54 -0
- package/dist/models/DeletePasskeyBody.d.ts +32 -0
- package/dist/models/DeletePasskeyBody.js +50 -0
- package/dist/models/DeviceInternalResponse.d.ts +40 -36
- package/dist/models/DeviceInternalResponse.js +36 -30
- package/dist/models/DeviceResponse.d.ts +33 -29
- package/dist/models/DeviceResponse.js +34 -26
- package/dist/models/DeviceStatsResponse.d.ts +2 -2
- package/dist/models/DeviceStatsResponse.js +2 -2
- package/dist/models/DeviceUpdateBody.d.ts +13 -13
- package/dist/models/DeviceUpdateBody.js +8 -8
- package/dist/models/ErrorResponse.d.ts +32 -0
- package/dist/models/ErrorResponse.js +50 -0
- package/dist/models/FFStatusResponse.d.ts +4 -5
- package/dist/models/FFStatusResponse.js +4 -5
- package/dist/models/GlobalStatsResponse.d.ts +52 -0
- package/dist/models/GlobalStatsResponse.js +62 -0
- package/dist/models/ListResponseBuildTaskShortResponse.d.ts +8 -8
- package/dist/models/ListResponseBuildTaskShortResponse.js +8 -7
- package/dist/models/ListResponseBuildTaskShortResponseDataInner.d.ts +87 -0
- package/dist/models/ListResponseBuildTaskShortResponseDataInner.js +85 -0
- package/dist/models/ListResponsePasteResponse.d.ts +39 -0
- package/dist/models/ListResponsePasteResponse.js +55 -0
- package/dist/models/ListResponsePasteResponseDataInner.d.ts +50 -0
- package/dist/models/ListResponsePasteResponseDataInner.js +60 -0
- package/dist/models/ListResponseReleaseResponse.d.ts +8 -8
- package/dist/models/ListResponseReleaseResponse.js +8 -7
- package/dist/models/ListResponseReleaseResponseDataInner.d.ts +155 -0
- package/dist/models/ListResponseReleaseResponseDataInner.js +121 -0
- package/dist/models/ListResponseShortDeviceResponse.d.ts +8 -8
- package/dist/models/ListResponseShortDeviceResponse.js +8 -7
- package/dist/models/ListResponseShortDeviceResponseDataInner.d.ts +98 -0
- package/dist/models/ListResponseShortDeviceResponseDataInner.js +92 -0
- package/dist/models/ListResponseString.d.ts +38 -0
- package/dist/models/ListResponseString.js +54 -0
- package/dist/models/ListResponseUserShortResponse.d.ts +8 -8
- package/dist/models/ListResponseUserShortResponse.js +8 -7
- package/dist/models/ListResponseUserShortResponseDataInner.d.ts +50 -0
- package/dist/models/ListResponseUserShortResponseDataInner.js +62 -0
- package/dist/models/LogListResponse.d.ts +5 -5
- package/dist/models/LogListResponse.js +6 -6
- package/dist/models/LogResponse.d.ts +15 -17
- package/dist/models/LogResponse.js +16 -16
- package/dist/models/LoginForm.d.ts +38 -0
- package/dist/models/LoginForm.js +54 -0
- package/dist/models/MaintainerShortResponse.d.ts +50 -0
- package/dist/models/MaintainerShortResponse.js +62 -0
- package/dist/models/NewBuildTaskBody.d.ts +13 -8
- package/dist/models/NewBuildTaskBody.js +8 -7
- package/dist/models/NewDeviceBody.d.ts +8 -8
- package/dist/models/NewDeviceBody.js +9 -9
- package/dist/models/NewReportRequest.d.ts +58 -0
- package/dist/models/NewReportRequest.js +62 -0
- package/dist/models/PasskeyCredentialResponse.d.ts +15 -15
- package/dist/models/PasskeyCredentialResponse.js +14 -14
- package/dist/models/PasskeyRegisterOptionsRequest.d.ts +3 -3
- package/dist/models/PasskeyRegisterOptionsRequest.js +2 -2
- package/dist/models/PasskeyVerifyRequest.d.ts +8 -10
- package/dist/models/PasskeyVerifyRequest.js +6 -6
- package/dist/models/PasteInput.d.ts +3 -3
- package/dist/models/PasteInput.js +2 -2
- package/dist/models/PasteResponse.d.ts +50 -0
- package/dist/models/PasteResponse.js +60 -0
- package/dist/models/RecoveryImgResponse.d.ts +6 -6
- package/dist/models/RecoveryImgResponse.js +6 -6
- package/dist/models/ReleaseGroupsResponse.d.ts +2 -2
- package/dist/models/ReleaseGroupsResponse.js +2 -2
- package/dist/models/ReleaseInternalResponse.d.ts +54 -53
- package/dist/models/ReleaseInternalResponse.js +52 -53
- package/dist/models/ReleaseResponse.d.ts +46 -42
- package/dist/models/ReleaseResponse.js +45 -44
- package/dist/models/ReleaseStatsResponse.d.ts +2 -2
- package/dist/models/ReleaseStatsResponse.js +2 -2
- package/dist/models/ReleaseUpdateBody.d.ts +9 -9
- package/dist/models/ReleaseUpdateBody.js +6 -6
- package/dist/models/RenamePasskeyBody.d.ts +3 -3
- package/dist/models/RenamePasskeyBody.js +2 -2
- package/dist/models/ShortDeviceResponse.d.ts +29 -25
- package/dist/models/ShortDeviceResponse.js +26 -18
- package/dist/models/ShortReleaseResponse.d.ts +31 -27
- package/dist/models/ShortReleaseResponse.js +35 -32
- package/dist/models/TaskUpdateBody.d.ts +7 -8
- package/dist/models/TaskUpdateBody.js +4 -5
- package/dist/models/TokenResponse.d.ts +3 -3
- package/dist/models/TokenResponse.js +5 -3
- package/dist/models/UserInternalResponse.d.ts +21 -24
- package/dist/models/UserInternalResponse.js +20 -23
- package/dist/models/UserShortResponse.d.ts +7 -7
- package/dist/models/UserShortResponse.js +9 -9
- package/dist/models/UserUpdateBody.d.ts +9 -9
- package/dist/models/UserUpdateBody.js +8 -8
- package/dist/models/WorkerStatusBody.d.ts +32 -0
- package/dist/models/WorkerStatusBody.js +50 -0
- package/dist/models/index.d.ts +16 -20
- package/dist/models/index.js +16 -20
- package/dist/runtime.d.ts +2 -2
- package/dist/runtime.js +2 -2
- package/docs/BuildTaskResponse.md +13 -13
- package/docs/BuildTaskShortResponse.md +12 -12
- package/docs/{BodyChangePasswordProfileChangePasswordPost.md → ChangePasswordBody.md} +6 -6
- package/docs/{PasswordConfirmationBody.md → DeletePasskeyBody.md} +5 -4
- package/docs/DeviceApi.md +83 -90
- package/docs/DeviceInternalResponse.md +22 -19
- package/docs/DeviceResponse.md +19 -17
- package/docs/DeviceUpdateBody.md +7 -6
- package/docs/{LocationInner.md → ErrorResponse.md} +6 -4
- package/docs/FFStatusResponse.md +1 -1
- package/docs/FoxFactoryApi.md +140 -191
- package/docs/GitlabApi.md +21 -14
- package/docs/{GlobalStatsAggregationModel.md → GlobalStatsResponse.md} +6 -6
- package/docs/InternalApi.md +433 -586
- package/docs/ListResponseBuildTaskShortResponse.md +2 -2
- package/docs/ListResponseBuildTaskShortResponseDataInner.md +52 -0
- package/docs/{ListResponseShortReleaseResponse.md → ListResponsePasteResponse.md} +6 -6
- package/docs/{UserGitlab.md → ListResponsePasteResponseDataInner.md} +11 -5
- package/docs/ListResponseReleaseResponse.md +2 -2
- package/docs/ListResponseReleaseResponseDataInner.md +74 -0
- package/docs/ListResponseShortDeviceResponse.md +2 -2
- package/docs/ListResponseShortDeviceResponseDataInner.md +56 -0
- package/docs/{ListResponseStr.md → ListResponseString.md} +6 -6
- package/docs/ListResponseUserShortResponse.md +2 -2
- package/docs/ListResponseUserShortResponseDataInner.md +40 -0
- package/docs/LogListResponse.md +2 -2
- package/docs/LogResponse.md +10 -10
- package/docs/{UserMail.md → LoginForm.md} +7 -4
- package/docs/{MaintainerShortModel.md → MaintainerShortResponse.md} +9 -7
- package/docs/NewBuildTaskBody.md +6 -3
- package/docs/NewDeviceBody.md +5 -4
- package/docs/{FFStatusEnum.md → NewReportRequest.md} +14 -4
- package/docs/PasskeyCredentialResponse.md +9 -8
- package/docs/PasskeyRegisterOptionsRequest.md +1 -0
- package/docs/PasskeyVerifyRequest.md +4 -3
- package/docs/PasteApi.md +25 -29
- package/docs/{PasteOutput.md → PasteResponse.md} +7 -7
- package/docs/RecoveryImgResponse.md +2 -2
- package/docs/ReleaseApi.md +176 -118
- package/docs/ReleaseInternalResponse.md +34 -31
- package/docs/ReleaseResponse.md +28 -26
- package/docs/ReleaseUpdateBody.md +5 -4
- package/docs/RenamePasskeyBody.md +1 -0
- package/docs/ReportApi.md +84 -0
- package/docs/ShortDeviceResponse.md +14 -12
- package/docs/ShortReleaseResponse.md +22 -20
- package/docs/StatsApi.md +10 -10
- package/docs/TaskUpdateBody.md +3 -2
- package/docs/UserInternalResponse.md +13 -13
- package/docs/UserShortResponse.md +4 -4
- package/docs/UserUpdateBody.md +7 -6
- package/docs/{BuildStatusEnum.md → WorkerStatusBody.md} +6 -4
- package/package.json +3 -12
- package/src/apis/DeviceApi.ts +130 -148
- package/src/apis/FoxFactoryApi.ts +239 -385
- package/src/apis/GitlabApi.ts +36 -25
- package/src/apis/InternalApi.ts +736 -1113
- package/src/apis/PasteApi.ts +47 -53
- package/src/apis/ReleaseApi.ts +237 -228
- package/src/apis/ReportApi.ts +139 -0
- package/src/apis/StatsApi.ts +28 -25
- package/src/apis/index.ts +1 -0
- package/src/models/BuildTaskResponse.ts +45 -57
- package/src/models/BuildTaskShortResponse.ts +40 -53
- package/src/models/ChangePasswordBody.ts +75 -0
- package/src/models/DeletePasskeyBody.ts +66 -0
- package/src/models/DeviceInternalResponse.ts +75 -66
- package/src/models/DeviceResponse.ts +65 -55
- package/src/models/DeviceStatsResponse.ts +2 -2
- package/src/models/DeviceUpdateBody.ts +19 -19
- package/src/models/ErrorResponse.ts +66 -0
- package/src/models/FFStatusResponse.ts +6 -16
- package/src/models/GlobalStatsResponse.ts +93 -0
- package/src/models/ListResponseBuildTaskShortResponse.ts +17 -16
- package/src/models/ListResponseBuildTaskShortResponseDataInner.ts +154 -0
- package/src/models/ListResponsePasteResponse.ts +83 -0
- package/src/models/ListResponsePasteResponseDataInner.ts +92 -0
- package/src/models/ListResponseReleaseResponse.ts +17 -16
- package/src/models/ListResponseReleaseResponseDataInner.ts +249 -0
- package/src/models/ListResponseShortDeviceResponse.ts +17 -16
- package/src/models/ListResponseShortDeviceResponseDataInner.ts +164 -0
- package/src/models/ListResponseString.ts +75 -0
- package/src/models/ListResponseUserShortResponse.ts +17 -16
- package/src/models/ListResponseUserShortResponseDataInner.ts +93 -0
- package/src/models/LogListResponse.ts +8 -8
- package/src/models/LogResponse.ts +32 -32
- package/src/models/LoginForm.ts +75 -0
- package/src/models/MaintainerShortResponse.ts +93 -0
- package/src/models/NewBuildTaskBody.ts +19 -21
- package/src/models/NewDeviceBody.ts +14 -14
- package/src/models/NewReportRequest.ts +100 -0
- package/src/models/PasskeyCredentialResponse.ts +25 -25
- package/src/models/PasskeyRegisterOptionsRequest.ts +3 -3
- package/src/models/PasskeyVerifyRequest.ts +11 -11
- package/src/models/PasteInput.ts +3 -3
- package/src/models/PasteResponse.ts +92 -0
- package/src/models/RecoveryImgResponse.ts +9 -9
- package/src/models/ReleaseGroupsResponse.ts +2 -2
- package/src/models/ReleaseInternalResponse.ts +104 -112
- package/src/models/ReleaseResponse.ts +85 -86
- package/src/models/ReleaseStatsResponse.ts +2 -2
- package/src/models/ReleaseUpdateBody.ts +13 -13
- package/src/models/RenamePasskeyBody.ts +3 -3
- package/src/models/ShortDeviceResponse.ts +50 -40
- package/src/models/ShortReleaseResponse.ts +62 -64
- package/src/models/TaskUpdateBody.ts +9 -19
- package/src/models/TokenResponse.ts +5 -4
- package/src/models/UserInternalResponse.ts +38 -59
- package/src/models/UserShortResponse.ts +13 -13
- package/src/models/UserUpdateBody.ts +15 -15
- package/src/models/WorkerStatusBody.ts +66 -0
- package/src/models/index.ts +16 -20
- package/src/runtime.ts +2 -2
- package/dist/esm/models/BodyChangePasswordProfileChangePasswordPost.d.ts +0 -38
- package/dist/esm/models/BodyChangePasswordProfileChangePasswordPost.js +0 -47
- package/dist/esm/models/BuildStatusEnum.d.ts +0 -30
- package/dist/esm/models/BuildStatusEnum.js +0 -48
- package/dist/esm/models/FFStatusEnum.d.ts +0 -26
- package/dist/esm/models/FFStatusEnum.js +0 -44
- package/dist/esm/models/GlobalStatsAggregationModel.d.ts +0 -52
- package/dist/esm/models/HTTPValidationError.d.ts +0 -33
- package/dist/esm/models/HTTPValidationError.js +0 -42
- package/dist/esm/models/ListResponseShortReleaseResponse.d.ts +0 -39
- package/dist/esm/models/ListResponseShortReleaseResponse.js +0 -47
- package/dist/esm/models/ListResponseStr.d.ts +0 -38
- package/dist/esm/models/ListResponseStr.js +0 -46
- package/dist/esm/models/LocationInner.d.ts +0 -26
- package/dist/esm/models/LocationInner.js +0 -31
- package/dist/esm/models/MaintainerShortModel.d.ts +0 -44
- package/dist/esm/models/MaintainerShortModel.js +0 -51
- package/dist/esm/models/PasskeyOptionsResponse.d.ts +0 -40
- package/dist/esm/models/PasskeyOptionsResponse.js +0 -47
- package/dist/esm/models/PasswordConfirmationBody.d.ts +0 -32
- package/dist/esm/models/PasswordConfirmationBody.js +0 -43
- package/dist/esm/models/PasteOutput.d.ts +0 -50
- package/dist/esm/models/PasteOutput.js +0 -53
- package/dist/esm/models/ReleaseInternalResponsePropValue.d.ts +0 -26
- package/dist/esm/models/ReleaseInternalResponsePropValue.js +0 -31
- package/dist/esm/models/ReleaseType.d.ts +0 -26
- package/dist/esm/models/ReleaseType.js +0 -44
- package/dist/esm/models/ReleasesSort.d.ts +0 -25
- package/dist/esm/models/ReleasesSort.js +0 -43
- package/dist/esm/models/ResponseGetReleases.d.ts +0 -41
- package/dist/esm/models/ResponseGetReleases.js +0 -46
- package/dist/esm/models/UserGitlab.d.ts +0 -32
- package/dist/esm/models/UserGitlab.js +0 -43
- package/dist/esm/models/UserMail.d.ts +0 -32
- package/dist/esm/models/UserMail.js +0 -43
- package/dist/esm/models/UserTelegram.d.ts +0 -32
- package/dist/esm/models/UserTelegram.js +0 -43
- package/dist/esm/models/ValidationError.d.ts +0 -57
- package/dist/esm/models/ValidationError.js +0 -56
- package/dist/models/BodyChangePasswordProfileChangePasswordPost.d.ts +0 -38
- package/dist/models/BodyChangePasswordProfileChangePasswordPost.js +0 -54
- package/dist/models/BuildStatusEnum.d.ts +0 -30
- package/dist/models/BuildStatusEnum.js +0 -56
- package/dist/models/FFStatusEnum.d.ts +0 -26
- package/dist/models/FFStatusEnum.js +0 -52
- package/dist/models/GlobalStatsAggregationModel.d.ts +0 -52
- package/dist/models/GlobalStatsAggregationModel.js +0 -62
- package/dist/models/HTTPValidationError.d.ts +0 -33
- package/dist/models/HTTPValidationError.js +0 -49
- package/dist/models/ListResponseShortReleaseResponse.d.ts +0 -39
- package/dist/models/ListResponseShortReleaseResponse.js +0 -54
- package/dist/models/ListResponseStr.d.ts +0 -38
- package/dist/models/ListResponseStr.js +0 -53
- package/dist/models/LocationInner.d.ts +0 -26
- package/dist/models/LocationInner.js +0 -38
- package/dist/models/MaintainerShortModel.d.ts +0 -44
- package/dist/models/MaintainerShortModel.js +0 -58
- package/dist/models/PasskeyOptionsResponse.d.ts +0 -40
- package/dist/models/PasskeyOptionsResponse.js +0 -54
- package/dist/models/PasswordConfirmationBody.d.ts +0 -32
- package/dist/models/PasswordConfirmationBody.js +0 -50
- package/dist/models/PasteOutput.d.ts +0 -50
- package/dist/models/PasteOutput.js +0 -60
- package/dist/models/ReleaseInternalResponsePropValue.d.ts +0 -26
- package/dist/models/ReleaseInternalResponsePropValue.js +0 -38
- package/dist/models/ReleaseType.d.ts +0 -26
- package/dist/models/ReleaseType.js +0 -52
- package/dist/models/ReleasesSort.d.ts +0 -25
- package/dist/models/ReleasesSort.js +0 -51
- package/dist/models/ResponseGetReleases.d.ts +0 -41
- package/dist/models/ResponseGetReleases.js +0 -53
- package/dist/models/UserGitlab.d.ts +0 -32
- package/dist/models/UserGitlab.js +0 -50
- package/dist/models/UserMail.d.ts +0 -32
- package/dist/models/UserMail.js +0 -50
- package/dist/models/UserTelegram.d.ts +0 -32
- package/dist/models/UserTelegram.js +0 -50
- package/dist/models/ValidationError.d.ts +0 -57
- package/dist/models/ValidationError.js +0 -63
- package/docs/HTTPValidationError.md +0 -34
- package/docs/PasskeyOptionsResponse.md +0 -36
- package/docs/ReleaseInternalResponsePropValue.md +0 -32
- package/docs/ReleaseType.md +0 -32
- package/docs/ReleasesSort.md +0 -32
- package/docs/ResponseGetReleases.md +0 -36
- package/docs/UserTelegram.md +0 -34
- package/docs/ValidationError.md +0 -42
- package/src/models/BodyChangePasswordProfileChangePasswordPost.ts +0 -75
- package/src/models/BuildStatusEnum.ts +0 -58
- package/src/models/FFStatusEnum.ts +0 -54
- package/src/models/GlobalStatsAggregationModel.ts +0 -93
- package/src/models/HTTPValidationError.ts +0 -73
- package/src/models/ListResponseShortReleaseResponse.ts +0 -82
- package/src/models/ListResponseStr.ts +0 -74
- package/src/models/LocationInner.ts +0 -46
- package/src/models/MaintainerShortModel.ts +0 -84
- package/src/models/PasskeyOptionsResponse.ts +0 -75
- package/src/models/PasswordConfirmationBody.ts +0 -66
- package/src/models/PasteOutput.ts +0 -92
- package/src/models/ReleaseInternalResponsePropValue.ts +0 -46
- package/src/models/ReleaseType.ts +0 -54
- package/src/models/ReleasesSort.ts +0 -53
- package/src/models/ResponseGetReleases.ts +0 -96
- package/src/models/UserGitlab.ts +0 -66
- package/src/models/UserMail.ts +0 -66
- package/src/models/UserTelegram.ts +0 -66
- package/src/models/ValidationError.ts +0 -108
package/docs/InternalApi.md
CHANGED
|
@@ -4,44 +4,41 @@ All URIs are relative to *https://api.orangefox.download*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**
|
|
15
|
-
| [**
|
|
16
|
-
| [**
|
|
17
|
-
| [**
|
|
18
|
-
| [**
|
|
19
|
-
| [**
|
|
20
|
-
| [**
|
|
21
|
-
| [**
|
|
22
|
-
| [**
|
|
23
|
-
| [**
|
|
24
|
-
| [**
|
|
25
|
-
| [**
|
|
26
|
-
| [**
|
|
27
|
-
| [**
|
|
28
|
-
| [**
|
|
29
|
-
| [**
|
|
30
|
-
| [**
|
|
31
|
-
| [**
|
|
32
|
-
| [**
|
|
33
|
-
| [**
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
Change Password
|
|
43
|
-
|
|
44
|
-
Change the password for a user.
|
|
7
|
+
| [**changePassword**](InternalApi.md#changepassword) | **POST** /profile/change_password | POST /profile/change_password - Change the authenticated user\'s password. |
|
|
8
|
+
| [**createDevice**](InternalApi.md#createdevice) | **POST** /internal/devices | POST /internal/devices/ - Create a new device. |
|
|
9
|
+
| [**deleteDevice**](InternalApi.md#deletedevice) | **DELETE** /internal/devices/{device_id} | DELETE /internal/devices/{device_id} - Delete a device (only if no releases exist). |
|
|
10
|
+
| [**deletePasskey**](InternalApi.md#deletepasskey) | **DELETE** /profile/passkeys/{credential_id} | DELETE /profile/passkeys/{credential_id} - Revoke a passkey credential (requires password). |
|
|
11
|
+
| [**deletePaste**](InternalApi.md#deletepaste) | **DELETE** /internal/paste/{paste_id} | DELETE /internal/paste/{paste_id} - Delete a paste (admin only). |
|
|
12
|
+
| [**deleteRelease**](InternalApi.md#deleterelease) | **DELETE** /internal/releases/{release_id} | DELETE /internal/releases/{release_id} - Delete a release. |
|
|
13
|
+
| [**deleteUser**](InternalApi.md#deleteuser) | **DELETE** /internal/users/{user_id} | DELETE /internal/users/{user_id} - Delete a user. |
|
|
14
|
+
| [**editDevice**](InternalApi.md#editdevice) | **PUT** /internal/devices/{device_id} | PUT /internal/devices/{device_id} - Update a device. |
|
|
15
|
+
| [**editRelease**](InternalApi.md#editrelease) | **PUT** /internal/releases/{release_id} | PUT /internal/releases/{release_id} - Edit a release. |
|
|
16
|
+
| [**editUser**](InternalApi.md#edituser) | **PUT** /internal/users/{user_id} | PUT /internal/users/{user_id} - Update a user (admin only). |
|
|
17
|
+
| [**getDeviceInfo**](InternalApi.md#getdeviceinfo) | **GET** /internal/devices/{device_id} | GET /internal/devices/{device_id} - Get device with stats. |
|
|
18
|
+
| [**getReleaseInfo**](InternalApi.md#getreleaseinfo) | **GET** /internal/releases/{release_id} | GET /internal/releases/{release_id} - Get release with stats and maintainer info. |
|
|
19
|
+
| [**getUser**](InternalApi.md#getuser) | **GET** /internal/users/{user_id} | GET /internal/users/{user_id} - Get user with maintained devices. |
|
|
20
|
+
| [**listLogs**](InternalApi.md#listlogs) | **GET** /internal/logs | GET /internal/logs/ - Get paginated audit logs. |
|
|
21
|
+
| [**listPasskeys**](InternalApi.md#listpasskeys) | **GET** /profile/passkeys | GET /profile/passkeys - List the authenticated user\'s passkey credentials. |
|
|
22
|
+
| [**listPastes**](InternalApi.md#listpastes) | **GET** /internal/paste | GET /internal/paste/ - List all pastes (admin only). |
|
|
23
|
+
| [**listUsers**](InternalApi.md#listusers) | **GET** /internal/users | GET /internal/users/ - List all users (short response). |
|
|
24
|
+
| [**login**](InternalApi.md#login) | **POST** /auth/login | POST /auth/login |
|
|
25
|
+
| [**logout**](InternalApi.md#logout) | **POST** /auth/logout | POST /auth/logout |
|
|
26
|
+
| [**passkeyLoginOptions**](InternalApi.md#passkeyloginoptions) | **POST** /auth/passkeys/login/options | POST /auth/passkeys/login/options |
|
|
27
|
+
| [**passkeyLoginVerify**](InternalApi.md#passkeyloginverify) | **POST** /auth/passkeys/login/verify | POST /auth/passkeys/login/verify |
|
|
28
|
+
| [**passkeyRegisterOptions**](InternalApi.md#passkeyregisteroptionsoperation) | **POST** /auth/passkeys/register/options | POST /auth/passkeys/register/options |
|
|
29
|
+
| [**passkeyRegisterVerify**](InternalApi.md#passkeyregisterverify) | **POST** /auth/passkeys/register/verify | POST /auth/passkeys/register/verify |
|
|
30
|
+
| [**renamePasskey**](InternalApi.md#renamepasskey) | **POST** /profile/passkeys/{credential_id}/rename | POST /profile/passkeys/{credential_id}/rename - Rename a passkey credential. |
|
|
31
|
+
| [**renew**](InternalApi.md#renew) | **POST** /auth/renew | POST /auth/renew |
|
|
32
|
+
| [**updatePaste**](InternalApi.md#updatepaste) | **PUT** /internal/paste/{paste_id} | PUT /internal/paste/{paste_id} - Update paste content (admin only). |
|
|
33
|
+
| [**uploadNewRelease**](InternalApi.md#uploadnewrelease) | **POST** /internal/releases | POST /internal/releases/ - Upload a new release. |
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
## changePassword
|
|
38
|
+
|
|
39
|
+
> changePassword(changePasswordBody)
|
|
40
|
+
|
|
41
|
+
POST /profile/change_password - Change the authenticated user\'s password.
|
|
45
42
|
|
|
46
43
|
### Example
|
|
47
44
|
|
|
@@ -50,19 +47,23 @@ import {
|
|
|
50
47
|
Configuration,
|
|
51
48
|
InternalApi,
|
|
52
49
|
} from '@orangefox-recovery/foxinternalclient';
|
|
53
|
-
import type {
|
|
50
|
+
import type { ChangePasswordRequest } from '@orangefox-recovery/foxinternalclient';
|
|
54
51
|
|
|
55
52
|
async function example() {
|
|
56
53
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
57
|
-
const
|
|
54
|
+
const config = new Configuration({
|
|
55
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
56
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
57
|
+
});
|
|
58
|
+
const api = new InternalApi(config);
|
|
58
59
|
|
|
59
60
|
const body = {
|
|
60
|
-
//
|
|
61
|
-
|
|
62
|
-
} satisfies
|
|
61
|
+
// ChangePasswordBody
|
|
62
|
+
changePasswordBody: ...,
|
|
63
|
+
} satisfies ChangePasswordRequest;
|
|
63
64
|
|
|
64
65
|
try {
|
|
65
|
-
const data = await api.
|
|
66
|
+
const data = await api.changePassword(body);
|
|
66
67
|
console.log(data);
|
|
67
68
|
} catch (error) {
|
|
68
69
|
console.error(error);
|
|
@@ -78,15 +79,15 @@ example().catch(console.error);
|
|
|
78
79
|
|
|
79
80
|
| Name | Type | Description | Notes |
|
|
80
81
|
|------------- | ------------- | ------------- | -------------|
|
|
81
|
-
| **
|
|
82
|
+
| **changePasswordBody** | [ChangePasswordBody](ChangePasswordBody.md) | | |
|
|
82
83
|
|
|
83
84
|
### Return type
|
|
84
85
|
|
|
85
|
-
|
|
86
|
+
`void` (Empty response body)
|
|
86
87
|
|
|
87
88
|
### Authorization
|
|
88
89
|
|
|
89
|
-
|
|
90
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
90
91
|
|
|
91
92
|
### HTTP request headers
|
|
92
93
|
|
|
@@ -97,19 +98,17 @@ No authorization required
|
|
|
97
98
|
### HTTP response details
|
|
98
99
|
| Status code | Description | Response headers |
|
|
99
100
|
|-------------|-------------|------------------|
|
|
100
|
-
| **200** |
|
|
101
|
-
| **
|
|
101
|
+
| **200** | Password changed | - |
|
|
102
|
+
| **400** | Bad request | - |
|
|
102
103
|
|
|
103
104
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
104
105
|
|
|
105
106
|
|
|
106
|
-
##
|
|
107
|
-
|
|
108
|
-
> boolean delReleaseInternalReleasesReleaseIdDelete(releaseId)
|
|
107
|
+
## createDevice
|
|
109
108
|
|
|
110
|
-
|
|
109
|
+
> ShortDeviceResponse createDevice(newDeviceBody)
|
|
111
110
|
|
|
112
|
-
|
|
111
|
+
POST /internal/devices/ - Create a new device.
|
|
113
112
|
|
|
114
113
|
### Example
|
|
115
114
|
|
|
@@ -118,25 +117,23 @@ import {
|
|
|
118
117
|
Configuration,
|
|
119
118
|
InternalApi,
|
|
120
119
|
} from '@orangefox-recovery/foxinternalclient';
|
|
121
|
-
import type {
|
|
120
|
+
import type { CreateDeviceRequest } from '@orangefox-recovery/foxinternalclient';
|
|
122
121
|
|
|
123
122
|
async function example() {
|
|
124
123
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
125
124
|
const config = new Configuration({
|
|
126
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
127
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
128
125
|
// Configure HTTP bearer authorization: bearer_auth
|
|
129
126
|
accessToken: "YOUR BEARER TOKEN",
|
|
130
127
|
});
|
|
131
128
|
const api = new InternalApi(config);
|
|
132
129
|
|
|
133
130
|
const body = {
|
|
134
|
-
//
|
|
135
|
-
|
|
136
|
-
} satisfies
|
|
131
|
+
// NewDeviceBody
|
|
132
|
+
newDeviceBody: ...,
|
|
133
|
+
} satisfies CreateDeviceRequest;
|
|
137
134
|
|
|
138
135
|
try {
|
|
139
|
-
const data = await api.
|
|
136
|
+
const data = await api.createDevice(body);
|
|
140
137
|
console.log(data);
|
|
141
138
|
} catch (error) {
|
|
142
139
|
console.error(error);
|
|
@@ -152,36 +149,36 @@ example().catch(console.error);
|
|
|
152
149
|
|
|
153
150
|
| Name | Type | Description | Notes |
|
|
154
151
|
|------------- | ------------- | ------------- | -------------|
|
|
155
|
-
| **
|
|
152
|
+
| **newDeviceBody** | [NewDeviceBody](NewDeviceBody.md) | | |
|
|
156
153
|
|
|
157
154
|
### Return type
|
|
158
155
|
|
|
159
|
-
**
|
|
156
|
+
[**ShortDeviceResponse**](ShortDeviceResponse.md)
|
|
160
157
|
|
|
161
158
|
### Authorization
|
|
162
159
|
|
|
163
|
-
[
|
|
160
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
164
161
|
|
|
165
162
|
### HTTP request headers
|
|
166
163
|
|
|
167
|
-
- **Content-Type**:
|
|
164
|
+
- **Content-Type**: `application/json`
|
|
168
165
|
- **Accept**: `application/json`
|
|
169
166
|
|
|
170
167
|
|
|
171
168
|
### HTTP response details
|
|
172
169
|
| Status code | Description | Response headers |
|
|
173
170
|
|-------------|-------------|------------------|
|
|
174
|
-
| **
|
|
175
|
-
| **
|
|
171
|
+
| **201** | Device created | - |
|
|
172
|
+
| **409** | Conflict | - |
|
|
176
173
|
|
|
177
174
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
178
175
|
|
|
179
176
|
|
|
180
|
-
##
|
|
177
|
+
## deleteDevice
|
|
181
178
|
|
|
182
|
-
> boolean
|
|
179
|
+
> boolean deleteDevice(deviceId)
|
|
183
180
|
|
|
184
|
-
Delete
|
|
181
|
+
DELETE /internal/devices/{device_id} - Delete a device (only if no releases exist).
|
|
185
182
|
|
|
186
183
|
### Example
|
|
187
184
|
|
|
@@ -190,25 +187,23 @@ import {
|
|
|
190
187
|
Configuration,
|
|
191
188
|
InternalApi,
|
|
192
189
|
} from '@orangefox-recovery/foxinternalclient';
|
|
193
|
-
import type {
|
|
190
|
+
import type { DeleteDeviceRequest } from '@orangefox-recovery/foxinternalclient';
|
|
194
191
|
|
|
195
192
|
async function example() {
|
|
196
193
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
197
194
|
const config = new Configuration({
|
|
198
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
199
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
200
195
|
// Configure HTTP bearer authorization: bearer_auth
|
|
201
196
|
accessToken: "YOUR BEARER TOKEN",
|
|
202
197
|
});
|
|
203
198
|
const api = new InternalApi(config);
|
|
204
199
|
|
|
205
200
|
const body = {
|
|
206
|
-
// string
|
|
201
|
+
// string | Device ID
|
|
207
202
|
deviceId: deviceId_example,
|
|
208
|
-
} satisfies
|
|
203
|
+
} satisfies DeleteDeviceRequest;
|
|
209
204
|
|
|
210
205
|
try {
|
|
211
|
-
const data = await api.
|
|
206
|
+
const data = await api.deleteDevice(body);
|
|
212
207
|
console.log(data);
|
|
213
208
|
} catch (error) {
|
|
214
209
|
console.error(error);
|
|
@@ -224,7 +219,7 @@ example().catch(console.error);
|
|
|
224
219
|
|
|
225
220
|
| Name | Type | Description | Notes |
|
|
226
221
|
|------------- | ------------- | ------------- | -------------|
|
|
227
|
-
| **deviceId** | `string` |
|
|
222
|
+
| **deviceId** | `string` | Device ID | [Defaults to `undefined`] |
|
|
228
223
|
|
|
229
224
|
### Return type
|
|
230
225
|
|
|
@@ -232,28 +227,29 @@ example().catch(console.error);
|
|
|
232
227
|
|
|
233
228
|
### Authorization
|
|
234
229
|
|
|
235
|
-
[
|
|
230
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
236
231
|
|
|
237
232
|
### HTTP request headers
|
|
238
233
|
|
|
239
234
|
- **Content-Type**: Not defined
|
|
240
|
-
- **Accept**: `application/json`
|
|
235
|
+
- **Accept**: `text/plain`, `application/json`
|
|
241
236
|
|
|
242
237
|
|
|
243
238
|
### HTTP response details
|
|
244
239
|
| Status code | Description | Response headers |
|
|
245
240
|
|-------------|-------------|------------------|
|
|
246
|
-
| **200** |
|
|
247
|
-
| **
|
|
241
|
+
| **200** | Device deleted | - |
|
|
242
|
+
| **404** | Not found | - |
|
|
243
|
+
| **409** | Conflict - device has releases | - |
|
|
248
244
|
|
|
249
245
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
250
246
|
|
|
251
247
|
|
|
252
|
-
##
|
|
248
|
+
## deletePasskey
|
|
253
249
|
|
|
254
|
-
>
|
|
250
|
+
> deletePasskey(credentialId, deletePasskeyBody)
|
|
255
251
|
|
|
256
|
-
|
|
252
|
+
DELETE /profile/passkeys/{credential_id} - Revoke a passkey credential (requires password).
|
|
257
253
|
|
|
258
254
|
### Example
|
|
259
255
|
|
|
@@ -262,21 +258,25 @@ import {
|
|
|
262
258
|
Configuration,
|
|
263
259
|
InternalApi,
|
|
264
260
|
} from '@orangefox-recovery/foxinternalclient';
|
|
265
|
-
import type {
|
|
261
|
+
import type { DeletePasskeyRequest } from '@orangefox-recovery/foxinternalclient';
|
|
266
262
|
|
|
267
263
|
async function example() {
|
|
268
264
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
269
|
-
const
|
|
265
|
+
const config = new Configuration({
|
|
266
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
267
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
268
|
+
});
|
|
269
|
+
const api = new InternalApi(config);
|
|
270
270
|
|
|
271
271
|
const body = {
|
|
272
|
-
// string
|
|
272
|
+
// string | Passkey credential ID
|
|
273
273
|
credentialId: credentialId_example,
|
|
274
|
-
//
|
|
275
|
-
|
|
276
|
-
} satisfies
|
|
274
|
+
// DeletePasskeyBody
|
|
275
|
+
deletePasskeyBody: ...,
|
|
276
|
+
} satisfies DeletePasskeyRequest;
|
|
277
277
|
|
|
278
278
|
try {
|
|
279
|
-
const data = await api.
|
|
279
|
+
const data = await api.deletePasskey(body);
|
|
280
280
|
console.log(data);
|
|
281
281
|
} catch (error) {
|
|
282
282
|
console.error(error);
|
|
@@ -292,16 +292,16 @@ example().catch(console.error);
|
|
|
292
292
|
|
|
293
293
|
| Name | Type | Description | Notes |
|
|
294
294
|
|------------- | ------------- | ------------- | -------------|
|
|
295
|
-
| **credentialId** | `string` |
|
|
296
|
-
| **
|
|
295
|
+
| **credentialId** | `string` | Passkey credential ID | [Defaults to `undefined`] |
|
|
296
|
+
| **deletePasskeyBody** | [DeletePasskeyBody](DeletePasskeyBody.md) | | |
|
|
297
297
|
|
|
298
298
|
### Return type
|
|
299
299
|
|
|
300
|
-
|
|
300
|
+
`void` (Empty response body)
|
|
301
301
|
|
|
302
302
|
### Authorization
|
|
303
303
|
|
|
304
|
-
|
|
304
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
305
305
|
|
|
306
306
|
### HTTP request headers
|
|
307
307
|
|
|
@@ -312,19 +312,18 @@ No authorization required
|
|
|
312
312
|
### HTTP response details
|
|
313
313
|
| Status code | Description | Response headers |
|
|
314
314
|
|-------------|-------------|------------------|
|
|
315
|
-
| **200** |
|
|
316
|
-
| **
|
|
315
|
+
| **200** | Passkey revoked | - |
|
|
316
|
+
| **400** | Bad request | - |
|
|
317
|
+
| **404** | Not found | - |
|
|
317
318
|
|
|
318
319
|
[[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
|
|
|
320
321
|
|
|
321
|
-
##
|
|
322
|
+
## deletePaste
|
|
322
323
|
|
|
323
|
-
>
|
|
324
|
+
> deletePaste(pasteId)
|
|
324
325
|
|
|
325
|
-
Delete
|
|
326
|
-
|
|
327
|
-
Delete a paste by ID. Requires admin permissions.
|
|
326
|
+
DELETE /internal/paste/{paste_id} - Delete a paste (admin only).
|
|
328
327
|
|
|
329
328
|
### Example
|
|
330
329
|
|
|
@@ -333,13 +332,11 @@ import {
|
|
|
333
332
|
Configuration,
|
|
334
333
|
InternalApi,
|
|
335
334
|
} from '@orangefox-recovery/foxinternalclient';
|
|
336
|
-
import type {
|
|
335
|
+
import type { DeletePasteRequest } from '@orangefox-recovery/foxinternalclient';
|
|
337
336
|
|
|
338
337
|
async function example() {
|
|
339
338
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
340
339
|
const config = new Configuration({
|
|
341
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
342
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
343
340
|
// Configure HTTP bearer authorization: bearer_auth
|
|
344
341
|
accessToken: "YOUR BEARER TOKEN",
|
|
345
342
|
});
|
|
@@ -348,10 +345,10 @@ async function example() {
|
|
|
348
345
|
const body = {
|
|
349
346
|
// string
|
|
350
347
|
pasteId: pasteId_example,
|
|
351
|
-
} satisfies
|
|
348
|
+
} satisfies DeletePasteRequest;
|
|
352
349
|
|
|
353
350
|
try {
|
|
354
|
-
const data = await api.
|
|
351
|
+
const data = await api.deletePaste(body);
|
|
355
352
|
console.log(data);
|
|
356
353
|
} catch (error) {
|
|
357
354
|
console.error(error);
|
|
@@ -375,7 +372,7 @@ example().catch(console.error);
|
|
|
375
372
|
|
|
376
373
|
### Authorization
|
|
377
374
|
|
|
378
|
-
[
|
|
375
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
379
376
|
|
|
380
377
|
### HTTP request headers
|
|
381
378
|
|
|
@@ -386,19 +383,17 @@ example().catch(console.error);
|
|
|
386
383
|
### HTTP response details
|
|
387
384
|
| Status code | Description | Response headers |
|
|
388
385
|
|-------------|-------------|------------------|
|
|
389
|
-
| **204** |
|
|
390
|
-
| **404** |
|
|
391
|
-
| **429** | Too many requests | - |
|
|
392
|
-
| **422** | Validation Error | - |
|
|
386
|
+
| **204** | Paste deleted | - |
|
|
387
|
+
| **404** | Not found | - |
|
|
393
388
|
|
|
394
389
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
395
390
|
|
|
396
391
|
|
|
397
|
-
##
|
|
392
|
+
## deleteRelease
|
|
398
393
|
|
|
399
|
-
> boolean
|
|
394
|
+
> boolean deleteRelease(releaseId)
|
|
400
395
|
|
|
401
|
-
Delete
|
|
396
|
+
DELETE /internal/releases/{release_id} - Delete a release.
|
|
402
397
|
|
|
403
398
|
### Example
|
|
404
399
|
|
|
@@ -407,25 +402,23 @@ import {
|
|
|
407
402
|
Configuration,
|
|
408
403
|
InternalApi,
|
|
409
404
|
} from '@orangefox-recovery/foxinternalclient';
|
|
410
|
-
import type {
|
|
405
|
+
import type { DeleteReleaseRequest } from '@orangefox-recovery/foxinternalclient';
|
|
411
406
|
|
|
412
407
|
async function example() {
|
|
413
408
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
414
409
|
const config = new Configuration({
|
|
415
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
416
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
417
410
|
// Configure HTTP bearer authorization: bearer_auth
|
|
418
411
|
accessToken: "YOUR BEARER TOKEN",
|
|
419
412
|
});
|
|
420
413
|
const api = new InternalApi(config);
|
|
421
414
|
|
|
422
415
|
const body = {
|
|
423
|
-
// string
|
|
424
|
-
|
|
425
|
-
} satisfies
|
|
416
|
+
// string | Release ID
|
|
417
|
+
releaseId: releaseId_example,
|
|
418
|
+
} satisfies DeleteReleaseRequest;
|
|
426
419
|
|
|
427
420
|
try {
|
|
428
|
-
const data = await api.
|
|
421
|
+
const data = await api.deleteRelease(body);
|
|
429
422
|
console.log(data);
|
|
430
423
|
} catch (error) {
|
|
431
424
|
console.error(error);
|
|
@@ -441,7 +434,7 @@ example().catch(console.error);
|
|
|
441
434
|
|
|
442
435
|
| Name | Type | Description | Notes |
|
|
443
436
|
|------------- | ------------- | ------------- | -------------|
|
|
444
|
-
| **
|
|
437
|
+
| **releaseId** | `string` | Release ID | [Defaults to `undefined`] |
|
|
445
438
|
|
|
446
439
|
### Return type
|
|
447
440
|
|
|
@@ -449,30 +442,28 @@ example().catch(console.error);
|
|
|
449
442
|
|
|
450
443
|
### Authorization
|
|
451
444
|
|
|
452
|
-
[
|
|
445
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
453
446
|
|
|
454
447
|
### HTTP request headers
|
|
455
448
|
|
|
456
449
|
- **Content-Type**: Not defined
|
|
457
|
-
- **Accept**: `application/json`
|
|
450
|
+
- **Accept**: `text/plain`, `application/json`
|
|
458
451
|
|
|
459
452
|
|
|
460
453
|
### HTTP response details
|
|
461
454
|
| Status code | Description | Response headers |
|
|
462
455
|
|-------------|-------------|------------------|
|
|
463
|
-
| **200** |
|
|
464
|
-
| **
|
|
456
|
+
| **200** | Release deleted | - |
|
|
457
|
+
| **404** | Not found | - |
|
|
465
458
|
|
|
466
459
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
467
460
|
|
|
468
461
|
|
|
469
|
-
##
|
|
470
|
-
|
|
471
|
-
> boolean editReleaseInternalReleasesReleaseIdPut(releaseId, releaseUpdateBody)
|
|
462
|
+
## deleteUser
|
|
472
463
|
|
|
473
|
-
|
|
464
|
+
> boolean deleteUser(userId)
|
|
474
465
|
|
|
475
|
-
|
|
466
|
+
DELETE /internal/users/{user_id} - Delete a user.
|
|
476
467
|
|
|
477
468
|
### Example
|
|
478
469
|
|
|
@@ -481,27 +472,23 @@ import {
|
|
|
481
472
|
Configuration,
|
|
482
473
|
InternalApi,
|
|
483
474
|
} from '@orangefox-recovery/foxinternalclient';
|
|
484
|
-
import type {
|
|
475
|
+
import type { DeleteUserRequest } from '@orangefox-recovery/foxinternalclient';
|
|
485
476
|
|
|
486
477
|
async function example() {
|
|
487
478
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
488
479
|
const config = new Configuration({
|
|
489
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
490
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
491
480
|
// Configure HTTP bearer authorization: bearer_auth
|
|
492
481
|
accessToken: "YOUR BEARER TOKEN",
|
|
493
482
|
});
|
|
494
483
|
const api = new InternalApi(config);
|
|
495
484
|
|
|
496
485
|
const body = {
|
|
497
|
-
// string
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
releaseUpdateBody: ...,
|
|
501
|
-
} satisfies EditReleaseInternalReleasesReleaseIdPutRequest;
|
|
486
|
+
// string | User ID
|
|
487
|
+
userId: userId_example,
|
|
488
|
+
} satisfies DeleteUserRequest;
|
|
502
489
|
|
|
503
490
|
try {
|
|
504
|
-
const data = await api.
|
|
491
|
+
const data = await api.deleteUser(body);
|
|
505
492
|
console.log(data);
|
|
506
493
|
} catch (error) {
|
|
507
494
|
console.error(error);
|
|
@@ -517,8 +504,7 @@ example().catch(console.error);
|
|
|
517
504
|
|
|
518
505
|
| Name | Type | Description | Notes |
|
|
519
506
|
|------------- | ------------- | ------------- | -------------|
|
|
520
|
-
| **
|
|
521
|
-
| **releaseUpdateBody** | [ReleaseUpdateBody](ReleaseUpdateBody.md) | | |
|
|
507
|
+
| **userId** | `string` | User ID | [Defaults to `undefined`] |
|
|
522
508
|
|
|
523
509
|
### Return type
|
|
524
510
|
|
|
@@ -526,28 +512,28 @@ example().catch(console.error);
|
|
|
526
512
|
|
|
527
513
|
### Authorization
|
|
528
514
|
|
|
529
|
-
[
|
|
515
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
530
516
|
|
|
531
517
|
### HTTP request headers
|
|
532
518
|
|
|
533
|
-
- **Content-Type**:
|
|
534
|
-
- **Accept**: `application/json`
|
|
519
|
+
- **Content-Type**: Not defined
|
|
520
|
+
- **Accept**: `text/plain`, `application/json`
|
|
535
521
|
|
|
536
522
|
|
|
537
523
|
### HTTP response details
|
|
538
524
|
| Status code | Description | Response headers |
|
|
539
525
|
|-------------|-------------|------------------|
|
|
540
|
-
| **200** |
|
|
541
|
-
| **
|
|
526
|
+
| **200** | User deleted | - |
|
|
527
|
+
| **404** | Not found | - |
|
|
542
528
|
|
|
543
529
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
544
530
|
|
|
545
531
|
|
|
546
|
-
##
|
|
532
|
+
## editDevice
|
|
547
533
|
|
|
548
|
-
>
|
|
534
|
+
> boolean editDevice(deviceId, deviceUpdateBody)
|
|
549
535
|
|
|
550
|
-
|
|
536
|
+
PUT /internal/devices/{device_id} - Update a device.
|
|
551
537
|
|
|
552
538
|
### Example
|
|
553
539
|
|
|
@@ -556,25 +542,25 @@ import {
|
|
|
556
542
|
Configuration,
|
|
557
543
|
InternalApi,
|
|
558
544
|
} from '@orangefox-recovery/foxinternalclient';
|
|
559
|
-
import type {
|
|
545
|
+
import type { EditDeviceRequest } from '@orangefox-recovery/foxinternalclient';
|
|
560
546
|
|
|
561
547
|
async function example() {
|
|
562
548
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
563
549
|
const config = new Configuration({
|
|
564
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
565
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
566
550
|
// Configure HTTP bearer authorization: bearer_auth
|
|
567
551
|
accessToken: "YOUR BEARER TOKEN",
|
|
568
552
|
});
|
|
569
553
|
const api = new InternalApi(config);
|
|
570
554
|
|
|
571
555
|
const body = {
|
|
572
|
-
// string
|
|
556
|
+
// string | Device ID
|
|
573
557
|
deviceId: deviceId_example,
|
|
574
|
-
|
|
558
|
+
// DeviceUpdateBody
|
|
559
|
+
deviceUpdateBody: ...,
|
|
560
|
+
} satisfies EditDeviceRequest;
|
|
575
561
|
|
|
576
562
|
try {
|
|
577
|
-
const data = await api.
|
|
563
|
+
const data = await api.editDevice(body);
|
|
578
564
|
console.log(data);
|
|
579
565
|
} catch (error) {
|
|
580
566
|
console.error(error);
|
|
@@ -590,38 +576,37 @@ example().catch(console.error);
|
|
|
590
576
|
|
|
591
577
|
| Name | Type | Description | Notes |
|
|
592
578
|
|------------- | ------------- | ------------- | -------------|
|
|
593
|
-
| **deviceId** | `string` |
|
|
579
|
+
| **deviceId** | `string` | Device ID | [Defaults to `undefined`] |
|
|
580
|
+
| **deviceUpdateBody** | [DeviceUpdateBody](DeviceUpdateBody.md) | | |
|
|
594
581
|
|
|
595
582
|
### Return type
|
|
596
583
|
|
|
597
|
-
|
|
584
|
+
**boolean**
|
|
598
585
|
|
|
599
586
|
### Authorization
|
|
600
587
|
|
|
601
|
-
[
|
|
588
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
602
589
|
|
|
603
590
|
### HTTP request headers
|
|
604
591
|
|
|
605
|
-
- **Content-Type**:
|
|
606
|
-
- **Accept**: `application/json`
|
|
592
|
+
- **Content-Type**: `application/json`
|
|
593
|
+
- **Accept**: `text/plain`, `application/json`
|
|
607
594
|
|
|
608
595
|
|
|
609
596
|
### HTTP response details
|
|
610
597
|
| Status code | Description | Response headers |
|
|
611
598
|
|-------------|-------------|------------------|
|
|
612
|
-
| **200** |
|
|
613
|
-
| **
|
|
599
|
+
| **200** | Device updated | - |
|
|
600
|
+
| **404** | Not found | - |
|
|
614
601
|
|
|
615
602
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
616
603
|
|
|
617
604
|
|
|
618
|
-
##
|
|
605
|
+
## editRelease
|
|
619
606
|
|
|
620
|
-
>
|
|
607
|
+
> boolean editRelease(releaseId, releaseUpdateBody)
|
|
621
608
|
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
Get a paginated list of logs with optional filtering.
|
|
609
|
+
PUT /internal/releases/{release_id} - Edit a release.
|
|
625
610
|
|
|
626
611
|
### Example
|
|
627
612
|
|
|
@@ -630,35 +615,25 @@ import {
|
|
|
630
615
|
Configuration,
|
|
631
616
|
InternalApi,
|
|
632
617
|
} from '@orangefox-recovery/foxinternalclient';
|
|
633
|
-
import type {
|
|
618
|
+
import type { EditReleaseRequest } from '@orangefox-recovery/foxinternalclient';
|
|
634
619
|
|
|
635
620
|
async function example() {
|
|
636
621
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
637
622
|
const config = new Configuration({
|
|
638
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
639
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
640
623
|
// Configure HTTP bearer authorization: bearer_auth
|
|
641
624
|
accessToken: "YOUR BEARER TOKEN",
|
|
642
625
|
});
|
|
643
626
|
const api = new InternalApi(config);
|
|
644
627
|
|
|
645
628
|
const body = {
|
|
646
|
-
//
|
|
647
|
-
page: 56,
|
|
648
|
-
// number (optional)
|
|
649
|
-
perPage: 56,
|
|
650
|
-
// string (optional)
|
|
651
|
-
deviceId: deviceId_example,
|
|
652
|
-
// string (optional)
|
|
629
|
+
// string | Release ID
|
|
653
630
|
releaseId: releaseId_example,
|
|
654
|
-
//
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
hideVerbose: true,
|
|
658
|
-
} satisfies GetLogsInternalLogsGetRequest;
|
|
631
|
+
// ReleaseUpdateBody
|
|
632
|
+
releaseUpdateBody: ...,
|
|
633
|
+
} satisfies EditReleaseRequest;
|
|
659
634
|
|
|
660
635
|
try {
|
|
661
|
-
const data = await api.
|
|
636
|
+
const data = await api.editRelease(body);
|
|
662
637
|
console.log(data);
|
|
663
638
|
} catch (error) {
|
|
664
639
|
console.error(error);
|
|
@@ -674,43 +649,37 @@ example().catch(console.error);
|
|
|
674
649
|
|
|
675
650
|
| Name | Type | Description | Notes |
|
|
676
651
|
|------------- | ------------- | ------------- | -------------|
|
|
677
|
-
| **
|
|
678
|
-
| **
|
|
679
|
-
| **deviceId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
680
|
-
| **releaseId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
681
|
-
| **userId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
682
|
-
| **hideVerbose** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
652
|
+
| **releaseId** | `string` | Release ID | [Defaults to `undefined`] |
|
|
653
|
+
| **releaseUpdateBody** | [ReleaseUpdateBody](ReleaseUpdateBody.md) | | |
|
|
683
654
|
|
|
684
655
|
### Return type
|
|
685
656
|
|
|
686
|
-
|
|
657
|
+
**boolean**
|
|
687
658
|
|
|
688
659
|
### Authorization
|
|
689
660
|
|
|
690
|
-
[
|
|
661
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
691
662
|
|
|
692
663
|
### HTTP request headers
|
|
693
664
|
|
|
694
|
-
- **Content-Type**:
|
|
695
|
-
- **Accept**: `application/json`
|
|
665
|
+
- **Content-Type**: `application/json`
|
|
666
|
+
- **Accept**: `text/plain`, `application/json`
|
|
696
667
|
|
|
697
668
|
|
|
698
669
|
### HTTP response details
|
|
699
670
|
| Status code | Description | Response headers |
|
|
700
671
|
|-------------|-------------|------------------|
|
|
701
|
-
| **200** |
|
|
702
|
-
| **
|
|
672
|
+
| **200** | Release updated | - |
|
|
673
|
+
| **404** | Not found | - |
|
|
703
674
|
|
|
704
675
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
705
676
|
|
|
706
677
|
|
|
707
|
-
##
|
|
678
|
+
## editUser
|
|
708
679
|
|
|
709
|
-
>
|
|
680
|
+
> boolean editUser(userId, userUpdateBody)
|
|
710
681
|
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
Get release information
|
|
682
|
+
PUT /internal/users/{user_id} - Update a user (admin only).
|
|
714
683
|
|
|
715
684
|
### Example
|
|
716
685
|
|
|
@@ -719,25 +688,25 @@ import {
|
|
|
719
688
|
Configuration,
|
|
720
689
|
InternalApi,
|
|
721
690
|
} from '@orangefox-recovery/foxinternalclient';
|
|
722
|
-
import type {
|
|
691
|
+
import type { EditUserRequest } from '@orangefox-recovery/foxinternalclient';
|
|
723
692
|
|
|
724
693
|
async function example() {
|
|
725
694
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
726
695
|
const config = new Configuration({
|
|
727
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
728
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
729
696
|
// Configure HTTP bearer authorization: bearer_auth
|
|
730
697
|
accessToken: "YOUR BEARER TOKEN",
|
|
731
698
|
});
|
|
732
699
|
const api = new InternalApi(config);
|
|
733
700
|
|
|
734
701
|
const body = {
|
|
735
|
-
// string
|
|
736
|
-
|
|
737
|
-
|
|
702
|
+
// string | User ID
|
|
703
|
+
userId: userId_example,
|
|
704
|
+
// UserUpdateBody
|
|
705
|
+
userUpdateBody: ...,
|
|
706
|
+
} satisfies EditUserRequest;
|
|
738
707
|
|
|
739
708
|
try {
|
|
740
|
-
const data = await api.
|
|
709
|
+
const data = await api.editUser(body);
|
|
741
710
|
console.log(data);
|
|
742
711
|
} catch (error) {
|
|
743
712
|
console.error(error);
|
|
@@ -753,38 +722,37 @@ example().catch(console.error);
|
|
|
753
722
|
|
|
754
723
|
| Name | Type | Description | Notes |
|
|
755
724
|
|------------- | ------------- | ------------- | -------------|
|
|
756
|
-
| **
|
|
725
|
+
| **userId** | `string` | User ID | [Defaults to `undefined`] |
|
|
726
|
+
| **userUpdateBody** | [UserUpdateBody](UserUpdateBody.md) | | |
|
|
757
727
|
|
|
758
728
|
### Return type
|
|
759
729
|
|
|
760
|
-
|
|
730
|
+
**boolean**
|
|
761
731
|
|
|
762
732
|
### Authorization
|
|
763
733
|
|
|
764
|
-
[
|
|
734
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
765
735
|
|
|
766
736
|
### HTTP request headers
|
|
767
737
|
|
|
768
|
-
- **Content-Type**:
|
|
769
|
-
- **Accept**: `application/json`
|
|
738
|
+
- **Content-Type**: `application/json`
|
|
739
|
+
- **Accept**: `text/plain`, `application/json`
|
|
770
740
|
|
|
771
741
|
|
|
772
742
|
### HTTP response details
|
|
773
743
|
| Status code | Description | Response headers |
|
|
774
744
|
|-------------|-------------|------------------|
|
|
775
|
-
| **200** |
|
|
776
|
-
| **
|
|
745
|
+
| **200** | User updated | - |
|
|
746
|
+
| **404** | Not found | - |
|
|
777
747
|
|
|
778
748
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
779
749
|
|
|
780
750
|
|
|
781
|
-
##
|
|
751
|
+
## getDeviceInfo
|
|
782
752
|
|
|
783
|
-
>
|
|
753
|
+
> DeviceInternalResponse getDeviceInfo(deviceId)
|
|
784
754
|
|
|
785
|
-
Get
|
|
786
|
-
|
|
787
|
-
Download release ZIP directly
|
|
755
|
+
GET /internal/devices/{device_id} - Get device with stats.
|
|
788
756
|
|
|
789
757
|
### Example
|
|
790
758
|
|
|
@@ -793,25 +761,23 @@ import {
|
|
|
793
761
|
Configuration,
|
|
794
762
|
InternalApi,
|
|
795
763
|
} from '@orangefox-recovery/foxinternalclient';
|
|
796
|
-
import type {
|
|
764
|
+
import type { GetDeviceInfoRequest } from '@orangefox-recovery/foxinternalclient';
|
|
797
765
|
|
|
798
766
|
async function example() {
|
|
799
767
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
800
768
|
const config = new Configuration({
|
|
801
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
802
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
803
769
|
// Configure HTTP bearer authorization: bearer_auth
|
|
804
770
|
accessToken: "YOUR BEARER TOKEN",
|
|
805
771
|
});
|
|
806
772
|
const api = new InternalApi(config);
|
|
807
773
|
|
|
808
774
|
const body = {
|
|
809
|
-
// string
|
|
810
|
-
|
|
811
|
-
} satisfies
|
|
775
|
+
// string | Device ID
|
|
776
|
+
deviceId: deviceId_example,
|
|
777
|
+
} satisfies GetDeviceInfoRequest;
|
|
812
778
|
|
|
813
779
|
try {
|
|
814
|
-
const data = await api.
|
|
780
|
+
const data = await api.getDeviceInfo(body);
|
|
815
781
|
console.log(data);
|
|
816
782
|
} catch (error) {
|
|
817
783
|
console.error(error);
|
|
@@ -827,15 +793,15 @@ example().catch(console.error);
|
|
|
827
793
|
|
|
828
794
|
| Name | Type | Description | Notes |
|
|
829
795
|
|------------- | ------------- | ------------- | -------------|
|
|
830
|
-
| **
|
|
796
|
+
| **deviceId** | `string` | Device ID | [Defaults to `undefined`] |
|
|
831
797
|
|
|
832
798
|
### Return type
|
|
833
799
|
|
|
834
|
-
**
|
|
800
|
+
[**DeviceInternalResponse**](DeviceInternalResponse.md)
|
|
835
801
|
|
|
836
802
|
### Authorization
|
|
837
803
|
|
|
838
|
-
[
|
|
804
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
839
805
|
|
|
840
806
|
### HTTP request headers
|
|
841
807
|
|
|
@@ -846,17 +812,17 @@ example().catch(console.error);
|
|
|
846
812
|
### HTTP response details
|
|
847
813
|
| Status code | Description | Response headers |
|
|
848
814
|
|-------------|-------------|------------------|
|
|
849
|
-
| **200** |
|
|
850
|
-
| **
|
|
815
|
+
| **200** | Device details with stats | - |
|
|
816
|
+
| **404** | Not found | - |
|
|
851
817
|
|
|
852
818
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
853
819
|
|
|
854
820
|
|
|
855
|
-
##
|
|
821
|
+
## getReleaseInfo
|
|
856
822
|
|
|
857
|
-
>
|
|
823
|
+
> ReleaseInternalResponse getReleaseInfo(releaseId)
|
|
858
824
|
|
|
859
|
-
Get
|
|
825
|
+
GET /internal/releases/{release_id} - Get release with stats and maintainer info.
|
|
860
826
|
|
|
861
827
|
### Example
|
|
862
828
|
|
|
@@ -865,25 +831,23 @@ import {
|
|
|
865
831
|
Configuration,
|
|
866
832
|
InternalApi,
|
|
867
833
|
} from '@orangefox-recovery/foxinternalclient';
|
|
868
|
-
import type {
|
|
834
|
+
import type { GetReleaseInfoRequest } from '@orangefox-recovery/foxinternalclient';
|
|
869
835
|
|
|
870
836
|
async function example() {
|
|
871
837
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
872
838
|
const config = new Configuration({
|
|
873
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
874
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
875
839
|
// Configure HTTP bearer authorization: bearer_auth
|
|
876
840
|
accessToken: "YOUR BEARER TOKEN",
|
|
877
841
|
});
|
|
878
842
|
const api = new InternalApi(config);
|
|
879
843
|
|
|
880
844
|
const body = {
|
|
881
|
-
// string
|
|
882
|
-
|
|
883
|
-
} satisfies
|
|
845
|
+
// string | Release ID
|
|
846
|
+
releaseId: releaseId_example,
|
|
847
|
+
} satisfies GetReleaseInfoRequest;
|
|
884
848
|
|
|
885
849
|
try {
|
|
886
|
-
const data = await api.
|
|
850
|
+
const data = await api.getReleaseInfo(body);
|
|
887
851
|
console.log(data);
|
|
888
852
|
} catch (error) {
|
|
889
853
|
console.error(error);
|
|
@@ -899,15 +863,15 @@ example().catch(console.error);
|
|
|
899
863
|
|
|
900
864
|
| Name | Type | Description | Notes |
|
|
901
865
|
|------------- | ------------- | ------------- | -------------|
|
|
902
|
-
| **
|
|
866
|
+
| **releaseId** | `string` | Release ID | [Defaults to `undefined`] |
|
|
903
867
|
|
|
904
868
|
### Return type
|
|
905
869
|
|
|
906
|
-
[**
|
|
870
|
+
[**ReleaseInternalResponse**](ReleaseInternalResponse.md)
|
|
907
871
|
|
|
908
872
|
### Authorization
|
|
909
873
|
|
|
910
|
-
[
|
|
874
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
911
875
|
|
|
912
876
|
### HTTP request headers
|
|
913
877
|
|
|
@@ -918,17 +882,17 @@ example().catch(console.error);
|
|
|
918
882
|
### HTTP response details
|
|
919
883
|
| Status code | Description | Response headers |
|
|
920
884
|
|-------------|-------------|------------------|
|
|
921
|
-
| **200** |
|
|
922
|
-
| **
|
|
885
|
+
| **200** | Release details | - |
|
|
886
|
+
| **404** | Not found | - |
|
|
923
887
|
|
|
924
888
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
925
889
|
|
|
926
890
|
|
|
927
|
-
##
|
|
891
|
+
## getUser
|
|
928
892
|
|
|
929
|
-
>
|
|
893
|
+
> UserInternalResponse getUser(userId)
|
|
930
894
|
|
|
931
|
-
|
|
895
|
+
GET /internal/users/{user_id} - Get user with maintained devices.
|
|
932
896
|
|
|
933
897
|
### Example
|
|
934
898
|
|
|
@@ -937,14 +901,23 @@ import {
|
|
|
937
901
|
Configuration,
|
|
938
902
|
InternalApi,
|
|
939
903
|
} from '@orangefox-recovery/foxinternalclient';
|
|
940
|
-
import type {
|
|
904
|
+
import type { GetUserRequest } from '@orangefox-recovery/foxinternalclient';
|
|
941
905
|
|
|
942
906
|
async function example() {
|
|
943
907
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
944
|
-
const
|
|
908
|
+
const config = new Configuration({
|
|
909
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
910
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
911
|
+
});
|
|
912
|
+
const api = new InternalApi(config);
|
|
913
|
+
|
|
914
|
+
const body = {
|
|
915
|
+
// string | User ID
|
|
916
|
+
userId: userId_example,
|
|
917
|
+
} satisfies GetUserRequest;
|
|
945
918
|
|
|
946
919
|
try {
|
|
947
|
-
const data = await api.
|
|
920
|
+
const data = await api.getUser(body);
|
|
948
921
|
console.log(data);
|
|
949
922
|
} catch (error) {
|
|
950
923
|
console.error(error);
|
|
@@ -957,15 +930,18 @@ example().catch(console.error);
|
|
|
957
930
|
|
|
958
931
|
### Parameters
|
|
959
932
|
|
|
960
|
-
|
|
933
|
+
|
|
934
|
+
| Name | Type | Description | Notes |
|
|
935
|
+
|------------- | ------------- | ------------- | -------------|
|
|
936
|
+
| **userId** | `string` | User ID | [Defaults to `undefined`] |
|
|
961
937
|
|
|
962
938
|
### Return type
|
|
963
939
|
|
|
964
|
-
[**
|
|
940
|
+
[**UserInternalResponse**](UserInternalResponse.md)
|
|
965
941
|
|
|
966
942
|
### Authorization
|
|
967
943
|
|
|
968
|
-
|
|
944
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
969
945
|
|
|
970
946
|
### HTTP request headers
|
|
971
947
|
|
|
@@ -976,18 +952,17 @@ No authorization required
|
|
|
976
952
|
### HTTP response details
|
|
977
953
|
| Status code | Description | Response headers |
|
|
978
954
|
|-------------|-------------|------------------|
|
|
979
|
-
| **200** |
|
|
955
|
+
| **200** | User details | - |
|
|
956
|
+
| **404** | Not found | - |
|
|
980
957
|
|
|
981
958
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
982
959
|
|
|
983
960
|
|
|
984
|
-
##
|
|
961
|
+
## listLogs
|
|
985
962
|
|
|
986
|
-
>
|
|
963
|
+
> LogListResponse listLogs(page, perPage, deviceId, releaseId, userId, hideVerbose)
|
|
987
964
|
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
List all pastes. Requires admin permissions.
|
|
965
|
+
GET /internal/logs/ - Get paginated audit logs.
|
|
991
966
|
|
|
992
967
|
### Example
|
|
993
968
|
|
|
@@ -996,20 +971,33 @@ import {
|
|
|
996
971
|
Configuration,
|
|
997
972
|
InternalApi,
|
|
998
973
|
} from '@orangefox-recovery/foxinternalclient';
|
|
999
|
-
import type {
|
|
974
|
+
import type { ListLogsRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1000
975
|
|
|
1001
976
|
async function example() {
|
|
1002
977
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1003
978
|
const config = new Configuration({
|
|
1004
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1005
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1006
979
|
// Configure HTTP bearer authorization: bearer_auth
|
|
1007
980
|
accessToken: "YOUR BEARER TOKEN",
|
|
1008
981
|
});
|
|
1009
982
|
const api = new InternalApi(config);
|
|
1010
983
|
|
|
984
|
+
const body = {
|
|
985
|
+
// number (optional)
|
|
986
|
+
page: 789,
|
|
987
|
+
// number (optional)
|
|
988
|
+
perPage: 789,
|
|
989
|
+
// string (optional)
|
|
990
|
+
deviceId: deviceId_example,
|
|
991
|
+
// string (optional)
|
|
992
|
+
releaseId: releaseId_example,
|
|
993
|
+
// string (optional)
|
|
994
|
+
userId: userId_example,
|
|
995
|
+
// boolean (optional)
|
|
996
|
+
hideVerbose: true,
|
|
997
|
+
} satisfies ListLogsRequest;
|
|
998
|
+
|
|
1011
999
|
try {
|
|
1012
|
-
const data = await api.
|
|
1000
|
+
const data = await api.listLogs(body);
|
|
1013
1001
|
console.log(data);
|
|
1014
1002
|
} catch (error) {
|
|
1015
1003
|
console.error(error);
|
|
@@ -1022,15 +1010,23 @@ example().catch(console.error);
|
|
|
1022
1010
|
|
|
1023
1011
|
### Parameters
|
|
1024
1012
|
|
|
1025
|
-
|
|
1013
|
+
|
|
1014
|
+
| Name | Type | Description | Notes |
|
|
1015
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1016
|
+
| **page** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1017
|
+
| **perPage** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
1018
|
+
| **deviceId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1019
|
+
| **releaseId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1020
|
+
| **userId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1021
|
+
| **hideVerbose** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
1026
1022
|
|
|
1027
1023
|
### Return type
|
|
1028
1024
|
|
|
1029
|
-
[**
|
|
1025
|
+
[**LogListResponse**](LogListResponse.md)
|
|
1030
1026
|
|
|
1031
1027
|
### Authorization
|
|
1032
1028
|
|
|
1033
|
-
[
|
|
1029
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1034
1030
|
|
|
1035
1031
|
### HTTP request headers
|
|
1036
1032
|
|
|
@@ -1041,17 +1037,17 @@ This endpoint does not need any parameter.
|
|
|
1041
1037
|
### HTTP response details
|
|
1042
1038
|
| Status code | Description | Response headers |
|
|
1043
1039
|
|-------------|-------------|------------------|
|
|
1044
|
-
| **200** |
|
|
1045
|
-
| **
|
|
1040
|
+
| **200** | Paginated audit logs | - |
|
|
1041
|
+
| **403** | Forbidden | - |
|
|
1046
1042
|
|
|
1047
1043
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1048
1044
|
|
|
1049
1045
|
|
|
1050
|
-
##
|
|
1046
|
+
## listPasskeys
|
|
1051
1047
|
|
|
1052
|
-
>
|
|
1048
|
+
> Array<PasskeyCredentialResponse> listPasskeys()
|
|
1053
1049
|
|
|
1054
|
-
List
|
|
1050
|
+
GET /profile/passkeys - List the authenticated user\'s passkey credentials.
|
|
1055
1051
|
|
|
1056
1052
|
### Example
|
|
1057
1053
|
|
|
@@ -1060,20 +1056,18 @@ import {
|
|
|
1060
1056
|
Configuration,
|
|
1061
1057
|
InternalApi,
|
|
1062
1058
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1063
|
-
import type {
|
|
1059
|
+
import type { ListPasskeysRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1064
1060
|
|
|
1065
1061
|
async function example() {
|
|
1066
1062
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1067
1063
|
const config = new Configuration({
|
|
1068
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1069
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1070
1064
|
// Configure HTTP bearer authorization: bearer_auth
|
|
1071
1065
|
accessToken: "YOUR BEARER TOKEN",
|
|
1072
1066
|
});
|
|
1073
1067
|
const api = new InternalApi(config);
|
|
1074
1068
|
|
|
1075
1069
|
try {
|
|
1076
|
-
const data = await api.
|
|
1070
|
+
const data = await api.listPasskeys();
|
|
1077
1071
|
console.log(data);
|
|
1078
1072
|
} catch (error) {
|
|
1079
1073
|
console.error(error);
|
|
@@ -1090,11 +1084,11 @@ This endpoint does not need any parameter.
|
|
|
1090
1084
|
|
|
1091
1085
|
### Return type
|
|
1092
1086
|
|
|
1093
|
-
[**
|
|
1087
|
+
[**Array<PasskeyCredentialResponse>**](PasskeyCredentialResponse.md)
|
|
1094
1088
|
|
|
1095
1089
|
### Authorization
|
|
1096
1090
|
|
|
1097
|
-
[
|
|
1091
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1098
1092
|
|
|
1099
1093
|
### HTTP request headers
|
|
1100
1094
|
|
|
@@ -1105,18 +1099,16 @@ This endpoint does not need any parameter.
|
|
|
1105
1099
|
### HTTP response details
|
|
1106
1100
|
| Status code | Description | Response headers |
|
|
1107
1101
|
|-------------|-------------|------------------|
|
|
1108
|
-
| **200** |
|
|
1102
|
+
| **200** | List of passkeys | - |
|
|
1109
1103
|
|
|
1110
1104
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1111
1105
|
|
|
1112
1106
|
|
|
1113
|
-
##
|
|
1107
|
+
## listPastes
|
|
1114
1108
|
|
|
1115
|
-
>
|
|
1109
|
+
> ListResponsePasteResponse listPastes()
|
|
1116
1110
|
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
OAuth2 compatible token login, get an access token for future requests
|
|
1111
|
+
GET /internal/paste/ - List all pastes (admin only).
|
|
1120
1112
|
|
|
1121
1113
|
### Example
|
|
1122
1114
|
|
|
@@ -1125,33 +1117,18 @@ import {
|
|
|
1125
1117
|
Configuration,
|
|
1126
1118
|
InternalApi,
|
|
1127
1119
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1128
|
-
import type {
|
|
1120
|
+
import type { ListPastesRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1129
1121
|
|
|
1130
1122
|
async function example() {
|
|
1131
1123
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1132
|
-
const
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
// string
|
|
1138
|
-
password: password_example,
|
|
1139
|
-
// number (optional)
|
|
1140
|
-
minTime: 8.14,
|
|
1141
|
-
// number (optional)
|
|
1142
|
-
maxTime: 8.14,
|
|
1143
|
-
// string (optional)
|
|
1144
|
-
grantType: grantType_example,
|
|
1145
|
-
// string (optional)
|
|
1146
|
-
scope: scope_example,
|
|
1147
|
-
// string (optional)
|
|
1148
|
-
clientId: clientId_example,
|
|
1149
|
-
// string (optional)
|
|
1150
|
-
clientSecret: clientSecret_example,
|
|
1151
|
-
} satisfies LoginOauthAuthLoginPostRequest;
|
|
1124
|
+
const config = new Configuration({
|
|
1125
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1126
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1127
|
+
});
|
|
1128
|
+
const api = new InternalApi(config);
|
|
1152
1129
|
|
|
1153
1130
|
try {
|
|
1154
|
-
const data = await api.
|
|
1131
|
+
const data = await api.listPastes();
|
|
1155
1132
|
console.log(data);
|
|
1156
1133
|
} catch (error) {
|
|
1157
1134
|
console.error(error);
|
|
@@ -1164,46 +1141,36 @@ example().catch(console.error);
|
|
|
1164
1141
|
|
|
1165
1142
|
### Parameters
|
|
1166
1143
|
|
|
1167
|
-
|
|
1168
|
-
| Name | Type | Description | Notes |
|
|
1169
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1170
|
-
| **username** | `string` | | [Defaults to `undefined`] |
|
|
1171
|
-
| **password** | `string` | | [Defaults to `undefined`] |
|
|
1172
|
-
| **minTime** | `number` | | [Optional] [Defaults to `0.3`] |
|
|
1173
|
-
| **maxTime** | `number` | | [Optional] [Defaults to `1`] |
|
|
1174
|
-
| **grantType** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1175
|
-
| **scope** | `string` | | [Optional] [Defaults to `''`] |
|
|
1176
|
-
| **clientId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1177
|
-
| **clientSecret** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1144
|
+
This endpoint does not need any parameter.
|
|
1178
1145
|
|
|
1179
1146
|
### Return type
|
|
1180
1147
|
|
|
1181
|
-
[**
|
|
1148
|
+
[**ListResponsePasteResponse**](ListResponsePasteResponse.md)
|
|
1182
1149
|
|
|
1183
1150
|
### Authorization
|
|
1184
1151
|
|
|
1185
|
-
|
|
1152
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1186
1153
|
|
|
1187
1154
|
### HTTP request headers
|
|
1188
1155
|
|
|
1189
|
-
- **Content-Type**:
|
|
1156
|
+
- **Content-Type**: Not defined
|
|
1190
1157
|
- **Accept**: `application/json`
|
|
1191
1158
|
|
|
1192
1159
|
|
|
1193
1160
|
### HTTP response details
|
|
1194
1161
|
| Status code | Description | Response headers |
|
|
1195
1162
|
|-------------|-------------|------------------|
|
|
1196
|
-
| **200** |
|
|
1197
|
-
| **
|
|
1163
|
+
| **200** | List of pastes | - |
|
|
1164
|
+
| **403** | Forbidden | - |
|
|
1198
1165
|
|
|
1199
1166
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1200
1167
|
|
|
1201
1168
|
|
|
1202
|
-
##
|
|
1169
|
+
## listUsers
|
|
1203
1170
|
|
|
1204
|
-
>
|
|
1171
|
+
> ListResponseUserShortResponse listUsers()
|
|
1205
1172
|
|
|
1206
|
-
|
|
1173
|
+
GET /internal/users/ - List all users (short response).
|
|
1207
1174
|
|
|
1208
1175
|
### Example
|
|
1209
1176
|
|
|
@@ -1212,25 +1179,18 @@ import {
|
|
|
1212
1179
|
Configuration,
|
|
1213
1180
|
InternalApi,
|
|
1214
1181
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1215
|
-
import type {
|
|
1182
|
+
import type { ListUsersRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1216
1183
|
|
|
1217
1184
|
async function example() {
|
|
1218
1185
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1219
1186
|
const config = new Configuration({
|
|
1220
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1221
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1222
1187
|
// Configure HTTP bearer authorization: bearer_auth
|
|
1223
1188
|
accessToken: "YOUR BEARER TOKEN",
|
|
1224
1189
|
});
|
|
1225
1190
|
const api = new InternalApi(config);
|
|
1226
1191
|
|
|
1227
|
-
const body = {
|
|
1228
|
-
// string
|
|
1229
|
-
body: body_example,
|
|
1230
|
-
} satisfies LogoutAuthLogoutPostRequest;
|
|
1231
|
-
|
|
1232
1192
|
try {
|
|
1233
|
-
const data = await api.
|
|
1193
|
+
const data = await api.listUsers();
|
|
1234
1194
|
console.log(data);
|
|
1235
1195
|
} catch (error) {
|
|
1236
1196
|
console.error(error);
|
|
@@ -1243,39 +1203,38 @@ example().catch(console.error);
|
|
|
1243
1203
|
|
|
1244
1204
|
### Parameters
|
|
1245
1205
|
|
|
1246
|
-
|
|
1247
|
-
| Name | Type | Description | Notes |
|
|
1248
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1249
|
-
| **body** | `string` | | |
|
|
1206
|
+
This endpoint does not need any parameter.
|
|
1250
1207
|
|
|
1251
1208
|
### Return type
|
|
1252
1209
|
|
|
1253
|
-
**
|
|
1210
|
+
[**ListResponseUserShortResponse**](ListResponseUserShortResponse.md)
|
|
1254
1211
|
|
|
1255
1212
|
### Authorization
|
|
1256
1213
|
|
|
1257
|
-
[
|
|
1214
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1258
1215
|
|
|
1259
1216
|
### HTTP request headers
|
|
1260
1217
|
|
|
1261
|
-
- **Content-Type**:
|
|
1218
|
+
- **Content-Type**: Not defined
|
|
1262
1219
|
- **Accept**: `application/json`
|
|
1263
1220
|
|
|
1264
1221
|
|
|
1265
1222
|
### HTTP response details
|
|
1266
1223
|
| Status code | Description | Response headers |
|
|
1267
1224
|
|-------------|-------------|------------------|
|
|
1268
|
-
| **200** |
|
|
1269
|
-
| **
|
|
1225
|
+
| **200** | List of users | - |
|
|
1226
|
+
| **403** | Forbidden | - |
|
|
1270
1227
|
|
|
1271
1228
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1272
1229
|
|
|
1273
1230
|
|
|
1274
|
-
##
|
|
1231
|
+
## login
|
|
1275
1232
|
|
|
1276
|
-
>
|
|
1233
|
+
> TokenResponse login(loginForm)
|
|
1277
1234
|
|
|
1278
|
-
|
|
1235
|
+
POST /auth/login
|
|
1236
|
+
|
|
1237
|
+
Accepts form data with `username` and `password`. Returns a bearer token (existing valid or newly created).
|
|
1279
1238
|
|
|
1280
1239
|
### Example
|
|
1281
1240
|
|
|
@@ -1284,25 +1243,19 @@ import {
|
|
|
1284
1243
|
Configuration,
|
|
1285
1244
|
InternalApi,
|
|
1286
1245
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1287
|
-
import type {
|
|
1246
|
+
import type { LoginRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1288
1247
|
|
|
1289
1248
|
async function example() {
|
|
1290
1249
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1291
|
-
const
|
|
1292
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1293
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1294
|
-
// Configure HTTP bearer authorization: bearer_auth
|
|
1295
|
-
accessToken: "YOUR BEARER TOKEN",
|
|
1296
|
-
});
|
|
1297
|
-
const api = new InternalApi(config);
|
|
1250
|
+
const api = new InternalApi();
|
|
1298
1251
|
|
|
1299
1252
|
const body = {
|
|
1300
|
-
//
|
|
1301
|
-
|
|
1302
|
-
} satisfies
|
|
1253
|
+
// LoginForm
|
|
1254
|
+
loginForm: ...,
|
|
1255
|
+
} satisfies LoginRequest;
|
|
1303
1256
|
|
|
1304
1257
|
try {
|
|
1305
|
-
const data = await api.
|
|
1258
|
+
const data = await api.login(body);
|
|
1306
1259
|
console.log(data);
|
|
1307
1260
|
} catch (error) {
|
|
1308
1261
|
console.error(error);
|
|
@@ -1318,15 +1271,15 @@ example().catch(console.error);
|
|
|
1318
1271
|
|
|
1319
1272
|
| Name | Type | Description | Notes |
|
|
1320
1273
|
|------------- | ------------- | ------------- | -------------|
|
|
1321
|
-
| **
|
|
1274
|
+
| **loginForm** | [LoginForm](LoginForm.md) | | |
|
|
1322
1275
|
|
|
1323
1276
|
### Return type
|
|
1324
1277
|
|
|
1325
|
-
**
|
|
1278
|
+
[**TokenResponse**](TokenResponse.md)
|
|
1326
1279
|
|
|
1327
1280
|
### Authorization
|
|
1328
1281
|
|
|
1329
|
-
|
|
1282
|
+
No authorization required
|
|
1330
1283
|
|
|
1331
1284
|
### HTTP request headers
|
|
1332
1285
|
|
|
@@ -1337,17 +1290,20 @@ example().catch(console.error);
|
|
|
1337
1290
|
### HTTP response details
|
|
1338
1291
|
| Status code | Description | Response headers |
|
|
1339
1292
|
|-------------|-------------|------------------|
|
|
1340
|
-
| **200** |
|
|
1341
|
-
| **
|
|
1293
|
+
| **200** | Login successful | - |
|
|
1294
|
+
| **401** | Unauthorized | - |
|
|
1295
|
+
| **429** | Too many requests | - |
|
|
1342
1296
|
|
|
1343
1297
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1344
1298
|
|
|
1345
1299
|
|
|
1346
|
-
##
|
|
1300
|
+
## logout
|
|
1347
1301
|
|
|
1348
|
-
>
|
|
1302
|
+
> logout()
|
|
1349
1303
|
|
|
1350
|
-
|
|
1304
|
+
POST /auth/logout
|
|
1305
|
+
|
|
1306
|
+
Reads the token from the Authorization: Bearer header. Deletes the token from the database and logs the action.
|
|
1351
1307
|
|
|
1352
1308
|
### Example
|
|
1353
1309
|
|
|
@@ -1356,37 +1312,18 @@ import {
|
|
|
1356
1312
|
Configuration,
|
|
1357
1313
|
InternalApi,
|
|
1358
1314
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1359
|
-
import type {
|
|
1315
|
+
import type { LogoutRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1360
1316
|
|
|
1361
1317
|
async function example() {
|
|
1362
1318
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1363
1319
|
const config = new Configuration({
|
|
1364
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1365
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1366
1320
|
// Configure HTTP bearer authorization: bearer_auth
|
|
1367
1321
|
accessToken: "YOUR BEARER TOKEN",
|
|
1368
1322
|
});
|
|
1369
1323
|
const api = new InternalApi(config);
|
|
1370
1324
|
|
|
1371
|
-
const body = {
|
|
1372
|
-
// string
|
|
1373
|
-
deviceId: deviceId_example,
|
|
1374
|
-
// string
|
|
1375
|
-
releaseZip: releaseZip_example,
|
|
1376
|
-
// string
|
|
1377
|
-
md5: md5_example,
|
|
1378
|
-
// Array<string>
|
|
1379
|
-
changelog: ...,
|
|
1380
|
-
// Array<string> (optional)
|
|
1381
|
-
bugs: ...,
|
|
1382
|
-
// string (optional)
|
|
1383
|
-
notes: notes_example,
|
|
1384
|
-
// boolean (optional)
|
|
1385
|
-
force: true,
|
|
1386
|
-
} satisfies NewReleaseInternalReleasesPostRequest;
|
|
1387
|
-
|
|
1388
1325
|
try {
|
|
1389
|
-
const data = await api.
|
|
1326
|
+
const data = await api.logout();
|
|
1390
1327
|
console.log(data);
|
|
1391
1328
|
} catch (error) {
|
|
1392
1329
|
console.error(error);
|
|
@@ -1399,45 +1336,38 @@ example().catch(console.error);
|
|
|
1399
1336
|
|
|
1400
1337
|
### Parameters
|
|
1401
1338
|
|
|
1402
|
-
|
|
1403
|
-
| Name | Type | Description | Notes |
|
|
1404
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1405
|
-
| **deviceId** | `string` | | [Defaults to `undefined`] |
|
|
1406
|
-
| **releaseZip** | `string` | | [Defaults to `undefined`] |
|
|
1407
|
-
| **md5** | `string` | | [Defaults to `undefined`] |
|
|
1408
|
-
| **changelog** | `Array<string>` | | |
|
|
1409
|
-
| **bugs** | `Array<string>` | | [Optional] |
|
|
1410
|
-
| **notes** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1411
|
-
| **force** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
1339
|
+
This endpoint does not need any parameter.
|
|
1412
1340
|
|
|
1413
1341
|
### Return type
|
|
1414
1342
|
|
|
1415
|
-
|
|
1343
|
+
`void` (Empty response body)
|
|
1416
1344
|
|
|
1417
1345
|
### Authorization
|
|
1418
1346
|
|
|
1419
|
-
[
|
|
1347
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1420
1348
|
|
|
1421
1349
|
### HTTP request headers
|
|
1422
1350
|
|
|
1423
|
-
- **Content-Type**:
|
|
1351
|
+
- **Content-Type**: Not defined
|
|
1424
1352
|
- **Accept**: `application/json`
|
|
1425
1353
|
|
|
1426
1354
|
|
|
1427
1355
|
### HTTP response details
|
|
1428
1356
|
| Status code | Description | Response headers |
|
|
1429
1357
|
|-------------|-------------|------------------|
|
|
1430
|
-
| **200** |
|
|
1431
|
-
| **
|
|
1358
|
+
| **200** | Logged out | - |
|
|
1359
|
+
| **401** | Unauthorized | - |
|
|
1432
1360
|
|
|
1433
1361
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1434
1362
|
|
|
1435
1363
|
|
|
1436
|
-
##
|
|
1364
|
+
## passkeyLoginOptions
|
|
1365
|
+
|
|
1366
|
+
> passkeyLoginOptions()
|
|
1437
1367
|
|
|
1438
|
-
|
|
1368
|
+
POST /auth/passkeys/login/options
|
|
1439
1369
|
|
|
1440
|
-
|
|
1370
|
+
Starts a passkey authentication flow (public, no auth required). Uses discoverable credentials (empty allow list).
|
|
1441
1371
|
|
|
1442
1372
|
### Example
|
|
1443
1373
|
|
|
@@ -1446,14 +1376,14 @@ import {
|
|
|
1446
1376
|
Configuration,
|
|
1447
1377
|
InternalApi,
|
|
1448
1378
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1449
|
-
import type {
|
|
1379
|
+
import type { PasskeyLoginOptionsRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1450
1380
|
|
|
1451
1381
|
async function example() {
|
|
1452
1382
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1453
1383
|
const api = new InternalApi();
|
|
1454
1384
|
|
|
1455
1385
|
try {
|
|
1456
|
-
const data = await api.
|
|
1386
|
+
const data = await api.passkeyLoginOptions();
|
|
1457
1387
|
console.log(data);
|
|
1458
1388
|
} catch (error) {
|
|
1459
1389
|
console.error(error);
|
|
@@ -1470,7 +1400,7 @@ This endpoint does not need any parameter.
|
|
|
1470
1400
|
|
|
1471
1401
|
### Return type
|
|
1472
1402
|
|
|
1473
|
-
|
|
1403
|
+
`void` (Empty response body)
|
|
1474
1404
|
|
|
1475
1405
|
### Authorization
|
|
1476
1406
|
|
|
@@ -1485,16 +1415,19 @@ No authorization required
|
|
|
1485
1415
|
### HTTP response details
|
|
1486
1416
|
| Status code | Description | Response headers |
|
|
1487
1417
|
|-------------|-------------|------------------|
|
|
1488
|
-
| **200** |
|
|
1418
|
+
| **200** | Login options | - |
|
|
1419
|
+
| **429** | Too many requests | - |
|
|
1489
1420
|
|
|
1490
1421
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1491
1422
|
|
|
1492
1423
|
|
|
1493
|
-
##
|
|
1424
|
+
## passkeyLoginVerify
|
|
1425
|
+
|
|
1426
|
+
> TokenResponse passkeyLoginVerify(passkeyVerifyRequest)
|
|
1494
1427
|
|
|
1495
|
-
|
|
1428
|
+
POST /auth/passkeys/login/verify
|
|
1496
1429
|
|
|
1497
|
-
|
|
1430
|
+
Completes a passkey authentication (public, no auth required). Finds the credential, verifies the authentication, and issues a token.
|
|
1498
1431
|
|
|
1499
1432
|
### Example
|
|
1500
1433
|
|
|
@@ -1503,7 +1436,7 @@ import {
|
|
|
1503
1436
|
Configuration,
|
|
1504
1437
|
InternalApi,
|
|
1505
1438
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1506
|
-
import type {
|
|
1439
|
+
import type { PasskeyLoginVerifyRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1507
1440
|
|
|
1508
1441
|
async function example() {
|
|
1509
1442
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
@@ -1512,10 +1445,10 @@ async function example() {
|
|
|
1512
1445
|
const body = {
|
|
1513
1446
|
// PasskeyVerifyRequest
|
|
1514
1447
|
passkeyVerifyRequest: ...,
|
|
1515
|
-
} satisfies
|
|
1448
|
+
} satisfies PasskeyLoginVerifyRequest;
|
|
1516
1449
|
|
|
1517
1450
|
try {
|
|
1518
|
-
const data = await api.
|
|
1451
|
+
const data = await api.passkeyLoginVerify(body);
|
|
1519
1452
|
console.log(data);
|
|
1520
1453
|
} catch (error) {
|
|
1521
1454
|
console.error(error);
|
|
@@ -1550,17 +1483,19 @@ No authorization required
|
|
|
1550
1483
|
### HTTP response details
|
|
1551
1484
|
| Status code | Description | Response headers |
|
|
1552
1485
|
|-------------|-------------|------------------|
|
|
1553
|
-
| **200** |
|
|
1554
|
-
| **
|
|
1486
|
+
| **200** | Login successful | - |
|
|
1487
|
+
| **429** | Too many requests | - |
|
|
1555
1488
|
|
|
1556
1489
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1557
1490
|
|
|
1558
1491
|
|
|
1559
|
-
##
|
|
1492
|
+
## passkeyRegisterOptions
|
|
1493
|
+
|
|
1494
|
+
> passkeyRegisterOptions(passkeyRegisterOptionsRequest)
|
|
1560
1495
|
|
|
1561
|
-
|
|
1496
|
+
POST /auth/passkeys/register/options
|
|
1562
1497
|
|
|
1563
|
-
|
|
1498
|
+
Starts a passkey registration flow. Requires authenticated user and password confirmation. Returns registration options and a challenge.
|
|
1564
1499
|
|
|
1565
1500
|
### Example
|
|
1566
1501
|
|
|
@@ -1569,13 +1504,11 @@ import {
|
|
|
1569
1504
|
Configuration,
|
|
1570
1505
|
InternalApi,
|
|
1571
1506
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1572
|
-
import type {
|
|
1507
|
+
import type { PasskeyRegisterOptionsOperationRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1573
1508
|
|
|
1574
1509
|
async function example() {
|
|
1575
1510
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1576
1511
|
const config = new Configuration({
|
|
1577
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1578
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1579
1512
|
// Configure HTTP bearer authorization: bearer_auth
|
|
1580
1513
|
accessToken: "YOUR BEARER TOKEN",
|
|
1581
1514
|
});
|
|
@@ -1584,10 +1517,10 @@ async function example() {
|
|
|
1584
1517
|
const body = {
|
|
1585
1518
|
// PasskeyRegisterOptionsRequest
|
|
1586
1519
|
passkeyRegisterOptionsRequest: ...,
|
|
1587
|
-
} satisfies
|
|
1520
|
+
} satisfies PasskeyRegisterOptionsOperationRequest;
|
|
1588
1521
|
|
|
1589
1522
|
try {
|
|
1590
|
-
const data = await api.
|
|
1523
|
+
const data = await api.passkeyRegisterOptions(body);
|
|
1591
1524
|
console.log(data);
|
|
1592
1525
|
} catch (error) {
|
|
1593
1526
|
console.error(error);
|
|
@@ -1607,11 +1540,11 @@ example().catch(console.error);
|
|
|
1607
1540
|
|
|
1608
1541
|
### Return type
|
|
1609
1542
|
|
|
1610
|
-
|
|
1543
|
+
`void` (Empty response body)
|
|
1611
1544
|
|
|
1612
1545
|
### Authorization
|
|
1613
1546
|
|
|
1614
|
-
[
|
|
1547
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1615
1548
|
|
|
1616
1549
|
### HTTP request headers
|
|
1617
1550
|
|
|
@@ -1622,17 +1555,20 @@ example().catch(console.error);
|
|
|
1622
1555
|
### HTTP response details
|
|
1623
1556
|
| Status code | Description | Response headers |
|
|
1624
1557
|
|-------------|-------------|------------------|
|
|
1625
|
-
| **200** |
|
|
1626
|
-
| **
|
|
1558
|
+
| **200** | Registration options | - |
|
|
1559
|
+
| **401** | Unauthorized | - |
|
|
1560
|
+
| **429** | Too many requests | - |
|
|
1627
1561
|
|
|
1628
1562
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1629
1563
|
|
|
1630
1564
|
|
|
1631
|
-
##
|
|
1565
|
+
## passkeyRegisterVerify
|
|
1566
|
+
|
|
1567
|
+
> passkeyRegisterVerify(passkeyVerifyRequest)
|
|
1632
1568
|
|
|
1633
|
-
|
|
1569
|
+
POST /auth/passkeys/register/verify
|
|
1634
1570
|
|
|
1635
|
-
|
|
1571
|
+
Completes a passkey registration. Consumes the challenge, verifies the credential, and stores the new passkey.
|
|
1636
1572
|
|
|
1637
1573
|
### Example
|
|
1638
1574
|
|
|
@@ -1641,13 +1577,11 @@ import {
|
|
|
1641
1577
|
Configuration,
|
|
1642
1578
|
InternalApi,
|
|
1643
1579
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1644
|
-
import type {
|
|
1580
|
+
import type { PasskeyRegisterVerifyRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1645
1581
|
|
|
1646
1582
|
async function example() {
|
|
1647
1583
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1648
1584
|
const config = new Configuration({
|
|
1649
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1650
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1651
1585
|
// Configure HTTP bearer authorization: bearer_auth
|
|
1652
1586
|
accessToken: "YOUR BEARER TOKEN",
|
|
1653
1587
|
});
|
|
@@ -1656,10 +1590,10 @@ async function example() {
|
|
|
1656
1590
|
const body = {
|
|
1657
1591
|
// PasskeyVerifyRequest
|
|
1658
1592
|
passkeyVerifyRequest: ...,
|
|
1659
|
-
} satisfies
|
|
1593
|
+
} satisfies PasskeyRegisterVerifyRequest;
|
|
1660
1594
|
|
|
1661
1595
|
try {
|
|
1662
|
-
const data = await api.
|
|
1596
|
+
const data = await api.passkeyRegisterVerify(body);
|
|
1663
1597
|
console.log(data);
|
|
1664
1598
|
} catch (error) {
|
|
1665
1599
|
console.error(error);
|
|
@@ -1679,11 +1613,11 @@ example().catch(console.error);
|
|
|
1679
1613
|
|
|
1680
1614
|
### Return type
|
|
1681
1615
|
|
|
1682
|
-
|
|
1616
|
+
`void` (Empty response body)
|
|
1683
1617
|
|
|
1684
1618
|
### Authorization
|
|
1685
1619
|
|
|
1686
|
-
[
|
|
1620
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1687
1621
|
|
|
1688
1622
|
### HTTP request headers
|
|
1689
1623
|
|
|
@@ -1694,17 +1628,18 @@ example().catch(console.error);
|
|
|
1694
1628
|
### HTTP response details
|
|
1695
1629
|
| Status code | Description | Response headers |
|
|
1696
1630
|
|-------------|-------------|------------------|
|
|
1697
|
-
| **200** |
|
|
1698
|
-
| **
|
|
1631
|
+
| **200** | Passkey registered | - |
|
|
1632
|
+
| **401** | Unauthorized | - |
|
|
1633
|
+
| **429** | Too many requests | - |
|
|
1699
1634
|
|
|
1700
1635
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1701
1636
|
|
|
1702
1637
|
|
|
1703
|
-
##
|
|
1638
|
+
## renamePasskey
|
|
1704
1639
|
|
|
1705
|
-
>
|
|
1640
|
+
> renamePasskey(credentialId, renamePasskeyBody)
|
|
1706
1641
|
|
|
1707
|
-
Rename
|
|
1642
|
+
POST /profile/passkeys/{credential_id}/rename - Rename a passkey credential.
|
|
1708
1643
|
|
|
1709
1644
|
### Example
|
|
1710
1645
|
|
|
@@ -1713,21 +1648,25 @@ import {
|
|
|
1713
1648
|
Configuration,
|
|
1714
1649
|
InternalApi,
|
|
1715
1650
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1716
|
-
import type {
|
|
1651
|
+
import type { RenamePasskeyRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1717
1652
|
|
|
1718
1653
|
async function example() {
|
|
1719
1654
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1720
|
-
const
|
|
1655
|
+
const config = new Configuration({
|
|
1656
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
1657
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1658
|
+
});
|
|
1659
|
+
const api = new InternalApi(config);
|
|
1721
1660
|
|
|
1722
1661
|
const body = {
|
|
1723
|
-
// string
|
|
1662
|
+
// string | Passkey credential ID
|
|
1724
1663
|
credentialId: credentialId_example,
|
|
1725
1664
|
// RenamePasskeyBody
|
|
1726
1665
|
renamePasskeyBody: ...,
|
|
1727
|
-
} satisfies
|
|
1666
|
+
} satisfies RenamePasskeyRequest;
|
|
1728
1667
|
|
|
1729
1668
|
try {
|
|
1730
|
-
const data = await api.
|
|
1669
|
+
const data = await api.renamePasskey(body);
|
|
1731
1670
|
console.log(data);
|
|
1732
1671
|
} catch (error) {
|
|
1733
1672
|
console.error(error);
|
|
@@ -1743,16 +1682,16 @@ example().catch(console.error);
|
|
|
1743
1682
|
|
|
1744
1683
|
| Name | Type | Description | Notes |
|
|
1745
1684
|
|------------- | ------------- | ------------- | -------------|
|
|
1746
|
-
| **credentialId** | `string` |
|
|
1685
|
+
| **credentialId** | `string` | Passkey credential ID | [Defaults to `undefined`] |
|
|
1747
1686
|
| **renamePasskeyBody** | [RenamePasskeyBody](RenamePasskeyBody.md) | | |
|
|
1748
1687
|
|
|
1749
1688
|
### Return type
|
|
1750
1689
|
|
|
1751
|
-
|
|
1690
|
+
`void` (Empty response body)
|
|
1752
1691
|
|
|
1753
1692
|
### Authorization
|
|
1754
1693
|
|
|
1755
|
-
|
|
1694
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1756
1695
|
|
|
1757
1696
|
### HTTP request headers
|
|
1758
1697
|
|
|
@@ -1763,17 +1702,19 @@ No authorization required
|
|
|
1763
1702
|
### HTTP response details
|
|
1764
1703
|
| Status code | Description | Response headers |
|
|
1765
1704
|
|-------------|-------------|------------------|
|
|
1766
|
-
| **200** |
|
|
1767
|
-
| **
|
|
1705
|
+
| **200** | Passkey renamed | - |
|
|
1706
|
+
| **404** | Not found | - |
|
|
1768
1707
|
|
|
1769
1708
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1770
1709
|
|
|
1771
1710
|
|
|
1772
|
-
##
|
|
1711
|
+
## renew
|
|
1712
|
+
|
|
1713
|
+
> TokenResponse renew(body)
|
|
1773
1714
|
|
|
1774
|
-
|
|
1715
|
+
POST /auth/renew
|
|
1775
1716
|
|
|
1776
|
-
|
|
1717
|
+
Accepts a raw JSON string body (the token value). If the token is still in first half of its lifetime, returns same token. Otherwise creates a new one and deletes old tokens.
|
|
1777
1718
|
|
|
1778
1719
|
### Example
|
|
1779
1720
|
|
|
@@ -1782,13 +1723,11 @@ import {
|
|
|
1782
1723
|
Configuration,
|
|
1783
1724
|
InternalApi,
|
|
1784
1725
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1785
|
-
import type {
|
|
1726
|
+
import type { RenewRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1786
1727
|
|
|
1787
1728
|
async function example() {
|
|
1788
1729
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1789
1730
|
const config = new Configuration({
|
|
1790
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1791
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1792
1731
|
// Configure HTTP bearer authorization: bearer_auth
|
|
1793
1732
|
accessToken: "YOUR BEARER TOKEN",
|
|
1794
1733
|
});
|
|
@@ -1797,10 +1736,10 @@ async function example() {
|
|
|
1797
1736
|
const body = {
|
|
1798
1737
|
// string
|
|
1799
1738
|
body: body_example,
|
|
1800
|
-
} satisfies
|
|
1739
|
+
} satisfies RenewRequest;
|
|
1801
1740
|
|
|
1802
1741
|
try {
|
|
1803
|
-
const data = await api.
|
|
1742
|
+
const data = await api.renew(body);
|
|
1804
1743
|
console.log(data);
|
|
1805
1744
|
} catch (error) {
|
|
1806
1745
|
console.error(error);
|
|
@@ -1820,109 +1759,33 @@ example().catch(console.error);
|
|
|
1820
1759
|
|
|
1821
1760
|
### Return type
|
|
1822
1761
|
|
|
1823
|
-
**
|
|
1824
|
-
|
|
1825
|
-
### Authorization
|
|
1826
|
-
|
|
1827
|
-
[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
|
|
1828
|
-
|
|
1829
|
-
### HTTP request headers
|
|
1830
|
-
|
|
1831
|
-
- **Content-Type**: `application/json`
|
|
1832
|
-
- **Accept**: `application/json`
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
### HTTP response details
|
|
1836
|
-
| Status code | Description | Response headers |
|
|
1837
|
-
|-------------|-------------|------------------|
|
|
1838
|
-
| **200** | Successful Response | - |
|
|
1839
|
-
| **422** | Validation Error | - |
|
|
1840
|
-
|
|
1841
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1842
|
-
|
|
1843
|
-
|
|
1844
|
-
## updateDeviceInternalDevicesDeviceIdPut
|
|
1845
|
-
|
|
1846
|
-
> boolean updateDeviceInternalDevicesDeviceIdPut(deviceId, deviceUpdateBody)
|
|
1847
|
-
|
|
1848
|
-
Update Device
|
|
1849
|
-
|
|
1850
|
-
### Example
|
|
1851
|
-
|
|
1852
|
-
```ts
|
|
1853
|
-
import {
|
|
1854
|
-
Configuration,
|
|
1855
|
-
InternalApi,
|
|
1856
|
-
} from '@orangefox-recovery/foxinternalclient';
|
|
1857
|
-
import type { UpdateDeviceInternalDevicesDeviceIdPutRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1858
|
-
|
|
1859
|
-
async function example() {
|
|
1860
|
-
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1861
|
-
const config = new Configuration({
|
|
1862
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1863
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1864
|
-
// Configure HTTP bearer authorization: bearer_auth
|
|
1865
|
-
accessToken: "YOUR BEARER TOKEN",
|
|
1866
|
-
});
|
|
1867
|
-
const api = new InternalApi(config);
|
|
1868
|
-
|
|
1869
|
-
const body = {
|
|
1870
|
-
// string
|
|
1871
|
-
deviceId: deviceId_example,
|
|
1872
|
-
// DeviceUpdateBody
|
|
1873
|
-
deviceUpdateBody: ...,
|
|
1874
|
-
} satisfies UpdateDeviceInternalDevicesDeviceIdPutRequest;
|
|
1875
|
-
|
|
1876
|
-
try {
|
|
1877
|
-
const data = await api.updateDeviceInternalDevicesDeviceIdPut(body);
|
|
1878
|
-
console.log(data);
|
|
1879
|
-
} catch (error) {
|
|
1880
|
-
console.error(error);
|
|
1881
|
-
}
|
|
1882
|
-
}
|
|
1883
|
-
|
|
1884
|
-
// Run the test
|
|
1885
|
-
example().catch(console.error);
|
|
1886
|
-
```
|
|
1887
|
-
|
|
1888
|
-
### Parameters
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
| Name | Type | Description | Notes |
|
|
1892
|
-
|------------- | ------------- | ------------- | -------------|
|
|
1893
|
-
| **deviceId** | `string` | | [Defaults to `undefined`] |
|
|
1894
|
-
| **deviceUpdateBody** | [DeviceUpdateBody](DeviceUpdateBody.md) | | |
|
|
1895
|
-
|
|
1896
|
-
### Return type
|
|
1897
|
-
|
|
1898
|
-
**boolean**
|
|
1762
|
+
[**TokenResponse**](TokenResponse.md)
|
|
1899
1763
|
|
|
1900
1764
|
### Authorization
|
|
1901
1765
|
|
|
1902
|
-
[
|
|
1766
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1903
1767
|
|
|
1904
1768
|
### HTTP request headers
|
|
1905
1769
|
|
|
1906
|
-
- **Content-Type**: `
|
|
1770
|
+
- **Content-Type**: `text/plain`
|
|
1907
1771
|
- **Accept**: `application/json`
|
|
1908
1772
|
|
|
1909
1773
|
|
|
1910
1774
|
### HTTP response details
|
|
1911
1775
|
| Status code | Description | Response headers |
|
|
1912
1776
|
|-------------|-------------|------------------|
|
|
1913
|
-
| **200** |
|
|
1914
|
-
| **
|
|
1777
|
+
| **200** | Token renewed | - |
|
|
1778
|
+
| **401** | Unauthorized | - |
|
|
1779
|
+
| **429** | Too many requests | - |
|
|
1915
1780
|
|
|
1916
1781
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1917
1782
|
|
|
1918
1783
|
|
|
1919
|
-
##
|
|
1784
|
+
## updatePaste
|
|
1920
1785
|
|
|
1921
|
-
>
|
|
1786
|
+
> boolean updatePaste(pasteId, pasteInput)
|
|
1922
1787
|
|
|
1923
|
-
Update
|
|
1924
|
-
|
|
1925
|
-
Update a paste by ID. Requires admin permissions.
|
|
1788
|
+
PUT /internal/paste/{paste_id} - Update paste content (admin only).
|
|
1926
1789
|
|
|
1927
1790
|
### Example
|
|
1928
1791
|
|
|
@@ -1931,13 +1794,11 @@ import {
|
|
|
1931
1794
|
Configuration,
|
|
1932
1795
|
InternalApi,
|
|
1933
1796
|
} from '@orangefox-recovery/foxinternalclient';
|
|
1934
|
-
import type {
|
|
1797
|
+
import type { UpdatePasteRequest } from '@orangefox-recovery/foxinternalclient';
|
|
1935
1798
|
|
|
1936
1799
|
async function example() {
|
|
1937
1800
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
1938
1801
|
const config = new Configuration({
|
|
1939
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
1940
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
1941
1802
|
// Configure HTTP bearer authorization: bearer_auth
|
|
1942
1803
|
accessToken: "YOUR BEARER TOKEN",
|
|
1943
1804
|
});
|
|
@@ -1948,10 +1809,10 @@ async function example() {
|
|
|
1948
1809
|
pasteId: pasteId_example,
|
|
1949
1810
|
// PasteInput
|
|
1950
1811
|
pasteInput: ...,
|
|
1951
|
-
} satisfies
|
|
1812
|
+
} satisfies UpdatePasteRequest;
|
|
1952
1813
|
|
|
1953
1814
|
try {
|
|
1954
|
-
const data = await api.
|
|
1815
|
+
const data = await api.updatePaste(body);
|
|
1955
1816
|
console.log(data);
|
|
1956
1817
|
} catch (error) {
|
|
1957
1818
|
console.error(error);
|
|
@@ -1972,34 +1833,32 @@ example().catch(console.error);
|
|
|
1972
1833
|
|
|
1973
1834
|
### Return type
|
|
1974
1835
|
|
|
1975
|
-
|
|
1836
|
+
**boolean**
|
|
1976
1837
|
|
|
1977
1838
|
### Authorization
|
|
1978
1839
|
|
|
1979
|
-
[
|
|
1840
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
1980
1841
|
|
|
1981
1842
|
### HTTP request headers
|
|
1982
1843
|
|
|
1983
1844
|
- **Content-Type**: `application/json`
|
|
1984
|
-
- **Accept**: `application/json`
|
|
1845
|
+
- **Accept**: `text/plain`, `application/json`
|
|
1985
1846
|
|
|
1986
1847
|
|
|
1987
1848
|
### HTTP response details
|
|
1988
1849
|
| Status code | Description | Response headers |
|
|
1989
1850
|
|-------------|-------------|------------------|
|
|
1990
|
-
| **200** |
|
|
1991
|
-
| **404** |
|
|
1992
|
-
| **429** | Too many requests | - |
|
|
1993
|
-
| **422** | Validation Error | - |
|
|
1851
|
+
| **200** | Paste updated | - |
|
|
1852
|
+
| **404** | Not found | - |
|
|
1994
1853
|
|
|
1995
1854
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1996
1855
|
|
|
1997
1856
|
|
|
1998
|
-
##
|
|
1857
|
+
## uploadNewRelease
|
|
1999
1858
|
|
|
2000
|
-
>
|
|
1859
|
+
> uploadNewRelease()
|
|
2001
1860
|
|
|
2002
|
-
|
|
1861
|
+
POST /internal/releases/ - Upload a new release.
|
|
2003
1862
|
|
|
2004
1863
|
### Example
|
|
2005
1864
|
|
|
@@ -2008,27 +1867,18 @@ import {
|
|
|
2008
1867
|
Configuration,
|
|
2009
1868
|
InternalApi,
|
|
2010
1869
|
} from '@orangefox-recovery/foxinternalclient';
|
|
2011
|
-
import type {
|
|
1870
|
+
import type { UploadNewReleaseRequest } from '@orangefox-recovery/foxinternalclient';
|
|
2012
1871
|
|
|
2013
1872
|
async function example() {
|
|
2014
1873
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
2015
1874
|
const config = new Configuration({
|
|
2016
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
2017
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
2018
1875
|
// Configure HTTP bearer authorization: bearer_auth
|
|
2019
1876
|
accessToken: "YOUR BEARER TOKEN",
|
|
2020
1877
|
});
|
|
2021
1878
|
const api = new InternalApi(config);
|
|
2022
1879
|
|
|
2023
|
-
const body = {
|
|
2024
|
-
// string
|
|
2025
|
-
userId: userId_example,
|
|
2026
|
-
// UserUpdateBody
|
|
2027
|
-
userUpdateBody: ...,
|
|
2028
|
-
} satisfies UpdateUserInternalUsersUserIdPutRequest;
|
|
2029
|
-
|
|
2030
1880
|
try {
|
|
2031
|
-
const data = await api.
|
|
1881
|
+
const data = await api.uploadNewRelease();
|
|
2032
1882
|
console.log(data);
|
|
2033
1883
|
} catch (error) {
|
|
2034
1884
|
console.error(error);
|
|
@@ -2041,31 +1891,28 @@ example().catch(console.error);
|
|
|
2041
1891
|
|
|
2042
1892
|
### Parameters
|
|
2043
1893
|
|
|
2044
|
-
|
|
2045
|
-
| Name | Type | Description | Notes |
|
|
2046
|
-
|------------- | ------------- | ------------- | -------------|
|
|
2047
|
-
| **userId** | `string` | | [Defaults to `undefined`] |
|
|
2048
|
-
| **userUpdateBody** | [UserUpdateBody](UserUpdateBody.md) | | |
|
|
1894
|
+
This endpoint does not need any parameter.
|
|
2049
1895
|
|
|
2050
1896
|
### Return type
|
|
2051
1897
|
|
|
2052
|
-
|
|
1898
|
+
`void` (Empty response body)
|
|
2053
1899
|
|
|
2054
1900
|
### Authorization
|
|
2055
1901
|
|
|
2056
|
-
[
|
|
1902
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
2057
1903
|
|
|
2058
1904
|
### HTTP request headers
|
|
2059
1905
|
|
|
2060
|
-
- **Content-Type**:
|
|
1906
|
+
- **Content-Type**: Not defined
|
|
2061
1907
|
- **Accept**: `application/json`
|
|
2062
1908
|
|
|
2063
1909
|
|
|
2064
1910
|
### HTTP response details
|
|
2065
1911
|
| Status code | Description | Response headers |
|
|
2066
1912
|
|-------------|-------------|------------------|
|
|
2067
|
-
| **
|
|
2068
|
-
| **
|
|
1913
|
+
| **201** | Release created | - |
|
|
1914
|
+
| **400** | Bad request | - |
|
|
1915
|
+
| **409** | Conflict | - |
|
|
2069
1916
|
|
|
2070
1917
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2071
1918
|
|