@orangefox-recovery/foxclient 5.2.0 → 5.2.2

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.
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Fox API
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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
5
+ * The version of the OpenAPI document: 5.2.2
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 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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
7
+ * The version of the OpenAPI document: 5.2.2
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 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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
5
+ * The version of the OpenAPI document: 5.2.2
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 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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
7
+ * The version of the OpenAPI document: 5.2.2
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 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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
5
+ * The version of the OpenAPI document: 5.2.2
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 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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
7
+ * The version of the OpenAPI document: 5.2.2
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 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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
5
+ * The version of the OpenAPI document: 5.2.2
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 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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
7
+ * The version of the OpenAPI document: 5.2.2
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 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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
5
+ * The version of the OpenAPI document: 5.2.2
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 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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
8
+ * The version of the OpenAPI document: 5.2.2
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
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.orangefox.download*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**getDeviceDevicesGetGet**](#getdevicedevicesgetget) | **GET** /devices/get | Get Device|
8
- |[**getDeviceShortDevicesDeviceIdGet**](#getdeviceshortdevicesdeviceidget) | **GET** /devices/{device_id} | Get Device Short|
9
- |[**getDevicesDevicesGet**](#getdevicesdevicesget) | **GET** /devices/ | Get Devices|
10
- |[**getOemsListOemsGet**](#getoemslistoemsget) | **GET** /oems/ | Get Oems List|
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
- # **getDeviceDevicesGetGet**
13
- > DeviceResponse getDeviceDevicesGetGet()
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
 
@@ -19,19 +19,17 @@ Extended get device method, including the ability to get a device using device c
19
19
  ```typescript
20
20
  import {
21
21
  DeviceApi,
22
- Configuration,
23
- ,
24
-
22
+ Configuration
25
23
  } from '@orangefox-recovery/foxclient';
26
24
 
27
25
  const configuration = new Configuration();
28
26
  const apiInstance = new DeviceApi(configuration);
29
27
 
30
- let deviceId: ; // (optional) (default to undefined)
31
- let id: ; //Filter by Device ID (deprecated) (optional) (default to undefined)
28
+ let deviceId: string; // (optional) (default to undefined)
29
+ let id: string; //Filter by Device ID (deprecated) (optional) (default to undefined)
32
30
  let codename: string; //Not recommended to use when you can (optional) (default to undefined)
33
31
 
34
- const { status, data } = await apiInstance.getDeviceDevicesGetGet(
32
+ const { status, data } = await apiInstance.getDevice(
35
33
  deviceId,
36
34
  id,
37
35
  codename
@@ -42,8 +40,8 @@ const { status, data } = await apiInstance.getDeviceDevicesGetGet(
42
40
 
43
41
  |Name | Type | Description | Notes|
44
42
  |------------- | ------------- | ------------- | -------------|
45
- | **deviceId** | **** | | (optional) defaults to undefined|
46
- | **id** | **** | Filter by Device ID (deprecated) | (optional) defaults to undefined|
43
+ | **deviceId** | [**string**] | | (optional) defaults to undefined|
44
+ | **id** | [**string**] | Filter by Device ID (deprecated) | (optional) defaults to undefined|
47
45
  | **codename** | [**string**] | Not recommended to use when you can | (optional) defaults to undefined|
48
46
 
49
47
 
@@ -71,8 +69,8 @@ No authorization required
71
69
 
72
70
  [[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)
73
71
 
74
- # **getDeviceShortDevicesDeviceIdGet**
75
- > DeviceResponse getDeviceShortDevicesDeviceIdGet()
72
+ # **getDeviceDeprecated**
73
+ > DeviceResponse getDeviceDeprecated()
76
74
 
77
75
  Gets device info using device ID.
78
76
 
@@ -89,7 +87,7 @@ const apiInstance = new DeviceApi(configuration);
89
87
 
90
88
  let deviceId: string; // (default to undefined)
91
89
 
92
- const { status, data } = await apiInstance.getDeviceShortDevicesDeviceIdGet(
90
+ const { status, data } = await apiInstance.getDeviceDeprecated(
93
91
  deviceId
94
92
  );
95
93
  ```
@@ -124,8 +122,8 @@ No authorization required
124
122
 
125
123
  [[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
124
 
127
- # **getDevicesDevicesGet**
128
- > ListResponseShortDeviceResponse getDevicesDevicesGet()
125
+ # **getDevices**
126
+ > ListResponseShortDeviceResponse getDevices()
129
127
 
130
128
  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
129
 
@@ -140,8 +138,8 @@ import {
140
138
  const configuration = new Configuration();
141
139
  const apiInstance = new DeviceApi(configuration);
142
140
 
143
- let id: Array<any>; //Filter by Device IDs (optional) (default to undefined)
144
- let id2: Array<any>; //Filter by Device IDs (deprecated) (optional) (default to undefined)
141
+ let id: Array<string>; //Filter by Device IDs (optional) (default to undefined)
142
+ let id2: Array<string>; //Filter by Device IDs (deprecated) (optional) (default to undefined)
145
143
  let oemName: Array<string>; //Filter by OEM names (optional) (default to undefined)
146
144
  let codename: Array<string>; //Filter by device codenames (optional) (default to undefined)
147
145
  let modelName: Array<string>; //Filter by model names (optional) (default to undefined)
@@ -152,7 +150,7 @@ let hasReleases: boolean; //Filter by has releases status (optional) (default to
152
150
  let skip: number; //Skip query results (optional) (default to undefined)
153
151
  let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
154
152
 
155
- const { status, data } = await apiInstance.getDevicesDevicesGet(
153
+ const { status, data } = await apiInstance.getDevices(
156
154
  id,
157
155
  id2,
158
156
  oemName,
@@ -171,8 +169,8 @@ const { status, data } = await apiInstance.getDevicesDevicesGet(
171
169
 
172
170
  |Name | Type | Description | Notes|
173
171
  |------------- | ------------- | ------------- | -------------|
174
- | **id** | **Array&lt;any&gt;** | Filter by Device IDs | (optional) defaults to undefined|
175
- | **id2** | **Array&lt;any&gt;** | Filter by Device IDs (deprecated) | (optional) defaults to undefined|
172
+ | **id** | **Array&lt;string&gt;** | Filter by Device IDs | (optional) defaults to undefined|
173
+ | **id2** | **Array&lt;string&gt;** | Filter by Device IDs (deprecated) | (optional) defaults to undefined|
176
174
  | **oemName** | **Array&lt;string&gt;** | Filter by OEM names | (optional) defaults to undefined|
177
175
  | **codename** | **Array&lt;string&gt;** | Filter by device codenames | (optional) defaults to undefined|
178
176
  | **modelName** | **Array&lt;string&gt;** | Filter by model names | (optional) defaults to undefined|
@@ -207,8 +205,8 @@ No authorization required
207
205
 
208
206
  [[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
207
 
210
- # **getOemsListOemsGet**
211
- > ListResponseStr getOemsListOemsGet()
208
+ # **getOems**
209
+ > ListResponseStr getOems()
212
210
 
213
211
  Lists all OEM names
214
212
 
@@ -223,7 +221,7 @@ import {
223
221
  const configuration = new Configuration();
224
222
  const apiInstance = new DeviceApi(configuration);
225
223
 
226
- const { status, data } = await apiInstance.getOemsListOemsGet();
224
+ const { status, data } = await apiInstance.getOems();
227
225
  ```
228
226
 
229
227
  ### Parameters
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.orangefox.download*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**getReleaseReleasesGetGet**](#getreleasereleasesgetget) | **GET** /releases/get | Get Release|
8
- |[**getReleaseShortReleasesReleaseIdGet**](#getreleaseshortreleasesreleaseidget) | **GET** /releases/{release_id} | Get Release Short|
9
- |[**getReleasesReleasesGet**](#getreleasesreleasesget) | **GET** /releases/ | Get Releases|
10
- |[**getUpdatesUpdatesLastKnownIdGet**](#getupdatesupdateslastknownidget) | **GET** /updates/{last_known_id} | Get Updates|
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
- # **getReleaseReleasesGetGet**
13
- > ReleaseResponse getReleaseReleasesGetGet()
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
 
@@ -19,20 +19,18 @@ Extended get device method, including the ability to get a device using device c
19
19
  ```typescript
20
20
  import {
21
21
  ReleaseApi,
22
- Configuration,
23
- ,
24
-
22
+ Configuration
25
23
  } from '@orangefox-recovery/foxclient';
26
24
 
27
25
  const configuration = new Configuration();
28
26
  const apiInstance = new ReleaseApi(configuration);
29
27
 
30
- let releaseId: ; //Release ID (optional) (default to undefined)
31
- let id: ; //Release ID (deprecated) (optional) (default to undefined)
28
+ let releaseId: string; //Release ID (optional) (default to undefined)
29
+ let id: string; //Release ID (deprecated) (optional) (default to undefined)
32
30
  let buildId: string; //Build ID, `ro.build.fox_id` prop (optional) (default to undefined)
33
31
  let filename: string; // (optional) (default to undefined)
34
32
 
35
- const { status, data } = await apiInstance.getReleaseReleasesGetGet(
33
+ const { status, data } = await apiInstance.getRelease(
36
34
  releaseId,
37
35
  id,
38
36
  buildId,
@@ -44,8 +42,8 @@ const { status, data } = await apiInstance.getReleaseReleasesGetGet(
44
42
 
45
43
  |Name | Type | Description | Notes|
46
44
  |------------- | ------------- | ------------- | -------------|
47
- | **releaseId** | **** | Release ID | (optional) defaults to undefined|
48
- | **id** | **** | Release ID (deprecated) | (optional) defaults to undefined|
45
+ | **releaseId** | [**string**] | Release ID | (optional) defaults to undefined|
46
+ | **id** | [**string**] | Release ID (deprecated) | (optional) defaults to undefined|
49
47
  | **buildId** | [**string**] | Build ID, &#x60;ro.build.fox_id&#x60; prop | (optional) defaults to undefined|
50
48
  | **filename** | [**string**] | | (optional) defaults to undefined|
51
49
 
@@ -72,8 +70,8 @@ No authorization required
72
70
 
73
71
  [[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
72
 
75
- # **getReleaseShortReleasesReleaseIdGet**
76
- > ReleaseResponse getReleaseShortReleasesReleaseIdGet()
73
+ # **getReleaseDeprecated**
74
+ > ReleaseResponse getReleaseDeprecated()
77
75
 
78
76
  Gets release information using the release ID, nothing to discuss really.
79
77
 
@@ -88,9 +86,9 @@ import {
88
86
  const configuration = new Configuration();
89
87
  const apiInstance = new ReleaseApi(configuration);
90
88
 
91
- let releaseId: any; // (default to undefined)
89
+ let releaseId: string; // (default to undefined)
92
90
 
93
- const { status, data } = await apiInstance.getReleaseShortReleasesReleaseIdGet(
91
+ const { status, data } = await apiInstance.getReleaseDeprecated(
94
92
  releaseId
95
93
  );
96
94
  ```
@@ -99,7 +97,7 @@ const { status, data } = await apiInstance.getReleaseShortReleasesReleaseIdGet(
99
97
 
100
98
  |Name | Type | Description | Notes|
101
99
  |------------- | ------------- | ------------- | -------------|
102
- | **releaseId** | **any** | | defaults to undefined|
100
+ | **releaseId** | [**string**] | | defaults to undefined|
103
101
 
104
102
 
105
103
  ### Return type
@@ -124,8 +122,8 @@ No authorization required
124
122
 
125
123
  [[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
124
 
127
- # **getReleasesReleasesGet**
128
- > ResponseGetReleasesReleasesGet getReleasesReleasesGet()
125
+ # **getReleases**
126
+ > ResponseGetReleases getReleases()
129
127
 
130
128
  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
129
 
@@ -134,31 +132,30 @@ Lists releases. This method contains a bunch of different parameters to filter
134
132
  ```typescript
135
133
  import {
136
134
  ReleaseApi,
137
- Configuration,
138
-
135
+ Configuration
139
136
  } from '@orangefox-recovery/foxclient';
140
137
 
141
138
  const configuration = new Configuration();
142
139
  const apiInstance = new ReleaseApi(configuration);
143
140
 
144
- let id: Array<any>; //Filter by Release IDs (optional) (default to undefined)
145
- let id2: Array<any>; //Filter by Release IDs (deprecated) (optional) (default to undefined)
141
+ let id: Array<string>; //Filter by Release IDs (optional) (default to undefined)
142
+ let id2: Array<string>; //Filter by Release IDs (deprecated) (optional) (default to undefined)
146
143
  let buildId: Array<string>; //Filter by Build IDs (optional) (default to undefined)
147
- let deviceId: Array<any>; //Filter by Device IDs (optional) (default to undefined)
148
- let maintainerId: Array<any>; //Filter by Maintainer IDs (optional) (default to undefined)
144
+ let deviceId: Array<string>; //Filter by Device IDs (optional) (default to undefined)
145
+ let maintainerId: Array<string>; //Filter by Maintainer IDs (optional) (default to undefined)
149
146
  let codename: Array<string>; //Filter by device codenames (optional) (default to undefined)
150
147
  let version: Array<string>; //Filter by release version (optional) (default to undefined)
151
148
  let type: Array<ReleaseType>; //Filter by release type (optional) (default to undefined)
152
149
  let archived: boolean; //Filter by the archived status (optional) (default to undefined)
153
150
  let freezed: boolean; //Filter by the freezed status (optional) (default to undefined)
154
- let afterReleaseId: ; //Show releases after the provided one (optional) (default to undefined)
151
+ let afterReleaseId: string; //Show releases after the provided one (optional) (default to undefined)
155
152
  let afterDate: number; //Show releases after the provided timestamp (optional) (default to undefined)
156
153
  let sort: ReleasesSort; //Sort mode (optional) (default to undefined)
157
154
  let group: boolean; //Group releases by version + variant. This will change the response! (optional) (default to undefined)
158
155
  let skip: number; //Skip query results (optional) (default to undefined)
159
156
  let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
160
157
 
161
- const { status, data } = await apiInstance.getReleasesReleasesGet(
158
+ const { status, data } = await apiInstance.getReleases(
162
159
  id,
163
160
  id2,
164
161
  buildId,
@@ -182,17 +179,17 @@ const { status, data } = await apiInstance.getReleasesReleasesGet(
182
179
 
183
180
  |Name | Type | Description | Notes|
184
181
  |------------- | ------------- | ------------- | -------------|
185
- | **id** | **Array&lt;any&gt;** | Filter by Release IDs | (optional) defaults to undefined|
186
- | **id2** | **Array&lt;any&gt;** | Filter by Release IDs (deprecated) | (optional) defaults to undefined|
182
+ | **id** | **Array&lt;string&gt;** | Filter by Release IDs | (optional) defaults to undefined|
183
+ | **id2** | **Array&lt;string&gt;** | Filter by Release IDs (deprecated) | (optional) defaults to undefined|
187
184
  | **buildId** | **Array&lt;string&gt;** | Filter by Build IDs | (optional) defaults to undefined|
188
- | **deviceId** | **Array&lt;any&gt;** | Filter by Device IDs | (optional) defaults to undefined|
189
- | **maintainerId** | **Array&lt;any&gt;** | Filter by Maintainer IDs | (optional) defaults to undefined|
185
+ | **deviceId** | **Array&lt;string&gt;** | Filter by Device IDs | (optional) defaults to undefined|
186
+ | **maintainerId** | **Array&lt;string&gt;** | Filter by Maintainer IDs | (optional) defaults to undefined|
190
187
  | **codename** | **Array&lt;string&gt;** | Filter by device codenames | (optional) defaults to undefined|
191
188
  | **version** | **Array&lt;string&gt;** | Filter by release version | (optional) defaults to undefined|
192
189
  | **type** | **Array&lt;ReleaseType&gt;** | Filter by release type | (optional) defaults to undefined|
193
190
  | **archived** | [**boolean**] | Filter by the archived status | (optional) defaults to undefined|
194
191
  | **freezed** | [**boolean**] | Filter by the freezed status | (optional) defaults to undefined|
195
- | **afterReleaseId** | **** | Show releases after the provided one | (optional) defaults to undefined|
192
+ | **afterReleaseId** | [**string**] | Show releases after the provided one | (optional) defaults to undefined|
196
193
  | **afterDate** | [**number**] | Show releases after the provided timestamp | (optional) defaults to undefined|
197
194
  | **sort** | **ReleasesSort** | Sort mode | (optional) defaults to undefined|
198
195
  | **group** | [**boolean**] | Group releases by version + variant. This will change the response! | (optional) defaults to undefined|
@@ -202,7 +199,7 @@ const { status, data } = await apiInstance.getReleasesReleasesGet(
202
199
 
203
200
  ### Return type
204
201
 
205
- **ResponseGetReleasesReleasesGet**
202
+ **ResponseGetReleases**
206
203
 
207
204
  ### Authorization
208
205
 
@@ -223,8 +220,8 @@ No authorization required
223
220
 
224
221
  [[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
222
 
226
- # **getUpdatesUpdatesLastKnownIdGet**
227
- > ListResponseShortReleaseResponse getUpdatesUpdatesLastKnownIdGet()
223
+ # **getUpdatesDeprecated**
224
+ > ListResponseShortReleaseResponse getUpdatesDeprecated()
228
225
 
229
226
  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
227
 
@@ -239,14 +236,14 @@ import {
239
236
  const configuration = new Configuration();
240
237
  const apiInstance = new ReleaseApi(configuration);
241
238
 
242
- let lastKnownId: any; // (default to undefined)
243
- let deviceId: Array<any>; //Filter by device ID (optional) (default to undefined)
239
+ let lastKnownId: string; // (default to undefined)
240
+ let deviceId: Array<string>; //Filter by device ID (optional) (default to undefined)
244
241
  let type: Array<ReleaseType>; //Filter by release type (optional) (default to undefined)
245
242
  let releaseType: Array<ReleaseType>; //Filter by release type (legacy) (optional) (default to undefined)
246
243
  let skip: number; //Skip query results (optional) (default to undefined)
247
244
  let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
248
245
 
249
- const { status, data } = await apiInstance.getUpdatesUpdatesLastKnownIdGet(
246
+ const { status, data } = await apiInstance.getUpdatesDeprecated(
250
247
  lastKnownId,
251
248
  deviceId,
252
249
  type,
@@ -260,8 +257,8 @@ const { status, data } = await apiInstance.getUpdatesUpdatesLastKnownIdGet(
260
257
 
261
258
  |Name | Type | Description | Notes|
262
259
  |------------- | ------------- | ------------- | -------------|
263
- | **lastKnownId** | **any** | | defaults to undefined|
264
- | **deviceId** | **Array&lt;any&gt;** | Filter by device ID | (optional) defaults to undefined|
260
+ | **lastKnownId** | [**string**] | | defaults to undefined|
261
+ | **deviceId** | **Array&lt;string&gt;** | Filter by device ID | (optional) defaults to undefined|
265
262
  | **type** | **Array&lt;ReleaseType&gt;** | Filter by release type | (optional) defaults to undefined|
266
263
  | **releaseType** | **Array&lt;ReleaseType&gt;** | Filter by release type (legacy) | (optional) defaults to undefined|
267
264
  | **skip** | [**number**] | Skip query results | (optional) defaults to undefined|
@@ -1,4 +1,4 @@
1
- # ResponseGetReleasesReleasesGet
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 { ResponseGetReleasesReleasesGet } from '@orangefox-recovery/foxclient';
14
+ import { ResponseGetReleases } from '@orangefox-recovery/foxclient';
15
15
 
16
- const instance: ResponseGetReleasesReleasesGet = {
16
+ const instance: ResponseGetReleases = {
17
17
  data,
18
18
  count,
19
19
  };
package/docs/StatsApi.md CHANGED
@@ -4,10 +4,10 @@ All URIs are relative to *https://api.orangefox.download*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**publicStatsStatsGet**](#publicstatsstatsget) | **GET** /stats/ | Public Stats|
7
+ |[**getPublicStats**](#getpublicstats) | **GET** /stats/ | Public Stats|
8
8
 
9
- # **publicStatsStatsGet**
10
- > GlobalStatsAggregationModel publicStatsStatsGet()
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.publicStatsStatsGet();
25
+ const { status, data } = await apiInstance.getPublicStats();
26
26
  ```
27
27
 
28
28
  ### Parameters
package/index.ts CHANGED
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Fox API
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 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
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.2.0
7
+ * The version of the OpenAPI document: 5.2.2
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orangefox-recovery/foxclient",
3
- "version": "5.2.0",
3
+ "version": "5.2.2",
4
4
  "description": "OpenAPI client for @orangefox-recovery/foxclient",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {