@orangefox-recovery/foxinternalclient 5.2.1

package/docs/ReleaseResponse.md

@@ -0,0 +1,56 @@
+# ReleaseResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** |  | [default to undefined]
+**size** | **number** |  | [default to undefined]
+**id** | **string** | Release ID, that\'s how we indentify the release in the infrastructure | [default to undefined]
+**build_id** | **string** |  | [optional] [default to undefined]
+**filename** | **string** |  | [default to undefined]
+**variant** | **string** |  | [default to undefined]
+**device_id** | **string** |  | [default to undefined]
+**date** | **string** |  | [default to undefined]
+**md5** | **string** |  | [default to undefined]
+**version** | **string** |  | [default to undefined]
+**type** | [**ReleaseType**](ReleaseType.md) |  | [default to undefined]
+**maintainer_id** | **string** |  | [optional] [default to undefined]
+**archived** | **boolean** |  | [default to undefined]
+**recovery_img** | [**RecoveryImgResponse**](RecoveryImgResponse.md) |  | [default to undefined]
+**changelog** | **Array<string>** |  | [default to undefined]
+**bugs** | **Array<string>** |  | [default to undefined]
+**notes** | **string** |  | [default to undefined]
+**url** | **string** | URL of the release on the official website | [readonly] [default to undefined]
+**mirrors** | **{ [key: string]: string; }** | Mirrors list (deprecated) | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { ReleaseResponse } from '@orangefox-recovery/foxinternalclient';
+
+const instance: ReleaseResponse = {
+    _id,
+    size,
+    id,
+    build_id,
+    filename,
+    variant,
+    device_id,
+    date,
+    md5,
+    version,
+    type,
+    maintainer_id,
+    archived,
+    recovery_img,
+    changelog,
+    bugs,
+    notes,
+    url,
+    mirrors,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReleaseStatsResponse.md

@@ -0,0 +1,24 @@
+# ReleaseStatsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**days** | **{ [key: string]: number; }** |  | [default to undefined]
+**mirrors** | **{ [key: string]: number; }** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReleaseStatsResponse } from '@orangefox-recovery/foxinternalclient';
+
+const instance: ReleaseStatsResponse = {
+    count,
+    days,
+    mirrors,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReleaseType.md

@@ -0,0 +1,12 @@
+# ReleaseType
+
+
+## Enum
+
+* `Stable` (value: `'stable'`)
+
+* `Beta` (value: `'beta'`)
+
+* `Alpha` (value: `'alpha'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReleaseUpdateBody.md

@@ -0,0 +1,26 @@
+# ReleaseUpdateBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**changelog** | **Array<string>** |  | [optional] [default to undefined]
+**bugs** | **Array<string>** |  | [optional] [default to undefined]
+**notes** | **string** |  | [optional] [default to undefined]
+**freezed** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReleaseUpdateBody } from '@orangefox-recovery/foxinternalclient';
+
+const instance: ReleaseUpdateBody = {
+    changelog,
+    bugs,
+    notes,
+    freezed,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ReleasesSort.md

@@ -0,0 +1,10 @@
+# ReleasesSort
+
+
+## Enum
+
+* `DateAsc` (value: `'date_asc'`)
+
+* `DateDesc` (value: `'date_desc'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ResponseGetReleases.md

@@ -0,0 +1,22 @@
+# ResponseGetReleases
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **{ [key: string]: Array<ReleaseResponse>; }** |  | [default to undefined]
+**count** | **number** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { ResponseGetReleases } from '@orangefox-recovery/foxinternalclient';
+
+const instance: ResponseGetReleases = {
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ShortDeviceResponse.md

@@ -0,0 +1,38 @@
+# ShortDeviceResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** |  | [default to undefined]
+**codename** | **string** | Device codename, legacy | [default to undefined]
+**model_name** | **string** | Model name of device, does not include the OEM part, legacy | [default to undefined]
+**oem_name** | **string** |  | [default to undefined]
+**id** | **string** |  | [default to undefined]
+**codenames** | **Array<string>** |  | [default to undefined]
+**model_names** | **Array<string>** |  | [default to undefined]
+**supported** | **boolean** |  | [default to undefined]
+**full_name** | **string** | Full name of device / devices, legacy | [readonly] [default to undefined]
+**url** | **string** | URL of the device on the official website | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { ShortDeviceResponse } from '@orangefox-recovery/foxinternalclient';
+
+const instance: ShortDeviceResponse = {
+    _id,
+    codename,
+    model_name,
+    oem_name,
+    id,
+    codenames,
+    model_names,
+    supported,
+    full_name,
+    url,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ShortReleaseResponse.md

@@ -0,0 +1,44 @@
+# ShortReleaseResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** |  | [default to undefined]
+**size** | **number** |  | [default to undefined]
+**id** | **string** | Release ID, that\'s how we indentify the release in the infrastructure | [default to undefined]
+**build_id** | **string** |  | [optional] [default to undefined]
+**filename** | **string** |  | [default to undefined]
+**variant** | **string** |  | [default to undefined]
+**device_id** | **string** |  | [default to undefined]
+**date** | **string** |  | [default to undefined]
+**md5** | **string** |  | [default to undefined]
+**version** | **string** |  | [default to undefined]
+**type** | [**ReleaseType**](ReleaseType.md) |  | [default to undefined]
+**maintainer_id** | **string** |  | [optional] [default to undefined]
+**archived** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ShortReleaseResponse } from '@orangefox-recovery/foxinternalclient';
+
+const instance: ShortReleaseResponse = {
+    _id,
+    size,
+    id,
+    build_id,
+    filename,
+    variant,
+    device_id,
+    date,
+    md5,
+    version,
+    type,
+    maintainer_id,
+    archived,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StatsApi.md

@@ -0,0 +1,53 @@
+# StatsApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getPublicStats**](#getpublicstats) | **GET** /stats/ | Public Stats|
+
+# **getPublicStats**
+> GlobalStatsAggregationModel getPublicStats()
+
+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
+
+```typescript
+import {
+    StatsApi,
+    Configuration
+} from '@orangefox-recovery/foxinternalclient';
+
+const configuration = new Configuration();
+const apiInstance = new StatsApi(configuration);
+
+const { status, data } = await apiInstance.getPublicStats();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GlobalStatsAggregationModel**
+
+### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/TaskUpdateBody.md

@@ -0,0 +1,22 @@
+# TaskUpdateBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**BuildStatusEnum**](BuildStatusEnum.md) |  | [optional] [default to undefined]
+**logs** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TaskUpdateBody } from '@orangefox-recovery/foxinternalclient';
+
+const instance: TaskUpdateBody = {
+    status,
+    logs,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TokenResponse.md

@@ -0,0 +1,22 @@
+# TokenResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **string** |  | [default to undefined]
+**token_type** | **string** |  | [optional] [default to 'bearer']
+
+## Example
+
+```typescript
+import { TokenResponse } from '@orangefox-recovery/foxinternalclient';
+
+const instance: TokenResponse = {
+    access_token,
+    token_type,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UserGitlab.md

@@ -0,0 +1,20 @@
+# UserGitlab
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UserGitlab } from '@orangefox-recovery/foxinternalclient';
+
+const instance: UserGitlab = {
+    id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UserInternalResponse.md

@@ -0,0 +1,38 @@
+# UserInternalResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**username** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**freezed** | **boolean** |  | [default to undefined]
+**roles** | **Array<string>** |  | [default to undefined]
+**telegram** | [**UserTelegram**](UserTelegram.md) |  | [optional] [default to undefined]
+**gitlab** | [**UserGitlab**](UserGitlab.md) |  | [optional] [default to undefined]
+**mail** | [**UserMail**](UserMail.md) |  | [optional] [default to undefined]
+**admin_notes** | **string** |  | [optional] [default to undefined]
+**maintained_devices** | [**Array<ShortDeviceResponse>**](ShortDeviceResponse.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UserInternalResponse } from '@orangefox-recovery/foxinternalclient';
+
+const instance: UserInternalResponse = {
+    id,
+    username,
+    name,
+    freezed,
+    roles,
+    telegram,
+    gitlab,
+    mail,
+    admin_notes,
+    maintained_devices,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UserMail.md

@@ -0,0 +1,20 @@
+# UserMail
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UserMail } from '@orangefox-recovery/foxinternalclient';
+
+const instance: UserMail = {
+    username,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UserShortResponse.md

@@ -0,0 +1,26 @@
+# UserShortResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**username** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**freezed** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UserShortResponse } from '@orangefox-recovery/foxinternalclient';
+
+const instance: UserShortResponse = {
+    id,
+    username,
+    name,
+    freezed,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UserTelegram.md

@@ -0,0 +1,20 @@
+# UserTelegram
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UserTelegram } from '@orangefox-recovery/foxinternalclient';
+
+const instance: UserTelegram = {
+    id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UserUpdateBody.md

@@ -0,0 +1,28 @@
+# UserUpdateBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**freezed** | **boolean** |  | [optional] [default to undefined]
+**roles** | **Array<string>** |  | [optional] [default to undefined]
+**admin_notes** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserUpdateBody } from '@orangefox-recovery/foxinternalclient';
+
+const instance: UserUpdateBody = {
+    username,
+    name,
+    freezed,
+    roles,
+    admin_notes,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ValidationError.md

@@ -0,0 +1,24 @@
+# ValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**loc** | [**Array<ValidationErrorLocInner>**](ValidationErrorLocInner.md) |  | [default to undefined]
+**msg** | **string** |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ValidationError } from '@orangefox-recovery/foxinternalclient';
+
+const instance: ValidationError = {
+    loc,
+    msg,
+    type,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ValidationErrorLocInner.md

@@ -0,0 +1,18 @@
+# ValidationErrorLocInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { ValidationErrorLocInner } from '@orangefox-recovery/foxinternalclient';
+
+const instance: ValidationErrorLocInner = {
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.2.1
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@orangefox-recovery/foxinternalclient",
+  "version": "5.2.1",
+  "description": "OpenAPI client for @orangefox-recovery/foxinternalclient",
+  "author": "OpenAPI-Generator Contributors",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+  },
+  "keywords": [
+    "axios",
+    "typescript",
+    "openapi-client",
+    "openapi-generator",
+    "@orangefox-recovery/foxinternalclient"
+  ],
+  "license": "Unlicense",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "dependencies": {
+    "axios": "^1.6.1"
+  },
+  "devDependencies": {
+    "@types/node": "12.11.5 - 12.20.42",
+    "typescript": "^4.0 || ^5.0"
+  },
+  "directories": {
+    "doc": "docs"
+  },
+  "type": "commonjs",
+  "bugs": {
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"
+  },
+  "homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID#readme"
+}

package/tsconfig.esm.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "outDir": "dist/esm"
+  }
+}