@orangefox-recovery/foxinternalclient 5.2.6 → 5.2.8

package/docs/DeviceApi.md

@@ -1,251 +0,0 @@
-# DeviceApi
-
-All URIs are relative to *https://api.orangefox.download*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getDevice**](#getdevice) | **GET** /devices/get | Get Device|
-|[**getDeviceDeprecated**](#getdevicedeprecated) | **GET** /devices/{device_id} | Get Device Short|
-|[**getDevices**](#getdevices) | **GET** /devices/ | Get Devices|
-|[**getOems**](#getoems) | **GET** /oems/ | Get Oems|
-
-# **getDevice**
-> DeviceResponse getDevice()
-
-Extended get device method, including the ability to get a device using device codename instead of the ID.  /device/get?codename=lavender   Due to the reasons mentioned in the /device route, identification devices using their codenames are considered  unrecommended.
-
-### Example
-
-```typescript
-import {
-    DeviceApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new DeviceApi(configuration);
-
-let deviceId: string; // (optional) (default to undefined)
-let id: string; //Filter by Device ID (deprecated) (optional) (default to undefined)
-let codename: string; //Not recommended to use when you can (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getDevice(
-    deviceId,
-    id,
-    codename
-);
-```
-
-### Parameters
-
-|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|
-
-
-### Return type
-
-**DeviceResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**404** | Item not found |  -  |
-|**400** | Bad request |  -  |
-|**422** | Validation Error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getDeviceDeprecated**
-> DeviceResponse getDeviceDeprecated()
-
-Gets device info using device ID.
-
-### Example
-
-```typescript
-import {
-    DeviceApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new DeviceApi(configuration);
-
-let deviceId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.getDeviceDeprecated(
-    deviceId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **deviceId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**DeviceResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**404** | Item not found |  -  |
-|**422** | Validation Error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getDevices**
-> ListResponseShortDeviceResponse getDevices()
-
-Get a device list.  Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons,  please use id instead.  Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some  OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification.  Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename.  Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective  communities.  Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
-
-### Example
-
-```typescript
-import {
-    DeviceApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new DeviceApi(configuration);
-
-let id: Array<string>; //Filter by Device IDs (optional) (default to undefined)
-let id2: Array<string>; //Filter by Device IDs (deprecated) (optional) (default to undefined)
-let oemName: Array<string>; //Filter by OEM names (optional) (default to undefined)
-let codename: Array<string>; //Filter by device codenames (optional) (default to undefined)
-let modelName: Array<string>; //Filter by model names (optional) (default to undefined)
-let supported: boolean; //Supported status (optional) (default to undefined)
-let maintainer: Array<string>; //Filter by maintainer ID (optional) (default to undefined)
-let freezed: boolean; //Filter by Freezed status (optional) (default to undefined)
-let hasReleases: boolean; //Filter by has releases status (optional) (default to undefined)
-let skip: number; //Skip query results (optional) (default to undefined)
-let limit: number; //Limit query results (0 means unlimited) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getDevices(
-    id,
-    id2,
-    oemName,
-    codename,
-    modelName,
-    supported,
-    maintainer,
-    freezed,
-    hasReleases,
-    skip,
-    limit
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | **Array&lt;string&gt;** | Filter by Device IDs | (optional) defaults to undefined|
-| **id2** | **Array&lt;string&gt;** | Filter by Device IDs (deprecated) | (optional) defaults to undefined|
-| **oemName** | **Array&lt;string&gt;** | Filter by OEM names | (optional) defaults to undefined|
-| **codename** | **Array&lt;string&gt;** | Filter by device codenames | (optional) defaults to undefined|
-| **modelName** | **Array&lt;string&gt;** | Filter by model names | (optional) defaults to undefined|
-| **supported** | [**boolean**] | Supported status | (optional) defaults to undefined|
-| **maintainer** | **Array&lt;string&gt;** | Filter by maintainer ID | (optional) defaults to undefined|
-| **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|
-
-
-### Return type
-
-**ListResponseShortDeviceResponse**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-|**404** | Item not found |  -  |
-|**422** | Validation Error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getOems**
-> ListResponseStr getOems()
-
-Lists all OEM names
-
-### Example
-
-```typescript
-import {
-    DeviceApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new DeviceApi(configuration);
-
-const { status, data } = await apiInstance.getOems();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**ListResponseStr**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Successful Response |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/DeviceInternalResponse.md

@@ -1,48 +0,0 @@
-# DeviceInternalResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [default to undefined]
-**codename** | **string** | Device codename, legacy | [default to undefined]
-**model_name** | **string** | Model name of device, does not include the OEM part, legacy | [default to undefined]
-**oem_name** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**codenames** | **Array<string>** |  | [default to undefined]
-**model_names** | **Array<string>** |  | [default to undefined]
-**supported** | **boolean** |  | [default to undefined]
-**maintainer** | [**MaintainerShortModel**](MaintainerShortModel.md) |  | [default to undefined]
-**notes** | **string** |  | [optional] [default to undefined]
-**device_tree** | **string** |  | [optional] [default to undefined]
-**stats** | [**DeviceStatsResponse**](DeviceStatsResponse.md) |  | [default to undefined]
-**freezed** | **boolean** |  | [default to undefined]
-**full_name** | **string** | Full name of device / devices, legacy | [readonly] [default to undefined]
-**url** | **string** | URL of the device on the official website | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { DeviceInternalResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: DeviceInternalResponse = {
-    _id,
-    codename,
-    model_name,
-    oem_name,
-    id,
-    codenames,
-    model_names,
-    supported,
-    maintainer,
-    notes,
-    device_tree,
-    stats,
-    freezed,
-    full_name,
-    url,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeviceResponse.md

@@ -1,44 +0,0 @@
-# DeviceResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [default to undefined]
-**codename** | **string** | Device codename, legacy | [default to undefined]
-**model_name** | **string** | Model name of device, does not include the OEM part, legacy | [default to undefined]
-**oem_name** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**codenames** | **Array<string>** |  | [default to undefined]
-**model_names** | **Array<string>** |  | [default to undefined]
-**supported** | **boolean** |  | [default to undefined]
-**maintainer** | [**MaintainerShortModel**](MaintainerShortModel.md) |  | [default to undefined]
-**notes** | **string** |  | [optional] [default to undefined]
-**device_tree** | **string** |  | [optional] [default to undefined]
-**full_name** | **string** | Full name of device / devices, legacy | [readonly] [default to undefined]
-**url** | **string** | URL of the device on the official website | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { DeviceResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: DeviceResponse = {
-    _id,
-    codename,
-    model_name,
-    oem_name,
-    id,
-    codenames,
-    model_names,
-    supported,
-    maintainer,
-    notes,
-    device_tree,
-    full_name,
-    url,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeviceStatsResponse.md

@@ -1,24 +0,0 @@
-# DeviceStatsResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **number** |  | [default to undefined]
-**days** | **{ [key: string]: number; }** |  | [default to undefined]
-**mirrors** | **{ [key: string]: number; }** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { DeviceStatsResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: DeviceStatsResponse = {
-    count,
-    days,
-    mirrors,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeviceUpdateBody.md

@@ -1,30 +0,0 @@
-# DeviceUpdateBody
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**oem_name** | **string** |  | [optional] [default to undefined]
-**codenames** | **Array<string>** |  | [optional] [default to undefined]
-**model_names** | **Array<string>** |  | [optional] [default to undefined]
-**supported** | **boolean** |  | [optional] [default to undefined]
-**freezed** | **boolean** |  | [optional] [default to undefined]
-**notes** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { DeviceUpdateBody } from '@orangefox-recovery/foxinternalclient';
-
-const instance: DeviceUpdateBody = {
-    oem_name,
-    codenames,
-    model_names,
-    supported,
-    freezed,
-    notes,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FFStatusEnum.md

@@ -1,12 +0,0 @@
-# FFStatusEnum
-
-
-## Enum
-
-* `Free` (value: `'free'`)
-
-* `Busy` (value: `'busy'`)
-
-* `Offline` (value: `'offline'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FFStatusResponse.md

@@ -1,20 +0,0 @@
-# FFStatusResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | [**FFStatusEnum**](FFStatusEnum.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { FFStatusResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: FFStatusResponse = {
-    status,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)