@orangefox-recovery/foxclient 6.0.6 → 6.0.8

package/dist/models/index.d.ts

@@ -12,7 +12,14 @@ export * from './PasteInput';
 export * from './PasteResponse';
 export * from './RecoveryImgResponse';
 export * from './ReleaseGroupsResponse';
+export * from './ReleaseListResponse';
 export * from './ReleaseResponse';
 export * from './ShortDeviceResponse';
 export * from './ShortReleaseResponse';
 export * from './TokenResponse';
+export * from './UptimeHealth';
+export * from './UptimeHealthHost';
+export * from './UptimeMonitor';
+export * from './UptimeMonitorGroup';
+export * from './UptimeMonitors';
+export * from './UptimeResponse';

package/dist/models/index.js

@@ -30,7 +30,14 @@ __exportStar(require("./PasteInput"), exports);
 __exportStar(require("./PasteResponse"), exports);
 __exportStar(require("./RecoveryImgResponse"), exports);
 __exportStar(require("./ReleaseGroupsResponse"), exports);
+__exportStar(require("./ReleaseListResponse"), exports);
 __exportStar(require("./ReleaseResponse"), exports);
 __exportStar(require("./ShortDeviceResponse"), exports);
 __exportStar(require("./ShortReleaseResponse"), exports);
 __exportStar(require("./TokenResponse"), exports);
+__exportStar(require("./UptimeHealth"), exports);
+__exportStar(require("./UptimeHealthHost"), exports);
+__exportStar(require("./UptimeMonitor"), exports);
+__exportStar(require("./UptimeMonitorGroup"), exports);
+__exportStar(require("./UptimeMonitors"), exports);
+__exportStar(require("./UptimeResponse"), exports);

package/dist/runtime.d.ts

@@ -2,7 +2,7 @@
  * 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: 6.0.6
+ * The version of the OpenAPI document: 6.0.8
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime.js

@@ -5,7 +5,7 @@
  * 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: 6.0.6
+ * The version of the OpenAPI document: 6.0.8
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/ListResponseReleaseResponseDataInner.md

@@ -26,7 +26,9 @@ Name | Type
 `mirrors` | { [key: string]: string; }
 `notes` | string
 `recoveryImg` | [RecoveryImgResponse](RecoveryImgResponse.md)
+`totalDownloads` | number
 `url` | string
+`weeklyDownloads` | number
 
 ## Example
 
@@ -55,7 +57,9 @@ const example = {
   "mirrors": null,
   "notes": null,
   "recoveryImg": null,
+  "totalDownloads": null,
   "url": null,
+  "weeklyDownloads": null,
 } satisfies ListResponseReleaseResponseDataInner
 
 console.log(example)

package/docs/ReleaseApi.md

@@ -300,7 +300,7 @@ No authorization required
 
 ## listReleases
 
-> ListResponseReleaseResponse listReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit)
+> ReleaseListResponse listReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit)
 
 GET /releases/ - List releases with filters.
 
@@ -388,7 +388,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**ListResponseReleaseResponse**](ListResponseReleaseResponse.md)
+[**ReleaseListResponse**](ReleaseListResponse.md)
 
 ### Authorization
 

package/docs/ReleaseListResponse.md

@@ -0,0 +1,37 @@
+
+# ReleaseListResponse
+
+Response body for `GET /releases`.  The shape of `data` depends on the `group` query parameter: a flat list by default (`ListResponse`), or a version-keyed map when `group=true` (`ReleaseGroupsResponse`). Modeled as an untagged `oneOf` so generated clients deserialize both shapes instead of assuming `data` is always an array (which made them call `.map` on the grouped object and throw).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`data` | { [key: string]: Array<ReleaseResponse>; }
+
+## Example
+
+```typescript
+import type { ReleaseListResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": null,
+  "data": null,
+} satisfies ReleaseListResponse
+
+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 ReleaseListResponse
+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

@@ -26,7 +26,9 @@ Name | Type
 `mirrors` | { [key: string]: string; }
 `notes` | string
 `recoveryImg` | [RecoveryImgResponse](RecoveryImgResponse.md)
+`totalDownloads` | number
 `url` | string
+`weeklyDownloads` | number
 
 ## Example
 
@@ -55,7 +57,9 @@ const example = {
   "mirrors": null,
   "notes": null,
   "recoveryImg": null,
+  "totalDownloads": null,
   "url": null,
+  "weeklyDownloads": null,
 } satisfies ReleaseResponse
 
 console.log(example)

package/docs/UptimeApi.md

@@ -0,0 +1,69 @@
+# UptimeApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getUptime**](UptimeApi.md#getuptime) | **GET** /uptime | GET /uptime - Aggregated public infrastructure status. |
+
+
+
+## getUptime
+
+> UptimeResponse getUptime()
+
+GET /uptime - Aggregated public infrastructure status.
+
+Combines the FoxHealth report with the Uptime Kuma status page into a single JSON object. Each upstream is fetched independently: if one fails its section is set to null. If both fail, a 502 is returned.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UptimeApi,
+} from '@orangefox-recovery/foxclient';
+import type { GetUptimeRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new UptimeApi();
+
+  try {
+    const data = await api.getUptime();
+    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
+
+[**UptimeResponse**](UptimeResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Aggregated infrastructure status |  -  |
+| **502** | All upstream status sources unavailable |  -  |
+
+[[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/UptimeHealth.md

@@ -0,0 +1,43 @@
+
+# UptimeHealth
+
+FoxHealth summary (without internal endpoint addresses).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`allUp` | boolean
+`hosts` | [Array<UptimeHealthHost>](UptimeHealthHost.md)
+`requiredUp` | boolean
+`role` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { UptimeHealth } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "allUp": null,
+  "hosts": null,
+  "requiredUp": null,
+  "role": null,
+  "status": null,
+} satisfies UptimeHealth
+
+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 UptimeHealth
+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/UptimeHealthHost.md

@@ -0,0 +1,41 @@
+
+# UptimeHealthHost
+
+A single FoxHealth host (the internal endpoint is intentionally omitted).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorText` | string
+`isOk` | boolean
+`isOptional` | boolean
+`nickname` | string
+
+## Example
+
+```typescript
+import type { UptimeHealthHost } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorText": null,
+  "isOk": null,
+  "isOptional": null,
+  "nickname": null,
+} satisfies UptimeHealthHost
+
+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 UptimeHealthHost
+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/UptimeMonitor.md

@@ -0,0 +1,49 @@
+
+# UptimeMonitor
+
+A single monitor with its current heartbeat and uptime ratio.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`lastHeartbeat` | string
+`name` | string
+`ping` | number
+`status` | string
+`type` | string
+`uptime24h` | number
+`url` | string
+
+## Example
+
+```typescript
+import type { UptimeMonitor } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "lastHeartbeat": null,
+  "name": null,
+  "ping": null,
+  "status": null,
+  "type": null,
+  "uptime24h": null,
+  "url": null,
+} satisfies UptimeMonitor
+
+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 UptimeMonitor
+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/UptimeMonitorGroup.md

@@ -0,0 +1,37 @@
+
+# UptimeMonitorGroup
+
+A group of monitors from the Uptime Kuma status page.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`monitors` | [Array<UptimeMonitor>](UptimeMonitor.md)
+`name` | string
+
+## Example
+
+```typescript
+import type { UptimeMonitorGroup } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "monitors": null,
+  "name": null,
+} satisfies UptimeMonitorGroup
+
+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 UptimeMonitorGroup
+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/UptimeMonitors.md

@@ -0,0 +1,37 @@
+
+# UptimeMonitors
+
+Uptime Kuma status page, grouped by monitor group.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`groups` | [Array<UptimeMonitorGroup>](UptimeMonitorGroup.md)
+`title` | string
+
+## Example
+
+```typescript
+import type { UptimeMonitors } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "groups": null,
+  "title": null,
+} satisfies UptimeMonitors
+
+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 UptimeMonitors
+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/UptimeResponse.md

@@ -0,0 +1,39 @@
+
+# UptimeResponse
+
+Aggregated infrastructure status returned by `GET /uptime`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`health` | [UptimeHealth](UptimeHealth.md)
+`monitors` | [UptimeMonitors](UptimeMonitors.md)
+`status` | string
+
+## Example
+
+```typescript
+import type { UptimeResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "health": null,
+  "monitors": null,
+  "status": null,
+} satisfies UptimeResponse
+
+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 UptimeResponse
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orangefox-recovery/foxclient",
-  "version": "6.0.6",
+  "version": "6.0.8",
   "description": "OpenAPI client for @orangefox-recovery/foxclient",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/DeviceApi.ts

@@ -4,7 +4,7 @@
  * 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: 6.0.6
+ * The version of the OpenAPI document: 6.0.8
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/PasteApi.ts

@@ -4,7 +4,7 @@
  * 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: 6.0.6
+ * The version of the OpenAPI document: 6.0.8
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/ReleaseApi.ts

@@ -4,7 +4,7 @@
  * 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: 6.0.6
+ * The version of the OpenAPI document: 6.0.8
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 import type {
   ErrorResponse,
   ListResponseReleaseResponse,
+  ReleaseListResponse,
   ReleaseResponse,
 } from '../models/index';
 import {
@@ -24,6 +25,8 @@ import {
     ErrorResponseToJSON,
     ListResponseReleaseResponseFromJSON,
     ListResponseReleaseResponseToJSON,
+    ReleaseListResponseFromJSON,
+    ReleaseListResponseToJSON,
     ReleaseResponseFromJSON,
     ReleaseResponseToJSON,
 } from '../models/index';
@@ -219,12 +222,12 @@ export interface ReleaseApiInterface {
      * @throws {RequiredError}
      * @memberof ReleaseApiInterface
      */
-    listReleasesRaw(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseReleaseResponse>>;
+    listReleasesRaw(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseListResponse>>;
 
     /**
      * GET /releases/ - List releases with filters.
      */
-    listReleases(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseReleaseResponse>;
+    listReleases(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseListResponse>;
 
 }
 
@@ -510,17 +513,17 @@ export class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInterface {
     /**
      * GET /releases/ - List releases with filters.
      */
-    async listReleasesRaw(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseReleaseResponse>> {
+    async listReleasesRaw(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseListResponse>> {
         const requestOptions = await this.listReleasesRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => ListResponseReleaseResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReleaseListResponseFromJSON(jsonValue));
     }
 
     /**
      * GET /releases/ - List releases with filters.
      */
-    async listReleases(requestParameters: ListReleasesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseReleaseResponse> {
+    async listReleases(requestParameters: ListReleasesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseListResponse> {
         const response = await this.listReleasesRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/apis/ReportApi.ts

@@ -4,7 +4,7 @@
  * 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: 6.0.6
+ * The version of the OpenAPI document: 6.0.8
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/apis/StatsApi.ts

@@ -4,7 +4,7 @@
  * 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: 6.0.6
+ * The version of the OpenAPI document: 6.0.8
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).