@orangefox-recovery/foxclient 6.0.9 → 6.1.0

package/docs/WikiPageResponse.md

@@ -0,0 +1,66 @@
+
+# WikiPageResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`draft` | boolean
+`fileName` | string
+`icon` | string
+`id` | string
+`image` | string
+`lastUpdated` | string
+`noindex` | boolean
+`parentPath` | string
+`path` | string
+`title` | string
+`type` | string
+`content` | string
+`createdAt` | string
+`deviceId` | string
+`revision` | number
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { WikiPageResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "draft": null,
+  "fileName": null,
+  "icon": null,
+  "id": null,
+  "image": null,
+  "lastUpdated": null,
+  "noindex": null,
+  "parentPath": null,
+  "path": null,
+  "title": null,
+  "type": null,
+  "content": null,
+  "createdAt": null,
+  "deviceId": null,
+  "revision": null,
+  "updatedAt": null,
+} satisfies WikiPageResponse
+
+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 WikiPageResponse
+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/WikiPageShortResponse.md

@@ -0,0 +1,57 @@
+
+# WikiPageShortResponse
+
+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.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`draft` | boolean
+`fileName` | string
+`icon` | string
+`id` | string
+`image` | string
+`lastUpdated` | string
+`noindex` | boolean
+`parentPath` | string
+`path` | string
+`title` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { WikiPageShortResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "draft": null,
+  "fileName": null,
+  "icon": null,
+  "id": null,
+  "image": null,
+  "lastUpdated": null,
+  "noindex": null,
+  "parentPath": null,
+  "path": null,
+  "title": null,
+  "type": null,
+} satisfies WikiPageShortResponse
+
+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 WikiPageShortResponse
+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/WikiSiteResponse.md

@@ -0,0 +1,48 @@
+
+# WikiSiteResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`defaultPage` | string
+`description` | string
+`devicePages` | string
+`id` | string
+`name` | string
+`slug` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { WikiSiteResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "defaultPage": null,
+  "description": null,
+  "devicePages": null,
+  "id": null,
+  "name": null,
+  "slug": null,
+  "updatedAt": null,
+} satisfies WikiSiteResponse
+
+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 WikiSiteResponse
+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.9",
+  "version": "6.1.0",
   "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.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).

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.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).

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.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).
@@ -201,7 +201,7 @@ export interface ReleaseApiInterface {
 
     /**
      * 
-     * @summary GET /releases/ - List releases with filters.
+     * @summary Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
      * @param {string} [id] 
      * @param {string} [id2] 
      * @param {string} [buildId] 
@@ -225,7 +225,7 @@ export interface ReleaseApiInterface {
     listReleasesRaw(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseListResponse>>;
 
     /**
-     * GET /releases/ - List releases with filters.
+     * Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
      */
     listReleases(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseListResponse>;
 
@@ -511,7 +511,7 @@ export class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInterface {
     }
 
     /**
-     * GET /releases/ - List releases with filters.
+     * Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
      */
     async listReleasesRaw(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseListResponse>> {
         const requestOptions = await this.listReleasesRequestOpts(requestParameters);
@@ -521,7 +521,7 @@ export class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInterface {
     }
 
     /**
-     * GET /releases/ - List releases with filters.
+     * Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
      */
     async listReleases(requestParameters: ListReleasesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseListResponse> {
         const response = await this.listReleasesRaw(requestParameters, initOverrides);

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.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).

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.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).

package/src/apis/UptimeApi.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).