@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/FoxFactoryApi.md
CHANGED
|
@@ -4,26 +4,24 @@ 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
|
-
| [**
|
|
7
|
+
| [**cancelTask**](FoxFactoryApi.md#canceltask) | **POST** /factory/{task_id}/cancel | POST /internal/factory/{task_id}/cancel – Cancel a running build task. |
|
|
8
|
+
| [**createTask**](FoxFactoryApi.md#createtask) | **POST** /factory | POST /internal/factory – Create a new build task. |
|
|
9
|
+
| [**deleteTask**](FoxFactoryApi.md#deletetask) | **DELETE** /factory/{task_id} | DELETE /internal/factory/{task_id} – Delete a build task and its artifact. |
|
|
10
|
+
| [**downloadArtifact**](FoxFactoryApi.md#downloadartifact) | **GET** /factory/{task_id}/artifact | GET /internal/factory/{task_id}/artifact – Download a build artifact. |
|
|
11
|
+
| [**getFactoryStatus**](FoxFactoryApi.md#getfactorystatus) | **GET** /factory/status | GET /internal/factory/status – Get the current FoxFactory worker status. |
|
|
12
|
+
| [**getTask**](FoxFactoryApi.md#gettask) | **GET** /factory/{task_id} | GET /internal/factory/{task_id} – Get a single build task. |
|
|
13
|
+
| [**listTasks**](FoxFactoryApi.md#listtasks) | **GET** /factory | GET /internal/factory – List build tasks. |
|
|
14
|
+
| [**updateTask**](FoxFactoryApi.md#updatetask) | **PATCH** /factory/{task_id} | PATCH /internal/factory/{task_id} – Update task status / logs. |
|
|
15
|
+
| [**updateWorkerStatus**](FoxFactoryApi.md#updateworkerstatus) | **POST** /factory/update_status | POST /internal/factory/update_status – Worker heartbeat / status update. |
|
|
16
|
+
| [**uploadArtifact**](FoxFactoryApi.md#uploadartifact) | **POST** /factory/{task_id}/artifact | POST /internal/factory/{task_id}/artifact – Upload a build artifact. |
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## cancelTask
|
|
21
21
|
|
|
22
|
-
> BuildTaskResponse
|
|
22
|
+
> BuildTaskResponse cancelTask(taskId)
|
|
23
23
|
|
|
24
|
-
Cancel
|
|
25
|
-
|
|
26
|
-
Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
24
|
+
POST /internal/factory/{task_id}/cancel – Cancel a running build task.
|
|
27
25
|
|
|
28
26
|
### Example
|
|
29
27
|
|
|
@@ -32,25 +30,23 @@ import {
|
|
|
32
30
|
Configuration,
|
|
33
31
|
FoxFactoryApi,
|
|
34
32
|
} from '@orangefox-recovery/foxinternalclient';
|
|
35
|
-
import type {
|
|
33
|
+
import type { CancelTaskRequest } from '@orangefox-recovery/foxinternalclient';
|
|
36
34
|
|
|
37
35
|
async function example() {
|
|
38
36
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
39
37
|
const config = new Configuration({
|
|
40
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
41
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
42
38
|
// Configure HTTP bearer authorization: bearer_auth
|
|
43
39
|
accessToken: "YOUR BEARER TOKEN",
|
|
44
40
|
});
|
|
45
41
|
const api = new FoxFactoryApi(config);
|
|
46
42
|
|
|
47
43
|
const body = {
|
|
48
|
-
// string
|
|
44
|
+
// string | Build task ID
|
|
49
45
|
taskId: taskId_example,
|
|
50
|
-
} satisfies
|
|
46
|
+
} satisfies CancelTaskRequest;
|
|
51
47
|
|
|
52
48
|
try {
|
|
53
|
-
const data = await api.
|
|
49
|
+
const data = await api.cancelTask(body);
|
|
54
50
|
console.log(data);
|
|
55
51
|
} catch (error) {
|
|
56
52
|
console.error(error);
|
|
@@ -66,7 +62,7 @@ example().catch(console.error);
|
|
|
66
62
|
|
|
67
63
|
| Name | Type | Description | Notes |
|
|
68
64
|
|------------- | ------------- | ------------- | -------------|
|
|
69
|
-
| **taskId** | `string` |
|
|
65
|
+
| **taskId** | `string` | Build task ID | [Defaults to `undefined`] |
|
|
70
66
|
|
|
71
67
|
### Return type
|
|
72
68
|
|
|
@@ -74,7 +70,7 @@ example().catch(console.error);
|
|
|
74
70
|
|
|
75
71
|
### Authorization
|
|
76
72
|
|
|
77
|
-
[
|
|
73
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
78
74
|
|
|
79
75
|
### HTTP request headers
|
|
80
76
|
|
|
@@ -85,19 +81,17 @@ example().catch(console.error);
|
|
|
85
81
|
### HTTP response details
|
|
86
82
|
| Status code | Description | Response headers |
|
|
87
83
|
|-------------|-------------|------------------|
|
|
88
|
-
| **200** |
|
|
89
|
-
| **
|
|
84
|
+
| **200** | Task cancelled | - |
|
|
85
|
+
| **404** | Not found | - |
|
|
90
86
|
|
|
91
87
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
92
88
|
|
|
93
89
|
|
|
94
|
-
##
|
|
95
|
-
|
|
96
|
-
> boolean deleteTaskFactoryTaskIdDelete(taskId)
|
|
90
|
+
## createTask
|
|
97
91
|
|
|
98
|
-
|
|
92
|
+
> createTask(newBuildTaskBody)
|
|
99
93
|
|
|
100
|
-
|
|
94
|
+
POST /internal/factory – Create a new build task.
|
|
101
95
|
|
|
102
96
|
### Example
|
|
103
97
|
|
|
@@ -106,25 +100,23 @@ import {
|
|
|
106
100
|
Configuration,
|
|
107
101
|
FoxFactoryApi,
|
|
108
102
|
} from '@orangefox-recovery/foxinternalclient';
|
|
109
|
-
import type {
|
|
103
|
+
import type { CreateTaskRequest } from '@orangefox-recovery/foxinternalclient';
|
|
110
104
|
|
|
111
105
|
async function example() {
|
|
112
106
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
113
107
|
const config = new Configuration({
|
|
114
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
115
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
116
108
|
// Configure HTTP bearer authorization: bearer_auth
|
|
117
109
|
accessToken: "YOUR BEARER TOKEN",
|
|
118
110
|
});
|
|
119
111
|
const api = new FoxFactoryApi(config);
|
|
120
112
|
|
|
121
113
|
const body = {
|
|
122
|
-
//
|
|
123
|
-
|
|
124
|
-
} satisfies
|
|
114
|
+
// NewBuildTaskBody
|
|
115
|
+
newBuildTaskBody: ...,
|
|
116
|
+
} satisfies CreateTaskRequest;
|
|
125
117
|
|
|
126
118
|
try {
|
|
127
|
-
const data = await api.
|
|
119
|
+
const data = await api.createTask(body);
|
|
128
120
|
console.log(data);
|
|
129
121
|
} catch (error) {
|
|
130
122
|
console.error(error);
|
|
@@ -140,38 +132,36 @@ example().catch(console.error);
|
|
|
140
132
|
|
|
141
133
|
| Name | Type | Description | Notes |
|
|
142
134
|
|------------- | ------------- | ------------- | -------------|
|
|
143
|
-
| **
|
|
135
|
+
| **newBuildTaskBody** | [NewBuildTaskBody](NewBuildTaskBody.md) | | |
|
|
144
136
|
|
|
145
137
|
### Return type
|
|
146
138
|
|
|
147
|
-
|
|
139
|
+
`void` (Empty response body)
|
|
148
140
|
|
|
149
141
|
### Authorization
|
|
150
142
|
|
|
151
|
-
[
|
|
143
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
152
144
|
|
|
153
145
|
### HTTP request headers
|
|
154
146
|
|
|
155
|
-
- **Content-Type**:
|
|
147
|
+
- **Content-Type**: `application/json`
|
|
156
148
|
- **Accept**: `application/json`
|
|
157
149
|
|
|
158
150
|
|
|
159
151
|
### HTTP response details
|
|
160
152
|
| Status code | Description | Response headers |
|
|
161
153
|
|-------------|-------------|------------------|
|
|
162
|
-
| **
|
|
163
|
-
| **
|
|
154
|
+
| **201** | Build task created | - |
|
|
155
|
+
| **400** | Bad request | - |
|
|
164
156
|
|
|
165
157
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
166
158
|
|
|
167
159
|
|
|
168
|
-
##
|
|
169
|
-
|
|
170
|
-
> any downloadArtifactFactoryTaskIdArtifactGet(taskId)
|
|
160
|
+
## deleteTask
|
|
171
161
|
|
|
172
|
-
|
|
162
|
+
> boolean deleteTask(taskId)
|
|
173
163
|
|
|
174
|
-
|
|
164
|
+
DELETE /internal/factory/{task_id} – Delete a build task and its artifact.
|
|
175
165
|
|
|
176
166
|
### Example
|
|
177
167
|
|
|
@@ -180,25 +170,23 @@ import {
|
|
|
180
170
|
Configuration,
|
|
181
171
|
FoxFactoryApi,
|
|
182
172
|
} from '@orangefox-recovery/foxinternalclient';
|
|
183
|
-
import type {
|
|
173
|
+
import type { DeleteTaskRequest } from '@orangefox-recovery/foxinternalclient';
|
|
184
174
|
|
|
185
175
|
async function example() {
|
|
186
176
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
187
177
|
const config = new Configuration({
|
|
188
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
189
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
190
178
|
// Configure HTTP bearer authorization: bearer_auth
|
|
191
179
|
accessToken: "YOUR BEARER TOKEN",
|
|
192
180
|
});
|
|
193
181
|
const api = new FoxFactoryApi(config);
|
|
194
182
|
|
|
195
183
|
const body = {
|
|
196
|
-
// string
|
|
184
|
+
// string | Build task ID
|
|
197
185
|
taskId: taskId_example,
|
|
198
|
-
} satisfies
|
|
186
|
+
} satisfies DeleteTaskRequest;
|
|
199
187
|
|
|
200
188
|
try {
|
|
201
|
-
const data = await api.
|
|
189
|
+
const data = await api.deleteTask(body);
|
|
202
190
|
console.log(data);
|
|
203
191
|
} catch (error) {
|
|
204
192
|
console.error(error);
|
|
@@ -214,38 +202,36 @@ example().catch(console.error);
|
|
|
214
202
|
|
|
215
203
|
| Name | Type | Description | Notes |
|
|
216
204
|
|------------- | ------------- | ------------- | -------------|
|
|
217
|
-
| **taskId** | `string` |
|
|
205
|
+
| **taskId** | `string` | Build task ID | [Defaults to `undefined`] |
|
|
218
206
|
|
|
219
207
|
### Return type
|
|
220
208
|
|
|
221
|
-
**
|
|
209
|
+
**boolean**
|
|
222
210
|
|
|
223
211
|
### Authorization
|
|
224
212
|
|
|
225
|
-
[
|
|
213
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
226
214
|
|
|
227
215
|
### HTTP request headers
|
|
228
216
|
|
|
229
217
|
- **Content-Type**: Not defined
|
|
230
|
-
- **Accept**: `application/json`
|
|
218
|
+
- **Accept**: `text/plain`, `application/json`
|
|
231
219
|
|
|
232
220
|
|
|
233
221
|
### HTTP response details
|
|
234
222
|
| Status code | Description | Response headers |
|
|
235
223
|
|-------------|-------------|------------------|
|
|
236
|
-
| **200** |
|
|
237
|
-
| **
|
|
224
|
+
| **200** | Task deleted | - |
|
|
225
|
+
| **404** | Not found | - |
|
|
238
226
|
|
|
239
227
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
240
228
|
|
|
241
229
|
|
|
242
|
-
##
|
|
230
|
+
## downloadArtifact
|
|
243
231
|
|
|
244
|
-
>
|
|
232
|
+
> downloadArtifact(taskId)
|
|
245
233
|
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
Endpoint for clients to get the current status of the worker. If the last update was longer than the defined timeout, worker is considered offline.
|
|
234
|
+
GET /internal/factory/{task_id}/artifact – Download a build artifact.
|
|
249
235
|
|
|
250
236
|
### Example
|
|
251
237
|
|
|
@@ -254,20 +240,23 @@ import {
|
|
|
254
240
|
Configuration,
|
|
255
241
|
FoxFactoryApi,
|
|
256
242
|
} from '@orangefox-recovery/foxinternalclient';
|
|
257
|
-
import type {
|
|
243
|
+
import type { DownloadArtifactRequest } from '@orangefox-recovery/foxinternalclient';
|
|
258
244
|
|
|
259
245
|
async function example() {
|
|
260
246
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
261
247
|
const config = new Configuration({
|
|
262
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
263
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
264
248
|
// Configure HTTP bearer authorization: bearer_auth
|
|
265
249
|
accessToken: "YOUR BEARER TOKEN",
|
|
266
250
|
});
|
|
267
251
|
const api = new FoxFactoryApi(config);
|
|
268
252
|
|
|
253
|
+
const body = {
|
|
254
|
+
// string | Build task ID
|
|
255
|
+
taskId: taskId_example,
|
|
256
|
+
} satisfies DownloadArtifactRequest;
|
|
257
|
+
|
|
269
258
|
try {
|
|
270
|
-
const data = await api.
|
|
259
|
+
const data = await api.downloadArtifact(body);
|
|
271
260
|
console.log(data);
|
|
272
261
|
} catch (error) {
|
|
273
262
|
console.error(error);
|
|
@@ -280,15 +269,18 @@ example().catch(console.error);
|
|
|
280
269
|
|
|
281
270
|
### Parameters
|
|
282
271
|
|
|
283
|
-
|
|
272
|
+
|
|
273
|
+
| Name | Type | Description | Notes |
|
|
274
|
+
|------------- | ------------- | ------------- | -------------|
|
|
275
|
+
| **taskId** | `string` | Build task ID | [Defaults to `undefined`] |
|
|
284
276
|
|
|
285
277
|
### Return type
|
|
286
278
|
|
|
287
|
-
|
|
279
|
+
`void` (Empty response body)
|
|
288
280
|
|
|
289
281
|
### Authorization
|
|
290
282
|
|
|
291
|
-
[
|
|
283
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
292
284
|
|
|
293
285
|
### HTTP request headers
|
|
294
286
|
|
|
@@ -299,18 +291,17 @@ This endpoint does not need any parameter.
|
|
|
299
291
|
### HTTP response details
|
|
300
292
|
| Status code | Description | Response headers |
|
|
301
293
|
|-------------|-------------|------------------|
|
|
302
|
-
| **200** |
|
|
294
|
+
| **200** | Artifact file | - |
|
|
295
|
+
| **404** | Not found | - |
|
|
303
296
|
|
|
304
297
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
305
298
|
|
|
306
299
|
|
|
307
|
-
##
|
|
300
|
+
## getFactoryStatus
|
|
308
301
|
|
|
309
|
-
>
|
|
302
|
+
> FFStatusResponse getFactoryStatus()
|
|
310
303
|
|
|
311
|
-
Get
|
|
312
|
-
|
|
313
|
-
Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
|
|
304
|
+
GET /internal/factory/status – Get the current FoxFactory worker status.
|
|
314
305
|
|
|
315
306
|
### Example
|
|
316
307
|
|
|
@@ -319,25 +310,14 @@ import {
|
|
|
319
310
|
Configuration,
|
|
320
311
|
FoxFactoryApi,
|
|
321
312
|
} from '@orangefox-recovery/foxinternalclient';
|
|
322
|
-
import type {
|
|
313
|
+
import type { GetFactoryStatusRequest } from '@orangefox-recovery/foxinternalclient';
|
|
323
314
|
|
|
324
315
|
async function example() {
|
|
325
316
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
326
|
-
const
|
|
327
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
328
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
329
|
-
// Configure HTTP bearer authorization: bearer_auth
|
|
330
|
-
accessToken: "YOUR BEARER TOKEN",
|
|
331
|
-
});
|
|
332
|
-
const api = new FoxFactoryApi(config);
|
|
333
|
-
|
|
334
|
-
const body = {
|
|
335
|
-
// string
|
|
336
|
-
taskId: taskId_example,
|
|
337
|
-
} satisfies GetTaskFactoryTaskIdGetRequest;
|
|
317
|
+
const api = new FoxFactoryApi();
|
|
338
318
|
|
|
339
319
|
try {
|
|
340
|
-
const data = await api.
|
|
320
|
+
const data = await api.getFactoryStatus();
|
|
341
321
|
console.log(data);
|
|
342
322
|
} catch (error) {
|
|
343
323
|
console.error(error);
|
|
@@ -350,18 +330,15 @@ example().catch(console.error);
|
|
|
350
330
|
|
|
351
331
|
### Parameters
|
|
352
332
|
|
|
353
|
-
|
|
354
|
-
| Name | Type | Description | Notes |
|
|
355
|
-
|------------- | ------------- | ------------- | -------------|
|
|
356
|
-
| **taskId** | `string` | | [Defaults to `undefined`] |
|
|
333
|
+
This endpoint does not need any parameter.
|
|
357
334
|
|
|
358
335
|
### Return type
|
|
359
336
|
|
|
360
|
-
[**
|
|
337
|
+
[**FFStatusResponse**](FFStatusResponse.md)
|
|
361
338
|
|
|
362
339
|
### Authorization
|
|
363
340
|
|
|
364
|
-
|
|
341
|
+
No authorization required
|
|
365
342
|
|
|
366
343
|
### HTTP request headers
|
|
367
344
|
|
|
@@ -372,19 +349,16 @@ example().catch(console.error);
|
|
|
372
349
|
### HTTP response details
|
|
373
350
|
| Status code | Description | Response headers |
|
|
374
351
|
|-------------|-------------|------------------|
|
|
375
|
-
| **200** |
|
|
376
|
-
| **422** | Validation Error | - |
|
|
352
|
+
| **200** | Factory worker status | - |
|
|
377
353
|
|
|
378
354
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
379
355
|
|
|
380
356
|
|
|
381
|
-
##
|
|
357
|
+
## getTask
|
|
382
358
|
|
|
383
|
-
>
|
|
359
|
+
> BuildTaskResponse getTask(taskId)
|
|
384
360
|
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
|
|
361
|
+
GET /internal/factory/{task_id} – Get a single build task.
|
|
388
362
|
|
|
389
363
|
### Example
|
|
390
364
|
|
|
@@ -393,25 +367,23 @@ import {
|
|
|
393
367
|
Configuration,
|
|
394
368
|
FoxFactoryApi,
|
|
395
369
|
} from '@orangefox-recovery/foxinternalclient';
|
|
396
|
-
import type {
|
|
370
|
+
import type { GetTaskRequest } from '@orangefox-recovery/foxinternalclient';
|
|
397
371
|
|
|
398
372
|
async function example() {
|
|
399
373
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
400
374
|
const config = new Configuration({
|
|
401
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
402
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
403
375
|
// Configure HTTP bearer authorization: bearer_auth
|
|
404
376
|
accessToken: "YOUR BEARER TOKEN",
|
|
405
377
|
});
|
|
406
378
|
const api = new FoxFactoryApi(config);
|
|
407
379
|
|
|
408
380
|
const body = {
|
|
409
|
-
// string
|
|
410
|
-
|
|
411
|
-
} satisfies
|
|
381
|
+
// string | Build task ID
|
|
382
|
+
taskId: taskId_example,
|
|
383
|
+
} satisfies GetTaskRequest;
|
|
412
384
|
|
|
413
385
|
try {
|
|
414
|
-
const data = await api.
|
|
386
|
+
const data = await api.getTask(body);
|
|
415
387
|
console.log(data);
|
|
416
388
|
} catch (error) {
|
|
417
389
|
console.error(error);
|
|
@@ -427,15 +399,15 @@ example().catch(console.error);
|
|
|
427
399
|
|
|
428
400
|
| Name | Type | Description | Notes |
|
|
429
401
|
|------------- | ------------- | ------------- | -------------|
|
|
430
|
-
| **
|
|
402
|
+
| **taskId** | `string` | Build task ID | [Defaults to `undefined`] |
|
|
431
403
|
|
|
432
404
|
### Return type
|
|
433
405
|
|
|
434
|
-
[**
|
|
406
|
+
[**BuildTaskResponse**](BuildTaskResponse.md)
|
|
435
407
|
|
|
436
408
|
### Authorization
|
|
437
409
|
|
|
438
|
-
[
|
|
410
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
439
411
|
|
|
440
412
|
### HTTP request headers
|
|
441
413
|
|
|
@@ -446,19 +418,17 @@ example().catch(console.error);
|
|
|
446
418
|
### HTTP response details
|
|
447
419
|
| Status code | Description | Response headers |
|
|
448
420
|
|-------------|-------------|------------------|
|
|
449
|
-
| **200** |
|
|
450
|
-
| **
|
|
421
|
+
| **200** | Build task details | - |
|
|
422
|
+
| **404** | Not found | - |
|
|
451
423
|
|
|
452
424
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
453
425
|
|
|
454
426
|
|
|
455
|
-
##
|
|
456
|
-
|
|
457
|
-
> boolean newTaskFactoryPost(newBuildTaskBody)
|
|
427
|
+
## listTasks
|
|
458
428
|
|
|
459
|
-
|
|
429
|
+
> ListResponseBuildTaskShortResponse listTasks(deviceId)
|
|
460
430
|
|
|
461
|
-
|
|
431
|
+
GET /internal/factory – List build tasks.
|
|
462
432
|
|
|
463
433
|
### Example
|
|
464
434
|
|
|
@@ -467,25 +437,23 @@ import {
|
|
|
467
437
|
Configuration,
|
|
468
438
|
FoxFactoryApi,
|
|
469
439
|
} from '@orangefox-recovery/foxinternalclient';
|
|
470
|
-
import type {
|
|
440
|
+
import type { ListTasksRequest } from '@orangefox-recovery/foxinternalclient';
|
|
471
441
|
|
|
472
442
|
async function example() {
|
|
473
443
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
474
444
|
const config = new Configuration({
|
|
475
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
476
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
477
445
|
// Configure HTTP bearer authorization: bearer_auth
|
|
478
446
|
accessToken: "YOUR BEARER TOKEN",
|
|
479
447
|
});
|
|
480
448
|
const api = new FoxFactoryApi(config);
|
|
481
449
|
|
|
482
450
|
const body = {
|
|
483
|
-
//
|
|
484
|
-
|
|
485
|
-
} satisfies
|
|
451
|
+
// string (optional)
|
|
452
|
+
deviceId: deviceId_example,
|
|
453
|
+
} satisfies ListTasksRequest;
|
|
486
454
|
|
|
487
455
|
try {
|
|
488
|
-
const data = await api.
|
|
456
|
+
const data = await api.listTasks(body);
|
|
489
457
|
console.log(data);
|
|
490
458
|
} catch (error) {
|
|
491
459
|
console.error(error);
|
|
@@ -501,38 +469,35 @@ example().catch(console.error);
|
|
|
501
469
|
|
|
502
470
|
| Name | Type | Description | Notes |
|
|
503
471
|
|------------- | ------------- | ------------- | -------------|
|
|
504
|
-
| **
|
|
472
|
+
| **deviceId** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
505
473
|
|
|
506
474
|
### Return type
|
|
507
475
|
|
|
508
|
-
**
|
|
476
|
+
[**ListResponseBuildTaskShortResponse**](ListResponseBuildTaskShortResponse.md)
|
|
509
477
|
|
|
510
478
|
### Authorization
|
|
511
479
|
|
|
512
|
-
[
|
|
480
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
513
481
|
|
|
514
482
|
### HTTP request headers
|
|
515
483
|
|
|
516
|
-
- **Content-Type**:
|
|
484
|
+
- **Content-Type**: Not defined
|
|
517
485
|
- **Accept**: `application/json`
|
|
518
486
|
|
|
519
487
|
|
|
520
488
|
### HTTP response details
|
|
521
489
|
| Status code | Description | Response headers |
|
|
522
490
|
|-------------|-------------|------------------|
|
|
523
|
-
| **200** |
|
|
524
|
-
| **422** | Validation Error | - |
|
|
491
|
+
| **200** | List of build tasks | - |
|
|
525
492
|
|
|
526
493
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
527
494
|
|
|
528
495
|
|
|
529
|
-
##
|
|
530
|
-
|
|
531
|
-
> boolean updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody)
|
|
496
|
+
## updateTask
|
|
532
497
|
|
|
533
|
-
|
|
498
|
+
> boolean updateTask(taskId, taskUpdateBody)
|
|
534
499
|
|
|
535
|
-
|
|
500
|
+
PATCH /internal/factory/{task_id} – Update task status / logs.
|
|
536
501
|
|
|
537
502
|
### Example
|
|
538
503
|
|
|
@@ -541,27 +506,25 @@ import {
|
|
|
541
506
|
Configuration,
|
|
542
507
|
FoxFactoryApi,
|
|
543
508
|
} from '@orangefox-recovery/foxinternalclient';
|
|
544
|
-
import type {
|
|
509
|
+
import type { UpdateTaskRequest } from '@orangefox-recovery/foxinternalclient';
|
|
545
510
|
|
|
546
511
|
async function example() {
|
|
547
512
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
548
513
|
const config = new Configuration({
|
|
549
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
550
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
551
514
|
// Configure HTTP bearer authorization: bearer_auth
|
|
552
515
|
accessToken: "YOUR BEARER TOKEN",
|
|
553
516
|
});
|
|
554
517
|
const api = new FoxFactoryApi(config);
|
|
555
518
|
|
|
556
519
|
const body = {
|
|
557
|
-
// string
|
|
520
|
+
// string | Build task ID
|
|
558
521
|
taskId: taskId_example,
|
|
559
522
|
// TaskUpdateBody
|
|
560
523
|
taskUpdateBody: ...,
|
|
561
|
-
} satisfies
|
|
524
|
+
} satisfies UpdateTaskRequest;
|
|
562
525
|
|
|
563
526
|
try {
|
|
564
|
-
const data = await api.
|
|
527
|
+
const data = await api.updateTask(body);
|
|
565
528
|
console.log(data);
|
|
566
529
|
} catch (error) {
|
|
567
530
|
console.error(error);
|
|
@@ -577,7 +540,7 @@ example().catch(console.error);
|
|
|
577
540
|
|
|
578
541
|
| Name | Type | Description | Notes |
|
|
579
542
|
|------------- | ------------- | ------------- | -------------|
|
|
580
|
-
| **taskId** | `string` |
|
|
543
|
+
| **taskId** | `string` | Build task ID | [Defaults to `undefined`] |
|
|
581
544
|
| **taskUpdateBody** | [TaskUpdateBody](TaskUpdateBody.md) | | |
|
|
582
545
|
|
|
583
546
|
### Return type
|
|
@@ -586,30 +549,28 @@ example().catch(console.error);
|
|
|
586
549
|
|
|
587
550
|
### Authorization
|
|
588
551
|
|
|
589
|
-
[
|
|
552
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
590
553
|
|
|
591
554
|
### HTTP request headers
|
|
592
555
|
|
|
593
556
|
- **Content-Type**: `application/json`
|
|
594
|
-
- **Accept**: `application/json`
|
|
557
|
+
- **Accept**: `text/plain`, `application/json`
|
|
595
558
|
|
|
596
559
|
|
|
597
560
|
### HTTP response details
|
|
598
561
|
| Status code | Description | Response headers |
|
|
599
562
|
|-------------|-------------|------------------|
|
|
600
|
-
| **200** |
|
|
601
|
-
| **
|
|
563
|
+
| **200** | Task updated | - |
|
|
564
|
+
| **404** | Not found | - |
|
|
602
565
|
|
|
603
566
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
604
567
|
|
|
605
568
|
|
|
606
|
-
##
|
|
607
|
-
|
|
608
|
-
> any updateWorkerStatusFactoryUpdateStatusPost(body)
|
|
569
|
+
## updateWorkerStatus
|
|
609
570
|
|
|
610
|
-
|
|
571
|
+
> updateWorkerStatus(workerStatusBody)
|
|
611
572
|
|
|
612
|
-
|
|
573
|
+
POST /internal/factory/update_status – Worker heartbeat / status update.
|
|
613
574
|
|
|
614
575
|
### Example
|
|
615
576
|
|
|
@@ -618,25 +579,23 @@ import {
|
|
|
618
579
|
Configuration,
|
|
619
580
|
FoxFactoryApi,
|
|
620
581
|
} from '@orangefox-recovery/foxinternalclient';
|
|
621
|
-
import type {
|
|
582
|
+
import type { UpdateWorkerStatusRequest } from '@orangefox-recovery/foxinternalclient';
|
|
622
583
|
|
|
623
584
|
async function example() {
|
|
624
585
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
625
586
|
const config = new Configuration({
|
|
626
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
627
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
628
587
|
// Configure HTTP bearer authorization: bearer_auth
|
|
629
588
|
accessToken: "YOUR BEARER TOKEN",
|
|
630
589
|
});
|
|
631
590
|
const api = new FoxFactoryApi(config);
|
|
632
591
|
|
|
633
592
|
const body = {
|
|
634
|
-
//
|
|
635
|
-
|
|
636
|
-
} satisfies
|
|
593
|
+
// WorkerStatusBody
|
|
594
|
+
workerStatusBody: ...,
|
|
595
|
+
} satisfies UpdateWorkerStatusRequest;
|
|
637
596
|
|
|
638
597
|
try {
|
|
639
|
-
const data = await api.
|
|
598
|
+
const data = await api.updateWorkerStatus(body);
|
|
640
599
|
console.log(data);
|
|
641
600
|
} catch (error) {
|
|
642
601
|
console.error(error);
|
|
@@ -652,15 +611,15 @@ example().catch(console.error);
|
|
|
652
611
|
|
|
653
612
|
| Name | Type | Description | Notes |
|
|
654
613
|
|------------- | ------------- | ------------- | -------------|
|
|
655
|
-
| **
|
|
614
|
+
| **workerStatusBody** | [WorkerStatusBody](WorkerStatusBody.md) | | |
|
|
656
615
|
|
|
657
616
|
### Return type
|
|
658
617
|
|
|
659
|
-
|
|
618
|
+
`void` (Empty response body)
|
|
660
619
|
|
|
661
620
|
### Authorization
|
|
662
621
|
|
|
663
|
-
[
|
|
622
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
664
623
|
|
|
665
624
|
### HTTP request headers
|
|
666
625
|
|
|
@@ -671,19 +630,17 @@ example().catch(console.error);
|
|
|
671
630
|
### HTTP response details
|
|
672
631
|
| Status code | Description | Response headers |
|
|
673
632
|
|-------------|-------------|------------------|
|
|
674
|
-
| **200** |
|
|
675
|
-
| **
|
|
633
|
+
| **200** | Status updated | - |
|
|
634
|
+
| **400** | Bad request | - |
|
|
676
635
|
|
|
677
636
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
678
637
|
|
|
679
638
|
|
|
680
|
-
##
|
|
639
|
+
## uploadArtifact
|
|
681
640
|
|
|
682
|
-
> boolean
|
|
641
|
+
> boolean uploadArtifact(taskId)
|
|
683
642
|
|
|
684
|
-
Upload
|
|
685
|
-
|
|
686
|
-
Upload an artifact zip file for a specific build task. This endpoint allows foxfactory workers to upload an artifact zip file, verifies its MD5 hash, and stores it in the appropriate directory. Parameters: task_id: The ID of the build task artifact: The artifact zip file to upload md5_hash: The expected MD5 hash of the artifact file
|
|
643
|
+
POST /internal/factory/{task_id}/artifact – Upload a build artifact.
|
|
687
644
|
|
|
688
645
|
### Example
|
|
689
646
|
|
|
@@ -692,29 +649,23 @@ import {
|
|
|
692
649
|
Configuration,
|
|
693
650
|
FoxFactoryApi,
|
|
694
651
|
} from '@orangefox-recovery/foxinternalclient';
|
|
695
|
-
import type {
|
|
652
|
+
import type { UploadArtifactRequest } from '@orangefox-recovery/foxinternalclient';
|
|
696
653
|
|
|
697
654
|
async function example() {
|
|
698
655
|
console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
|
|
699
656
|
const config = new Configuration({
|
|
700
|
-
// To configure OAuth2 access token for authorization: oauth2_password password
|
|
701
|
-
accessToken: "YOUR ACCESS TOKEN",
|
|
702
657
|
// Configure HTTP bearer authorization: bearer_auth
|
|
703
658
|
accessToken: "YOUR BEARER TOKEN",
|
|
704
659
|
});
|
|
705
660
|
const api = new FoxFactoryApi(config);
|
|
706
661
|
|
|
707
662
|
const body = {
|
|
708
|
-
// string
|
|
663
|
+
// string | Build task ID
|
|
709
664
|
taskId: taskId_example,
|
|
710
|
-
|
|
711
|
-
artifact: BINARY_DATA_HERE,
|
|
712
|
-
// string
|
|
713
|
-
md5Hash: md5Hash_example,
|
|
714
|
-
} satisfies UploadArtifactFactoryTaskIdArtifactPostRequest;
|
|
665
|
+
} satisfies UploadArtifactRequest;
|
|
715
666
|
|
|
716
667
|
try {
|
|
717
|
-
const data = await api.
|
|
668
|
+
const data = await api.uploadArtifact(body);
|
|
718
669
|
console.log(data);
|
|
719
670
|
} catch (error) {
|
|
720
671
|
console.error(error);
|
|
@@ -730,9 +681,7 @@ example().catch(console.error);
|
|
|
730
681
|
|
|
731
682
|
| Name | Type | Description | Notes |
|
|
732
683
|
|------------- | ------------- | ------------- | -------------|
|
|
733
|
-
| **taskId** | `string` |
|
|
734
|
-
| **artifact** | `Blob` | | [Defaults to `undefined`] |
|
|
735
|
-
| **md5Hash** | `string` | | [Defaults to `undefined`] |
|
|
684
|
+
| **taskId** | `string` | Build task ID | [Defaults to `undefined`] |
|
|
736
685
|
|
|
737
686
|
### Return type
|
|
738
687
|
|
|
@@ -740,19 +689,19 @@ example().catch(console.error);
|
|
|
740
689
|
|
|
741
690
|
### Authorization
|
|
742
691
|
|
|
743
|
-
[
|
|
692
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
744
693
|
|
|
745
694
|
### HTTP request headers
|
|
746
695
|
|
|
747
|
-
- **Content-Type**:
|
|
748
|
-
- **Accept**: `application/json`
|
|
696
|
+
- **Content-Type**: Not defined
|
|
697
|
+
- **Accept**: `text/plain`, `application/json`
|
|
749
698
|
|
|
750
699
|
|
|
751
700
|
### HTTP response details
|
|
752
701
|
| Status code | Description | Response headers |
|
|
753
702
|
|-------------|-------------|------------------|
|
|
754
|
-
| **200** |
|
|
755
|
-
| **
|
|
703
|
+
| **200** | Artifact uploaded | - |
|
|
704
|
+
| **404** | Not found | - |
|
|
756
705
|
|
|
757
706
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
758
707
|
|