@orangefox-recovery/foxclient 6.0.7 → 6.0.9

package/dist/models/UptimeMonitor.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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.9
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A single monitor with its current heartbeat and uptime ratio.
+ * @export
+ * @interface UptimeMonitor
+ */
+export interface UptimeMonitor {
+    /**
+     *
+     * @type {number}
+     * @memberof UptimeMonitor
+     */
+    id: number;
+    /**
+     *
+     * @type {string}
+     * @memberof UptimeMonitor
+     */
+    lastHeartbeat?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UptimeMonitor
+     */
+    name: string;
+    /**
+     *
+     * @type {number}
+     * @memberof UptimeMonitor
+     */
+    ping?: number | null;
+    /**
+     * "up", "down", "pending", "maintenance" or "unknown".
+     * @type {string}
+     * @memberof UptimeMonitor
+     */
+    status: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UptimeMonitor
+     */
+    type: string;
+    /**
+     *
+     * @type {number}
+     * @memberof UptimeMonitor
+     */
+    uptime24h?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UptimeMonitor
+     */
+    url?: string | null;
+}
+/**
+ * Check if a given object implements the UptimeMonitor interface.
+ */
+export declare function instanceOfUptimeMonitor(value: object): value is UptimeMonitor;
+export declare function UptimeMonitorFromJSON(json: any): UptimeMonitor;
+export declare function UptimeMonitorFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeMonitor;
+export declare function UptimeMonitorToJSON(json: any): UptimeMonitor;
+export declare function UptimeMonitorToJSONTyped(value?: UptimeMonitor | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UptimeMonitor.js

@@ -0,0 +1,70 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.9
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUptimeMonitor = instanceOfUptimeMonitor;
+exports.UptimeMonitorFromJSON = UptimeMonitorFromJSON;
+exports.UptimeMonitorFromJSONTyped = UptimeMonitorFromJSONTyped;
+exports.UptimeMonitorToJSON = UptimeMonitorToJSON;
+exports.UptimeMonitorToJSONTyped = UptimeMonitorToJSONTyped;
+/**
+ * Check if a given object implements the UptimeMonitor interface.
+ */
+function instanceOfUptimeMonitor(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    return true;
+}
+function UptimeMonitorFromJSON(json) {
+    return UptimeMonitorFromJSONTyped(json, false);
+}
+function UptimeMonitorFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'lastHeartbeat': json['lastHeartbeat'] == null ? undefined : json['lastHeartbeat'],
+        'name': json['name'],
+        'ping': json['ping'] == null ? undefined : json['ping'],
+        'status': json['status'],
+        'type': json['type'],
+        'uptime24h': json['uptime24h'] == null ? undefined : json['uptime24h'],
+        'url': json['url'] == null ? undefined : json['url'],
+    };
+}
+function UptimeMonitorToJSON(json) {
+    return UptimeMonitorToJSONTyped(json, false);
+}
+function UptimeMonitorToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'lastHeartbeat': value['lastHeartbeat'],
+        'name': value['name'],
+        'ping': value['ping'],
+        'status': value['status'],
+        'type': value['type'],
+        'uptime24h': value['uptime24h'],
+        'url': value['url'],
+    };
+}

package/dist/models/UptimeMonitorGroup.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.9
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { UptimeMonitor } from './UptimeMonitor';
+/**
+ * A group of monitors from the Uptime Kuma status page.
+ * @export
+ * @interface UptimeMonitorGroup
+ */
+export interface UptimeMonitorGroup {
+    /**
+     *
+     * @type {Array<UptimeMonitor>}
+     * @memberof UptimeMonitorGroup
+     */
+    monitors: Array<UptimeMonitor>;
+    /**
+     *
+     * @type {string}
+     * @memberof UptimeMonitorGroup
+     */
+    name: string;
+}
+/**
+ * Check if a given object implements the UptimeMonitorGroup interface.
+ */
+export declare function instanceOfUptimeMonitorGroup(value: object): value is UptimeMonitorGroup;
+export declare function UptimeMonitorGroupFromJSON(json: any): UptimeMonitorGroup;
+export declare function UptimeMonitorGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeMonitorGroup;
+export declare function UptimeMonitorGroupToJSON(json: any): UptimeMonitorGroup;
+export declare function UptimeMonitorGroupToJSONTyped(value?: UptimeMonitorGroup | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UptimeMonitorGroup.js

@@ -0,0 +1,55 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.9
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUptimeMonitorGroup = instanceOfUptimeMonitorGroup;
+exports.UptimeMonitorGroupFromJSON = UptimeMonitorGroupFromJSON;
+exports.UptimeMonitorGroupFromJSONTyped = UptimeMonitorGroupFromJSONTyped;
+exports.UptimeMonitorGroupToJSON = UptimeMonitorGroupToJSON;
+exports.UptimeMonitorGroupToJSONTyped = UptimeMonitorGroupToJSONTyped;
+const UptimeMonitor_1 = require("./UptimeMonitor");
+/**
+ * Check if a given object implements the UptimeMonitorGroup interface.
+ */
+function instanceOfUptimeMonitorGroup(value) {
+    if (!('monitors' in value) || value['monitors'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function UptimeMonitorGroupFromJSON(json) {
+    return UptimeMonitorGroupFromJSONTyped(json, false);
+}
+function UptimeMonitorGroupFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'monitors': (json['monitors'].map(UptimeMonitor_1.UptimeMonitorFromJSON)),
+        'name': json['name'],
+    };
+}
+function UptimeMonitorGroupToJSON(json) {
+    return UptimeMonitorGroupToJSONTyped(json, false);
+}
+function UptimeMonitorGroupToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'monitors': (value['monitors'].map(UptimeMonitor_1.UptimeMonitorToJSON)),
+        'name': value['name'],
+    };
+}

package/dist/models/UptimeMonitors.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.9
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { UptimeMonitorGroup } from './UptimeMonitorGroup';
+/**
+ * Uptime Kuma status page, grouped by monitor group.
+ * @export
+ * @interface UptimeMonitors
+ */
+export interface UptimeMonitors {
+    /**
+     *
+     * @type {Array<UptimeMonitorGroup>}
+     * @memberof UptimeMonitors
+     */
+    groups: Array<UptimeMonitorGroup>;
+    /**
+     *
+     * @type {string}
+     * @memberof UptimeMonitors
+     */
+    title: string;
+}
+/**
+ * Check if a given object implements the UptimeMonitors interface.
+ */
+export declare function instanceOfUptimeMonitors(value: object): value is UptimeMonitors;
+export declare function UptimeMonitorsFromJSON(json: any): UptimeMonitors;
+export declare function UptimeMonitorsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeMonitors;
+export declare function UptimeMonitorsToJSON(json: any): UptimeMonitors;
+export declare function UptimeMonitorsToJSONTyped(value?: UptimeMonitors | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UptimeMonitors.js

@@ -0,0 +1,55 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.9
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUptimeMonitors = instanceOfUptimeMonitors;
+exports.UptimeMonitorsFromJSON = UptimeMonitorsFromJSON;
+exports.UptimeMonitorsFromJSONTyped = UptimeMonitorsFromJSONTyped;
+exports.UptimeMonitorsToJSON = UptimeMonitorsToJSON;
+exports.UptimeMonitorsToJSONTyped = UptimeMonitorsToJSONTyped;
+const UptimeMonitorGroup_1 = require("./UptimeMonitorGroup");
+/**
+ * Check if a given object implements the UptimeMonitors interface.
+ */
+function instanceOfUptimeMonitors(value) {
+    if (!('groups' in value) || value['groups'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    return true;
+}
+function UptimeMonitorsFromJSON(json) {
+    return UptimeMonitorsFromJSONTyped(json, false);
+}
+function UptimeMonitorsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'groups': (json['groups'].map(UptimeMonitorGroup_1.UptimeMonitorGroupFromJSON)),
+        'title': json['title'],
+    };
+}
+function UptimeMonitorsToJSON(json) {
+    return UptimeMonitorsToJSONTyped(json, false);
+}
+function UptimeMonitorsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'groups': (value['groups'].map(UptimeMonitorGroup_1.UptimeMonitorGroupToJSON)),
+        'title': value['title'],
+    };
+}

package/dist/models/UptimeResponse.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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.9
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { UptimeHealth } from './UptimeHealth';
+import type { UptimeMonitors } from './UptimeMonitors';
+/**
+ * Aggregated infrastructure status returned by `GET /uptime`.
+ * @export
+ * @interface UptimeResponse
+ */
+export interface UptimeResponse {
+    /**
+     * FoxHealth result, or null if that upstream is unavailable.
+     * @type {UptimeHealth}
+     * @memberof UptimeResponse
+     */
+    health?: UptimeHealth | null;
+    /**
+     * Uptime Kuma status page result, or null if that upstream is unavailable.
+     * @type {UptimeMonitors}
+     * @memberof UptimeResponse
+     */
+    monitors?: UptimeMonitors | null;
+    /**
+     * Overall status: "healthy", "degraded" or "down".
+     * @type {string}
+     * @memberof UptimeResponse
+     */
+    status: string;
+}
+/**
+ * Check if a given object implements the UptimeResponse interface.
+ */
+export declare function instanceOfUptimeResponse(value: object): value is UptimeResponse;
+export declare function UptimeResponseFromJSON(json: any): UptimeResponse;
+export declare function UptimeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeResponse;
+export declare function UptimeResponseToJSON(json: any): UptimeResponse;
+export declare function UptimeResponseToJSONTyped(value?: UptimeResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/UptimeResponse.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.9
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfUptimeResponse = instanceOfUptimeResponse;
+exports.UptimeResponseFromJSON = UptimeResponseFromJSON;
+exports.UptimeResponseFromJSONTyped = UptimeResponseFromJSONTyped;
+exports.UptimeResponseToJSON = UptimeResponseToJSON;
+exports.UptimeResponseToJSONTyped = UptimeResponseToJSONTyped;
+const UptimeHealth_1 = require("./UptimeHealth");
+const UptimeMonitors_1 = require("./UptimeMonitors");
+/**
+ * Check if a given object implements the UptimeResponse interface.
+ */
+function instanceOfUptimeResponse(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+function UptimeResponseFromJSON(json) {
+    return UptimeResponseFromJSONTyped(json, false);
+}
+function UptimeResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'health': json['health'] == null ? undefined : (0, UptimeHealth_1.UptimeHealthFromJSON)(json['health']),
+        'monitors': json['monitors'] == null ? undefined : (0, UptimeMonitors_1.UptimeMonitorsFromJSON)(json['monitors']),
+        'status': json['status'],
+    };
+}
+function UptimeResponseToJSON(json) {
+    return UptimeResponseToJSONTyped(json, false);
+}
+function UptimeResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'health': (0, UptimeHealth_1.UptimeHealthToJSON)(value['health']),
+        'monitors': (0, UptimeMonitors_1.UptimeMonitorsToJSON)(value['monitors']),
+        'status': value['status'],
+    };
+}

package/dist/models/index.d.ts

@@ -17,3 +17,9 @@ 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

@@ -35,3 +35,9 @@ __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.7
+ * The version of the OpenAPI document: 6.0.9
  * 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.7
+ * The version of the OpenAPI document: 6.0.9
  * 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/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)
+
+