@orangefox-recovery/foxinternalclient 5.4.0 → 6.0.4

package/docs/ReportApi.md

@@ -0,0 +1,84 @@
+# ReportApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**newReport**](ReportApi.md#newreportoperation) | **POST** /report/{release_id} | POST /report/{release_id} - Submit a bug report. |
+
+
+
+## newReport
+
+> string newReport(releaseId, newReportRequest)
+
+POST /report/{release_id} - Submit a bug report.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { NewReportOperationRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ReportApi(config);
+
+  const body = {
+    // string | Release ID
+    releaseId: releaseId_example,
+    // NewReportRequest
+    newReportRequest: ...,
+  } satisfies NewReportOperationRequest;
+
+  try {
+    const data = await api.newReport(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **releaseId** | `string` | Release ID | [Defaults to `undefined`] |
+| **newReportRequest** | [NewReportRequest](NewReportRequest.md) |  | |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `text/plain`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Report submitted |  -  |
+| **400** | Bad request |  -  |
+| **404** | Release not found |  -  |
+| **500** | Internal server error |  -  |
+
+[[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

@@ -6,16 +6,17 @@
 
 Name | Type
 ------------ | -------------
+`legacyId` | string
 `codename` | string
-`modelName` | string
-`oemName` | string
-`id` | string
 `codenames` | Array<string>
-`modelNames` | Array<string>
-`supported` | boolean
-`isFeatured` | boolean
 `featuredText` | string
 `fullName` | string
+`id` | string
+`isFeatured` | boolean
+`modelName` | string
+`modelNames` | Array<string>
+`oemName` | string
+`supported` | boolean
 `url` | string
 
 ## Example
@@ -25,16 +26,17 @@ import type { ShortDeviceResponse } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
+  "legacyId": null,
   "codename": null,
-  "modelName": null,
-  "oemName": null,
-  "id": null,
   "codenames": null,
-  "modelNames": null,
-  "supported": null,
-  "isFeatured": null,
   "featuredText": null,
   "fullName": null,
+  "id": null,
+  "isFeatured": null,
+  "modelName": null,
+  "modelNames": null,
+  "oemName": null,
+  "supported": null,
   "url": null,
 } satisfies ShortDeviceResponse
 

package/docs/ShortReleaseResponse.md

@@ -6,20 +6,21 @@
 
 Name | Type
 ------------ | -------------
-`size` | number
-`id` | string
+`legacyId` | string
+`archived` | boolean
 `buildId` | string
-`filename` | string
-`variant` | string
-`deviceId` | string
 `date` | number
+`deviceId` | string
+`featuredText` | string
+`filename` | string
+`id` | string
+`isFeatured` | boolean
+`maintainerId` | string
 `md5` | string
+`size` | number
+`type` | string
+`variant` | string
 `version` | string
-`type` | [ReleaseType](ReleaseType.md)
-`maintainerId` | string
-`archived` | boolean
-`isFeatured` | boolean
-`featuredText` | string
 
 ## Example
 
@@ -28,20 +29,21 @@ import type { ShortReleaseResponse } from '@orangefox-recovery/foxinternalclient
 
 // TODO: Update the object below with actual values
 const example = {
-  "size": null,
-  "id": null,
+  "legacyId": null,
+  "archived": null,
   "buildId": null,
-  "filename": null,
-  "variant": null,
-  "deviceId": null,
   "date": null,
+  "deviceId": null,
+  "featuredText": null,
+  "filename": null,
+  "id": null,
+  "isFeatured": null,
+  "maintainerId": null,
   "md5": null,
-  "version": null,
+  "size": null,
   "type": null,
-  "maintainerId": null,
-  "archived": null,
-  "isFeatured": null,
-  "featuredText": null,
+  "variant": null,
+  "version": null,
 } satisfies ShortReleaseResponse
 
 console.log(example)

package/docs/StatsApi.md

@@ -4,17 +4,17 @@ All URIs are relative to *https://api.orangefox.download*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**getPublicStats**](StatsApi.md#getpublicstats) | **GET** /stats/ | Public Stats |
+| [**getGlobalStats**](StatsApi.md#getglobalstats) | **GET** /stats | GET /stats/ - Get global download statistics. |
 
 
 
-## getPublicStats
+## getGlobalStats
 
-> GlobalStatsAggregationModel getPublicStats()
+> GlobalStatsResponse getGlobalStats()
 
-Public Stats
+GET /stats/ - Get global download statistics.
 
-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.
+Uses a MongoDB aggregation pipeline to compute total download count, unique devices count, unique releases count, and per-day breakdown.
 
 ### Example
 
@@ -23,14 +23,14 @@ import {
   Configuration,
   StatsApi,
 } from '@orangefox-recovery/foxinternalclient';
-import type { GetPublicStatsRequest } from '@orangefox-recovery/foxinternalclient';
+import type { GetGlobalStatsRequest } from '@orangefox-recovery/foxinternalclient';
 
 async function example() {
   console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
   const api = new StatsApi();
 
   try {
-    const data = await api.getPublicStats();
+    const data = await api.getGlobalStats();
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -47,7 +47,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**GlobalStatsAggregationModel**](GlobalStatsAggregationModel.md)
+[**GlobalStatsResponse**](GlobalStatsResponse.md)
 
 ### Authorization
 
@@ -62,8 +62,8 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Successful Response |  -  |
-| **429** | Too many requests |  -  |
+| **200** | Global download statistics |  -  |
+| **500** | Internal server error |  -  |
 
 [[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/TaskUpdateBody.md

@@ -1,13 +1,14 @@
 
 # TaskUpdateBody
 
+Body for updating a build task
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`status` | [BuildStatusEnum](BuildStatusEnum.md)
 `logs` | Array<string>
+`status` | string
 
 ## Example
 
@@ -16,8 +17,8 @@ import type { TaskUpdateBody } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
-  "status": null,
   "logs": null,
+  "status": null,
 } satisfies TaskUpdateBody
 
 console.log(example)

package/docs/UserInternalResponse.md

@@ -6,16 +6,16 @@
 
 Name | Type
 ------------ | -------------
+`adminNotes` | string
+`freezed` | boolean
+`gitlab` | object
 `id` | string
-`username` | string
+`mail` | object
+`maintainedDevices` | [Array<ShortDeviceResponse>](ShortDeviceResponse.md)
 `name` | string
-`freezed` | boolean
 `roles` | Array<string>
-`telegram` | [UserTelegram](UserTelegram.md)
-`gitlab` | [UserGitlab](UserGitlab.md)
-`mail` | [UserMail](UserMail.md)
-`adminNotes` | string
-`maintainedDevices` | [Array<ShortDeviceResponse>](ShortDeviceResponse.md)
+`telegram` | object
+`username` | string
 
 ## Example
 
@@ -24,16 +24,16 @@ import type { UserInternalResponse } from '@orangefox-recovery/foxinternalclient
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "username": null,
-  "name": null,
+  "adminNotes": null,
   "freezed": null,
-  "roles": null,
-  "telegram": null,
   "gitlab": null,
+  "id": null,
   "mail": null,
-  "adminNotes": null,
   "maintainedDevices": null,
+  "name": null,
+  "roles": null,
+  "telegram": null,
+  "username": null,
 } satisfies UserInternalResponse
 
 console.log(example)

package/docs/UserShortResponse.md

@@ -6,10 +6,10 @@
 
 Name | Type
 ------------ | -------------
+`freezed` | boolean
 `id` | string
-`username` | string
 `name` | string
-`freezed` | boolean
+`username` | string
 
 ## Example
 
@@ -18,10 +18,10 @@ import type { UserShortResponse } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
+  "freezed": null,
   "id": null,
-  "username": null,
   "name": null,
-  "freezed": null,
+  "username": null,
 } satisfies UserShortResponse
 
 console.log(example)

package/docs/UserUpdateBody.md

@@ -1,16 +1,17 @@
 
 # UserUpdateBody
 
+Body for updating a user
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`username` | string
-`name` | string
+`adminNotes` | string
 `freezed` | boolean
+`name` | string
 `roles` | Array<string>
-`adminNotes` | string
+`username` | string
 
 ## Example
 
@@ -19,11 +20,11 @@ import type { UserUpdateBody } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
-  "username": null,
-  "name": null,
+  "adminNotes": null,
   "freezed": null,
+  "name": null,
   "roles": null,
-  "adminNotes": null,
+  "username": null,
 } satisfies UserUpdateBody
 
 console.log(example)

package/docs/{BuildStatusEnum.md → WorkerStatusBody.md}

@@ -1,20 +1,22 @@
 
-# BuildStatusEnum
+# WorkerStatusBody
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`status` | string
 
 ## Example
 
 ```typescript
-import type { BuildStatusEnum } from '@orangefox-recovery/foxinternalclient'
+import type { WorkerStatusBody } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
-} satisfies BuildStatusEnum
+  "status": null,
+} satisfies WorkerStatusBody
 
 console.log(example)
 
@@ -23,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as BuildStatusEnum
+const exampleParsed = JSON.parse(exampleJSON) as WorkerStatusBody
 console.log(exampleParsed)
 ```
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@orangefox-recovery/foxinternalclient",
-  "version": "5.4.0",
+  "version": "6.0.4",
   "description": "OpenAPI client for @orangefox-recovery/foxinternalclient",
   "author": "OpenAPI-Generator",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -23,14 +23,5 @@
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts"
     }
-  },
-  "directories": {
-    "doc": "docs"
-  },
-  "keywords": [],
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"
-  },
-  "homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID#readme"
+  }
 }