@orangefox-recovery/foxclient 5.3.0 → 5.3.2

package/docs/ReleaseResponse.md

@@ -0,0 +1,72 @@
+
+# ReleaseResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`size` | number
+`id` | string
+`buildId` | string
+`filename` | string
+`variant` | string
+`deviceId` | string
+`date` | number
+`md5` | string
+`version` | string
+`type` | [ReleaseType](ReleaseType.md)
+`maintainerId` | string
+`archived` | boolean
+`isFeatured` | boolean
+`featuredText` | string
+`recoveryImg` | [RecoveryImgResponse](RecoveryImgResponse.md)
+`changelog` | Array<string>
+`bugs` | Array<string>
+`notes` | string
+`url` | string
+`mirrors` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { ReleaseResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "size": null,
+  "id": null,
+  "buildId": null,
+  "filename": null,
+  "variant": null,
+  "deviceId": null,
+  "date": null,
+  "md5": null,
+  "version": null,
+  "type": null,
+  "maintainerId": null,
+  "archived": null,
+  "isFeatured": null,
+  "featuredText": null,
+  "recoveryImg": null,
+  "changelog": null,
+  "bugs": null,
+  "notes": null,
+  "url": null,
+  "mirrors": null,
+} satisfies ReleaseResponse
+
+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 ReleaseResponse
+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/ReleaseType.md

@@ -0,0 +1,32 @@
+
+# ReleaseType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ReleaseType } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ReleaseType
+
+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 ReleaseType
+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/ReleasesSort.md

@@ -0,0 +1,32 @@
+
+# ReleasesSort
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ReleasesSort } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ReleasesSort
+
+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 ReleasesSort
+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/ResponseGetReleases.md

@@ -0,0 +1,36 @@
+
+# ResponseGetReleases
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | { [key: string]: Array<ReleaseResponse>; }
+`count` | number
+
+## Example
+
+```typescript
+import type { ResponseGetReleases } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "count": null,
+} satisfies ResponseGetReleases
+
+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 ResponseGetReleases
+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/ShortDeviceResponse.md

@@ -0,0 +1,54 @@
+
+# ShortDeviceResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`codename` | string
+`modelName` | string
+`oemName` | string
+`id` | string
+`codenames` | Array<string>
+`modelNames` | Array<string>
+`supported` | boolean
+`isFeatured` | boolean
+`featuredText` | string
+`fullName` | string
+`url` | string
+
+## Example
+
+```typescript
+import type { ShortDeviceResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "codename": null,
+  "modelName": null,
+  "oemName": null,
+  "id": null,
+  "codenames": null,
+  "modelNames": null,
+  "supported": null,
+  "isFeatured": null,
+  "featuredText": null,
+  "fullName": null,
+  "url": null,
+} satisfies ShortDeviceResponse
+
+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 ShortDeviceResponse
+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/ShortReleaseResponse.md

@@ -0,0 +1,60 @@
+
+# ShortReleaseResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`size` | number
+`id` | string
+`buildId` | string
+`filename` | string
+`variant` | string
+`deviceId` | string
+`date` | number
+`md5` | string
+`version` | string
+`type` | [ReleaseType](ReleaseType.md)
+`maintainerId` | string
+`archived` | boolean
+`isFeatured` | boolean
+`featuredText` | string
+
+## Example
+
+```typescript
+import type { ShortReleaseResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "size": null,
+  "id": null,
+  "buildId": null,
+  "filename": null,
+  "variant": null,
+  "deviceId": null,
+  "date": null,
+  "md5": null,
+  "version": null,
+  "type": null,
+  "maintainerId": null,
+  "archived": null,
+  "isFeatured": null,
+  "featuredText": null,
+} satisfies ShortReleaseResponse
+
+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 ShortReleaseResponse
+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/StatsApi.md

@@ -0,0 +1,69 @@
+# StatsApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getPublicStats**](StatsApi.md#getpublicstats) | **GET** /stats/ | Public Stats |
+
+
+
+## getPublicStats
+
+> GlobalStatsAggregationModel getPublicStats()
+
+Public Stats
+
+Returns the global OrangeFox downloads statistics. This request causes an increased load to the database, as it needs to aggregate all the release stats data, therefore, it is limited to a small number of requests per minute for public usage.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StatsApi,
+} from '@orangefox-recovery/foxclient';
+import type { GetPublicStatsRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new StatsApi();
+
+  try {
+    const data = await api.getPublicStats();
+    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
+
+[**GlobalStatsAggregationModel**](GlobalStatsAggregationModel.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **429** | Too many requests |  -  |
+
+[[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/ValidationError.md

@@ -0,0 +1,38 @@
+
+# ValidationError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`loc` | [Array<ValidationErrorLocInner>](ValidationErrorLocInner.md)
+`msg` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { ValidationError } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "loc": null,
+  "msg": null,
+  "type": null,
+} satisfies ValidationError
+
+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 ValidationError
+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/ValidationErrorLocInner.md

@@ -0,0 +1,32 @@
+
+# ValidationErrorLocInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ValidationErrorLocInner } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ValidationErrorLocInner
+
+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 ValidationErrorLocInner
+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": "5.3.0",
+  "version": "5.3.2",
   "description": "OpenAPI client for @orangefox-recovery/foxclient",
   "author": "OpenAPI-Generator",
   "repository": {
@@ -8,7 +8,7 @@
     "url": "git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
   },
   "main": "./dist/index.js",
-  "typings": "./dist/index.d.ts",
+  "types": "./dist/index.d.ts",
   "sideEffects": false,
   "scripts": {
     "build": "tsc && tsc -p tsconfig.esm.json",
@@ -24,6 +24,9 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "directories": {
+    "doc": "docs"
+  },
   "keywords": [],
   "license": "ISC",
   "type": "commonjs",

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: 5.3.0
+ * The version of the OpenAPI document: 5.3.2
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -167,8 +167,11 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/devices/get`;
+
         const response = await this.request({
-            path: `/devices/get`,
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -203,8 +206,12 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/devices/{device_id}`;
+        urlPath = urlPath.replace(`{${"device_id"}}`, encodeURIComponent(String(requestParameters['deviceId'])));
+
         const response = await this.request({
-            path: `/devices/{device_id}`.replace(`{${"device_id"}}`, encodeURIComponent(String(requestParameters['deviceId']))),
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -276,8 +283,11 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/devices/`;
+
         const response = await this.request({
-            path: `/devices/`,
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -304,8 +314,11 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/oems/`;
+
         const response = await this.request({
-            path: `/oems/`,
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,

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: 5.3.0
+ * The version of the OpenAPI document: 5.3.2
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -100,8 +100,11 @@ export class PasteApi extends runtime.BaseAPI implements PasteApiInterface {
 
         headerParameters['Content-Type'] = 'application/json';
 
+
+        let urlPath = `/paste/`;
+
         const response = await this.request({
-            path: `/paste/`,
+            path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
@@ -136,8 +139,12 @@ export class PasteApi extends runtime.BaseAPI implements PasteApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/paste/{paste_id}`;
+        urlPath = urlPath.replace(`{${"paste_id"}}`, encodeURIComponent(String(requestParameters['pasteId'])));
+
         const response = await this.request({
-            path: `/paste/{paste_id}`.replace(`{${"paste_id"}}`, encodeURIComponent(String(requestParameters['pasteId']))),
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,

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: 5.3.0
+ * The version of the OpenAPI document: 5.3.2
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -206,8 +206,11 @@ export class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/releases/get`;
+
         const response = await this.request({
-            path: `/releases/get`,
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -242,8 +245,12 @@ export class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/releases/{release_id}`;
+        urlPath = urlPath.replace(`{${"release_id"}}`, encodeURIComponent(String(requestParameters['releaseId'])));
+
         const response = await this.request({
-            path: `/releases/{release_id}`.replace(`{${"release_id"}}`, encodeURIComponent(String(requestParameters['releaseId']))),
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -335,8 +342,11 @@ export class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/releases/`;
+
         const response = await this.request({
-            path: `/releases/`,
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
@@ -391,8 +401,12 @@ export class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/updates/{last_known_id}`;
+        urlPath = urlPath.replace(`{${"last_known_id"}}`, encodeURIComponent(String(requestParameters['lastKnownId'])));
+
         const response = await this.request({
-            path: `/updates/{last_known_id}`.replace(`{${"last_known_id"}}`, encodeURIComponent(String(requestParameters['lastKnownId']))),
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,

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: 5.3.0
+ * The version of the OpenAPI document: 5.3.2
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -60,8 +60,11 @@ export class StatsApi extends runtime.BaseAPI implements StatsApiInterface {
 
         const headerParameters: runtime.HTTPHeaders = {};
 
+
+        let urlPath = `/stats/`;
+
         const response = await this.request({
-            path: `/stats/`,
+            path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,

package/src/models/DeviceResponse.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: 5.3.0
+ * The version of the OpenAPI document: 5.3.2
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -71,6 +71,18 @@ export interface DeviceResponse {
      * @memberof DeviceResponse
      */
     supported: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DeviceResponse
+     */
+    isFeatured?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof DeviceResponse
+     */
+    featuredText?: string | null;
     /**
      * 
      * @type {MaintainerShortModel}
@@ -137,6 +149,8 @@ export function DeviceResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'codenames': json['codenames'],
         'modelNames': json['model_names'],
         'supported': json['supported'],
+        'isFeatured': json['is_featured'] == null ? undefined : json['is_featured'],
+        'featuredText': json['featured_text'] == null ? undefined : json['featured_text'],
         'maintainer': MaintainerShortModelFromJSON(json['maintainer']),
         'notes': json['notes'] == null ? undefined : json['notes'],
         'deviceTree': json['device_tree'] == null ? undefined : json['device_tree'],
@@ -163,6 +177,8 @@ export function DeviceResponseToJSONTyped(value?: Omit<DeviceResponse, 'full_nam
         'codenames': value['codenames'],
         'model_names': value['modelNames'],
         'supported': value['supported'],
+        'is_featured': value['isFeatured'],
+        'featured_text': value['featuredText'],
         'maintainer': MaintainerShortModelToJSON(value['maintainer']),
         'notes': value['notes'],
         'device_tree': value['deviceTree'],