@orangefox-recovery/foxinternalclient 5.2.8 → 5.3.2

package/docs/ReleasesSort.md

@@ -0,0 +1,32 @@
+
+# ReleasesSort
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ReleasesSort } from '@orangefox-recovery/foxinternalclient'
+
+// 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/foxinternalclient'
+
+// 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/foxinternalclient'
+
+// 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/foxinternalclient'
+
+// 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/foxinternalclient';
+import type { GetPublicStatsRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient 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/TaskUpdateBody.md

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

@@ -0,0 +1,36 @@
+
+# TokenResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`accessToken` | string
+`tokenType` | string
+
+## Example
+
+```typescript
+import type { TokenResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "accessToken": null,
+  "tokenType": null,
+} satisfies TokenResponse
+
+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 TokenResponse
+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/UserGitlab.md

@@ -0,0 +1,34 @@
+
+# UserGitlab
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+
+## Example
+
+```typescript
+import type { UserGitlab } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+} satisfies UserGitlab
+
+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 UserGitlab
+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/UserInternalResponse.md

@@ -0,0 +1,52 @@
+
+# UserInternalResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`username` | string
+`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)
+
+## Example
+
+```typescript
+import type { UserInternalResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "username": null,
+  "name": null,
+  "freezed": null,
+  "roles": null,
+  "telegram": null,
+  "gitlab": null,
+  "mail": null,
+  "adminNotes": null,
+  "maintainedDevices": null,
+} satisfies UserInternalResponse
+
+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 UserInternalResponse
+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/UserMail.md

@@ -0,0 +1,34 @@
+
+# UserMail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+
+## Example
+
+```typescript
+import type { UserMail } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+} satisfies UserMail
+
+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 UserMail
+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/UserShortResponse.md

@@ -0,0 +1,40 @@
+
+# UserShortResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`username` | string
+`name` | string
+`freezed` | boolean
+
+## Example
+
+```typescript
+import type { UserShortResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "username": null,
+  "name": null,
+  "freezed": null,
+} satisfies UserShortResponse
+
+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 UserShortResponse
+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/UserTelegram.md

@@ -0,0 +1,34 @@
+
+# UserTelegram
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+
+## Example
+
+```typescript
+import type { UserTelegram } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+} satisfies UserTelegram
+
+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 UserTelegram
+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/UserUpdateBody.md

@@ -0,0 +1,42 @@
+
+# UserUpdateBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`name` | string
+`freezed` | boolean
+`roles` | Array<string>
+`adminNotes` | string
+
+## Example
+
+```typescript
+import type { UserUpdateBody } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "name": null,
+  "freezed": null,
+  "roles": null,
+  "adminNotes": null,
+} satisfies UserUpdateBody
+
+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 UserUpdateBody
+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/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/foxinternalclient'
+
+// 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/foxinternalclient'
+
+// 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/foxinternalclient",
-  "version": "5.2.8",
+  "version": "5.3.2",
   "description": "OpenAPI client for @orangefox-recovery/foxinternalclient",
   "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",