@orangefox-recovery/foxclient 1.0.0 → 5.2.0

package/dist/esm/common.d.ts

@@ -1,8 +1,8 @@
 /**
  * Fox API
- *  Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' 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 20 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.1.1
+ * The version of the OpenAPI document: 5.2.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -2,9 +2,9 @@
 /* eslint-disable */
 /**
  * Fox API
- *  Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' 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 20 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.1.1
+ * The version of the OpenAPI document: 5.2.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -1,8 +1,8 @@
 /**
  * Fox API
- *  Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' 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 20 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.1.1
+ * The version of the OpenAPI document: 5.2.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -2,9 +2,9 @@
 /* eslint-disable */
 /**
  * Fox API
- *  Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' 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 20 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.1.1
+ * The version of the OpenAPI document: 5.2.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -1,8 +1,8 @@
 /**
  * Fox API
- *  Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' 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 20 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.1.1
+ * The version of the OpenAPI document: 5.2.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -2,9 +2,9 @@
 /* eslint-disable */
 /**
  * Fox API
- *  Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' 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 20 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.1.1
+ * The version of the OpenAPI document: 5.2.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 /**
  * Fox API
- *  Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' 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 20 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.1.1
+ * The version of the OpenAPI document: 5.2.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -3,9 +3,9 @@
 /* eslint-disable */
 /**
  * Fox API
- *  Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' 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 20 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.1.1
+ * The version of the OpenAPI document: 5.2.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/DeviceApi.md

@@ -1,34 +1,40 @@
 # DeviceApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://api.orangefox.download*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getDeviceDevicesDeviceIdGet**](#getdevicedevicesdeviceidget) | **GET** /devices/{device_id} | Get Device|
-|[**getDeviceExtendedDevicesGetGet**](#getdeviceextendeddevicesgetget) | **GET** /devices/get | Get Device Extended|
-|[**getDevicesListDevicesGet**](#getdeviceslistdevicesget) | **GET** /devices/ | Get Devices List|
+|[**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|
 
-# **getDeviceDevicesDeviceIdGet**
-> DeviceResponse getDeviceDevicesDeviceIdGet()
+# **getDeviceDevicesGetGet**
+> DeviceResponse getDeviceDevicesGetGet()
 
-Gets device info using device ID.
+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.
 
 ### Example
 
 ```typescript
 import {
     DeviceApi,
-    Configuration
+    Configuration,
+    ,
+    
 } from '@orangefox-recovery/foxclient';
 
 const configuration = new Configuration();
 const apiInstance = new DeviceApi(configuration);
 
-let deviceId: string; // (default to undefined)
+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.getDeviceDevicesDeviceIdGet(
-    deviceId
+const { status, data } = await apiInstance.getDeviceDevicesGetGet(
+    deviceId,
+    id,
+    codename
 );
 ```
 
@@ -36,7 +42,9 @@ const { status, data } = await apiInstance.getDeviceDevicesDeviceIdGet(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **deviceId** | [**string**] |  | defaults to undefined|
+| **deviceId** | **** |  | (optional) defaults to undefined|
+| **id** | **** | Filter by Device ID (deprecated) | (optional) defaults to undefined|
+| **codename** | [**string**] | Not recommended to use when you can | (optional) defaults to undefined|
 
 
 ### Return type
@@ -45,7 +53,7 @@ const { status, data } = await apiInstance.getDeviceDevicesDeviceIdGet(
 
 ### Authorization
 
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
+No authorization required
 
 ### HTTP request headers
 
@@ -58,36 +66,31 @@ const { status, data } = await apiInstance.getDeviceDevicesDeviceIdGet(
 |-------------|-------------|------------------|
 |**200** | Successful Response |  -  |
 |**404** | Item not found |  -  |
+|**400** | Bad request |  -  |
 |**422** | Validation Error |  -  |
 
 [[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)
 
-# **getDeviceExtendedDevicesGetGet**
-> DeviceResponse getDeviceExtendedDevicesGetGet()
+# **getDeviceShortDevicesDeviceIdGet**
+> DeviceResponse getDeviceShortDevicesDeviceIdGet()
 
-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.
+Gets device info using device ID.
 
 ### Example
 
 ```typescript
 import {
     DeviceApi,
-    Configuration,
-    ,
-    
+    Configuration
 } from '@orangefox-recovery/foxclient';
 
 const configuration = new Configuration();
 const apiInstance = new DeviceApi(configuration);
 
-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)
+let deviceId: string; // (default to undefined)
 
-const { status, data } = await apiInstance.getDeviceExtendedDevicesGetGet(
-    deviceId,
-    id,
-    codename
+const { status, data } = await apiInstance.getDeviceShortDevicesDeviceIdGet(
+    deviceId
 );
 ```
 
@@ -95,9 +98,7 @@ const { status, data } = await apiInstance.getDeviceExtendedDevicesGetGet(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **deviceId** | **** |  | (optional) defaults to undefined|
-| **id** | **** | Filter by Device ID (deprecated) | (optional) defaults to undefined|
-| **codename** | [**string**] | Not recommended to use when you can | (optional) defaults to undefined|
+| **deviceId** | [**string**] |  | defaults to undefined|
 
 
 ### Return type
@@ -106,7 +107,7 @@ const { status, data } = await apiInstance.getDeviceExtendedDevicesGetGet(
 
 ### Authorization
 
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
+No authorization required
 
 ### HTTP request headers
 
@@ -119,13 +120,12 @@ const { status, data } = await apiInstance.getDeviceExtendedDevicesGetGet(
 |-------------|-------------|------------------|
 |**200** | Successful Response |  -  |
 |**404** | Item not found |  -  |
-|**400** | Bad request |  -  |
 |**422** | Validation Error |  -  |
 
 [[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)
 
-# **getDevicesListDevicesGet**
-> ListResponseShortDeviceResponse getDevicesListDevicesGet()
+# **getDevicesDevicesGet**
+> ListResponseShortDeviceResponse getDevicesDevicesGet()
 
 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.getDevicesListDevicesGet(
+const { status, data } = await apiInstance.getDevicesDevicesGet(
     id,
     id2,
     oemName,
@@ -190,7 +190,7 @@ const { status, data } = await apiInstance.getDevicesListDevicesGet(
 
 ### Authorization
 
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
+No authorization required
 
 ### HTTP request headers
 
@@ -236,7 +236,7 @@ This endpoint does not have any parameters.
 
 ### Authorization
 
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
+No authorization required
 
 ### HTTP request headers
 

package/docs/ReleaseApi.md

@@ -1,16 +1,16 @@
 # ReleaseApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://api.orangefox.download*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**getReleaseExtendedReleasesGetGet**](#getreleaseextendedreleasesgetget) | **GET** /releases/get | Get Release Extended|
-|[**getReleaseReleasesReleaseIdGet**](#getreleasereleasesreleaseidget) | **GET** /releases/{release_id} | Get Release|
+|[**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|
 
-# **getReleaseExtendedReleasesGetGet**
-> ReleaseResponse getReleaseExtendedReleasesGetGet()
+# **getReleaseReleasesGetGet**
+> ReleaseResponse getReleaseReleasesGetGet()
 
 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.getReleaseExtendedReleasesGetGet(
+const { status, data } = await apiInstance.getReleaseReleasesGetGet(
     releaseId,
     id,
     buildId,
@@ -56,7 +56,7 @@ const { status, data } = await apiInstance.getReleaseExtendedReleasesGetGet(
 
 ### Authorization
 
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
+No authorization required
 
 ### HTTP request headers
 
@@ -72,8 +72,8 @@ const { status, data } = await apiInstance.getReleaseExtendedReleasesGetGet(
 
 [[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)
 
-# **getReleaseReleasesReleaseIdGet**
-> ReleaseResponse getReleaseReleasesReleaseIdGet()
+# **getReleaseShortReleasesReleaseIdGet**
+> ReleaseResponse getReleaseShortReleasesReleaseIdGet()
 
 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.getReleaseReleasesReleaseIdGet(
+const { status, data } = await apiInstance.getReleaseShortReleasesReleaseIdGet(
     releaseId
 );
 ```
@@ -108,7 +108,7 @@ const { status, data } = await apiInstance.getReleaseReleasesReleaseIdGet(
 
 ### Authorization
 
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
+No authorization required
 
 ### HTTP request headers
 
@@ -206,7 +206,7 @@ const { status, data } = await apiInstance.getReleasesReleasesGet(
 
 ### Authorization
 
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
+No authorization required
 
 ### HTTP request headers
 
@@ -274,7 +274,7 @@ const { status, data } = await apiInstance.getUpdatesUpdatesLastKnownIdGet(
 
 ### Authorization
 
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
+No authorization required
 
 ### HTTP request headers
 

package/docs/StatsApi.md

@@ -1,6 +1,6 @@
 # StatsApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://api.orangefox.download*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -35,7 +35,7 @@ This endpoint does not have any parameters.
 
 ### Authorization
 
-[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
+No authorization required
 
 ### HTTP request headers
 

package/index.ts

@@ -2,9 +2,9 @@
 /* eslint-disable */
 /**
  * Fox API
- *  Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' 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 20 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.1.1
+ * The version of the OpenAPI document: 5.2.0
  * 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": "1.0.0",
+  "version": "5.2.0",
   "description": "OpenAPI client for @orangefox-recovery/foxclient",
   "author": "OpenAPI-Generator Contributors",
   "repository": {