@orangefox-recovery/foxclient 5.2.0 → 5.2.1

package/docs/DeviceApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://api.orangefox.download*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getDeviceDevicesGetGet**](#getdevicedevicesgetget) | **GET** /devices/get | Get Device|
-|[**getDeviceShortDevicesDeviceIdGet**](#getdeviceshortdevicesdeviceidget) | **GET** /devices/{device_id} | Get Device Short|
-|[**getDevicesDevicesGet**](#getdevicesdevicesget) | **GET** /devices/ | Get Devices|
-|[**getOemsListOemsGet**](#getoemslistoemsget) | **GET** /oems/ | Get Oems List|
+|[**getDevice**](#getdevice) | **GET** /devices/get | Get Device|
+|[**getDeviceDeprecated**](#getdevicedeprecated) | **GET** /devices/{device_id} | Get Device Short|
+|[**getDevices**](#getdevices) | **GET** /devices/ | Get Devices|
+|[**getOems**](#getoems) | **GET** /oems/ | Get Oems|
 
-# **getDeviceDevicesGetGet**
-> DeviceResponse getDeviceDevicesGetGet()
+# **getDevice**
+> DeviceResponse getDevice()
 
 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.
 
@@ -31,7 +31,7 @@ let deviceId: ; // (optional) (default to undefined)
 let id: ; //Filter by Device ID (deprecated) (optional) (default to undefined)
 let codename: string; //Not recommended to use when you can (optional) (default to undefined)
 
-const { status, data } = await apiInstance.getDeviceDevicesGetGet(
+const { status, data } = await apiInstance.getDevice(
     deviceId,
     id,
     codename
@@ -71,8 +71,8 @@ No authorization required
 
 [[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)
 
-# **getDeviceShortDevicesDeviceIdGet**
-> DeviceResponse getDeviceShortDevicesDeviceIdGet()
+# **getDeviceDeprecated**
+> DeviceResponse getDeviceDeprecated()
 
 Gets device info using device ID.
 
@@ -89,7 +89,7 @@ const apiInstance = new DeviceApi(configuration);
 
 let deviceId: string; // (default to undefined)
 
-const { status, data } = await apiInstance.getDeviceShortDevicesDeviceIdGet(
+const { status, data } = await apiInstance.getDeviceDeprecated(
     deviceId
 );
 ```
@@ -124,8 +124,8 @@ No authorization required
 
 [[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)
 
-# **getDevicesDevicesGet**
-> ListResponseShortDeviceResponse getDevicesDevicesGet()
+# **getDevices**
+> ListResponseShortDeviceResponse getDevices()
 
 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.
 
@@ -152,7 +152,7 @@ let hasReleases: boolean; //Filter by has releases status (optional) (default to
 let skip: number; //Skip query results (optional) (default to undefined)
 let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
 
-const { status, data } = await apiInstance.getDevicesDevicesGet(
+const { status, data } = await apiInstance.getDevices(
     id,
     id2,
     oemName,
@@ -207,8 +207,8 @@ No authorization required
 
 [[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)
 
-# **getOemsListOemsGet**
-> ListResponseStr getOemsListOemsGet()
+# **getOems**
+> ListResponseStr getOems()
 
 Lists all OEM names
 
@@ -223,7 +223,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new DeviceApi(configuration);
 
-const { status, data } = await apiInstance.getOemsListOemsGet();
+const { status, data } = await apiInstance.getOems();
 ```
 
 ### Parameters

package/docs/ReleaseApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://api.orangefox.download*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getReleaseReleasesGetGet**](#getreleasereleasesgetget) | **GET** /releases/get | Get Release|
-|[**getReleaseShortReleasesReleaseIdGet**](#getreleaseshortreleasesreleaseidget) | **GET** /releases/{release_id} | Get Release Short|
-|[**getReleasesReleasesGet**](#getreleasesreleasesget) | **GET** /releases/ | Get Releases|
-|[**getUpdatesUpdatesLastKnownIdGet**](#getupdatesupdateslastknownidget) | **GET** /updates/{last_known_id} | Get Updates|
+|[**getRelease**](#getrelease) | **GET** /releases/get | Get Release|
+|[**getReleaseDeprecated**](#getreleasedeprecated) | **GET** /releases/{release_id} | Get Release Short|
+|[**getReleases**](#getreleases) | **GET** /releases/ | Get Releases|
+|[**getUpdatesDeprecated**](#getupdatesdeprecated) | **GET** /updates/{last_known_id} | Get Updates|
 
-# **getReleaseReleasesGetGet**
-> ReleaseResponse getReleaseReleasesGetGet()
+# **getRelease**
+> ReleaseResponse getRelease()
 
 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!
 
@@ -32,7 +32,7 @@ let id: ; //Release ID (deprecated) (optional) (default to undefined)
 let buildId: string; //Build ID, `ro.build.fox_id` prop (optional) (default to undefined)
 let filename: string; // (optional) (default to undefined)
 
-const { status, data } = await apiInstance.getReleaseReleasesGetGet(
+const { status, data } = await apiInstance.getRelease(
     releaseId,
     id,
     buildId,
@@ -72,8 +72,8 @@ No authorization required
 
 [[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)
 
-# **getReleaseShortReleasesReleaseIdGet**
-> ReleaseResponse getReleaseShortReleasesReleaseIdGet()
+# **getReleaseDeprecated**
+> ReleaseResponse getReleaseDeprecated()
 
 Gets release information using the release ID, nothing to discuss really.
 
@@ -90,7 +90,7 @@ const apiInstance = new ReleaseApi(configuration);
 
 let releaseId: any; // (default to undefined)
 
-const { status, data } = await apiInstance.getReleaseShortReleasesReleaseIdGet(
+const { status, data } = await apiInstance.getReleaseDeprecated(
     releaseId
 );
 ```
@@ -124,8 +124,8 @@ No authorization required
 
 [[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)
 
-# **getReleasesReleasesGet**
-> ResponseGetReleasesReleasesGet getReleasesReleasesGet()
+# **getReleases**
+> ResponseGetReleases getReleases()
 
 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.
 
@@ -158,7 +158,7 @@ let group: boolean; //Group releases by version + variant. This will change the
 let skip: number; //Skip query results (optional) (default to undefined)
 let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
 
-const { status, data } = await apiInstance.getReleasesReleasesGet(
+const { status, data } = await apiInstance.getReleases(
     id,
     id2,
     buildId,
@@ -202,7 +202,7 @@ const { status, data } = await apiInstance.getReleasesReleasesGet(
 
 ### Return type
 
-**ResponseGetReleasesReleasesGet**
+**ResponseGetReleases**
 
 ### Authorization
 
@@ -223,8 +223,8 @@ No authorization required
 
 [[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)
 
-# **getUpdatesUpdatesLastKnownIdGet**
-> ListResponseShortReleaseResponse getUpdatesUpdatesLastKnownIdGet()
+# **getUpdatesDeprecated**
+> ListResponseShortReleaseResponse getUpdatesDeprecated()
 
 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!
 
@@ -246,7 +246,7 @@ let releaseType: Array<ReleaseType>; //Filter by release type (legacy) (optional
 let skip: number; //Skip query results (optional) (default to undefined)
 let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
 
-const { status, data } = await apiInstance.getUpdatesUpdatesLastKnownIdGet(
+const { status, data } = await apiInstance.getUpdatesDeprecated(
     lastKnownId,
     deviceId,
     type,

package/docs/{ResponseGetReleasesReleasesGet.md → ResponseGetReleases.md}

@@ -1,4 +1,4 @@
-# ResponseGetReleasesReleasesGet
+# ResponseGetReleases
 
 
 ## Properties
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { ResponseGetReleasesReleasesGet } from '@orangefox-recovery/foxclient';
+import { ResponseGetReleases } from '@orangefox-recovery/foxclient';
 
-const instance: ResponseGetReleasesReleasesGet = {
+const instance: ResponseGetReleases = {
     data,
     count,
 };

package/docs/StatsApi.md

@@ -4,10 +4,10 @@ All URIs are relative to *https://api.orangefox.download*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**publicStatsStatsGet**](#publicstatsstatsget) | **GET** /stats/ | Public Stats|
+|[**getPublicStats**](#getpublicstats) | **GET** /stats/ | Public Stats|
 
-# **publicStatsStatsGet**
-> GlobalStatsAggregationModel publicStatsStatsGet()
+# **getPublicStats**
+> GlobalStatsAggregationModel getPublicStats()
 
 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.
 
@@ -22,7 +22,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new StatsApi(configuration);
 
-const { status, data } = await apiInstance.publicStatsStatsGet();
+const { status, data } = await apiInstance.getPublicStats();
 ```
 
 ### Parameters

package/index.ts

@@ -2,9 +2,9 @@
 /* eslint-disable */
 /**
  * Fox API
- *  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. 
+ *  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. 
  *
- * The version of the OpenAPI document: 5.2.0
+ * The version of the OpenAPI document: 5.2.1
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orangefox-recovery/foxclient",
-  "version": "5.2.0",
+  "version": "5.2.1",
   "description": "OpenAPI client for @orangefox-recovery/foxclient",
   "author": "OpenAPI-Generator Contributors",
   "repository": {