@orangefox-recovery/foxinternalclient 5.4.0 → 6.0.4

package/docs/DeviceApi.md

@@ -4,20 +4,18 @@ All URIs are relative to *https://api.orangefox.download*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**getDevice**](DeviceApi.md#getdevice) | **GET** /devices/get | Get Device |
-| [**getDeviceDeprecated**](DeviceApi.md#getdevicedeprecated) | **GET** /devices/{device_id} | Get Device Short |
-| [**getDevices**](DeviceApi.md#getdevices) | **GET** /devices/ | Get Devices |
-| [**getOems**](DeviceApi.md#getoems) | **GET** /oems/ | Get Oems |
+| [**getDevice**](DeviceApi.md#getdevice) | **GET** /devices/get | GET /devices/get - Get a single device by device_id, codename, or _id. |
+| [**getDeviceById**](DeviceApi.md#getdevicebyid) | **GET** /devices/{device_id} | GET /devices/{device_id} - Get device by ID (deprecated). |
+| [**getOems**](DeviceApi.md#getoems) | **GET** /oems | GET /oems - Get a list of all unique OEM names. |
+| [**listDevices**](DeviceApi.md#listdevices) | **GET** /devices | GET /devices/ - List devices with filters. |
 
 
 
 ## getDevice
 
-> DeviceResponse getDevice(deviceId, id, codename)
+> DeviceResponse getDevice(deviceId, codename, id)
 
-Get Device
-
-Extended get device method, including the ability to get a device using device codename instead of the ID.  /device/get?codename=lavender   Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
+GET /devices/get - Get a single device by device_id, codename, or _id.
 
 ### Example
 
@@ -35,10 +33,10 @@ async function example() {
   const body = {
     // string (optional)
     deviceId: deviceId_example,
-    // string | Filter by Device ID (deprecated) (optional)
-    id: id_example,
-    // string | Not recommended to use when you can (optional)
+    // string (optional)
     codename: codename_example,
+    // string (optional)
+    id: id_example,
   } satisfies GetDeviceRequest;
 
   try {
@@ -59,8 +57,8 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **deviceId** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **id** | `string` | Filter by Device ID (deprecated) | [Optional] [Defaults to `undefined`] |
-| **codename** | `string` | Not recommended to use when you can | [Optional] [Defaults to `undefined`] |
+| **codename** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **id** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -79,21 +77,18 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
-| **404** | Item not found |  -  |
-| **400** | Bad request |  -  |
-| **422** | Validation Error |  -  |
+| **200** | Device details |  -  |
+| **404** | Not found |  -  |
+| **500** | Internal server error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## getDeviceDeprecated
-
-> DeviceResponse getDeviceDeprecated(deviceId)
+## getDeviceById
 
-Get Device Short
+> DeviceResponse getDeviceById(deviceId)
 
-Gets device info using device ID.
+GET /devices/{device_id} - Get device by ID (deprecated).
 
 ### Example
 
@@ -102,19 +97,19 @@ import {
   Configuration,
   DeviceApi,
 } from '@orangefox-recovery/foxinternalclient';
-import type { GetDeviceDeprecatedRequest } from '@orangefox-recovery/foxinternalclient';
+import type { GetDeviceByIdRequest } from '@orangefox-recovery/foxinternalclient';
 
 async function example() {
   console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
   const api = new DeviceApi();
 
   const body = {
-    // string
+    // string | Device ID
     deviceId: deviceId_example,
-  } satisfies GetDeviceDeprecatedRequest;
+  } satisfies GetDeviceByIdRequest;
 
   try {
-    const data = await api.getDeviceDeprecated(body);
+    const data = await api.getDeviceById(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -130,7 +125,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **deviceId** | `string` |  | [Defaults to `undefined`] |
+| **deviceId** | `string` | Device ID | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -149,20 +144,19 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
-| **404** | Item not found |  -  |
-| **422** | Validation Error |  -  |
+| **200** | Device details |  -  |
+| **400** | Invalid device ID format |  -  |
+| **404** | Not found |  -  |
+| **500** | Internal server error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## getDevices
-
-> ListResponseShortDeviceResponse getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit)
+## getOems
 
-Get Devices
+> ListResponseString getOems()
 
-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 /oems - Get a list of all unique OEM names.
 
 ### Example
 
@@ -171,39 +165,14 @@ import {
   Configuration,
   DeviceApi,
 } from '@orangefox-recovery/foxinternalclient';
-import type { GetDevicesRequest } from '@orangefox-recovery/foxinternalclient';
+import type { GetOemsRequest } from '@orangefox-recovery/foxinternalclient';
 
 async function example() {
   console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
   const api = new DeviceApi();
 
-  const body = {
-    // Array<string> | Filter by Device IDs (optional)
-    id: ...,
-    // Array<string> | Filter by Device IDs (deprecated) (optional)
-    id2: ...,
-    // Array<string> | Filter by OEM names (optional)
-    oemName: ...,
-    // Array<string> | Filter by device codenames (optional)
-    codename: ...,
-    // Array<string> | Filter by model names (optional)
-    modelName: ...,
-    // boolean | Supported status (optional)
-    supported: true,
-    // Array<string> | Filter by maintainer ID (optional)
-    maintainer: ...,
-    // boolean | Filter by Freezed status (optional)
-    freezed: true,
-    // boolean | Filter by has releases status (optional)
-    hasReleases: true,
-    // number | Skip query results (optional)
-    skip: 56,
-    // number | Limit query results (0 means unlimited) (optional)
-    limit: 56,
-  } satisfies GetDevicesRequest;
-
   try {
-    const data = await api.getDevices(body);
+    const data = await api.getOems();
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -216,24 +185,11 @@ example().catch(console.error);
 
 ### Parameters
 
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **id** | `Array<string>` | Filter by Device IDs | [Optional] |
-| **id2** | `Array<string>` | Filter by Device IDs (deprecated) | [Optional] |
-| **oemName** | `Array<string>` | Filter by OEM names | [Optional] |
-| **codename** | `Array<string>` | Filter by device codenames | [Optional] |
-| **modelName** | `Array<string>` | Filter by model names | [Optional] |
-| **supported** | `boolean` | Supported status | [Optional] [Defaults to `undefined`] |
-| **maintainer** | `Array<string>` | Filter by maintainer ID | [Optional] |
-| **freezed** | `boolean` | Filter by Freezed status | [Optional] [Defaults to `undefined`] |
-| **hasReleases** | `boolean` | Filter by has releases status | [Optional] [Defaults to `undefined`] |
-| **skip** | `number` | Skip query results | [Optional] [Defaults to `undefined`] |
-| **limit** | `number` | Limit query results (0 means unlimited) | [Optional] [Defaults to `undefined`] |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**ListResponseShortDeviceResponse**](ListResponseShortDeviceResponse.md)
+[**ListResponseString**](ListResponseString.md)
 
 ### Authorization
 
@@ -248,20 +204,17 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
-| **404** | Item not found |  -  |
-| **422** | Validation Error |  -  |
+| **200** | List of OEM names |  -  |
+| **500** | Internal server error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## getOems
-
-> ListResponseStr getOems()
+## listDevices
 
-Get Oems
+> ListResponseShortDeviceResponse listDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit)
 
-Lists all OEM names
+GET /devices/ - List devices with filters.
 
 ### Example
 
@@ -270,14 +223,39 @@ import {
   Configuration,
   DeviceApi,
 } from '@orangefox-recovery/foxinternalclient';
-import type { GetOemsRequest } from '@orangefox-recovery/foxinternalclient';
+import type { ListDevicesRequest } from '@orangefox-recovery/foxinternalclient';
 
 async function example() {
   console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
   const api = new DeviceApi();
 
+  const body = {
+    // string (optional)
+    id: id_example,
+    // string (optional)
+    id2: id_example,
+    // string (optional)
+    oemName: oemName_example,
+    // string (optional)
+    codename: codename_example,
+    // string (optional)
+    modelName: modelName_example,
+    // boolean (optional)
+    supported: true,
+    // string (optional)
+    maintainer: maintainer_example,
+    // boolean (optional)
+    freezed: true,
+    // boolean (optional)
+    hasReleases: true,
+    // number (optional)
+    skip: 789,
+    // number (optional)
+    limit: 789,
+  } satisfies ListDevicesRequest;
+
   try {
-    const data = await api.getOems();
+    const data = await api.listDevices(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -290,11 +268,24 @@ example().catch(console.error);
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **id2** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **oemName** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **codename** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **modelName** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **supported** | `boolean` |  | [Optional] [Defaults to `undefined`] |
+| **maintainer** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **freezed** | `boolean` |  | [Optional] [Defaults to `undefined`] |
+| **hasReleases** | `boolean` |  | [Optional] [Defaults to `undefined`] |
+| **skip** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-[**ListResponseStr**](ListResponseStr.md)
+[**ListResponseShortDeviceResponse**](ListResponseShortDeviceResponse.md)
 
 ### Authorization
 
@@ -309,7 +300,9 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
+| **200** | List of devices |  -  |
+| **404** | Not found |  -  |
+| **500** | Internal server error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 

package/docs/DeviceInternalResponse.md

@@ -1,27 +1,29 @@
 
 # DeviceInternalResponse
 
+Internal device response with stats
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`legacyId` | string
 `codename` | string
-`modelName` | string
-`oemName` | string
-`id` | string
 `codenames` | Array<string>
+`featuredText` | string
+`fullName` | string
+`id` | string
+`isFeatured` | boolean
+`modelName` | string
 `modelNames` | Array<string>
+`oemName` | string
 `supported` | boolean
-`isFeatured` | boolean
-`featuredText` | string
-`maintainer` | [MaintainerShortModel](MaintainerShortModel.md)
-`notes` | string
+`url` | string
 `deviceTree` | string
-`stats` | [DeviceStatsResponse](DeviceStatsResponse.md)
+`maintainer` | [MaintainerShortResponse](MaintainerShortResponse.md)
+`notes` | string
 `freezed` | boolean
-`fullName` | string
-`url` | string
+`stats` | [DeviceStatsResponse](DeviceStatsResponse.md)
 
 ## Example
 
@@ -30,22 +32,23 @@ import type { DeviceInternalResponse } from '@orangefox-recovery/foxinternalclie
 
 // TODO: Update the object below with actual values
 const example = {
+  "legacyId": null,
   "codename": null,
-  "modelName": null,
-  "oemName": null,
-  "id": null,
   "codenames": null,
+  "featuredText": null,
+  "fullName": null,
+  "id": null,
+  "isFeatured": null,
+  "modelName": null,
   "modelNames": null,
+  "oemName": null,
   "supported": null,
-  "isFeatured": null,
-  "featuredText": null,
+  "url": null,
+  "deviceTree": null,
   "maintainer": null,
   "notes": null,
-  "deviceTree": null,
-  "stats": null,
   "freezed": null,
-  "fullName": null,
-  "url": null,
+  "stats": null,
 } satisfies DeviceInternalResponse
 
 console.log(example)

package/docs/DeviceResponse.md

@@ -6,20 +6,21 @@
 
 Name | Type
 ------------ | -------------
+`legacyId` | string
 `codename` | string
-`modelName` | string
-`oemName` | string
-`id` | string
 `codenames` | Array<string>
-`modelNames` | Array<string>
-`supported` | boolean
-`isFeatured` | boolean
 `featuredText` | string
-`maintainer` | [MaintainerShortModel](MaintainerShortModel.md)
-`notes` | string
-`deviceTree` | string
 `fullName` | string
+`id` | string
+`isFeatured` | boolean
+`modelName` | string
+`modelNames` | Array<string>
+`oemName` | string
+`supported` | boolean
 `url` | string
+`deviceTree` | string
+`maintainer` | [MaintainerShortResponse](MaintainerShortResponse.md)
+`notes` | string
 
 ## Example
 
@@ -28,20 +29,21 @@ import type { DeviceResponse } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
+  "legacyId": null,
   "codename": null,
-  "modelName": null,
-  "oemName": null,
-  "id": null,
   "codenames": null,
+  "featuredText": null,
+  "fullName": null,
+  "id": null,
+  "isFeatured": null,
+  "modelName": null,
   "modelNames": null,
+  "oemName": null,
   "supported": null,
-  "isFeatured": null,
-  "featuredText": null,
+  "url": null,
+  "deviceTree": null,
   "maintainer": null,
   "notes": null,
-  "deviceTree": null,
-  "fullName": null,
-  "url": null,
 } satisfies DeviceResponse
 
 console.log(example)

package/docs/DeviceUpdateBody.md

@@ -1,17 +1,18 @@
 
 # DeviceUpdateBody
 
+Body for updating a device
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`oemName` | string
 `codenames` | Array<string>
-`modelNames` | Array<string>
-`supported` | boolean
 `freezed` | boolean
+`modelNames` | Array<string>
 `notes` | string
+`oemName` | string
+`supported` | boolean
 
 ## Example
 
@@ -20,12 +21,12 @@ import type { DeviceUpdateBody } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
-  "oemName": null,
   "codenames": null,
-  "modelNames": null,
-  "supported": null,
   "freezed": null,
+  "modelNames": null,
   "notes": null,
+  "oemName": null,
+  "supported": null,
 } satisfies DeviceUpdateBody
 
 console.log(example)

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

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

package/docs/FFStatusResponse.md

@@ -6,7 +6,7 @@
 
 Name | Type
 ------------ | -------------
-`status` | [FFStatusEnum](FFStatusEnum.md)
+`status` | string
 
 ## Example