@orangefox-recovery/foxinternalclient 5.3.0 → 5.3.2

package/docs/ReleaseApi.md

@@ -0,0 +1,354 @@
+# ReleaseApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getRelease**](ReleaseApi.md#getrelease) | **GET** /releases/get | Get Release |
+| [**getReleaseDeprecated**](ReleaseApi.md#getreleasedeprecated) | **GET** /releases/{release_id} | Get Release Short |
+| [**getReleases**](ReleaseApi.md#getreleases) | **GET** /releases/ | Get Releases |
+| [**getUpdatesDeprecated**](ReleaseApi.md#getupdatesdeprecated) | **GET** /updates/{last_known_id} | Get Updates |
+
+
+
+## getRelease
+
+> ReleaseResponse getRelease(releaseId, id, buildId, filename)
+
+Get Release
+
+Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID.  Example: /device/get?codename=lavender  Calling this method without parameters will return the latest available release in the database  Warning: the filename identification is deprecated! Use /release/<release_id> instead!
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReleaseApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { GetReleaseRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const api = new ReleaseApi();
+
+  const body = {
+    // string | Release ID (optional)
+    releaseId: releaseId_example,
+    // string | Release ID (deprecated) (optional)
+    id: id_example,
+    // string | Build ID, `ro.build.fox_id` prop (optional)
+    buildId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    filename: filename_example,
+  } satisfies GetReleaseRequest;
+
+  try {
+    const data = await api.getRelease(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **releaseId** | `string` | Release ID | [Optional] [Defaults to `undefined`] |
+| **id** | `string` | Release ID (deprecated) | [Optional] [Defaults to `undefined`] |
+| **buildId** | `string` | Build ID, `ro.build.fox_id` prop | [Optional] [Defaults to `undefined`] |
+| **filename** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ReleaseResponse**](ReleaseResponse.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 |  -  |
+| **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)
+
+
+## getReleaseDeprecated
+
+> ReleaseResponse getReleaseDeprecated(releaseId)
+
+Get Release Short
+
+Gets release information using the release ID, nothing to discuss really.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReleaseApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { GetReleaseDeprecatedRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const api = new ReleaseApi();
+
+  const body = {
+    // string
+    releaseId: releaseId_example,
+  } satisfies GetReleaseDeprecatedRequest;
+
+  try {
+    const data = await api.getReleaseDeprecated(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **releaseId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ReleaseResponse**](ReleaseResponse.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 |  -  |
+| **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)
+
+
+## getReleases
+
+> ResponseGetReleases getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit)
+
+Get Releases
+
+Lists releases.  This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one  (aka get updates).  You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device.  Getting releases by device codename is obsolete thought. The reason for this is that devices could change  codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID  somewhere and use it afterward.  Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod  versions and very different by each maintainer.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReleaseApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { GetReleasesRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const api = new ReleaseApi();
+
+  const body = {
+    // Array<string> | Filter by Release IDs (optional)
+    id: ...,
+    // Array<string> | Filter by Release IDs (deprecated) (optional)
+    id2: ...,
+    // Array<string> | Filter by Build IDs (optional)
+    buildId: ...,
+    // Array<string> | Filter by Device IDs (optional)
+    deviceId: ...,
+    // Array<string> | Filter by Maintainer IDs (optional)
+    maintainerId: ...,
+    // Array<string> | Filter by device codenames (optional)
+    codename: ...,
+    // Array<string> | Filter by release version (optional)
+    version: ...,
+    // Array<ReleaseType> | Filter by release type (optional)
+    type: ...,
+    // boolean | Filter by the archived status (optional)
+    archived: true,
+    // boolean | Filter by the freezed status (optional)
+    freezed: true,
+    // string | Show releases after the provided one (optional)
+    afterReleaseId: afterReleaseId_example,
+    // number | Show releases after the provided timestamp (optional)
+    afterDate: 56,
+    // ReleasesSort | Sort mode (optional)
+    sort: ...,
+    // boolean | Group releases by version + variant. This will change the response! (optional)
+    group: true,
+    // number | Skip query results (optional)
+    skip: 56,
+    // number | Limit query results (0 means unlimited) (optional)
+    limit: 56,
+  } satisfies GetReleasesRequest;
+
+  try {
+    const data = await api.getReleases(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 Release IDs | [Optional] |
+| **id2** | `Array<string>` | Filter by Release IDs (deprecated) | [Optional] |
+| **buildId** | `Array<string>` | Filter by Build IDs | [Optional] |
+| **deviceId** | `Array<string>` | Filter by Device IDs | [Optional] |
+| **maintainerId** | `Array<string>` | Filter by Maintainer IDs | [Optional] |
+| **codename** | `Array<string>` | Filter by device codenames | [Optional] |
+| **version** | `Array<string>` | Filter by release version | [Optional] |
+| **type** | `Array<ReleaseType>` | Filter by release type | [Optional] |
+| **archived** | `boolean` | Filter by the archived status | [Optional] [Defaults to `undefined`] |
+| **freezed** | `boolean` | Filter by the freezed status | [Optional] [Defaults to `undefined`] |
+| **afterReleaseId** | `string` | Show releases after the provided one | [Optional] [Defaults to `undefined`] |
+| **afterDate** | `number` | Show releases after the provided timestamp | [Optional] [Defaults to `undefined`] |
+| **sort** | `ReleasesSort` | Sort mode | [Optional] [Defaults to `undefined`] [Enum: date_asc, date_desc] |
+| **group** | `boolean` | Group releases by version + variant. This will change the response! | [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
+
+[**ResponseGetReleases**](ResponseGetReleases.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)
+
+
+## getUpdatesDeprecated
+
+> ListResponseShortReleaseResponse getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit)
+
+Get Updates
+
+Get updates method. Returns all new releases with release IDs.  For example, \&quot;/updates/&lt;id&gt;\&quot; will return a list of all releases that were created after. You can also use \&quot;device_id\&quot; or / and \&quot;release_type\&quot; params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device.  Warning: This method is obsolete! Please use /release/?after_release_id&#x3D; instead!
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReleaseApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { GetUpdatesDeprecatedRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const api = new ReleaseApi();
+
+  const body = {
+    // string
+    lastKnownId: lastKnownId_example,
+    // Array<string> | Filter by device ID (optional)
+    deviceId: ...,
+    // Array<ReleaseType> | Filter by release type (optional)
+    type: ...,
+    // Array<ReleaseType> | Filter by release type (legacy) (optional)
+    releaseType: ...,
+    // number | Skip query results (optional)
+    skip: 56,
+    // number | Limit query results (0 means unlimited) (optional)
+    limit: 56,
+  } satisfies GetUpdatesDeprecatedRequest;
+
+  try {
+    const data = await api.getUpdatesDeprecated(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **lastKnownId** | `string` |  | [Defaults to `undefined`] |
+| **deviceId** | `Array<string>` | Filter by device ID | [Optional] |
+| **type** | `Array<ReleaseType>` | Filter by release type | [Optional] |
+| **releaseType** | `Array<ReleaseType>` | Filter by release type (legacy) | [Optional] |
+| **skip** | `number` | Skip query results | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` | Limit query results (0 means unlimited) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListResponseShortReleaseResponse**](ListResponseShortReleaseResponse.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 |  -  |
+| **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)
+

package/docs/ReleaseGroupsResponse.md

@@ -0,0 +1,34 @@
+
+# ReleaseGroupsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | { [key: string]: Array<ReleaseResponse>; }
+
+## Example
+
+```typescript
+import type { ReleaseGroupsResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies ReleaseGroupsResponse
+
+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 ReleaseGroupsResponse
+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/ReleaseInternalResponse.md

@@ -0,0 +1,78 @@
+
+# ReleaseInternalResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`size` | number
+`id` | string
+`buildId` | string
+`filename` | string
+`variant` | string
+`deviceId` | string
+`date` | number
+`md5` | string
+`version` | string
+`type` | [ReleaseType](ReleaseType.md)
+`maintainerId` | string
+`archived` | boolean
+`isFeatured` | boolean
+`featuredText` | string
+`recoveryImg` | [RecoveryImgResponse](RecoveryImgResponse.md)
+`changelog` | Array<string>
+`bugs` | Array<string>
+`notes` | string
+`prop` | [{ [key: string]: ReleaseInternalResponsePropValue; }](ReleaseInternalResponsePropValue.md)
+`stats` | [ReleaseStatsResponse](ReleaseStatsResponse.md)
+`maintainer` | [MaintainerShortModel](MaintainerShortModel.md)
+`url` | string
+`mirrors` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { ReleaseInternalResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "size": null,
+  "id": null,
+  "buildId": null,
+  "filename": null,
+  "variant": null,
+  "deviceId": null,
+  "date": null,
+  "md5": null,
+  "version": null,
+  "type": null,
+  "maintainerId": null,
+  "archived": null,
+  "isFeatured": null,
+  "featuredText": null,
+  "recoveryImg": null,
+  "changelog": null,
+  "bugs": null,
+  "notes": null,
+  "prop": null,
+  "stats": null,
+  "maintainer": null,
+  "url": null,
+  "mirrors": null,
+} satisfies ReleaseInternalResponse
+
+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 ReleaseInternalResponse
+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/ReleaseInternalResponsePropValue.md

@@ -0,0 +1,32 @@
+
+# ReleaseInternalResponsePropValue
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ReleaseInternalResponsePropValue } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ReleaseInternalResponsePropValue
+
+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 ReleaseInternalResponsePropValue
+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/ReleaseResponse.md

@@ -0,0 +1,72 @@
+
+# ReleaseResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`size` | number
+`id` | string
+`buildId` | string
+`filename` | string
+`variant` | string
+`deviceId` | string
+`date` | number
+`md5` | string
+`version` | string
+`type` | [ReleaseType](ReleaseType.md)
+`maintainerId` | string
+`archived` | boolean
+`isFeatured` | boolean
+`featuredText` | string
+`recoveryImg` | [RecoveryImgResponse](RecoveryImgResponse.md)
+`changelog` | Array<string>
+`bugs` | Array<string>
+`notes` | string
+`url` | string
+`mirrors` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { ReleaseResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "size": null,
+  "id": null,
+  "buildId": null,
+  "filename": null,
+  "variant": null,
+  "deviceId": null,
+  "date": null,
+  "md5": null,
+  "version": null,
+  "type": null,
+  "maintainerId": null,
+  "archived": null,
+  "isFeatured": null,
+  "featuredText": null,
+  "recoveryImg": null,
+  "changelog": null,
+  "bugs": null,
+  "notes": null,
+  "url": null,
+  "mirrors": null,
+} satisfies ReleaseResponse
+
+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 ReleaseResponse
+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/ReleaseStatsResponse.md

@@ -0,0 +1,38 @@
+
+# ReleaseStatsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`days` | { [key: string]: number; }
+`mirrors` | { [key: string]: number; }
+
+## Example
+
+```typescript
+import type { ReleaseStatsResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": null,
+  "days": null,
+  "mirrors": null,
+} satisfies ReleaseStatsResponse
+
+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 ReleaseStatsResponse
+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/ReleaseType.md

@@ -0,0 +1,32 @@
+
+# ReleaseType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ReleaseType } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ReleaseType
+
+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 ReleaseType
+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/ReleaseUpdateBody.md

@@ -0,0 +1,40 @@
+
+# ReleaseUpdateBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`changelog` | Array<string>
+`bugs` | Array<string>
+`notes` | string
+`freezed` | boolean
+
+## Example
+
+```typescript
+import type { ReleaseUpdateBody } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "changelog": null,
+  "bugs": null,
+  "notes": null,
+  "freezed": null,
+} satisfies ReleaseUpdateBody
+
+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 ReleaseUpdateBody
+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)
+
+