@orangefox-recovery/foxclient 5.3.3 → 5.4.0

package/dist/models/ReleasesSort.d.ts

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

package/dist/models/ReleasesSort.js

@@ -5,7 +5,7 @@
  * 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 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.3.3
+ * The version of the OpenAPI document: 5.4.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ResponseGetReleases.d.ts

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

package/dist/models/ResponseGetReleases.js

@@ -5,7 +5,7 @@
  * 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 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.3.3
+ * The version of the OpenAPI document: 5.4.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ShortDeviceResponse.d.ts

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

package/dist/models/ShortDeviceResponse.js

@@ -5,7 +5,7 @@
  * 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 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.3.3
+ * The version of the OpenAPI document: 5.4.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ShortReleaseResponse.d.ts

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

package/dist/models/ShortReleaseResponse.js

@@ -5,7 +5,7 @@
  * 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 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.3.3
+ * The version of the OpenAPI document: 5.4.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/models/ValidationError.d.ts

@@ -2,14 +2,14 @@
  * 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 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.3.3
+ * The version of the OpenAPI document: 5.4.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { ValidationErrorLocInner } from './ValidationErrorLocInner';
+import type { LocationInner } from './LocationInner';
 /**
  *
  * @export
@@ -18,10 +18,10 @@ import type { ValidationErrorLocInner } from './ValidationErrorLocInner';
 export interface ValidationError {
     /**
      *
-     * @type {Array<ValidationErrorLocInner>}
+     * @type {Array<LocationInner>}
      * @memberof ValidationError
      */
-    loc: Array<ValidationErrorLocInner>;
+    loc: Array<LocationInner>;
     /**
      *
      * @type {string}
@@ -34,6 +34,18 @@ export interface ValidationError {
      * @memberof ValidationError
      */
     type: string;
+    /**
+     *
+     * @type {any}
+     * @memberof ValidationError
+     */
+    input?: any | null;
+    /**
+     *
+     * @type {object}
+     * @memberof ValidationError
+     */
+    ctx?: object;
 }
 /**
  * Check if a given object implements the ValidationError interface.

package/dist/models/ValidationError.js

@@ -5,7 +5,7 @@
  * 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 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.3.3
+ * The version of the OpenAPI document: 5.4.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,7 +18,7 @@ exports.ValidationErrorFromJSON = ValidationErrorFromJSON;
 exports.ValidationErrorFromJSONTyped = ValidationErrorFromJSONTyped;
 exports.ValidationErrorToJSON = ValidationErrorToJSON;
 exports.ValidationErrorToJSONTyped = ValidationErrorToJSONTyped;
-const ValidationErrorLocInner_1 = require("./ValidationErrorLocInner");
+const LocationInner_1 = require("./LocationInner");
 /**
  * Check if a given object implements the ValidationError interface.
  */
@@ -39,9 +39,11 @@ function ValidationErrorFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'loc': (json['loc'].map(ValidationErrorLocInner_1.ValidationErrorLocInnerFromJSON)),
+        'loc': (json['loc'].map(LocationInner_1.LocationInnerFromJSON)),
         'msg': json['msg'],
         'type': json['type'],
+        'input': json['input'] == null ? undefined : json['input'],
+        'ctx': json['ctx'] == null ? undefined : json['ctx'],
     };
 }
 function ValidationErrorToJSON(json) {
@@ -52,8 +54,10 @@ function ValidationErrorToJSONTyped(value, ignoreDiscriminator = false) {
         return value;
     }
     return {
-        'loc': (value['loc'].map(ValidationErrorLocInner_1.ValidationErrorLocInnerToJSON)),
+        'loc': (value['loc'].map(LocationInner_1.LocationInnerToJSON)),
         'msg': value['msg'],
         'type': value['type'],
+        'input': value['input'],
+        'ctx': value['ctx'],
     };
 }

package/dist/models/index.d.ts

@@ -5,6 +5,7 @@ export * from './ListResponseReleaseResponse';
 export * from './ListResponseShortDeviceResponse';
 export * from './ListResponseShortReleaseResponse';
 export * from './ListResponseStr';
+export * from './LocationInner';
 export * from './MaintainerShortModel';
 export * from './PasteInput';
 export * from './PasteOutput';
@@ -17,4 +18,3 @@ export * from './ResponseGetReleases';
 export * from './ShortDeviceResponse';
 export * from './ShortReleaseResponse';
 export * from './ValidationError';
-export * from './ValidationErrorLocInner';

package/dist/models/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./ListResponseReleaseResponse"), exports);
 __exportStar(require("./ListResponseShortDeviceResponse"), exports);
 __exportStar(require("./ListResponseShortReleaseResponse"), exports);
 __exportStar(require("./ListResponseStr"), exports);
+__exportStar(require("./LocationInner"), exports);
 __exportStar(require("./MaintainerShortModel"), exports);
 __exportStar(require("./PasteInput"), exports);
 __exportStar(require("./PasteOutput"), exports);
@@ -35,4 +36,3 @@ __exportStar(require("./ResponseGetReleases"), exports);
 __exportStar(require("./ShortDeviceResponse"), exports);
 __exportStar(require("./ShortReleaseResponse"), exports);
 __exportStar(require("./ValidationError"), exports);
-__exportStar(require("./ValidationErrorLocInner"), exports);

package/dist/runtime.d.ts

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

package/dist/runtime.js

@@ -5,7 +5,7 @@
  * 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 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.3.3
+ * The version of the OpenAPI document: 5.4.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -232,6 +232,11 @@ class ResponseError extends Error {
         super(msg);
         this.response = response;
         this.name = "ResponseError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 exports.ResponseError = ResponseError;
@@ -240,6 +245,11 @@ class FetchError extends Error {
         super(msg);
         this.cause = cause;
         this.name = "FetchError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 exports.FetchError = FetchError;
@@ -248,6 +258,11 @@ class RequiredError extends Error {
         super(msg);
         this.field = field;
         this.name = "RequiredError";
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
     }
 }
 exports.RequiredError = RequiredError;

package/docs/DeviceApi.md

@@ -17,7 +17,7 @@ All URIs are relative to *https://api.orangefox.download*
 
 Get Device
 
-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.
+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
 
@@ -162,7 +162,7 @@ No authorization required
 
 Get Devices
 
-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.
+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.
 
 ### Example
 

package/docs/{ValidationErrorLocInner.md → LocationInner.md}

@@ -1,5 +1,5 @@
 
-# ValidationErrorLocInner
+# LocationInner
 
 
 ## Properties
@@ -10,11 +10,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ValidationErrorLocInner } from '@orangefox-recovery/foxclient'
+import type { LocationInner } from '@orangefox-recovery/foxclient'
 
 // TODO: Update the object below with actual values
 const example = {
-} satisfies ValidationErrorLocInner
+} satisfies LocationInner
 
 console.log(example)
 
@@ -23,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ValidationErrorLocInner
+const exampleParsed = JSON.parse(exampleJSON) as LocationInner
 console.log(exampleParsed)
 ```
 

package/docs/ReleaseApi.md

@@ -162,7 +162,7 @@ No authorization required
 
 Get Releases
 
-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.
+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.
 
 ### Example
 

package/docs/ValidationError.md

@@ -6,9 +6,11 @@
 
 Name | Type
 ------------ | -------------
-`loc` | [Array<ValidationErrorLocInner>](ValidationErrorLocInner.md)
+`loc` | [Array<LocationInner>](LocationInner.md)
 `msg` | string
 `type` | string
+`input` | any
+`ctx` | object
 
 ## Example
 
@@ -20,6 +22,8 @@ const example = {
   "loc": null,
   "msg": null,
   "type": null,
+  "input": null,
+  "ctx": null,
 } satisfies ValidationError
 
 console.log(example)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orangefox-recovery/foxclient",
-  "version": "5.3.3",
+  "version": "5.4.0",
   "description": "OpenAPI client for @orangefox-recovery/foxclient",
   "author": "OpenAPI-Generator",
   "repository": {
@@ -29,7 +29,6 @@
   },
   "keywords": [],
   "license": "ISC",
-  "type": "commonjs",
   "bugs": {
     "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"
   },