@orangefox-recovery/foxinternalclient 5.3.0 → 5.3.2

package/docs/BodyChangePasswordProfileChangePasswordPost.md

@@ -0,0 +1,36 @@
+
+# BodyChangePasswordProfileChangePasswordPost
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`oldPassword` | string
+`newPassword` | string
+
+## Example
+
+```typescript
+import type { BodyChangePasswordProfileChangePasswordPost } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "oldPassword": null,
+  "newPassword": null,
+} satisfies BodyChangePasswordProfileChangePasswordPost
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as BodyChangePasswordProfileChangePasswordPost
+console.log(exampleParsed)
+```
+
+[[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/BuildStatusEnum.md

@@ -0,0 +1,32 @@
+
+# BuildStatusEnum
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { BuildStatusEnum } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies BuildStatusEnum
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as BuildStatusEnum
+console.log(exampleParsed)
+```
+
+[[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/BuildTaskResponse.md

@@ -0,0 +1,56 @@
+
+# BuildTaskResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`startedById` | string
+`device` | [ShortDeviceResponse](ShortDeviceResponse.md)
+`status` | [BuildStatusEnum](BuildStatusEnum.md)
+`version` | string
+`type` | [ReleaseType](ReleaseType.md)
+`variant` | string
+`startedAt` | Date
+`finishedAt` | Date
+`hasArtifact` | boolean
+`environment` | { [key: string]: string; }
+`logs` | Array<string>
+
+## Example
+
+```typescript
+import type { BuildTaskResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "startedById": null,
+  "device": null,
+  "status": null,
+  "version": null,
+  "type": null,
+  "variant": null,
+  "startedAt": null,
+  "finishedAt": null,
+  "hasArtifact": null,
+  "environment": null,
+  "logs": null,
+} satisfies BuildTaskResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as BuildTaskResponse
+console.log(exampleParsed)
+```
+
+[[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/BuildTaskShortResponse.md

@@ -0,0 +1,52 @@
+
+# BuildTaskShortResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`startedById` | string
+`device` | [ShortDeviceResponse](ShortDeviceResponse.md)
+`status` | [BuildStatusEnum](BuildStatusEnum.md)
+`version` | string
+`type` | [ReleaseType](ReleaseType.md)
+`variant` | string
+`startedAt` | Date
+`finishedAt` | Date
+`hasArtifact` | boolean
+
+## Example
+
+```typescript
+import type { BuildTaskShortResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "startedById": null,
+  "device": null,
+  "status": null,
+  "version": null,
+  "type": null,
+  "variant": null,
+  "startedAt": null,
+  "finishedAt": null,
+  "hasArtifact": null,
+} satisfies BuildTaskShortResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as BuildTaskShortResponse
+console.log(exampleParsed)
+```
+
+[[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/DeviceApi.md

@@ -0,0 +1,315 @@
+# DeviceApi
+
+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
+
+> DeviceResponse getDevice(deviceId, id, codename)
+
+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.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DeviceApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { GetDeviceRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const api = new DeviceApi();
+
+  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)
+    codename: codename_example,
+  } satisfies GetDeviceRequest;
+
+  try {
+    const data = await api.getDevice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### 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**](DeviceResponse.md)
+
+### 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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDeviceDeprecated
+
+> DeviceResponse getDeviceDeprecated(deviceId)
+
+Get Device Short
+
+Gets device info using device ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DeviceApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { GetDeviceDeprecatedRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const api = new DeviceApi();
+
+  const body = {
+    // string
+    deviceId: deviceId_example,
+  } satisfies GetDeviceDeprecatedRequest;
+
+  try {
+    const data = await api.getDeviceDeprecated(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeviceResponse**](DeviceResponse.md)
+
+### 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#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)
+
+Get Devices
+
+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
+
+```ts
+import {
+  Configuration,
+  DeviceApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { GetDevicesRequest } 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);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+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`] |
+
+### Return type
+
+[**ListResponseShortDeviceResponse**](ListResponseShortDeviceResponse.md)
+
+### 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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getOems
+
+> ListResponseStr getOems()
+
+Get Oems
+
+Lists all OEM names
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DeviceApi,
+} 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();
+
+  try {
+    const data = await api.getOems();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListResponseStr**](ListResponseStr.md)
+
+### 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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/DeviceInternalResponse.md

@@ -0,0 +1,64 @@
+
+# DeviceInternalResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`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
+`stats` | [DeviceStatsResponse](DeviceStatsResponse.md)
+`freezed` | boolean
+`fullName` | string
+`url` | string
+
+## Example
+
+```typescript
+import type { DeviceInternalResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "codename": null,
+  "modelName": null,
+  "oemName": null,
+  "id": null,
+  "codenames": null,
+  "modelNames": null,
+  "supported": null,
+  "isFeatured": null,
+  "featuredText": null,
+  "maintainer": null,
+  "notes": null,
+  "deviceTree": null,
+  "stats": null,
+  "freezed": null,
+  "fullName": null,
+  "url": null,
+} satisfies DeviceInternalResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DeviceInternalResponse
+console.log(exampleParsed)
+```
+
+[[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/DeviceResponse.md

@@ -0,0 +1,60 @@
+
+# DeviceResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`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
+`url` | string
+
+## Example
+
+```typescript
+import type { DeviceResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "codename": null,
+  "modelName": null,
+  "oemName": null,
+  "id": null,
+  "codenames": null,
+  "modelNames": null,
+  "supported": null,
+  "isFeatured": null,
+  "featuredText": null,
+  "maintainer": null,
+  "notes": null,
+  "deviceTree": null,
+  "fullName": null,
+  "url": null,
+} satisfies DeviceResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DeviceResponse
+console.log(exampleParsed)
+```
+
+[[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/DeviceStatsResponse.md

@@ -0,0 +1,38 @@
+
+# DeviceStatsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`days` | { [key: string]: number; }
+`mirrors` | { [key: string]: number; }
+
+## Example
+
+```typescript
+import type { DeviceStatsResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": null,
+  "days": null,
+  "mirrors": null,
+} satisfies DeviceStatsResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DeviceStatsResponse
+console.log(exampleParsed)
+```
+
+[[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/DeviceUpdateBody.md

@@ -0,0 +1,44 @@
+
+# DeviceUpdateBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`oemName` | string
+`codenames` | Array<string>
+`modelNames` | Array<string>
+`supported` | boolean
+`freezed` | boolean
+`notes` | string
+
+## Example
+
+```typescript
+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,
+  "notes": null,
+} satisfies DeviceUpdateBody
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DeviceUpdateBody
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+