@orangefox-recovery/foxclient 5.1.1 → 5.2.1
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 +1 -1
- package/README.md +13 -13
- package/api.ts +173 -235
- package/base.ts +3 -3
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +116 -106
- package/dist/api.js +146 -192
- package/dist/base.d.ts +2 -2
- package/dist/base.js +3 -3
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +116 -106
- package/dist/esm/api.js +147 -193
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +3 -3
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/DeviceApi.md +40 -40
- package/docs/ReleaseApi.md +22 -22
- package/docs/{ResponseGetReleasesReleasesGet.md → ResponseGetReleases.md} +3 -3
- package/docs/StatsApi.md +6 -6
- package/index.ts +2 -2
- package/package.json +1 -1
package/dist/esm/base.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fox API
|
|
3
|
-
* Warning: Please add a custom
|
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.1
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Fox API
|
|
5
|
-
* Warning: Please add a custom
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.1
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import globalAxios from 'axios';
|
|
15
|
-
export const BASE_PATH = "
|
|
15
|
+
export const BASE_PATH = "https://api.orangefox.download".replace(/\/+$/, "");
|
|
16
16
|
/**
|
|
17
17
|
*
|
|
18
18
|
* @export
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fox API
|
|
3
|
-
* Warning: Please add a custom
|
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.1
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Fox API
|
|
5
|
-
* Warning: Please add a custom
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.1
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fox API
|
|
3
|
-
* Warning: Please add a custom
|
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.1
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Fox API
|
|
5
|
-
* Warning: Please add a custom
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.1
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fox API
|
|
3
|
-
* Warning: Please add a custom
|
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.1
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Fox API
|
|
5
|
-
* Warning: Please add a custom
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.1
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fox API
|
|
3
|
-
* Warning: Please add a custom
|
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.1
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Fox API
|
|
6
|
-
* Warning: Please add a custom
|
|
6
|
+
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.
|
|
8
|
+
* The version of the OpenAPI document: 5.2.1
|
|
9
9
|
* Contact: admin@orangefox.tech
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/DeviceApi.md
CHANGED
|
@@ -1,34 +1,40 @@
|
|
|
1
1
|
# DeviceApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *https://api.orangefox.download*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**
|
|
9
|
-
|[**
|
|
10
|
-
|[**
|
|
7
|
+
|[**getDevice**](#getdevice) | **GET** /devices/get | Get Device|
|
|
8
|
+
|[**getDeviceDeprecated**](#getdevicedeprecated) | **GET** /devices/{device_id} | Get Device Short|
|
|
9
|
+
|[**getDevices**](#getdevices) | **GET** /devices/ | Get Devices|
|
|
10
|
+
|[**getOems**](#getoems) | **GET** /oems/ | Get Oems|
|
|
11
11
|
|
|
12
|
-
# **
|
|
13
|
-
> DeviceResponse
|
|
12
|
+
# **getDevice**
|
|
13
|
+
> DeviceResponse getDevice()
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
19
19
|
```typescript
|
|
20
20
|
import {
|
|
21
21
|
DeviceApi,
|
|
22
|
-
Configuration
|
|
22
|
+
Configuration,
|
|
23
|
+
,
|
|
24
|
+
|
|
23
25
|
} from '@orangefox-recovery/foxclient';
|
|
24
26
|
|
|
25
27
|
const configuration = new Configuration();
|
|
26
28
|
const apiInstance = new DeviceApi(configuration);
|
|
27
29
|
|
|
28
|
-
let deviceId:
|
|
30
|
+
let deviceId: ; // (optional) (default to undefined)
|
|
31
|
+
let id: ; //Filter by Device ID (deprecated) (optional) (default to undefined)
|
|
32
|
+
let codename: string; //Not recommended to use when you can (optional) (default to undefined)
|
|
29
33
|
|
|
30
|
-
const { status, data } = await apiInstance.
|
|
31
|
-
deviceId
|
|
34
|
+
const { status, data } = await apiInstance.getDevice(
|
|
35
|
+
deviceId,
|
|
36
|
+
id,
|
|
37
|
+
codename
|
|
32
38
|
);
|
|
33
39
|
```
|
|
34
40
|
|
|
@@ -36,7 +42,9 @@ const { status, data } = await apiInstance.getDeviceDevicesDeviceIdGet(
|
|
|
36
42
|
|
|
37
43
|
|Name | Type | Description | Notes|
|
|
38
44
|
|------------- | ------------- | ------------- | -------------|
|
|
39
|
-
| **deviceId** |
|
|
45
|
+
| **deviceId** | **** | | (optional) defaults to undefined|
|
|
46
|
+
| **id** | **** | Filter by Device ID (deprecated) | (optional) defaults to undefined|
|
|
47
|
+
| **codename** | [**string**] | Not recommended to use when you can | (optional) defaults to undefined|
|
|
40
48
|
|
|
41
49
|
|
|
42
50
|
### Return type
|
|
@@ -45,7 +53,7 @@ const { status, data } = await apiInstance.getDeviceDevicesDeviceIdGet(
|
|
|
45
53
|
|
|
46
54
|
### Authorization
|
|
47
55
|
|
|
48
|
-
|
|
56
|
+
No authorization required
|
|
49
57
|
|
|
50
58
|
### HTTP request headers
|
|
51
59
|
|
|
@@ -58,36 +66,31 @@ const { status, data } = await apiInstance.getDeviceDevicesDeviceIdGet(
|
|
|
58
66
|
|-------------|-------------|------------------|
|
|
59
67
|
|**200** | Successful Response | - |
|
|
60
68
|
|**404** | Item not found | - |
|
|
69
|
+
|**400** | Bad request | - |
|
|
61
70
|
|**422** | Validation Error | - |
|
|
62
71
|
|
|
63
72
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
64
73
|
|
|
65
|
-
# **
|
|
66
|
-
> DeviceResponse
|
|
74
|
+
# **getDeviceDeprecated**
|
|
75
|
+
> DeviceResponse getDeviceDeprecated()
|
|
67
76
|
|
|
68
|
-
|
|
77
|
+
Gets device info using device ID.
|
|
69
78
|
|
|
70
79
|
### Example
|
|
71
80
|
|
|
72
81
|
```typescript
|
|
73
82
|
import {
|
|
74
83
|
DeviceApi,
|
|
75
|
-
Configuration
|
|
76
|
-
,
|
|
77
|
-
|
|
84
|
+
Configuration
|
|
78
85
|
} from '@orangefox-recovery/foxclient';
|
|
79
86
|
|
|
80
87
|
const configuration = new Configuration();
|
|
81
88
|
const apiInstance = new DeviceApi(configuration);
|
|
82
89
|
|
|
83
|
-
let deviceId: ; // (
|
|
84
|
-
let id: ; //Filter by Device ID (deprecated) (optional) (default to undefined)
|
|
85
|
-
let codename: string; //Not recommended to use when you can (optional) (default to undefined)
|
|
90
|
+
let deviceId: string; // (default to undefined)
|
|
86
91
|
|
|
87
|
-
const { status, data } = await apiInstance.
|
|
88
|
-
deviceId
|
|
89
|
-
id,
|
|
90
|
-
codename
|
|
92
|
+
const { status, data } = await apiInstance.getDeviceDeprecated(
|
|
93
|
+
deviceId
|
|
91
94
|
);
|
|
92
95
|
```
|
|
93
96
|
|
|
@@ -95,9 +98,7 @@ const { status, data } = await apiInstance.getDeviceExtendedDevicesGetGet(
|
|
|
95
98
|
|
|
96
99
|
|Name | Type | Description | Notes|
|
|
97
100
|
|------------- | ------------- | ------------- | -------------|
|
|
98
|
-
| **deviceId** |
|
|
99
|
-
| **id** | **** | Filter by Device ID (deprecated) | (optional) defaults to undefined|
|
|
100
|
-
| **codename** | [**string**] | Not recommended to use when you can | (optional) defaults to undefined|
|
|
101
|
+
| **deviceId** | [**string**] | | defaults to undefined|
|
|
101
102
|
|
|
102
103
|
|
|
103
104
|
### Return type
|
|
@@ -106,7 +107,7 @@ const { status, data } = await apiInstance.getDeviceExtendedDevicesGetGet(
|
|
|
106
107
|
|
|
107
108
|
### Authorization
|
|
108
109
|
|
|
109
|
-
|
|
110
|
+
No authorization required
|
|
110
111
|
|
|
111
112
|
### HTTP request headers
|
|
112
113
|
|
|
@@ -119,13 +120,12 @@ const { status, data } = await apiInstance.getDeviceExtendedDevicesGetGet(
|
|
|
119
120
|
|-------------|-------------|------------------|
|
|
120
121
|
|**200** | Successful Response | - |
|
|
121
122
|
|**404** | Item not found | - |
|
|
122
|
-
|**400** | Bad request | - |
|
|
123
123
|
|**422** | Validation Error | - |
|
|
124
124
|
|
|
125
125
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
126
126
|
|
|
127
|
-
# **
|
|
128
|
-
> ListResponseShortDeviceResponse
|
|
127
|
+
# **getDevices**
|
|
128
|
+
> ListResponseShortDeviceResponse getDevices()
|
|
129
129
|
|
|
130
130
|
Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
|
|
131
131
|
|
|
@@ -152,7 +152,7 @@ let hasReleases: boolean; //Filter by has releases status (optional) (default to
|
|
|
152
152
|
let skip: number; //Skip query results (optional) (default to undefined)
|
|
153
153
|
let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
|
|
154
154
|
|
|
155
|
-
const { status, data } = await apiInstance.
|
|
155
|
+
const { status, data } = await apiInstance.getDevices(
|
|
156
156
|
id,
|
|
157
157
|
id2,
|
|
158
158
|
oemName,
|
|
@@ -190,7 +190,7 @@ const { status, data } = await apiInstance.getDevicesListDevicesGet(
|
|
|
190
190
|
|
|
191
191
|
### Authorization
|
|
192
192
|
|
|
193
|
-
|
|
193
|
+
No authorization required
|
|
194
194
|
|
|
195
195
|
### HTTP request headers
|
|
196
196
|
|
|
@@ -207,8 +207,8 @@ const { status, data } = await apiInstance.getDevicesListDevicesGet(
|
|
|
207
207
|
|
|
208
208
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
209
209
|
|
|
210
|
-
# **
|
|
211
|
-
> ListResponseStr
|
|
210
|
+
# **getOems**
|
|
211
|
+
> ListResponseStr getOems()
|
|
212
212
|
|
|
213
213
|
Lists all OEM names
|
|
214
214
|
|
|
@@ -223,7 +223,7 @@ import {
|
|
|
223
223
|
const configuration = new Configuration();
|
|
224
224
|
const apiInstance = new DeviceApi(configuration);
|
|
225
225
|
|
|
226
|
-
const { status, data } = await apiInstance.
|
|
226
|
+
const { status, data } = await apiInstance.getOems();
|
|
227
227
|
```
|
|
228
228
|
|
|
229
229
|
### Parameters
|
|
@@ -236,7 +236,7 @@ This endpoint does not have any parameters.
|
|
|
236
236
|
|
|
237
237
|
### Authorization
|
|
238
238
|
|
|
239
|
-
|
|
239
|
+
No authorization required
|
|
240
240
|
|
|
241
241
|
### HTTP request headers
|
|
242
242
|
|
package/docs/ReleaseApi.md
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
# ReleaseApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *https://api.orangefox.download*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**
|
|
9
|
-
|[**
|
|
10
|
-
|[**
|
|
7
|
+
|[**getRelease**](#getrelease) | **GET** /releases/get | Get Release|
|
|
8
|
+
|[**getReleaseDeprecated**](#getreleasedeprecated) | **GET** /releases/{release_id} | Get Release Short|
|
|
9
|
+
|[**getReleases**](#getreleases) | **GET** /releases/ | Get Releases|
|
|
10
|
+
|[**getUpdatesDeprecated**](#getupdatesdeprecated) | **GET** /updates/{last_known_id} | Get Updates|
|
|
11
11
|
|
|
12
|
-
# **
|
|
13
|
-
> ReleaseResponse
|
|
12
|
+
# **getRelease**
|
|
13
|
+
> ReleaseResponse getRelease()
|
|
14
14
|
|
|
15
15
|
Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
|
|
16
16
|
|
|
@@ -32,7 +32,7 @@ let id: ; //Release ID (deprecated) (optional) (default to undefined)
|
|
|
32
32
|
let buildId: string; //Build ID, `ro.build.fox_id` prop (optional) (default to undefined)
|
|
33
33
|
let filename: string; // (optional) (default to undefined)
|
|
34
34
|
|
|
35
|
-
const { status, data } = await apiInstance.
|
|
35
|
+
const { status, data } = await apiInstance.getRelease(
|
|
36
36
|
releaseId,
|
|
37
37
|
id,
|
|
38
38
|
buildId,
|
|
@@ -56,7 +56,7 @@ const { status, data } = await apiInstance.getReleaseExtendedReleasesGetGet(
|
|
|
56
56
|
|
|
57
57
|
### Authorization
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
No authorization required
|
|
60
60
|
|
|
61
61
|
### HTTP request headers
|
|
62
62
|
|
|
@@ -72,8 +72,8 @@ const { status, data } = await apiInstance.getReleaseExtendedReleasesGetGet(
|
|
|
72
72
|
|
|
73
73
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
74
74
|
|
|
75
|
-
# **
|
|
76
|
-
> ReleaseResponse
|
|
75
|
+
# **getReleaseDeprecated**
|
|
76
|
+
> ReleaseResponse getReleaseDeprecated()
|
|
77
77
|
|
|
78
78
|
Gets release information using the release ID, nothing to discuss really.
|
|
79
79
|
|
|
@@ -90,7 +90,7 @@ const apiInstance = new ReleaseApi(configuration);
|
|
|
90
90
|
|
|
91
91
|
let releaseId: any; // (default to undefined)
|
|
92
92
|
|
|
93
|
-
const { status, data } = await apiInstance.
|
|
93
|
+
const { status, data } = await apiInstance.getReleaseDeprecated(
|
|
94
94
|
releaseId
|
|
95
95
|
);
|
|
96
96
|
```
|
|
@@ -108,7 +108,7 @@ const { status, data } = await apiInstance.getReleaseReleasesReleaseIdGet(
|
|
|
108
108
|
|
|
109
109
|
### Authorization
|
|
110
110
|
|
|
111
|
-
|
|
111
|
+
No authorization required
|
|
112
112
|
|
|
113
113
|
### HTTP request headers
|
|
114
114
|
|
|
@@ -124,8 +124,8 @@ const { status, data } = await apiInstance.getReleaseReleasesReleaseIdGet(
|
|
|
124
124
|
|
|
125
125
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
126
126
|
|
|
127
|
-
# **
|
|
128
|
-
>
|
|
127
|
+
# **getReleases**
|
|
128
|
+
> ResponseGetReleases getReleases()
|
|
129
129
|
|
|
130
130
|
Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
|
|
131
131
|
|
|
@@ -158,7 +158,7 @@ let group: boolean; //Group releases by version + variant. This will change the
|
|
|
158
158
|
let skip: number; //Skip query results (optional) (default to undefined)
|
|
159
159
|
let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
|
|
160
160
|
|
|
161
|
-
const { status, data } = await apiInstance.
|
|
161
|
+
const { status, data } = await apiInstance.getReleases(
|
|
162
162
|
id,
|
|
163
163
|
id2,
|
|
164
164
|
buildId,
|
|
@@ -202,11 +202,11 @@ const { status, data } = await apiInstance.getReleasesReleasesGet(
|
|
|
202
202
|
|
|
203
203
|
### Return type
|
|
204
204
|
|
|
205
|
-
**
|
|
205
|
+
**ResponseGetReleases**
|
|
206
206
|
|
|
207
207
|
### Authorization
|
|
208
208
|
|
|
209
|
-
|
|
209
|
+
No authorization required
|
|
210
210
|
|
|
211
211
|
### HTTP request headers
|
|
212
212
|
|
|
@@ -223,8 +223,8 @@ const { status, data } = await apiInstance.getReleasesReleasesGet(
|
|
|
223
223
|
|
|
224
224
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
225
225
|
|
|
226
|
-
# **
|
|
227
|
-
> ListResponseShortReleaseResponse
|
|
226
|
+
# **getUpdatesDeprecated**
|
|
227
|
+
> ListResponseShortReleaseResponse getUpdatesDeprecated()
|
|
228
228
|
|
|
229
229
|
Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
|
|
230
230
|
|
|
@@ -246,7 +246,7 @@ let releaseType: Array<ReleaseType>; //Filter by release type (legacy) (optional
|
|
|
246
246
|
let skip: number; //Skip query results (optional) (default to undefined)
|
|
247
247
|
let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
|
|
248
248
|
|
|
249
|
-
const { status, data } = await apiInstance.
|
|
249
|
+
const { status, data } = await apiInstance.getUpdatesDeprecated(
|
|
250
250
|
lastKnownId,
|
|
251
251
|
deviceId,
|
|
252
252
|
type,
|
|
@@ -274,7 +274,7 @@ const { status, data } = await apiInstance.getUpdatesUpdatesLastKnownIdGet(
|
|
|
274
274
|
|
|
275
275
|
### Authorization
|
|
276
276
|
|
|
277
|
-
|
|
277
|
+
No authorization required
|
|
278
278
|
|
|
279
279
|
### HTTP request headers
|
|
280
280
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ResponseGetReleases
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { ResponseGetReleases } from '@orangefox-recovery/foxclient';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: ResponseGetReleases = {
|
|
17
17
|
data,
|
|
18
18
|
count,
|
|
19
19
|
};
|
package/docs/StatsApi.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# StatsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *https://api.orangefox.download*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
7
|
+
|[**getPublicStats**](#getpublicstats) | **GET** /stats/ | Public Stats|
|
|
8
8
|
|
|
9
|
-
# **
|
|
10
|
-
> GlobalStatsAggregationModel
|
|
9
|
+
# **getPublicStats**
|
|
10
|
+
> GlobalStatsAggregationModel getPublicStats()
|
|
11
11
|
|
|
12
12
|
Returns the global OrangeFox downloads statistics. This request causes an increased load to the database, as it needs to aggregate all the release stats data, therefore, it is limited to a small number of requests per minute for public usage.
|
|
13
13
|
|
|
@@ -22,7 +22,7 @@ import {
|
|
|
22
22
|
const configuration = new Configuration();
|
|
23
23
|
const apiInstance = new StatsApi(configuration);
|
|
24
24
|
|
|
25
|
-
const { status, data } = await apiInstance.
|
|
25
|
+
const { status, data } = await apiInstance.getPublicStats();
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
### Parameters
|
|
@@ -35,7 +35,7 @@ This endpoint does not have any parameters.
|
|
|
35
35
|
|
|
36
36
|
### Authorization
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
No authorization required
|
|
39
39
|
|
|
40
40
|
### HTTP request headers
|
|
41
41
|
|
package/index.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Fox API
|
|
5
|
-
* Warning: Please add a custom
|
|
5
|
+
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.1
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|