@orangefox-recovery/foxclient 6.0.10 → 6.1.1

package/docs/WikiApi.md

@@ -0,0 +1,360 @@
+# WikiApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAsset**](WikiApi.md#getasset) | **GET** /wiki/{site}/assets/{path} | GET /wiki/{site}/assets/{path} - Serve asset bytes. |
+| [**getPage**](WikiApi.md#getpage) | **GET** /wiki/{site}/pages/{path} | GET /wiki/{site}/pages/{path} - Fetch one published page. |
+| [**getSite**](WikiApi.md#getsite) | **GET** /wiki/sites/{slug} | GET /wiki/sites/{slug} - Fetch one wiki site. |
+| [**listPages**](WikiApi.md#listpages) | **GET** /wiki/{site}/pages | GET /wiki/{site}/pages - List every published page in a site. |
+| [**listSites**](WikiApi.md#listsites) | **GET** /wiki/sites | GET /wiki/sites - List wiki sites. |
+
+
+
+## getAsset
+
+> getAsset(site, path)
+
+GET /wiki/{site}/assets/{path} - Serve asset bytes.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WikiApi,
+} from '@orangefox-recovery/foxclient';
+import type { GetAssetRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new WikiApi();
+
+  const body = {
+    // string | Site slug
+    site: site_example,
+    // string | Asset path, e.g. images/waving.png
+    path: path_example,
+  } satisfies GetAssetRequest;
+
+  try {
+    const data = await api.getAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **site** | `string` | Site slug | [Defaults to `undefined`] |
+| **path** | `string` | Asset path, e.g. images/waving.png | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `*/*`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Asset bytes |  -  |
+| **304** | Not modified |  -  |
+| **404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPage
+
+> WikiPageResponse getPage(site, path)
+
+GET /wiki/{site}/pages/{path} - Fetch one published page.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WikiApi,
+} from '@orangefox-recovery/foxclient';
+import type { GetPageRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new WikiApi();
+
+  const body = {
+    // string | Site slug
+    site: site_example,
+    // string | Page path, e.g. Installation/Windows
+    path: path_example,
+  } satisfies GetPageRequest;
+
+  try {
+    const data = await api.getPage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **site** | `string` | Site slug | [Defaults to `undefined`] |
+| **path** | `string` | Page path, e.g. Installation/Windows | [Defaults to `undefined`] |
+
+### Return type
+
+[**WikiPageResponse**](WikiPageResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Wiki page |  -  |
+| **404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSite
+
+> WikiSiteResponse getSite(slug)
+
+GET /wiki/sites/{slug} - Fetch one wiki site.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WikiApi,
+} from '@orangefox-recovery/foxclient';
+import type { GetSiteRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new WikiApi();
+
+  const body = {
+    // string | Site slug
+    slug: slug_example,
+  } satisfies GetSiteRequest;
+
+  try {
+    const data = await api.getSite(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **slug** | `string` | Site slug | [Defaults to `undefined`] |
+
+### Return type
+
+[**WikiSiteResponse**](WikiSiteResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Wiki site |  -  |
+| **404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listPages
+
+> ListResponseWikiPageShortResponse listPages(site, skip, limit)
+
+GET /wiki/{site}/pages - List every published page in a site.
+
+FoxWiki builds its whole navigation tree from one call to this, so it returns the complete flat set (paged at the standard 1000 ceiling) rather than one folder\'s children.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WikiApi,
+} from '@orangefox-recovery/foxclient';
+import type { ListPagesRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new WikiApi();
+
+  const body = {
+    // string | Site slug
+    site: site_example,
+    // number (optional)
+    skip: 789,
+    // number (optional)
+    limit: 789,
+  } satisfies ListPagesRequest;
+
+  try {
+    const data = await api.listPages(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **site** | `string` | Site slug | [Defaults to `undefined`] |
+| **skip** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListResponseWikiPageShortResponse**](ListResponseWikiPageShortResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Published pages |  -  |
+| **404** | Site not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listSites
+
+> ListResponseWikiSiteResponse listSites(skip, limit)
+
+GET /wiki/sites - List wiki sites.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WikiApi,
+} from '@orangefox-recovery/foxclient';
+import type { ListSitesRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new WikiApi();
+
+  const body = {
+    // number (optional)
+    skip: 789,
+    // number (optional)
+    limit: 789,
+  } satisfies ListSitesRequest;
+
+  try {
+    const data = await api.listSites(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **skip** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListResponseWikiSiteResponse**](ListResponseWikiSiteResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of wiki sites |  -  |
+
+[[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/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.10",
+  "version": "6.1.1",
   "description": "OpenAPI client for @orangefox-recovery/foxclient",
   "author": "OpenAPI-Generator",
   "repository": {
@@ -15,7 +15,7 @@
     "prepare": "npm run build"
   },
   "devDependencies": {
-    "typescript": "^4.0 || ^5.0"
+    "typescript": "^7.0.2"
   },
   "exports": {
     ".": {

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.10
+ * The version of the OpenAPI document: 6.1.1
  * 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.10
+ * The version of the OpenAPI document: 6.1.1
  * 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.10
+ * The version of the OpenAPI document: 6.1.1
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -19,6 +19,7 @@ import type {
   ListResponseReleaseResponse,
   ReleaseListResponse,
   ReleaseResponse,
+  ReleaseSort,
 } from '../models/index';
 import {
     ErrorResponseFromJSON,
@@ -29,6 +30,8 @@ import {
     ReleaseListResponseToJSON,
     ReleaseResponseFromJSON,
     ReleaseResponseToJSON,
+    ReleaseSortFromJSON,
+    ReleaseSortToJSON,
 } from '../models/index';
 
 export interface DownloadReleaseRequest {
@@ -63,7 +66,7 @@ export interface ListReleasesRequest {
     freezed?: boolean | null;
     afterReleaseId?: string | null;
     afterDate?: number | null;
-    sort?: string | null;
+    sort?: ReleaseSort | null;
     group?: boolean | null;
     skip?: number | null;
     limit?: number | null;
@@ -190,7 +193,7 @@ export interface ReleaseApiInterface {
      * @param {boolean} [freezed] 
      * @param {string} [afterReleaseId] 
      * @param {number} [afterDate] 
-     * @param {string} [sort] 
+     * @param {ReleaseSort} [sort] 
      * @param {boolean} [group] 
      * @param {number} [skip] 
      * @param {number} [limit] 
@@ -214,7 +217,7 @@ export interface ReleaseApiInterface {
      * @param {boolean} [freezed] 
      * @param {string} [afterReleaseId] 
      * @param {number} [afterDate] 
-     * @param {string} [sort] 
+     * @param {ReleaseSort} [sort] 
      * @param {boolean} [group] 
      * @param {number} [skip] 
      * @param {number} [limit] 

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