@orangefox-recovery/foxclient 5.3.3 → 6.0.4

package/dist/apis/DeviceApi.js

@@ -3,9 +3,9 @@
 /* eslint-disable */
 /**
  * Fox API
- *  Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement.  To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit.  The requests may be logged for analytics and development purposes.
+ * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement.  To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit.  The requests may be logged for analytics and development purposes.
  *
- * The version of the OpenAPI document: 5.3.3
+ * The version of the OpenAPI document: 6.0.4
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,35 +30,42 @@ const index_1 = require("../models/index");
  */
 class DeviceApi extends runtime.BaseAPI {
     /**
-     * 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.
-     * Get Device
+     * Creates request options for getDevice without sending the request
      */
-    getDeviceRaw(requestParameters, initOverrides) {
+    getDeviceRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             if (requestParameters['deviceId'] != null) {
                 queryParameters['device_id'] = requestParameters['deviceId'];
             }
-            if (requestParameters['id'] != null) {
-                queryParameters['_id'] = requestParameters['id'];
-            }
             if (requestParameters['codename'] != null) {
                 queryParameters['codename'] = requestParameters['codename'];
             }
+            if (requestParameters['id'] != null) {
+                queryParameters['_id'] = requestParameters['id'];
+            }
             const headerParameters = {};
             let urlPath = `/devices/get`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * GET /devices/get - Get a single device by device_id, codename, or _id.
+     */
+    getDeviceRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDeviceRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DeviceResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * 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.
-     * Get Device
+     * GET /devices/get - Get a single device by device_id, codename, or _id.
      */
     getDevice() {
         return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
@@ -67,44 +74,83 @@ class DeviceApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Gets device info using device ID.
-     * Get Device Short
-     * @deprecated
+     * Creates request options for getDeviceById without sending the request
      */
-    getDeviceDeprecatedRaw(requestParameters, initOverrides) {
+    getDeviceByIdRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['deviceId'] == null) {
-                throw new runtime.RequiredError('deviceId', 'Required parameter "deviceId" was null or undefined when calling getDeviceDeprecated().');
+                throw new runtime.RequiredError('deviceId', 'Required parameter "deviceId" was null or undefined when calling getDeviceById().');
             }
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/devices/{device_id}`;
             urlPath = urlPath.replace(`{${"device_id"}}`, encodeURIComponent(String(requestParameters['deviceId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * GET /devices/{device_id} - Get device by ID (deprecated).
+     */
+    getDeviceByIdRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDeviceByIdRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DeviceResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * Gets device info using device ID.
-     * Get Device Short
-     * @deprecated
+     * GET /devices/{device_id} - Get device by ID (deprecated).
+     */
+    getDeviceById(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDeviceByIdRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getOems without sending the request
+     */
+    getOemsRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/oems`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * GET /oems - Get a list of all unique OEM names.
+     */
+    getOemsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getOemsRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListResponseStringFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * GET /oems - Get a list of all unique OEM names.
      */
-    getDeviceDeprecated(requestParameters, initOverrides) {
+    getOems(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getDeviceDeprecatedRaw(requestParameters, initOverrides);
+            const response = yield this.getOemsRaw(initOverrides);
             return yield response.value();
         });
     }
     /**
-     * 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 Devices
+     * Creates request options for listDevices without sending the request
      */
-    getDevicesRaw(requestParameters, initOverrides) {
+    listDevicesRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             if (requestParameters['id'] != null) {
@@ -141,51 +187,31 @@ class DeviceApi extends runtime.BaseAPI {
                 queryParameters['limit'] = requestParameters['limit'];
             }
             const headerParameters = {};
-            let urlPath = `/devices/`;
-            const response = yield this.request({
+            let urlPath = `/devices`;
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListResponseShortDeviceResponseFromJSON)(jsonValue));
+            };
         });
     }
     /**
-     * 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 Devices
+     * GET /devices/ - List devices with filters.
      */
-    getDevices() {
-        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
-            const response = yield this.getDevicesRaw(requestParameters, initOverrides);
-            return yield response.value();
-        });
-    }
-    /**
-     * Lists all OEM names
-     * Get Oems
-     */
-    getOemsRaw(initOverrides) {
+    listDevicesRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = {};
-            const headerParameters = {};
-            let urlPath = `/oems/`;
-            const response = yield this.request({
-                path: urlPath,
-                method: 'GET',
-                headers: headerParameters,
-                query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListResponseStrFromJSON)(jsonValue));
+            const requestOptions = yield this.listDevicesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListResponseShortDeviceResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * Lists all OEM names
-     * Get Oems
+     * GET /devices/ - List devices with filters.
      */
-    getOems(initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getOemsRaw(initOverrides);
+    listDevices() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listDevicesRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }

package/dist/apis/PasteApi.d.ts

@@ -1,8 +1,8 @@
 /**
  * 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.
+ * 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: 6.0.4
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,11 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { PasteInput, PasteOutput } from '../models/index';
-export interface CreatePastePastePostRequest {
+import type { PasteInput, PasteResponse } from '../models/index';
+export interface CreatePasteRequest {
     pasteInput: PasteInput;
 }
-export interface GetPastePastePasteIdGetRequest {
+export interface GetPasteRequest {
     pasteId: string;
 }
 /**
@@ -25,56 +25,72 @@ export interface GetPastePastePasteIdGetRequest {
  */
 export interface PasteApiInterface {
     /**
-     * Create a new paste.
-     * @summary Create Paste
+     * Creates request options for createPaste without sending the request
+     * @param {PasteInput} pasteInput
+     * @throws {RequiredError}
+     * @memberof PasteApiInterface
+     */
+    createPasteRequestOpts(requestParameters: CreatePasteRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary POST /paste/ - Create a new paste.
      * @param {PasteInput} pasteInput
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PasteApiInterface
      */
-    createPastePastePostRaw(requestParameters: CreatePastePastePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasteOutput>>;
+    createPasteRaw(requestParameters: CreatePasteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasteResponse>>;
     /**
-     * Create a new paste.
-     * Create Paste
+     * POST /paste/ - Create a new paste.
      */
-    createPastePastePost(requestParameters: CreatePastePastePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteOutput>;
+    createPaste(requestParameters: CreatePasteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteResponse>;
     /**
-     * Get a paste by ID.
-     * @summary Get Paste
-     * @param {string} pasteId
+     * Creates request options for getPaste without sending the request
+     * @param {string} pasteId Paste ID
+     * @throws {RequiredError}
+     * @memberof PasteApiInterface
+     */
+    getPasteRequestOpts(requestParameters: GetPasteRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary GET /paste/{paste_id} - Get a paste by ID.
+     * @param {string} pasteId Paste ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PasteApiInterface
      */
-    getPastePastePasteIdGetRaw(requestParameters: GetPastePastePasteIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasteOutput>>;
+    getPasteRaw(requestParameters: GetPasteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasteResponse>>;
     /**
-     * Get a paste by ID.
-     * Get Paste
+     * GET /paste/{paste_id} - Get a paste by ID.
      */
-    getPastePastePasteIdGet(requestParameters: GetPastePastePasteIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteOutput>;
+    getPaste(requestParameters: GetPasteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteResponse>;
 }
 /**
  *
  */
 export declare class PasteApi extends runtime.BaseAPI implements PasteApiInterface {
     /**
-     * Create a new paste.
-     * Create Paste
+     * Creates request options for createPaste without sending the request
+     */
+    createPasteRequestOpts(requestParameters: CreatePasteRequest): Promise<runtime.RequestOpts>;
+    /**
+     * POST /paste/ - Create a new paste.
+     */
+    createPasteRaw(requestParameters: CreatePasteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasteResponse>>;
+    /**
+     * POST /paste/ - Create a new paste.
      */
-    createPastePastePostRaw(requestParameters: CreatePastePastePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasteOutput>>;
+    createPaste(requestParameters: CreatePasteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteResponse>;
     /**
-     * Create a new paste.
-     * Create Paste
+     * Creates request options for getPaste without sending the request
      */
-    createPastePastePost(requestParameters: CreatePastePastePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteOutput>;
+    getPasteRequestOpts(requestParameters: GetPasteRequest): Promise<runtime.RequestOpts>;
     /**
-     * Get a paste by ID.
-     * Get Paste
+     * GET /paste/{paste_id} - Get a paste by ID.
      */
-    getPastePastePasteIdGetRaw(requestParameters: GetPastePastePasteIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasteOutput>>;
+    getPasteRaw(requestParameters: GetPasteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasteResponse>>;
     /**
-     * Get a paste by ID.
-     * Get Paste
+     * GET /paste/{paste_id} - Get a paste by ID.
      */
-    getPastePastePasteIdGet(requestParameters: GetPastePastePasteIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteOutput>;
+    getPaste(requestParameters: GetPasteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteResponse>;
 }

package/dist/apis/PasteApi.js

@@ -3,9 +3,9 @@
 /* eslint-disable */
 /**
  * Fox API
- *  Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement.  To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit.  The requests may be logged for analytics and development purposes.
+ * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement.  To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit.  The requests may be logged for analytics and development purposes.
  *
- * The version of the OpenAPI document: 5.3.3
+ * The version of the OpenAPI document: 6.0.4
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,67 +30,81 @@ const index_1 = require("../models/index");
  */
 class PasteApi extends runtime.BaseAPI {
     /**
-     * Create a new paste.
-     * Create Paste
+     * Creates request options for createPaste without sending the request
      */
-    createPastePastePostRaw(requestParameters, initOverrides) {
+    createPasteRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['pasteInput'] == null) {
-                throw new runtime.RequiredError('pasteInput', 'Required parameter "pasteInput" was null or undefined when calling createPastePastePost().');
+                throw new runtime.RequiredError('pasteInput', 'Required parameter "pasteInput" was null or undefined when calling createPaste().');
             }
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
-            let urlPath = `/paste/`;
-            const response = yield this.request({
+            let urlPath = `/paste`;
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.PasteInputToJSON)(requestParameters['pasteInput']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PasteOutputFromJSON)(jsonValue));
+            };
         });
     }
     /**
-     * Create a new paste.
-     * Create Paste
+     * POST /paste/ - Create a new paste.
      */
-    createPastePastePost(requestParameters, initOverrides) {
+    createPasteRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.createPastePastePostRaw(requestParameters, initOverrides);
+            const requestOptions = yield this.createPasteRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PasteResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * POST /paste/ - Create a new paste.
+     */
+    createPaste(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createPasteRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }
     /**
-     * Get a paste by ID.
-     * Get Paste
+     * Creates request options for getPaste without sending the request
      */
-    getPastePastePasteIdGetRaw(requestParameters, initOverrides) {
+    getPasteRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['pasteId'] == null) {
-                throw new runtime.RequiredError('pasteId', 'Required parameter "pasteId" was null or undefined when calling getPastePastePasteIdGet().');
+                throw new runtime.RequiredError('pasteId', 'Required parameter "pasteId" was null or undefined when calling getPaste().');
             }
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/paste/{paste_id}`;
             urlPath = urlPath.replace(`{${"paste_id"}}`, encodeURIComponent(String(requestParameters['pasteId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PasteOutputFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * GET /paste/{paste_id} - Get a paste by ID.
+     */
+    getPasteRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getPasteRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PasteResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * Get a paste by ID.
-     * Get Paste
+     * GET /paste/{paste_id} - Get a paste by ID.
      */
-    getPastePastePasteIdGet(requestParameters, initOverrides) {
+    getPaste(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.getPastePastePasteIdGetRaw(requestParameters, initOverrides);
+            const response = yield this.getPasteRaw(requestParameters, initOverrides);
             return yield response.value();
         });
     }