@orangefox-recovery/foxinternalclient 5.2.6 → 5.2.8

package/docs/ListResponseBuildTaskShortResponse.md

@@ -1,22 +0,0 @@
-# ListResponseBuildTaskShortResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<BuildTaskShortResponse>**](BuildTaskShortResponse.md) |  | [default to undefined]
-**count** | **number** |  | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ListResponseBuildTaskShortResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ListResponseBuildTaskShortResponse = {
-    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/ListResponseReleaseResponse.md

@@ -1,22 +0,0 @@
-# ListResponseReleaseResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<ReleaseResponse>**](ReleaseResponse.md) |  | [default to undefined]
-**count** | **number** |  | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ListResponseReleaseResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ListResponseReleaseResponse = {
-    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/ListResponseShortDeviceResponse.md

@@ -1,22 +0,0 @@
-# ListResponseShortDeviceResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<ShortDeviceResponse>**](ShortDeviceResponse.md) |  | [default to undefined]
-**count** | **number** |  | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ListResponseShortDeviceResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ListResponseShortDeviceResponse = {
-    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/ListResponseShortReleaseResponse.md

@@ -1,22 +0,0 @@
-# ListResponseShortReleaseResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<ShortReleaseResponse>**](ShortReleaseResponse.md) |  | [default to undefined]
-**count** | **number** |  | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ListResponseShortReleaseResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ListResponseShortReleaseResponse = {
-    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/ListResponseStr.md

@@ -1,22 +0,0 @@
-# ListResponseStr
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | **Array<string>** |  | [default to undefined]
-**count** | **number** |  | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ListResponseStr } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ListResponseStr = {
-    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/ListResponseUserShortResponse.md

@@ -1,22 +0,0 @@
-# ListResponseUserShortResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**data** | [**Array<UserShortResponse>**](UserShortResponse.md) |  | [default to undefined]
-**count** | **number** |  | [readonly] [default to undefined]
-
-## Example
-
-```typescript
-import { ListResponseUserShortResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: ListResponseUserShortResponse = {
-    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/LogListResponse.md

@@ -1,26 +0,0 @@
-# LogListResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**logs** | [**Array<LogResponse>**](LogResponse.md) |  | [default to undefined]
-**total** | **number** |  | [default to undefined]
-**page** | **number** |  | [default to undefined]
-**per_page** | **number** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { LogListResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: LogListResponse = {
-    logs,
-    total,
-    page,
-    per_page,
-};
-```
-
-[[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/LogResponse.md

@@ -1,36 +0,0 @@
-# LogResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**user** | [**MaintainerShortModel**](MaintainerShortModel.md) |  | [default to undefined]
-**timestamp** | **string** |  | [default to undefined]
-**action** | **string** |  | [default to undefined]
-**ip** | **string** |  | [optional] [default to undefined]
-**device_id** | **string** |  | [optional] [default to undefined]
-**release_id** | **string** |  | [optional] [default to undefined]
-**user_id** | **string** |  | [optional] [default to undefined]
-**data** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { LogResponse } from '@orangefox-recovery/foxinternalclient';
-
-const instance: LogResponse = {
-    id,
-    user,
-    timestamp,
-    action,
-    ip,
-    device_id,
-    release_id,
-    user_id,
-    data,
-};
-```
-
-[[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/MaintainerShortModel.md

@@ -1,26 +0,0 @@
-# MaintainerShortModel
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [default to undefined]
-**id** | **string** |  | [default to undefined]
-**name** | **string** |  | [default to undefined]
-**username** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { MaintainerShortModel } from '@orangefox-recovery/foxinternalclient';
-
-const instance: MaintainerShortModel = {
-    _id,
-    id,
-    name,
-    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/NewBuildTaskBody.md

@@ -1,28 +0,0 @@
-# NewBuildTaskBody
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**device_id** | **string** |  | [default to undefined]
-**tree_branch** | **string** |  | [optional] [default to undefined]
-**type** | [**ReleaseType**](ReleaseType.md) |  | [optional] [default to undefined]
-**variant** | **string** |  | [optional] [default to 'default']
-**additional_env** | **Array<string>** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NewBuildTaskBody } from '@orangefox-recovery/foxinternalclient';
-
-const instance: NewBuildTaskBody = {
-    device_id,
-    tree_branch,
-    type,
-    variant,
-    additional_env,
-};
-```
-
-[[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/NewDeviceBody.md

@@ -1,26 +0,0 @@
-# NewDeviceBody
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**oem_name** | **string** |  | [default to undefined]
-**codenames** | **Array<string>** |  | [default to undefined]
-**model_names** | **Array<string>** |  | [default to undefined]
-**maintainer** | **string** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { NewDeviceBody } from '@orangefox-recovery/foxinternalclient';
-
-const instance: NewDeviceBody = {
-    oem_name,
-    codenames,
-    model_names,
-    maintainer,
-};
-```
-
-[[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/PasteApi.md

@@ -1,117 +0,0 @@
-# PasteApi
-
-All URIs are relative to *https://api.orangefox.download*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createPastePastePost**](#createpastepastepost) | **POST** /paste/ | Create Paste|
-|[**getPastePastePasteIdGet**](#getpastepastepasteidget) | **GET** /paste/{paste_id} | Get Paste|
-
-# **createPastePastePost**
-> PasteOutput createPastePastePost(pasteInput)
-
-Create a new paste.
-
-### Example
-
-```typescript
-import {
-    PasteApi,
-    Configuration,
-    PasteInput
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new PasteApi(configuration);
-
-let pasteInput: PasteInput; //
-
-const { status, data } = await apiInstance.createPastePastePost(
-    pasteInput
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **pasteInput** | **PasteInput**|  | |
-
-
-### Return type
-
-**PasteOutput**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | Successful Response |  -  |
-|**429** | Too many requests |  -  |
-|**422** | Validation Error |  -  |
-
-[[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)
-
-# **getPastePastePasteIdGet**
-> PasteOutput getPastePastePasteIdGet()
-
-Get a paste by ID.
-
-### Example
-
-```typescript
-import {
-    PasteApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new PasteApi(configuration);
-
-let pasteId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.getPastePastePasteIdGet(
-    pasteId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **pasteId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**PasteOutput**
-
-### 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 |  -  |
-|**404** | Item not found |  -  |
-|**429** | Too many requests |  -  |
-|**422** | Validation Error |  -  |
-
-[[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/PasteInput.md

@@ -1,26 +0,0 @@
-# PasteInput
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [optional] [default to undefined]
-**content** | **string** |  | [default to undefined]
-**ip_address** | **string** |  | [default to undefined]
-**created_at** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PasteInput } from '@orangefox-recovery/foxinternalclient';
-
-const instance: PasteInput = {
-    _id,
-    content,
-    ip_address,
-    created_at,
-};
-```
-
-[[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/PasteOutput.md

@@ -1,26 +0,0 @@
-# PasteOutput
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**_id** | **string** |  | [optional] [default to undefined]
-**content** | **string** |  | [default to undefined]
-**ip_address** | **string** |  | [default to undefined]
-**created_at** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PasteOutput } from '@orangefox-recovery/foxinternalclient';
-
-const instance: PasteOutput = {
-    _id,
-    content,
-    ip_address,
-    created_at,
-};
-```
-
-[[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/RecoveryImgResponse.md

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