@orangefox-recovery/foxinternalclient 5.3.0 → 5.3.3

package/docs/ListResponseBuildTaskShortResponse.md

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

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

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

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

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

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

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

@@ -0,0 +1,50 @@
+
+# LogResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`user` | [MaintainerShortModel](MaintainerShortModel.md)
+`timestamp` | Date
+`action` | string
+`ip` | string
+`deviceId` | string
+`releaseId` | string
+`userId` | string
+`data` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { LogResponse } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "user": null,
+  "timestamp": null,
+  "action": null,
+  "ip": null,
+  "deviceId": null,
+  "releaseId": null,
+  "userId": null,
+  "data": null,
+} satisfies LogResponse
+
+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 LogResponse
+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/MaintainerShortModel.md

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

@@ -0,0 +1,42 @@
+
+# NewBuildTaskBody
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceId` | string
+`treeBranch` | string
+`type` | [ReleaseType](ReleaseType.md)
+`variant` | string
+`additionalEnv` | Array<string>
+
+## Example
+
+```typescript
+import type { NewBuildTaskBody } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceId": null,
+  "treeBranch": null,
+  "type": null,
+  "variant": null,
+  "additionalEnv": null,
+} satisfies NewBuildTaskBody
+
+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 NewBuildTaskBody
+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/NewDeviceBody.md

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

@@ -0,0 +1,149 @@
+# PasteApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createPastePastePost**](PasteApi.md#createpastepastepost) | **POST** /paste/ | Create Paste |
+| [**getPastePastePasteIdGet**](PasteApi.md#getpastepastepasteidget) | **GET** /paste/{paste_id} | Get Paste |
+
+
+
+## createPastePastePost
+
+> PasteOutput createPastePastePost(pasteInput)
+
+Create Paste
+
+Create a new paste.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PasteApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { CreatePastePastePostRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const api = new PasteApi();
+
+  const body = {
+    // PasteInput
+    pasteInput: ...,
+  } satisfies CreatePastePastePostRequest;
+
+  try {
+    const data = await api.createPastePastePost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pasteInput** | [PasteInput](PasteInput.md) |  | |
+
+### Return type
+
+[**PasteOutput**](PasteOutput.md)
+
+### 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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPastePastePasteIdGet
+
+> PasteOutput getPastePastePasteIdGet(pasteId)
+
+Get Paste
+
+Get a paste by ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PasteApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { GetPastePastePasteIdGetRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const api = new PasteApi();
+
+  const body = {
+    // string
+    pasteId: pasteId_example,
+  } satisfies GetPastePastePasteIdGetRequest;
+
+  try {
+    const data = await api.getPastePastePasteIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pasteId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**PasteOutput**](PasteOutput.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 |  -  |
+| **404** | Item not found |  -  |
+| **429** | Too many requests |  -  |
+| **422** | Validation 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/PasteInput.md

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

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

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