@orangefox-recovery/foxinternalclient 5.2.6 → 5.2.7

package/src/apis/DeviceApi.ts

@@ -0,0 +1,326 @@
+/* tslint:disable */
+/* 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. 
+ *
+ * The version of the OpenAPI document: 5.2.7
+ * 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 * as runtime from '../runtime';
+import type {
+  DeviceResponse,
+  HTTPValidationError,
+  ListResponseShortDeviceResponse,
+  ListResponseStr,
+} from '../models/index';
+import {
+    DeviceResponseFromJSON,
+    DeviceResponseToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+    ListResponseShortDeviceResponseFromJSON,
+    ListResponseShortDeviceResponseToJSON,
+    ListResponseStrFromJSON,
+    ListResponseStrToJSON,
+} from '../models/index';
+
+export interface GetDeviceRequest {
+    deviceId?: string | null;
+    id?: string | null;
+    codename?: string | null;
+}
+
+export interface GetDeviceDeprecatedRequest {
+    deviceId: string;
+}
+
+export interface GetDevicesRequest {
+    id?: Array<string>;
+    id2?: Array<string>;
+    oemName?: Array<string>;
+    codename?: Array<string>;
+    modelName?: Array<string>;
+    supported?: boolean | null;
+    maintainer?: Array<string>;
+    freezed?: boolean | null;
+    hasReleases?: boolean | null;
+    skip?: number | null;
+    limit?: number | null;
+}
+
+/**
+ * DeviceApi - interface
+ * 
+ * @export
+ * @interface DeviceApiInterface
+ */
+export interface DeviceApiInterface {
+    /**
+     * 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 {string} [id] Filter by Device ID (deprecated)
+     * @param {string} [codename] Not recommended to use when you can
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DeviceApiInterface
+     */
+    getDeviceRaw(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>>;
+
+    /**
+     * 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
+     */
+    getDevice(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
+
+    /**
+     * Gets device info using device ID.
+     * @summary Get Device Short
+     * @param {string} deviceId 
+     * @param {*} [options] Override http request option.
+     * @deprecated
+     * @throws {RequiredError}
+     * @memberof DeviceApiInterface
+     */
+    getDeviceDeprecatedRaw(requestParameters: GetDeviceDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>>;
+
+    /**
+     * Gets device info using device ID.
+     * Get Device Short
+     * @deprecated
+     */
+    getDeviceDeprecated(requestParameters: GetDeviceDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
+
+    /**
+     * 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
+     * @param {Array<string>} [id] Filter by Device IDs
+     * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
+     * @param {Array<string>} [oemName] Filter by OEM names
+     * @param {Array<string>} [codename] Filter by device codenames
+     * @param {Array<string>} [modelName] Filter by model names
+     * @param {boolean} [supported] Supported status
+     * @param {Array<string>} [maintainer] Filter by maintainer ID
+     * @param {boolean} [freezed] Filter by Freezed status
+     * @param {boolean} [hasReleases] Filter by has releases status
+     * @param {number} [skip] Skip query results
+     * @param {number} [limit] Limit query results (0 means unlimited)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DeviceApiInterface
+     */
+    getDevicesRaw(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseShortDeviceResponse>>;
+
+    /**
+     * 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
+     */
+    getDevices(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseShortDeviceResponse>;
+
+    /**
+     * Lists all OEM names
+     * @summary Get Oems
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DeviceApiInterface
+     */
+    getOemsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseStr>>;
+
+    /**
+     * Lists all OEM names
+     * Get Oems
+     */
+    getOems(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseStr>;
+
+}
+
+/**
+ * 
+ */
+export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
+
+    /**
+     * 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
+     */
+    async getDeviceRaw(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>> {
+        const queryParameters: any = {};
+
+        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'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/devices/get`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => 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
+     */
+    async getDevice(requestParameters: GetDeviceRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse> {
+        const response = await this.getDeviceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Gets device info using device ID.
+     * Get Device Short
+     * @deprecated
+     */
+    async getDeviceDeprecatedRaw(requestParameters: GetDeviceDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>> {
+        if (requestParameters['deviceId'] == null) {
+            throw new runtime.RequiredError(
+                'deviceId',
+                'Required parameter "deviceId" was null or undefined when calling getDeviceDeprecated().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/devices/{device_id}`.replace(`{${"device_id"}}`, encodeURIComponent(String(requestParameters['deviceId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DeviceResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Gets device info using device ID.
+     * Get Device Short
+     * @deprecated
+     */
+    async getDeviceDeprecated(requestParameters: GetDeviceDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse> {
+        const response = await this.getDeviceDeprecatedRaw(requestParameters, initOverrides);
+        return await 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
+     */
+    async getDevicesRaw(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseShortDeviceResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['id'] != null) {
+            queryParameters['id'] = requestParameters['id'];
+        }
+
+        if (requestParameters['id2'] != null) {
+            queryParameters['_id'] = requestParameters['id2'];
+        }
+
+        if (requestParameters['oemName'] != null) {
+            queryParameters['oem_name'] = requestParameters['oemName'];
+        }
+
+        if (requestParameters['codename'] != null) {
+            queryParameters['codename'] = requestParameters['codename'];
+        }
+
+        if (requestParameters['modelName'] != null) {
+            queryParameters['model_name'] = requestParameters['modelName'];
+        }
+
+        if (requestParameters['supported'] != null) {
+            queryParameters['supported'] = requestParameters['supported'];
+        }
+
+        if (requestParameters['maintainer'] != null) {
+            queryParameters['maintainer'] = requestParameters['maintainer'];
+        }
+
+        if (requestParameters['freezed'] != null) {
+            queryParameters['freezed'] = requestParameters['freezed'];
+        }
+
+        if (requestParameters['hasReleases'] != null) {
+            queryParameters['has_releases'] = requestParameters['hasReleases'];
+        }
+
+        if (requestParameters['skip'] != null) {
+            queryParameters['skip'] = requestParameters['skip'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/devices/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => 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
+     */
+    async getDevices(requestParameters: GetDevicesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseShortDeviceResponse> {
+        const response = await this.getDevicesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Lists all OEM names
+     * Get Oems
+     */
+    async getOemsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseStr>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/oems/`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListResponseStrFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists all OEM names
+     * Get Oems
+     */
+    async getOems(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseStr> {
+        const response = await this.getOemsRaw(initOverrides);
+        return await response.value();
+    }
+
+}