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