@orangefox-recovery/foxclient 6.0.9 → 6.1.0

package/src/models/WikiPageResponse.ts

@@ -0,0 +1,205 @@
+/* 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.1.0
+ * 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';
+/**
+ * 
+ * @export
+ * @interface WikiPageResponse
+ */
+export interface WikiPageResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    description?: string;
+    /**
+     * Always `false` on public responses — drafts are filtered out by the query.
+     * @type {boolean}
+     * @memberof WikiPageResponse
+     */
+    draft: boolean;
+    /**
+     * Last path segment.
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    fileName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    icon?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    image?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    lastUpdated: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof WikiPageResponse
+     */
+    noindex: boolean;
+    /**
+     * Parent folder path, "" at the root.
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    parentPath: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    path: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    title: string;
+    /**
+     * "md" or "json". Named `type` to match FoxWiki's `WikiPageShort`.
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    type: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    content: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    createdAt: string;
+    /**
+     * Set when the page is a device page owned by its maintainer.
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    deviceId?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof WikiPageResponse
+     */
+    revision: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageResponse
+     */
+    updatedAt?: string | null;
+}
+
+/**
+ * Check if a given object implements the WikiPageResponse interface.
+ */
+export function instanceOfWikiPageResponse(value: object): value is WikiPageResponse {
+    if (!('draft' in value) || value['draft'] === undefined) return false;
+    if (!('fileName' in value) || value['fileName'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('lastUpdated' in value) || value['lastUpdated'] === undefined) return false;
+    if (!('noindex' in value) || value['noindex'] === undefined) return false;
+    if (!('parentPath' in value) || value['parentPath'] === undefined) return false;
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('revision' in value) || value['revision'] === undefined) return false;
+    return true;
+}
+
+export function WikiPageResponseFromJSON(json: any): WikiPageResponse {
+    return WikiPageResponseFromJSONTyped(json, false);
+}
+
+export function WikiPageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikiPageResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'description': json['description'] == null ? undefined : json['description'],
+        'draft': json['draft'],
+        'fileName': json['file_name'],
+        'icon': json['icon'] == null ? undefined : json['icon'],
+        'id': json['id'],
+        'image': json['image'] == null ? undefined : json['image'],
+        'lastUpdated': json['last_updated'],
+        'noindex': json['noindex'],
+        'parentPath': json['parent_path'],
+        'path': json['path'],
+        'title': json['title'],
+        'type': json['type'],
+        'content': json['content'],
+        'createdAt': json['created_at'],
+        'deviceId': json['device_id'] == null ? undefined : json['device_id'],
+        'revision': json['revision'],
+        'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
+    };
+}
+
+export function WikiPageResponseToJSON(json: any): WikiPageResponse {
+    return WikiPageResponseToJSONTyped(json, false);
+}
+
+export function WikiPageResponseToJSONTyped(value?: WikiPageResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'description': value['description'],
+        'draft': value['draft'],
+        'file_name': value['fileName'],
+        'icon': value['icon'],
+        'id': value['id'],
+        'image': value['image'],
+        'last_updated': value['lastUpdated'],
+        'noindex': value['noindex'],
+        'parent_path': value['parentPath'],
+        'path': value['path'],
+        'title': value['title'],
+        'type': value['type'],
+        'content': value['content'],
+        'created_at': value['createdAt'],
+        'device_id': value['deviceId'],
+        'revision': value['revision'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/WikiPageShortResponse.ts

@@ -0,0 +1,163 @@
+/* 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.1.0
+ * 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 page without its body. FoxWiki fetches the whole set of these once and
+ * builds its navigation tree from them, so this must stay cheap.
+ * @export
+ * @interface WikiPageShortResponse
+ */
+export interface WikiPageShortResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    description?: string | null;
+    /**
+     * Always `false` on public responses — drafts are filtered out by the query.
+     * @type {boolean}
+     * @memberof WikiPageShortResponse
+     */
+    draft: boolean;
+    /**
+     * Last path segment.
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    fileName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    icon?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    image?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    lastUpdated: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof WikiPageShortResponse
+     */
+    noindex: boolean;
+    /**
+     * Parent folder path, "" at the root.
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    parentPath: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    path: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    title: string;
+    /**
+     * "md" or "json". Named `type` to match FoxWiki's `WikiPageShort`.
+     * @type {string}
+     * @memberof WikiPageShortResponse
+     */
+    type: string;
+}
+
+/**
+ * Check if a given object implements the WikiPageShortResponse interface.
+ */
+export function instanceOfWikiPageShortResponse(value: object): value is WikiPageShortResponse {
+    if (!('draft' in value) || value['draft'] === undefined) return false;
+    if (!('fileName' in value) || value['fileName'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('lastUpdated' in value) || value['lastUpdated'] === undefined) return false;
+    if (!('noindex' in value) || value['noindex'] === undefined) return false;
+    if (!('parentPath' in value) || value['parentPath'] === undefined) return false;
+    if (!('path' in value) || value['path'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function WikiPageShortResponseFromJSON(json: any): WikiPageShortResponse {
+    return WikiPageShortResponseFromJSONTyped(json, false);
+}
+
+export function WikiPageShortResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikiPageShortResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'description': json['description'] == null ? undefined : json['description'],
+        'draft': json['draft'],
+        'fileName': json['file_name'],
+        'icon': json['icon'] == null ? undefined : json['icon'],
+        'id': json['id'],
+        'image': json['image'] == null ? undefined : json['image'],
+        'lastUpdated': json['last_updated'],
+        'noindex': json['noindex'],
+        'parentPath': json['parent_path'],
+        'path': json['path'],
+        'title': json['title'],
+        'type': json['type'],
+    };
+}
+
+export function WikiPageShortResponseToJSON(json: any): WikiPageShortResponse {
+    return WikiPageShortResponseToJSONTyped(json, false);
+}
+
+export function WikiPageShortResponseToJSONTyped(value?: WikiPageShortResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'description': value['description'],
+        'draft': value['draft'],
+        'file_name': value['fileName'],
+        'icon': value['icon'],
+        'id': value['id'],
+        'image': value['image'],
+        'last_updated': value['lastUpdated'],
+        'noindex': value['noindex'],
+        'parent_path': value['parentPath'],
+        'path': value['path'],
+        'title': value['title'],
+        'type': value['type'],
+    };
+}
+

package/src/models/WikiSiteResponse.ts

@@ -0,0 +1,126 @@
+/* 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.1.0
+ * 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';
+/**
+ * 
+ * @export
+ * @interface WikiSiteResponse
+ */
+export interface WikiSiteResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiSiteResponse
+     */
+    createdAt: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiSiteResponse
+     */
+    defaultPage: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiSiteResponse
+     */
+    description?: string | null;
+    /**
+     * Path prefix device maintainers may write under, if the site opted in.
+     * @type {string}
+     * @memberof WikiSiteResponse
+     */
+    devicePages?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiSiteResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiSiteResponse
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiSiteResponse
+     */
+    slug: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WikiSiteResponse
+     */
+    updatedAt?: string | null;
+}
+
+/**
+ * Check if a given object implements the WikiSiteResponse interface.
+ */
+export function instanceOfWikiSiteResponse(value: object): value is WikiSiteResponse {
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('defaultPage' in value) || value['defaultPage'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('slug' in value) || value['slug'] === undefined) return false;
+    return true;
+}
+
+export function WikiSiteResponseFromJSON(json: any): WikiSiteResponse {
+    return WikiSiteResponseFromJSONTyped(json, false);
+}
+
+export function WikiSiteResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikiSiteResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'createdAt': json['created_at'],
+        'defaultPage': json['default_page'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'devicePages': json['device_pages'] == null ? undefined : json['device_pages'],
+        'id': json['id'],
+        'name': json['name'],
+        'slug': json['slug'],
+        'updatedAt': json['updated_at'] == null ? undefined : json['updated_at'],
+    };
+}
+
+export function WikiSiteResponseToJSON(json: any): WikiSiteResponse {
+    return WikiSiteResponseToJSONTyped(json, false);
+}
+
+export function WikiSiteResponseToJSONTyped(value?: WikiSiteResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'created_at': value['createdAt'],
+        'default_page': value['defaultPage'],
+        'description': value['description'],
+        'device_pages': value['devicePages'],
+        'id': value['id'],
+        'name': value['name'],
+        'slug': value['slug'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/index.ts

@@ -8,6 +8,10 @@ export * from './ListResponseReleaseResponseDataInner';
 export * from './ListResponseShortDeviceResponse';
 export * from './ListResponseShortDeviceResponseDataInner';
 export * from './ListResponseString';
+export * from './ListResponseWikiPageShortResponse';
+export * from './ListResponseWikiPageShortResponseDataInner';
+export * from './ListResponseWikiSiteResponse';
+export * from './ListResponseWikiSiteResponseDataInner';
 export * from './MaintainerShortResponse';
 export * from './NewReportRequest';
 export * from './PasteInput';
@@ -25,3 +29,6 @@ export * from './UptimeMonitor';
 export * from './UptimeMonitorGroup';
 export * from './UptimeMonitors';
 export * from './UptimeResponse';
+export * from './WikiPageResponse';
+export * from './WikiPageShortResponse';
+export * from './WikiSiteResponse';

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