@orangefox-recovery/foxclient 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 +20 -22
- package/.openapi-generator/VERSION +1 -1
- package/README.md +30 -38
- package/dist/apis/DeviceApi.d.ts +116 -77
- package/dist/apis/DeviceApi.js +85 -59
- 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/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/DeviceResponse.d.ts +33 -29
- package/dist/esm/models/DeviceResponse.js +34 -26
- package/dist/esm/models/ErrorResponse.d.ts +32 -0
- package/dist/esm/models/ErrorResponse.js +43 -0
- package/dist/esm/models/GlobalStatsResponse.d.ts +52 -0
- package/dist/esm/models/{GlobalStatsAggregationModel.js → GlobalStatsResponse.js} +14 -14
- 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/MaintainerShortResponse.d.ts +50 -0
- package/dist/esm/models/MaintainerShortResponse.js +55 -0
- package/dist/esm/models/NewReportRequest.d.ts +58 -0
- package/dist/esm/models/NewReportRequest.js +55 -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/ReleaseResponse.d.ts +46 -42
- package/dist/esm/models/ReleaseResponse.js +45 -44
- 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/TokenResponse.d.ts +38 -0
- package/dist/esm/models/TokenResponse.js +47 -0
- package/dist/esm/models/index.d.ts +9 -11
- package/dist/esm/models/index.js +9 -11
- package/dist/esm/runtime.d.ts +2 -2
- package/dist/esm/runtime.js +17 -2
- package/dist/models/DeviceResponse.d.ts +33 -29
- package/dist/models/DeviceResponse.js +34 -26
- package/dist/models/ErrorResponse.d.ts +32 -0
- package/dist/models/ErrorResponse.js +50 -0
- package/dist/models/GlobalStatsResponse.d.ts +52 -0
- package/dist/models/GlobalStatsResponse.js +62 -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/MaintainerShortResponse.d.ts +50 -0
- package/dist/models/MaintainerShortResponse.js +62 -0
- package/dist/models/NewReportRequest.d.ts +58 -0
- package/dist/models/NewReportRequest.js +62 -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/ReleaseResponse.d.ts +46 -42
- package/dist/models/ReleaseResponse.js +45 -44
- 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/TokenResponse.d.ts +38 -0
- package/dist/models/TokenResponse.js +54 -0
- package/dist/models/index.d.ts +9 -11
- package/dist/models/index.js +9 -11
- package/dist/runtime.d.ts +2 -2
- package/dist/runtime.js +17 -2
- package/docs/DeviceApi.md +83 -90
- package/docs/DeviceResponse.md +19 -17
- package/docs/{ReleasesSort.md → ErrorResponse.md} +6 -4
- package/docs/{GlobalStatsAggregationModel.md → GlobalStatsResponse.md} +6 -6
- 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/{MaintainerShortModel.md → MaintainerShortResponse.md} +9 -7
- package/docs/{ListResponseShortReleaseResponse.md → NewReportRequest.md} +14 -8
- 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/ReleaseResponse.md +28 -26
- 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/{ValidationErrorLocInner.md → TokenResponse.md} +8 -4
- package/package.json +3 -13
- package/src/apis/DeviceApi.ts +175 -116
- 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/DeviceResponse.ts +65 -55
- package/src/models/ErrorResponse.ts +66 -0
- package/src/models/GlobalStatsResponse.ts +93 -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/MaintainerShortResponse.ts +93 -0
- package/src/models/NewReportRequest.ts +100 -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/ReleaseResponse.ts +85 -86
- package/src/models/ShortDeviceResponse.ts +50 -40
- package/src/models/ShortReleaseResponse.ts +62 -64
- package/src/models/TokenResponse.ts +75 -0
- package/src/models/index.ts +9 -11
- package/src/runtime.ts +20 -2
- 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/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/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/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/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/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/HTTPValidationError.md +0 -34
- package/docs/ReleaseType.md +0 -32
- package/docs/ResponseGetReleases.md +0 -36
- package/docs/ValidationError.md +0 -38
- 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/ReleaseType.ts +0 -54
- package/src/models/ReleasesSort.ts +0 -53
- package/src/models/ResponseGetReleases.ts +0 -96
- package/src/models/ValidationError.ts +0 -92
- package/src/models/ValidationErrorLocInner.ts +0 -46
package/.openapi-generator/FILES
CHANGED
|
@@ -4,55 +4,53 @@
|
|
|
4
4
|
README.md
|
|
5
5
|
docs/DeviceApi.md
|
|
6
6
|
docs/DeviceResponse.md
|
|
7
|
-
docs/
|
|
8
|
-
docs/
|
|
7
|
+
docs/ErrorResponse.md
|
|
8
|
+
docs/GlobalStatsResponse.md
|
|
9
9
|
docs/ListResponseReleaseResponse.md
|
|
10
|
+
docs/ListResponseReleaseResponseDataInner.md
|
|
10
11
|
docs/ListResponseShortDeviceResponse.md
|
|
11
|
-
docs/
|
|
12
|
-
docs/
|
|
13
|
-
docs/
|
|
12
|
+
docs/ListResponseShortDeviceResponseDataInner.md
|
|
13
|
+
docs/ListResponseString.md
|
|
14
|
+
docs/MaintainerShortResponse.md
|
|
15
|
+
docs/NewReportRequest.md
|
|
14
16
|
docs/PasteApi.md
|
|
15
17
|
docs/PasteInput.md
|
|
16
|
-
docs/
|
|
18
|
+
docs/PasteResponse.md
|
|
17
19
|
docs/RecoveryImgResponse.md
|
|
18
20
|
docs/ReleaseApi.md
|
|
19
21
|
docs/ReleaseGroupsResponse.md
|
|
20
22
|
docs/ReleaseResponse.md
|
|
21
|
-
docs/
|
|
22
|
-
docs/ReleasesSort.md
|
|
23
|
-
docs/ResponseGetReleases.md
|
|
23
|
+
docs/ReportApi.md
|
|
24
24
|
docs/ShortDeviceResponse.md
|
|
25
25
|
docs/ShortReleaseResponse.md
|
|
26
26
|
docs/StatsApi.md
|
|
27
|
-
docs/
|
|
28
|
-
docs/ValidationErrorLocInner.md
|
|
27
|
+
docs/TokenResponse.md
|
|
29
28
|
package.json
|
|
30
29
|
src/apis/DeviceApi.ts
|
|
31
30
|
src/apis/PasteApi.ts
|
|
32
31
|
src/apis/ReleaseApi.ts
|
|
32
|
+
src/apis/ReportApi.ts
|
|
33
33
|
src/apis/StatsApi.ts
|
|
34
34
|
src/apis/index.ts
|
|
35
35
|
src/index.ts
|
|
36
36
|
src/models/DeviceResponse.ts
|
|
37
|
-
src/models/
|
|
38
|
-
src/models/
|
|
37
|
+
src/models/ErrorResponse.ts
|
|
38
|
+
src/models/GlobalStatsResponse.ts
|
|
39
39
|
src/models/ListResponseReleaseResponse.ts
|
|
40
|
+
src/models/ListResponseReleaseResponseDataInner.ts
|
|
40
41
|
src/models/ListResponseShortDeviceResponse.ts
|
|
41
|
-
src/models/
|
|
42
|
-
src/models/
|
|
43
|
-
src/models/
|
|
42
|
+
src/models/ListResponseShortDeviceResponseDataInner.ts
|
|
43
|
+
src/models/ListResponseString.ts
|
|
44
|
+
src/models/MaintainerShortResponse.ts
|
|
45
|
+
src/models/NewReportRequest.ts
|
|
44
46
|
src/models/PasteInput.ts
|
|
45
|
-
src/models/
|
|
47
|
+
src/models/PasteResponse.ts
|
|
46
48
|
src/models/RecoveryImgResponse.ts
|
|
47
49
|
src/models/ReleaseGroupsResponse.ts
|
|
48
50
|
src/models/ReleaseResponse.ts
|
|
49
|
-
src/models/ReleaseType.ts
|
|
50
|
-
src/models/ReleasesSort.ts
|
|
51
|
-
src/models/ResponseGetReleases.ts
|
|
52
51
|
src/models/ShortDeviceResponse.ts
|
|
53
52
|
src/models/ShortReleaseResponse.ts
|
|
54
|
-
src/models/
|
|
55
|
-
src/models/ValidationErrorLocInner.ts
|
|
53
|
+
src/models/TokenResponse.ts
|
|
56
54
|
src/models/index.ts
|
|
57
55
|
src/runtime.ts
|
|
58
56
|
tsconfig.esm.json
|
|
@@ -1 +1 @@
|
|
|
1
|
-
7.
|
|
1
|
+
7.21.0
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @orangefox-recovery/foxclient@
|
|
1
|
+
# @orangefox-recovery/foxclient@6.0.4
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the api.orangefox.download API.
|
|
4
4
|
|
|
@@ -27,10 +27,10 @@ async function example() {
|
|
|
27
27
|
const body = {
|
|
28
28
|
// string (optional)
|
|
29
29
|
deviceId: deviceId_example,
|
|
30
|
-
// string
|
|
31
|
-
id: id_example,
|
|
32
|
-
// string | Not recommended to use when you can (optional)
|
|
30
|
+
// string (optional)
|
|
33
31
|
codename: codename_example,
|
|
32
|
+
// string (optional)
|
|
33
|
+
id: id_example,
|
|
34
34
|
} satisfies GetDeviceRequest;
|
|
35
35
|
|
|
36
36
|
try {
|
|
@@ -54,41 +54,41 @@ All URIs are relative to *https://api.orangefox.download*
|
|
|
54
54
|
|
|
55
55
|
| Class | Method | HTTP request | Description
|
|
56
56
|
| ----- | ------ | ------------ | -------------
|
|
57
|
-
*DeviceApi* | [**getDevice**](docs/DeviceApi.md#getdevice) | **GET** /devices/get | Get
|
|
58
|
-
*DeviceApi* | [**
|
|
59
|
-
*DeviceApi* | [**
|
|
60
|
-
*DeviceApi* | [**
|
|
61
|
-
*PasteApi* | [**
|
|
62
|
-
*PasteApi* | [**
|
|
63
|
-
*ReleaseApi* | [**
|
|
64
|
-
*ReleaseApi* | [**
|
|
65
|
-
*ReleaseApi* | [**
|
|
66
|
-
*ReleaseApi* | [**
|
|
67
|
-
*
|
|
57
|
+
*DeviceApi* | [**getDevice**](docs/DeviceApi.md#getdevice) | **GET** /devices/get | GET /devices/get - Get a single device by device_id, codename, or _id.
|
|
58
|
+
*DeviceApi* | [**getDeviceById**](docs/DeviceApi.md#getdevicebyid) | **GET** /devices/{device_id} | GET /devices/{device_id} - Get device by ID (deprecated).
|
|
59
|
+
*DeviceApi* | [**getOems**](docs/DeviceApi.md#getoems) | **GET** /oems | GET /oems - Get a list of all unique OEM names.
|
|
60
|
+
*DeviceApi* | [**listDevices**](docs/DeviceApi.md#listdevices) | **GET** /devices | GET /devices/ - List devices with filters.
|
|
61
|
+
*PasteApi* | [**createPaste**](docs/PasteApi.md#createpaste) | **POST** /paste | POST /paste/ - Create a new paste.
|
|
62
|
+
*PasteApi* | [**getPaste**](docs/PasteApi.md#getpaste) | **GET** /paste/{paste_id} | GET /paste/{paste_id} - Get a paste by ID.
|
|
63
|
+
*ReleaseApi* | [**downloadRelease**](docs/ReleaseApi.md#downloadrelease) | **GET** /release/{release_id}/dl | GET /release/{release_id}/dl - Download a release binary.
|
|
64
|
+
*ReleaseApi* | [**getRelease**](docs/ReleaseApi.md#getrelease) | **GET** /releases/get | GET /releases/get - Get a single release.
|
|
65
|
+
*ReleaseApi* | [**getReleaseById**](docs/ReleaseApi.md#getreleasebyid) | **GET** /releases/{release_id} | GET /releases/{release_id} - Get release by ID (deprecated).
|
|
66
|
+
*ReleaseApi* | [**getUpdatesAfter**](docs/ReleaseApi.md#getupdatesafter) | **GET** /updates/{last_known_id} | GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).
|
|
67
|
+
*ReleaseApi* | [**listReleases**](docs/ReleaseApi.md#listreleases) | **GET** /releases | GET /releases/ - List releases with filters.
|
|
68
|
+
*ReportApi* | [**newReport**](docs/ReportApi.md#newreportoperation) | **POST** /report/{release_id} | POST /report/{release_id} - Submit a bug report.
|
|
69
|
+
*StatsApi* | [**getGlobalStats**](docs/StatsApi.md#getglobalstats) | **GET** /stats | GET /stats/ - Get global download statistics.
|
|
68
70
|
|
|
69
71
|
|
|
70
72
|
### Models
|
|
71
73
|
|
|
72
74
|
- [DeviceResponse](docs/DeviceResponse.md)
|
|
73
|
-
- [
|
|
74
|
-
- [
|
|
75
|
+
- [ErrorResponse](docs/ErrorResponse.md)
|
|
76
|
+
- [GlobalStatsResponse](docs/GlobalStatsResponse.md)
|
|
75
77
|
- [ListResponseReleaseResponse](docs/ListResponseReleaseResponse.md)
|
|
78
|
+
- [ListResponseReleaseResponseDataInner](docs/ListResponseReleaseResponseDataInner.md)
|
|
76
79
|
- [ListResponseShortDeviceResponse](docs/ListResponseShortDeviceResponse.md)
|
|
77
|
-
- [
|
|
78
|
-
- [
|
|
79
|
-
- [
|
|
80
|
+
- [ListResponseShortDeviceResponseDataInner](docs/ListResponseShortDeviceResponseDataInner.md)
|
|
81
|
+
- [ListResponseString](docs/ListResponseString.md)
|
|
82
|
+
- [MaintainerShortResponse](docs/MaintainerShortResponse.md)
|
|
83
|
+
- [NewReportRequest](docs/NewReportRequest.md)
|
|
80
84
|
- [PasteInput](docs/PasteInput.md)
|
|
81
|
-
- [
|
|
85
|
+
- [PasteResponse](docs/PasteResponse.md)
|
|
82
86
|
- [RecoveryImgResponse](docs/RecoveryImgResponse.md)
|
|
83
87
|
- [ReleaseGroupsResponse](docs/ReleaseGroupsResponse.md)
|
|
84
88
|
- [ReleaseResponse](docs/ReleaseResponse.md)
|
|
85
|
-
- [ReleaseType](docs/ReleaseType.md)
|
|
86
|
-
- [ReleasesSort](docs/ReleasesSort.md)
|
|
87
|
-
- [ResponseGetReleases](docs/ResponseGetReleases.md)
|
|
88
89
|
- [ShortDeviceResponse](docs/ShortDeviceResponse.md)
|
|
89
90
|
- [ShortReleaseResponse](docs/ShortReleaseResponse.md)
|
|
90
|
-
- [
|
|
91
|
-
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
|
|
91
|
+
- [TokenResponse](docs/TokenResponse.md)
|
|
92
92
|
|
|
93
93
|
### Authorization
|
|
94
94
|
|
|
@@ -99,14 +99,6 @@ Authentication schemes defined for the API:
|
|
|
99
99
|
|
|
100
100
|
|
|
101
101
|
- **Type**: HTTP Bearer Token authentication (JWT)
|
|
102
|
-
<a id="oauth2_password-password"></a>
|
|
103
|
-
#### oauth2_password password
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
- **Type**: OAuth
|
|
107
|
-
- **Flow**: password
|
|
108
|
-
- **Authorization URL**:
|
|
109
|
-
- **Scopes**: N/A
|
|
110
102
|
|
|
111
103
|
## About
|
|
112
104
|
|
|
@@ -114,9 +106,9 @@ This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.or
|
|
|
114
106
|
and is automatically generated by the
|
|
115
107
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
116
108
|
|
|
117
|
-
- API version: `
|
|
118
|
-
- Package version: `
|
|
119
|
-
- Generator version: `7.
|
|
109
|
+
- API version: `6.0.4`
|
|
110
|
+
- Package version: `6.0.4`
|
|
111
|
+
- Generator version: `7.21.0`
|
|
120
112
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
121
113
|
|
|
122
114
|
The generated npm module supports the following:
|
|
@@ -155,4 +147,4 @@ npm publish
|
|
|
155
147
|
|
|
156
148
|
## License
|
|
157
149
|
|
|
158
|
-
[]()
|
|
150
|
+
[GPL-3.0-only]()
|
package/dist/apis/DeviceApi.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fox API
|
|
3
|
-
*
|
|
3
|
+
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 6.0.4
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -10,23 +10,23 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { DeviceResponse, ListResponseShortDeviceResponse,
|
|
13
|
+
import type { DeviceResponse, ListResponseShortDeviceResponse, ListResponseString } from '../models/index';
|
|
14
14
|
export interface GetDeviceRequest {
|
|
15
15
|
deviceId?: string | null;
|
|
16
|
-
id?: string | null;
|
|
17
16
|
codename?: string | null;
|
|
17
|
+
id?: string | null;
|
|
18
18
|
}
|
|
19
|
-
export interface
|
|
19
|
+
export interface GetDeviceByIdRequest {
|
|
20
20
|
deviceId: string;
|
|
21
21
|
}
|
|
22
|
-
export interface
|
|
23
|
-
id?:
|
|
24
|
-
id2?:
|
|
25
|
-
oemName?:
|
|
26
|
-
codename?:
|
|
27
|
-
modelName?:
|
|
22
|
+
export interface ListDevicesRequest {
|
|
23
|
+
id?: string | null;
|
|
24
|
+
id2?: string | null;
|
|
25
|
+
oemName?: string | null;
|
|
26
|
+
codename?: string | null;
|
|
27
|
+
modelName?: string | null;
|
|
28
28
|
supported?: boolean | null;
|
|
29
|
-
maintainer?:
|
|
29
|
+
maintainer?: string | null;
|
|
30
30
|
freezed?: boolean | null;
|
|
31
31
|
hasReleases?: boolean | null;
|
|
32
32
|
skip?: number | null;
|
|
@@ -40,119 +40,158 @@ export interface GetDevicesRequest {
|
|
|
40
40
|
*/
|
|
41
41
|
export interface DeviceApiInterface {
|
|
42
42
|
/**
|
|
43
|
-
*
|
|
44
|
-
* @
|
|
43
|
+
* Creates request options for getDevice without sending the request
|
|
44
|
+
* @param {string} [deviceId]
|
|
45
|
+
* @param {string} [codename]
|
|
46
|
+
* @param {string} [id]
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
* @memberof DeviceApiInterface
|
|
49
|
+
*/
|
|
50
|
+
getDeviceRequestOpts(requestParameters: GetDeviceRequest): Promise<runtime.RequestOpts>;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @summary GET /devices/get - Get a single device by device_id, codename, or _id.
|
|
45
54
|
* @param {string} [deviceId]
|
|
46
|
-
* @param {string} [
|
|
47
|
-
* @param {string} [
|
|
55
|
+
* @param {string} [codename]
|
|
56
|
+
* @param {string} [id]
|
|
48
57
|
* @param {*} [options] Override http request option.
|
|
49
58
|
* @throws {RequiredError}
|
|
50
59
|
* @memberof DeviceApiInterface
|
|
51
60
|
*/
|
|
52
61
|
getDeviceRaw(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>>;
|
|
53
62
|
/**
|
|
54
|
-
*
|
|
55
|
-
* Get Device
|
|
63
|
+
* GET /devices/get - Get a single device by device_id, codename, or _id.
|
|
56
64
|
*/
|
|
57
65
|
getDevice(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
|
|
58
66
|
/**
|
|
59
|
-
*
|
|
60
|
-
* @
|
|
61
|
-
* @
|
|
67
|
+
* Creates request options for getDeviceById without sending the request
|
|
68
|
+
* @param {string} deviceId Device ID
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
* @memberof DeviceApiInterface
|
|
71
|
+
*/
|
|
72
|
+
getDeviceByIdRequestOpts(requestParameters: GetDeviceByIdRequest): Promise<runtime.RequestOpts>;
|
|
73
|
+
/**
|
|
74
|
+
*
|
|
75
|
+
* @summary GET /devices/{device_id} - Get device by ID (deprecated).
|
|
76
|
+
* @param {string} deviceId Device ID
|
|
62
77
|
* @param {*} [options] Override http request option.
|
|
63
|
-
* @deprecated
|
|
64
78
|
* @throws {RequiredError}
|
|
65
79
|
* @memberof DeviceApiInterface
|
|
66
80
|
*/
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
*
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
*
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
*
|
|
80
|
-
* @
|
|
81
|
-
* @param {Array<string>} [modelName] Filter by model names
|
|
82
|
-
* @param {boolean} [supported] Supported status
|
|
83
|
-
* @param {Array<string>} [maintainer] Filter by maintainer ID
|
|
84
|
-
* @param {boolean} [freezed] Filter by Freezed status
|
|
85
|
-
* @param {boolean} [hasReleases] Filter by has releases status
|
|
86
|
-
* @param {number} [skip] Skip query results
|
|
87
|
-
* @param {number} [limit] Limit query results (0 means unlimited)
|
|
81
|
+
getDeviceByIdRaw(requestParameters: GetDeviceByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>>;
|
|
82
|
+
/**
|
|
83
|
+
* GET /devices/{device_id} - Get device by ID (deprecated).
|
|
84
|
+
*/
|
|
85
|
+
getDeviceById(requestParameters: GetDeviceByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
|
|
86
|
+
/**
|
|
87
|
+
* Creates request options for getOems without sending the request
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
* @memberof DeviceApiInterface
|
|
90
|
+
*/
|
|
91
|
+
getOemsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
92
|
+
/**
|
|
93
|
+
*
|
|
94
|
+
* @summary GET /oems - Get a list of all unique OEM names.
|
|
88
95
|
* @param {*} [options] Override http request option.
|
|
89
96
|
* @throws {RequiredError}
|
|
90
97
|
* @memberof DeviceApiInterface
|
|
91
98
|
*/
|
|
92
|
-
|
|
99
|
+
getOemsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseString>>;
|
|
93
100
|
/**
|
|
94
|
-
*
|
|
95
|
-
* Get Devices
|
|
101
|
+
* GET /oems - Get a list of all unique OEM names.
|
|
96
102
|
*/
|
|
97
|
-
|
|
103
|
+
getOems(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseString>;
|
|
98
104
|
/**
|
|
99
|
-
*
|
|
100
|
-
* @
|
|
105
|
+
* Creates request options for listDevices without sending the request
|
|
106
|
+
* @param {string} [id]
|
|
107
|
+
* @param {string} [id2]
|
|
108
|
+
* @param {string} [oemName]
|
|
109
|
+
* @param {string} [codename]
|
|
110
|
+
* @param {string} [modelName]
|
|
111
|
+
* @param {boolean} [supported]
|
|
112
|
+
* @param {string} [maintainer]
|
|
113
|
+
* @param {boolean} [freezed]
|
|
114
|
+
* @param {boolean} [hasReleases]
|
|
115
|
+
* @param {number} [skip]
|
|
116
|
+
* @param {number} [limit]
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
* @memberof DeviceApiInterface
|
|
119
|
+
*/
|
|
120
|
+
listDevicesRequestOpts(requestParameters: ListDevicesRequest): Promise<runtime.RequestOpts>;
|
|
121
|
+
/**
|
|
122
|
+
*
|
|
123
|
+
* @summary GET /devices/ - List devices with filters.
|
|
124
|
+
* @param {string} [id]
|
|
125
|
+
* @param {string} [id2]
|
|
126
|
+
* @param {string} [oemName]
|
|
127
|
+
* @param {string} [codename]
|
|
128
|
+
* @param {string} [modelName]
|
|
129
|
+
* @param {boolean} [supported]
|
|
130
|
+
* @param {string} [maintainer]
|
|
131
|
+
* @param {boolean} [freezed]
|
|
132
|
+
* @param {boolean} [hasReleases]
|
|
133
|
+
* @param {number} [skip]
|
|
134
|
+
* @param {number} [limit]
|
|
101
135
|
* @param {*} [options] Override http request option.
|
|
102
136
|
* @throws {RequiredError}
|
|
103
137
|
* @memberof DeviceApiInterface
|
|
104
138
|
*/
|
|
105
|
-
|
|
139
|
+
listDevicesRaw(requestParameters: ListDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseShortDeviceResponse>>;
|
|
106
140
|
/**
|
|
107
|
-
*
|
|
108
|
-
* Get Oems
|
|
141
|
+
* GET /devices/ - List devices with filters.
|
|
109
142
|
*/
|
|
110
|
-
|
|
143
|
+
listDevices(requestParameters: ListDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseShortDeviceResponse>;
|
|
111
144
|
}
|
|
112
145
|
/**
|
|
113
146
|
*
|
|
114
147
|
*/
|
|
115
148
|
export declare class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
|
|
116
149
|
/**
|
|
117
|
-
*
|
|
118
|
-
|
|
150
|
+
* Creates request options for getDevice without sending the request
|
|
151
|
+
*/
|
|
152
|
+
getDeviceRequestOpts(requestParameters: GetDeviceRequest): Promise<runtime.RequestOpts>;
|
|
153
|
+
/**
|
|
154
|
+
* GET /devices/get - Get a single device by device_id, codename, or _id.
|
|
119
155
|
*/
|
|
120
156
|
getDeviceRaw(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>>;
|
|
121
157
|
/**
|
|
122
|
-
*
|
|
123
|
-
* Get Device
|
|
158
|
+
* GET /devices/get - Get a single device by device_id, codename, or _id.
|
|
124
159
|
*/
|
|
125
160
|
getDevice(requestParameters?: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
|
|
126
161
|
/**
|
|
127
|
-
*
|
|
128
|
-
|
|
129
|
-
|
|
162
|
+
* Creates request options for getDeviceById without sending the request
|
|
163
|
+
*/
|
|
164
|
+
getDeviceByIdRequestOpts(requestParameters: GetDeviceByIdRequest): Promise<runtime.RequestOpts>;
|
|
165
|
+
/**
|
|
166
|
+
* GET /devices/{device_id} - Get device by ID (deprecated).
|
|
167
|
+
*/
|
|
168
|
+
getDeviceByIdRaw(requestParameters: GetDeviceByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>>;
|
|
169
|
+
/**
|
|
170
|
+
* GET /devices/{device_id} - Get device by ID (deprecated).
|
|
171
|
+
*/
|
|
172
|
+
getDeviceById(requestParameters: GetDeviceByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
|
|
173
|
+
/**
|
|
174
|
+
* Creates request options for getOems without sending the request
|
|
130
175
|
*/
|
|
131
|
-
|
|
176
|
+
getOemsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
132
177
|
/**
|
|
133
|
-
*
|
|
134
|
-
* Get Device Short
|
|
135
|
-
* @deprecated
|
|
178
|
+
* GET /oems - Get a list of all unique OEM names.
|
|
136
179
|
*/
|
|
137
|
-
|
|
180
|
+
getOemsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseString>>;
|
|
138
181
|
/**
|
|
139
|
-
*
|
|
140
|
-
* Get Devices
|
|
182
|
+
* GET /oems - Get a list of all unique OEM names.
|
|
141
183
|
*/
|
|
142
|
-
|
|
184
|
+
getOems(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseString>;
|
|
143
185
|
/**
|
|
144
|
-
*
|
|
145
|
-
* Get Devices
|
|
186
|
+
* Creates request options for listDevices without sending the request
|
|
146
187
|
*/
|
|
147
|
-
|
|
188
|
+
listDevicesRequestOpts(requestParameters: ListDevicesRequest): Promise<runtime.RequestOpts>;
|
|
148
189
|
/**
|
|
149
|
-
*
|
|
150
|
-
* Get Oems
|
|
190
|
+
* GET /devices/ - List devices with filters.
|
|
151
191
|
*/
|
|
152
|
-
|
|
192
|
+
listDevicesRaw(requestParameters: ListDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseShortDeviceResponse>>;
|
|
153
193
|
/**
|
|
154
|
-
*
|
|
155
|
-
* Get Oems
|
|
194
|
+
* GET /devices/ - List devices with filters.
|
|
156
195
|
*/
|
|
157
|
-
|
|
196
|
+
listDevices(requestParameters?: ListDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseShortDeviceResponse>;
|
|
158
197
|
}
|