@orangefox-recovery/foxclient 5.1.1 → 5.2.0

package/dist/api.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).
@@ -55,17 +55,16 @@ exports.ReleasesSort = {
 const DeviceApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * 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.
          * @summary Get Device
-         * @param {string} deviceId
+         * @param { | null} [deviceId]
+         * @param { | null} [id] Filter by Device ID (deprecated)
+         * @param {string | null} [codename] Not recommended to use when you can
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDeviceDevicesDeviceIdGet: (deviceId_1, ...args_1) => __awaiter(this, [deviceId_1, ...args_1], void 0, function* (deviceId, options = {}) {
-            // verify required parameter 'deviceId' is not null or undefined
-            (0, common_1.assertParamExists)('getDeviceDevicesDeviceIdGet', 'deviceId', deviceId);
-            const localVarPath = `/devices/{device_id}`
-                .replace(`{${"device_id"}}`, encodeURIComponent(String(deviceId)));
+        getDeviceDevicesGetGet: (deviceId_1, id_1, codename_1, ...args_1) => __awaiter(this, [deviceId_1, id_1, codename_1, ...args_1], void 0, function* (deviceId, id, codename, options = {}) {
+            const localVarPath = `/devices/get`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -75,12 +74,19 @@ const DeviceApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication oauth2_password required
-            // oauth required
-            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2_password", [], configuration);
-            // authentication bearer_auth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            if (deviceId !== undefined) {
+                for (const [key, value] of Object.entries(deviceId)) {
+                    localVarQueryParameter[key] = value;
+                }
+            }
+            if (id !== undefined) {
+                for (const [key, value] of Object.entries(id)) {
+                    localVarQueryParameter[key] = value;
+                }
+            }
+            if (codename !== undefined) {
+                localVarQueryParameter['codename'] = codename;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -90,16 +96,18 @@ const DeviceApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * 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.
-         * @summary Get Device Extended
-         * @param { | null} [deviceId]
-         * @param { | null} [id] Filter by Device ID (deprecated)
-         * @param {string | null} [codename] Not recommended to use when you can
+         * Gets device info using device ID.
+         * @summary Get Device Short
+         * @param {string} deviceId
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
-        getDeviceExtendedDevicesGetGet: (deviceId_1, id_1, codename_1, ...args_1) => __awaiter(this, [deviceId_1, id_1, codename_1, ...args_1], void 0, function* (deviceId, id, codename, options = {}) {
-            const localVarPath = `/devices/get`;
+        getDeviceShortDevicesDeviceIdGet: (deviceId_1, ...args_1) => __awaiter(this, [deviceId_1, ...args_1], void 0, function* (deviceId, options = {}) {
+            // verify required parameter 'deviceId' is not null or undefined
+            (0, common_1.assertParamExists)('getDeviceShortDevicesDeviceIdGet', 'deviceId', deviceId);
+            const localVarPath = `/devices/{device_id}`
+                .replace(`{${"device_id"}}`, encodeURIComponent(String(deviceId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -109,25 +117,6 @@ const DeviceApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication oauth2_password required
-            // oauth required
-            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2_password", [], configuration);
-            // authentication bearer_auth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
-            if (deviceId !== undefined) {
-                for (const [key, value] of Object.entries(deviceId)) {
-                    localVarQueryParameter[key] = value;
-                }
-            }
-            if (id !== undefined) {
-                for (const [key, value] of Object.entries(id)) {
-                    localVarQueryParameter[key] = value;
-                }
-            }
-            if (codename !== undefined) {
-                localVarQueryParameter['codename'] = codename;
-            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -138,7 +127,7 @@ const DeviceApiAxiosParamCreator = function (configuration) {
         }),
         /**
          * 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.
-         * @summary Get Devices List
+         * @summary Get Devices
          * @param {Array<any>} [id] Filter by Device IDs
          * @param {Array<any>} [id2] Filter by Device IDs (deprecated)
          * @param {Array<string>} [oemName] Filter by OEM names
@@ -153,7 +142,7 @@ const DeviceApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDevicesListDevicesGet: (id_1, id2_1, oemName_1, codename_1, modelName_1, supported_1, maintainer_1, freezed_1, hasReleases_1, skip_1, limit_1, ...args_1) => __awaiter(this, [id_1, id2_1, oemName_1, codename_1, modelName_1, supported_1, maintainer_1, freezed_1, hasReleases_1, skip_1, limit_1, ...args_1], void 0, function* (id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options = {}) {
+        getDevicesDevicesGet: (id_1, id2_1, oemName_1, codename_1, modelName_1, supported_1, maintainer_1, freezed_1, hasReleases_1, skip_1, limit_1, ...args_1) => __awaiter(this, [id_1, id2_1, oemName_1, codename_1, modelName_1, supported_1, maintainer_1, freezed_1, hasReleases_1, skip_1, limit_1, ...args_1], void 0, function* (id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options = {}) {
             const localVarPath = `/devices/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -164,12 +153,6 @@ const DeviceApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication oauth2_password required
-            // oauth required
-            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2_password", [], configuration);
-            // authentication bearer_auth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
             if (id) {
                 localVarQueryParameter['id'] = id;
             }
@@ -228,12 +211,6 @@ const DeviceApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication oauth2_password required
-            // oauth required
-            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2_password", [], configuration);
-            // authentication bearer_auth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -253,42 +230,43 @@ const DeviceApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.DeviceApiAxiosParamCreator)(configuration);
     return {
         /**
-         * 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.
          * @summary Get Device
-         * @param {string} deviceId
+         * @param { | null} [deviceId]
+         * @param { | null} [id] Filter by Device ID (deprecated)
+         * @param {string | null} [codename] Not recommended to use when you can
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDeviceDevicesDeviceIdGet(deviceId, options) {
+        getDeviceDevicesGetGet(deviceId, id, codename, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeviceDevicesDeviceIdGet(deviceId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeviceDevicesGetGet(deviceId, id, codename, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getDeviceDevicesDeviceIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getDeviceDevicesGetGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
         /**
-         * 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.
-         * @summary Get Device Extended
-         * @param { | null} [deviceId]
-         * @param { | null} [id] Filter by Device ID (deprecated)
-         * @param {string | null} [codename] Not recommended to use when you can
+         * Gets device info using device ID.
+         * @summary Get Device Short
+         * @param {string} deviceId
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
-        getDeviceExtendedDevicesGetGet(deviceId, id, codename, options) {
+        getDeviceShortDevicesDeviceIdGet(deviceId, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeviceExtendedDevicesGetGet(deviceId, id, codename, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeviceShortDevicesDeviceIdGet(deviceId, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getDeviceExtendedDevicesGetGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getDeviceShortDevicesDeviceIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
         /**
          * 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.
-         * @summary Get Devices List
+         * @summary Get Devices
          * @param {Array<any>} [id] Filter by Device IDs
          * @param {Array<any>} [id2] Filter by Device IDs (deprecated)
          * @param {Array<string>} [oemName] Filter by OEM names
@@ -303,12 +281,12 @@ const DeviceApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDevicesListDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
+        getDevicesDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDevicesListDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDevicesDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getDevicesListDevicesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getDevicesDevicesGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
@@ -338,30 +316,31 @@ const DeviceApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.DeviceApiFp)(configuration);
     return {
         /**
-         * 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.
          * @summary Get Device
-         * @param {string} deviceId
+         * @param { | null} [deviceId]
+         * @param { | null} [id] Filter by Device ID (deprecated)
+         * @param {string | null} [codename] Not recommended to use when you can
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDeviceDevicesDeviceIdGet(deviceId, options) {
-            return localVarFp.getDeviceDevicesDeviceIdGet(deviceId, options).then((request) => request(axios, basePath));
+        getDeviceDevicesGetGet(deviceId, id, codename, options) {
+            return localVarFp.getDeviceDevicesGetGet(deviceId, id, codename, options).then((request) => request(axios, basePath));
         },
         /**
-         * 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.
-         * @summary Get Device Extended
-         * @param { | null} [deviceId]
-         * @param { | null} [id] Filter by Device ID (deprecated)
-         * @param {string | null} [codename] Not recommended to use when you can
+         * Gets device info using device ID.
+         * @summary Get Device Short
+         * @param {string} deviceId
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
-        getDeviceExtendedDevicesGetGet(deviceId, id, codename, options) {
-            return localVarFp.getDeviceExtendedDevicesGetGet(deviceId, id, codename, options).then((request) => request(axios, basePath));
+        getDeviceShortDevicesDeviceIdGet(deviceId, options) {
+            return localVarFp.getDeviceShortDevicesDeviceIdGet(deviceId, options).then((request) => request(axios, basePath));
         },
         /**
          * 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.
-         * @summary Get Devices List
+         * @summary Get Devices
          * @param {Array<any>} [id] Filter by Device IDs
          * @param {Array<any>} [id2] Filter by Device IDs (deprecated)
          * @param {Array<string>} [oemName] Filter by OEM names
@@ -376,8 +355,8 @@ const DeviceApiFactory = function (configuration, basePath, axios) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDevicesListDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
-            return localVarFp.getDevicesListDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(axios, basePath));
+        getDevicesDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
+            return localVarFp.getDevicesDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(axios, basePath));
         },
         /**
          * Lists all OEM names
@@ -399,32 +378,33 @@ exports.DeviceApiFactory = DeviceApiFactory;
  */
 class DeviceApi extends base_1.BaseAPI {
     /**
-     * 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.
      * @summary Get Device
-     * @param {string} deviceId
+     * @param { | null} [deviceId]
+     * @param { | null} [id] Filter by Device ID (deprecated)
+     * @param {string | null} [codename] Not recommended to use when you can
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DeviceApi
      */
-    getDeviceDevicesDeviceIdGet(deviceId, options) {
-        return (0, exports.DeviceApiFp)(this.configuration).getDeviceDevicesDeviceIdGet(deviceId, options).then((request) => request(this.axios, this.basePath));
+    getDeviceDevicesGetGet(deviceId, id, codename, options) {
+        return (0, exports.DeviceApiFp)(this.configuration).getDeviceDevicesGetGet(deviceId, id, codename, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * 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.
-     * @summary Get Device Extended
-     * @param { | null} [deviceId]
-     * @param { | null} [id] Filter by Device ID (deprecated)
-     * @param {string | null} [codename] Not recommended to use when you can
+     * Gets device info using device ID.
+     * @summary Get Device Short
+     * @param {string} deviceId
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof DeviceApi
      */
-    getDeviceExtendedDevicesGetGet(deviceId, id, codename, options) {
-        return (0, exports.DeviceApiFp)(this.configuration).getDeviceExtendedDevicesGetGet(deviceId, id, codename, options).then((request) => request(this.axios, this.basePath));
+    getDeviceShortDevicesDeviceIdGet(deviceId, options) {
+        return (0, exports.DeviceApiFp)(this.configuration).getDeviceShortDevicesDeviceIdGet(deviceId, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * 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.
-     * @summary Get Devices List
+     * @summary Get Devices
      * @param {Array<any>} [id] Filter by Device IDs
      * @param {Array<any>} [id2] Filter by Device IDs (deprecated)
      * @param {Array<string>} [oemName] Filter by OEM names
@@ -440,8 +420,8 @@ class DeviceApi extends base_1.BaseAPI {
      * @throws {RequiredError}
      * @memberof DeviceApi
      */
-    getDevicesListDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
-        return (0, exports.DeviceApiFp)(this.configuration).getDevicesListDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(this.axios, this.basePath));
+    getDevicesDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
+        return (0, exports.DeviceApiFp)(this.configuration).getDevicesDevicesGet(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Lists all OEM names
@@ -463,7 +443,7 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
     return {
         /**
          * 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!
-         * @summary Get Release Extended
+         * @summary Get Release
          * @param { | null} [releaseId] Release ID
          * @param { | null} [id] Release ID (deprecated)
          * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
@@ -471,7 +451,7 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getReleaseExtendedReleasesGetGet: (releaseId_1, id_1, buildId_1, filename_1, ...args_1) => __awaiter(this, [releaseId_1, id_1, buildId_1, filename_1, ...args_1], void 0, function* (releaseId, id, buildId, filename, options = {}) {
+        getReleaseReleasesGetGet: (releaseId_1, id_1, buildId_1, filename_1, ...args_1) => __awaiter(this, [releaseId_1, id_1, buildId_1, filename_1, ...args_1], void 0, function* (releaseId, id, buildId, filename, options = {}) {
             const localVarPath = `/releases/get`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -482,12 +462,6 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication oauth2_password required
-            // oauth required
-            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2_password", [], configuration);
-            // authentication bearer_auth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
             if (releaseId !== undefined) {
                 for (const [key, value] of Object.entries(releaseId)) {
                     localVarQueryParameter[key] = value;
@@ -514,14 +488,15 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
         }),
         /**
          * Gets release information using the release ID, nothing to discuss really.
-         * @summary Get Release
+         * @summary Get Release Short
          * @param {any} releaseId
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
-        getReleaseReleasesReleaseIdGet: (releaseId_1, ...args_1) => __awaiter(this, [releaseId_1, ...args_1], void 0, function* (releaseId, options = {}) {
+        getReleaseShortReleasesReleaseIdGet: (releaseId_1, ...args_1) => __awaiter(this, [releaseId_1, ...args_1], void 0, function* (releaseId, options = {}) {
             // verify required parameter 'releaseId' is not null or undefined
-            (0, common_1.assertParamExists)('getReleaseReleasesReleaseIdGet', 'releaseId', releaseId);
+            (0, common_1.assertParamExists)('getReleaseShortReleasesReleaseIdGet', 'releaseId', releaseId);
             const localVarPath = `/releases/{release_id}`
                 .replace(`{${"release_id"}}`, encodeURIComponent(String(releaseId)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -533,12 +508,6 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication oauth2_password required
-            // oauth required
-            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2_password", [], configuration);
-            // authentication bearer_auth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -580,12 +549,6 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication oauth2_password required
-            // oauth required
-            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2_password", [], configuration);
-            // authentication bearer_auth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
             if (id) {
                 localVarQueryParameter['id'] = id;
             }
@@ -671,12 +634,6 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication oauth2_password required
-            // oauth required
-            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2_password", [], configuration);
-            // authentication bearer_auth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
             if (deviceId) {
                 localVarQueryParameter['device_id'] = deviceId;
             }
@@ -712,7 +669,7 @@ const ReleaseApiFp = function (configuration) {
     return {
         /**
          * 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!
-         * @summary Get Release Extended
+         * @summary Get Release
          * @param { | null} [releaseId] Release ID
          * @param { | null} [id] Release ID (deprecated)
          * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
@@ -720,28 +677,29 @@ const ReleaseApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getReleaseExtendedReleasesGetGet(releaseId, id, buildId, filename, options) {
+        getReleaseReleasesGetGet(releaseId, id, buildId, filename, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getReleaseExtendedReleasesGetGet(releaseId, id, buildId, filename, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getReleaseReleasesGetGet(releaseId, id, buildId, filename, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReleaseApi.getReleaseExtendedReleasesGetGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReleaseApi.getReleaseReleasesGetGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
         /**
          * Gets release information using the release ID, nothing to discuss really.
-         * @summary Get Release
+         * @summary Get Release Short
          * @param {any} releaseId
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
-        getReleaseReleasesReleaseIdGet(releaseId, options) {
+        getReleaseShortReleasesReleaseIdGet(releaseId, options) {
             return __awaiter(this, void 0, void 0, function* () {
                 var _a, _b, _c;
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.getReleaseReleasesReleaseIdGet(releaseId, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getReleaseShortReleasesReleaseIdGet(releaseId, options);
                 const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
-                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReleaseApi.getReleaseReleasesReleaseIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReleaseApi.getReleaseShortReleasesReleaseIdGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
@@ -810,7 +768,7 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
     return {
         /**
          * 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!
-         * @summary Get Release Extended
+         * @summary Get Release
          * @param { | null} [releaseId] Release ID
          * @param { | null} [id] Release ID (deprecated)
          * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
@@ -818,18 +776,19 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getReleaseExtendedReleasesGetGet(releaseId, id, buildId, filename, options) {
-            return localVarFp.getReleaseExtendedReleasesGetGet(releaseId, id, buildId, filename, options).then((request) => request(axios, basePath));
+        getReleaseReleasesGetGet(releaseId, id, buildId, filename, options) {
+            return localVarFp.getReleaseReleasesGetGet(releaseId, id, buildId, filename, options).then((request) => request(axios, basePath));
         },
         /**
          * Gets release information using the release ID, nothing to discuss really.
-         * @summary Get Release
+         * @summary Get Release Short
          * @param {any} releaseId
          * @param {*} [options] Override http request option.
+         * @deprecated
          * @throws {RequiredError}
          */
-        getReleaseReleasesReleaseIdGet(releaseId, options) {
-            return localVarFp.getReleaseReleasesReleaseIdGet(releaseId, options).then((request) => request(axios, basePath));
+        getReleaseShortReleasesReleaseIdGet(releaseId, options) {
+            return localVarFp.getReleaseShortReleasesReleaseIdGet(releaseId, options).then((request) => request(axios, basePath));
         },
         /**
          * 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.
@@ -884,7 +843,7 @@ exports.ReleaseApiFactory = ReleaseApiFactory;
 class ReleaseApi extends base_1.BaseAPI {
     /**
      * 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!
-     * @summary Get Release Extended
+     * @summary Get Release
      * @param { | null} [releaseId] Release ID
      * @param { | null} [id] Release ID (deprecated)
      * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
@@ -893,19 +852,20 @@ class ReleaseApi extends base_1.BaseAPI {
      * @throws {RequiredError}
      * @memberof ReleaseApi
      */
-    getReleaseExtendedReleasesGetGet(releaseId, id, buildId, filename, options) {
-        return (0, exports.ReleaseApiFp)(this.configuration).getReleaseExtendedReleasesGetGet(releaseId, id, buildId, filename, options).then((request) => request(this.axios, this.basePath));
+    getReleaseReleasesGetGet(releaseId, id, buildId, filename, options) {
+        return (0, exports.ReleaseApiFp)(this.configuration).getReleaseReleasesGetGet(releaseId, id, buildId, filename, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Gets release information using the release ID, nothing to discuss really.
-     * @summary Get Release
+     * @summary Get Release Short
      * @param {any} releaseId
      * @param {*} [options] Override http request option.
+     * @deprecated
      * @throws {RequiredError}
      * @memberof ReleaseApi
      */
-    getReleaseReleasesReleaseIdGet(releaseId, options) {
-        return (0, exports.ReleaseApiFp)(this.configuration).getReleaseReleasesReleaseIdGet(releaseId, options).then((request) => request(this.axios, this.basePath));
+    getReleaseShortReleasesReleaseIdGet(releaseId, options) {
+        return (0, exports.ReleaseApiFp)(this.configuration).getReleaseShortReleasesReleaseIdGet(releaseId, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * 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.
@@ -975,12 +935,6 @@ const StatsApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
-            // authentication oauth2_password required
-            // oauth required
-            yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "oauth2_password", [], configuration);
-            // authentication bearer_auth required
-            // http bearer authentication required
-            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);

package/dist/base.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/base.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).
@@ -15,7 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 const axios_1 = require("axios");
-exports.BASE_PATH = "http://localhost".replace(/\/+$/, "");
+exports.BASE_PATH = "https://api.orangefox.download".replace(/\/+$/, "");
 /**
  *
  * @export

package/dist/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).