@orangefox-recovery/foxclient 6.0.7 → 6.0.8

package/src/models/UptimeHealth.ts

@@ -0,0 +1,110 @@
+/* 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.8
+ * 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 { mapValues } from '../runtime';
+import type { UptimeHealthHost } from './UptimeHealthHost';
+import {
+    UptimeHealthHostFromJSON,
+    UptimeHealthHostFromJSONTyped,
+    UptimeHealthHostToJSON,
+    UptimeHealthHostToJSONTyped,
+} from './UptimeHealthHost';
+
+/**
+ * FoxHealth summary (without internal endpoint addresses).
+ * @export
+ * @interface UptimeHealth
+ */
+export interface UptimeHealth {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UptimeHealth
+     */
+    allUp: boolean;
+    /**
+     * 
+     * @type {Array<UptimeHealthHost>}
+     * @memberof UptimeHealth
+     */
+    hosts: Array<UptimeHealthHost>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UptimeHealth
+     */
+    requiredUp: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof UptimeHealth
+     */
+    role: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UptimeHealth
+     */
+    status: string;
+}
+
+/**
+ * Check if a given object implements the UptimeHealth interface.
+ */
+export function instanceOfUptimeHealth(value: object): value is UptimeHealth {
+    if (!('allUp' in value) || value['allUp'] === undefined) return false;
+    if (!('hosts' in value) || value['hosts'] === undefined) return false;
+    if (!('requiredUp' in value) || value['requiredUp'] === undefined) return false;
+    if (!('role' in value) || value['role'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function UptimeHealthFromJSON(json: any): UptimeHealth {
+    return UptimeHealthFromJSONTyped(json, false);
+}
+
+export function UptimeHealthFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeHealth {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'allUp': json['allUp'],
+        'hosts': ((json['hosts'] as Array<any>).map(UptimeHealthHostFromJSON)),
+        'requiredUp': json['requiredUp'],
+        'role': json['role'],
+        'status': json['status'],
+    };
+}
+
+export function UptimeHealthToJSON(json: any): UptimeHealth {
+    return UptimeHealthToJSONTyped(json, false);
+}
+
+export function UptimeHealthToJSONTyped(value?: UptimeHealth | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'allUp': value['allUp'],
+        'hosts': ((value['hosts'] as Array<any>).map(UptimeHealthHostToJSON)),
+        'requiredUp': value['requiredUp'],
+        'role': value['role'],
+        'status': value['status'],
+    };
+}
+

package/src/models/UptimeHealthHost.ts

@@ -0,0 +1,92 @@
+/* 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.8
+ * 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 { mapValues } from '../runtime';
+/**
+ * A single FoxHealth host (the internal endpoint is intentionally omitted).
+ * @export
+ * @interface UptimeHealthHost
+ */
+export interface UptimeHealthHost {
+    /**
+     * 
+     * @type {string}
+     * @memberof UptimeHealthHost
+     */
+    errorText?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UptimeHealthHost
+     */
+    isOk: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UptimeHealthHost
+     */
+    isOptional: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof UptimeHealthHost
+     */
+    nickname: string;
+}
+
+/**
+ * Check if a given object implements the UptimeHealthHost interface.
+ */
+export function instanceOfUptimeHealthHost(value: object): value is UptimeHealthHost {
+    if (!('isOk' in value) || value['isOk'] === undefined) return false;
+    if (!('isOptional' in value) || value['isOptional'] === undefined) return false;
+    if (!('nickname' in value) || value['nickname'] === undefined) return false;
+    return true;
+}
+
+export function UptimeHealthHostFromJSON(json: any): UptimeHealthHost {
+    return UptimeHealthHostFromJSONTyped(json, false);
+}
+
+export function UptimeHealthHostFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeHealthHost {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'errorText': json['errorText'] == null ? undefined : json['errorText'],
+        'isOk': json['isOk'],
+        'isOptional': json['isOptional'],
+        'nickname': json['nickname'],
+    };
+}
+
+export function UptimeHealthHostToJSON(json: any): UptimeHealthHost {
+    return UptimeHealthHostToJSONTyped(json, false);
+}
+
+export function UptimeHealthHostToJSONTyped(value?: UptimeHealthHost | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'errorText': value['errorText'],
+        'isOk': value['isOk'],
+        'isOptional': value['isOptional'],
+        'nickname': value['nickname'],
+    };
+}
+

package/src/models/UptimeMonitor.ts

@@ -0,0 +1,125 @@
+/* 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.8
+ * 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 { mapValues } from '../runtime';
+/**
+ * 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 function instanceOfUptimeMonitor(value: object): value is UptimeMonitor {
+    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;
+}
+
+export function UptimeMonitorFromJSON(json: any): UptimeMonitor {
+    return UptimeMonitorFromJSONTyped(json, false);
+}
+
+export function UptimeMonitorFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeMonitor {
+    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'],
+    };
+}
+
+export function UptimeMonitorToJSON(json: any): UptimeMonitor {
+    return UptimeMonitorToJSONTyped(json, false);
+}
+
+export function UptimeMonitorToJSONTyped(value?: UptimeMonitor | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/UptimeMonitorGroup.ts

@@ -0,0 +1,83 @@
+/* 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.8
+ * 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 { mapValues } from '../runtime';
+import type { UptimeMonitor } from './UptimeMonitor';
+import {
+    UptimeMonitorFromJSON,
+    UptimeMonitorFromJSONTyped,
+    UptimeMonitorToJSON,
+    UptimeMonitorToJSONTyped,
+} 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 function instanceOfUptimeMonitorGroup(value: object): value is UptimeMonitorGroup {
+    if (!('monitors' in value) || value['monitors'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function UptimeMonitorGroupFromJSON(json: any): UptimeMonitorGroup {
+    return UptimeMonitorGroupFromJSONTyped(json, false);
+}
+
+export function UptimeMonitorGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeMonitorGroup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'monitors': ((json['monitors'] as Array<any>).map(UptimeMonitorFromJSON)),
+        'name': json['name'],
+    };
+}
+
+export function UptimeMonitorGroupToJSON(json: any): UptimeMonitorGroup {
+    return UptimeMonitorGroupToJSONTyped(json, false);
+}
+
+export function UptimeMonitorGroupToJSONTyped(value?: UptimeMonitorGroup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'monitors': ((value['monitors'] as Array<any>).map(UptimeMonitorToJSON)),
+        'name': value['name'],
+    };
+}
+

package/src/models/UptimeMonitors.ts

@@ -0,0 +1,83 @@
+/* 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.8
+ * 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 { mapValues } from '../runtime';
+import type { UptimeMonitorGroup } from './UptimeMonitorGroup';
+import {
+    UptimeMonitorGroupFromJSON,
+    UptimeMonitorGroupFromJSONTyped,
+    UptimeMonitorGroupToJSON,
+    UptimeMonitorGroupToJSONTyped,
+} 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 function instanceOfUptimeMonitors(value: object): value is UptimeMonitors {
+    if (!('groups' in value) || value['groups'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    return true;
+}
+
+export function UptimeMonitorsFromJSON(json: any): UptimeMonitors {
+    return UptimeMonitorsFromJSONTyped(json, false);
+}
+
+export function UptimeMonitorsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeMonitors {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'groups': ((json['groups'] as Array<any>).map(UptimeMonitorGroupFromJSON)),
+        'title': json['title'],
+    };
+}
+
+export function UptimeMonitorsToJSON(json: any): UptimeMonitors {
+    return UptimeMonitorsToJSONTyped(json, false);
+}
+
+export function UptimeMonitorsToJSONTyped(value?: UptimeMonitors | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'groups': ((value['groups'] as Array<any>).map(UptimeMonitorGroupToJSON)),
+        'title': value['title'],
+    };
+}
+

package/src/models/UptimeResponse.ts

@@ -0,0 +1,97 @@
+/* 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.8
+ * 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 { mapValues } from '../runtime';
+import type { UptimeHealth } from './UptimeHealth';
+import {
+    UptimeHealthFromJSON,
+    UptimeHealthFromJSONTyped,
+    UptimeHealthToJSON,
+    UptimeHealthToJSONTyped,
+} from './UptimeHealth';
+import type { UptimeMonitors } from './UptimeMonitors';
+import {
+    UptimeMonitorsFromJSON,
+    UptimeMonitorsFromJSONTyped,
+    UptimeMonitorsToJSON,
+    UptimeMonitorsToJSONTyped,
+} 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 function instanceOfUptimeResponse(value: object): value is UptimeResponse {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function UptimeResponseFromJSON(json: any): UptimeResponse {
+    return UptimeResponseFromJSONTyped(json, false);
+}
+
+export function UptimeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UptimeResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'health': json['health'] == null ? undefined : UptimeHealthFromJSON(json['health']),
+        'monitors': json['monitors'] == null ? undefined : UptimeMonitorsFromJSON(json['monitors']),
+        'status': json['status'],
+    };
+}
+
+export function UptimeResponseToJSON(json: any): UptimeResponse {
+    return UptimeResponseToJSONTyped(json, false);
+}
+
+export function UptimeResponseToJSONTyped(value?: UptimeResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'health': UptimeHealthToJSON(value['health']),
+        'monitors': UptimeMonitorsToJSON(value['monitors']),
+        'status': value['status'],
+    };
+}
+

package/src/models/index.ts

@@ -19,3 +19,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/src/runtime.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.7
+ * 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).