@orangefox-recovery/foxinternalclient 5.3.3 → 6.0.4

package/docs/ListResponseBuildTaskShortResponse.md

@@ -6,8 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`data` | [Array<BuildTaskShortResponse>](BuildTaskShortResponse.md)
 `count` | number
+`data` | [Array<ListResponseBuildTaskShortResponseDataInner>](ListResponseBuildTaskShortResponseDataInner.md)
 
 ## Example
 
@@ -16,8 +16,8 @@ import type { ListResponseBuildTaskShortResponse } from '@orangefox-recovery/fox
 
 // TODO: Update the object below with actual values
 const example = {
-  "data": null,
   "count": null,
+  "data": null,
 } satisfies ListResponseBuildTaskShortResponse
 
 console.log(example)

package/docs/ListResponseBuildTaskShortResponseDataInner.md

@@ -0,0 +1,52 @@
+
+# ListResponseBuildTaskShortResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`device` | [ShortDeviceResponse](ShortDeviceResponse.md)
+`finishedAt` | string
+`hasArtifact` | boolean
+`id` | string
+`startedAt` | string
+`startedById` | string
+`status` | string
+`type` | string
+`variant` | string
+`version` | string
+
+## Example
+
+```typescript
+import type { ListResponseBuildTaskShortResponseDataInner } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "device": null,
+  "finishedAt": null,
+  "hasArtifact": null,
+  "id": null,
+  "startedAt": null,
+  "startedById": null,
+  "status": null,
+  "type": null,
+  "variant": null,
+  "version": null,
+} satisfies ListResponseBuildTaskShortResponseDataInner
+
+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 ListResponseBuildTaskShortResponseDataInner
+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 → ListResponsePasteResponse.md}

@@ -1,24 +1,24 @@
 
-# ListResponseShortReleaseResponse
+# ListResponsePasteResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<ShortReleaseResponse>](ShortReleaseResponse.md)
 `count` | number
+`data` | [Array<ListResponsePasteResponseDataInner>](ListResponsePasteResponseDataInner.md)
 
 ## Example
 
 ```typescript
-import type { ListResponseShortReleaseResponse } from '@orangefox-recovery/foxinternalclient'
+import type { ListResponsePasteResponse } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
-  "data": null,
   "count": null,
-} satisfies ListResponseShortReleaseResponse
+  "data": null,
+} satisfies ListResponsePasteResponse
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ListResponseShortReleaseResponse
+const exampleParsed = JSON.parse(exampleJSON) as ListResponsePasteResponse
 console.log(exampleParsed)
 ```
 

package/docs/{UserGitlab.md → ListResponsePasteResponseDataInner.md}

@@ -1,22 +1,28 @@
 
-# UserGitlab
+# ListResponsePasteResponseDataInner
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | number
+`content` | string
+`createdAt` | string
+`id` | string
+`isOwner` | boolean
 
 ## Example
 
 ```typescript
-import type { UserGitlab } from '@orangefox-recovery/foxinternalclient'
+import type { ListResponsePasteResponseDataInner } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
+  "content": null,
+  "createdAt": null,
   "id": null,
-} satisfies UserGitlab
+  "isOwner": null,
+} satisfies ListResponsePasteResponseDataInner
 
 console.log(example)
 
@@ -25,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as UserGitlab
+const exampleParsed = JSON.parse(exampleJSON) as ListResponsePasteResponseDataInner
 console.log(exampleParsed)
 ```
 

package/docs/ListResponseReleaseResponse.md

@@ -6,8 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`data` | [Array<ReleaseResponse>](ReleaseResponse.md)
 `count` | number
+`data` | [Array<ListResponseReleaseResponseDataInner>](ListResponseReleaseResponseDataInner.md)
 
 ## Example
 
@@ -16,8 +16,8 @@ import type { ListResponseReleaseResponse } from '@orangefox-recovery/foxinterna
 
 // TODO: Update the object below with actual values
 const example = {
-  "data": null,
   "count": null,
+  "data": null,
 } satisfies ListResponseReleaseResponse
 
 console.log(example)

package/docs/ListResponseReleaseResponseDataInner.md

@@ -0,0 +1,74 @@
+
+# ListResponseReleaseResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`legacyId` | string
+`archived` | boolean
+`buildId` | 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
+`bugs` | Array<string>
+`changelog` | Array<string>
+`mirrors` | { [key: string]: string; }
+`notes` | string
+`recoveryImg` | [RecoveryImgResponse](RecoveryImgResponse.md)
+`url` | string
+
+## Example
+
+```typescript
+import type { ListResponseReleaseResponseDataInner } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "legacyId": null,
+  "archived": null,
+  "buildId": null,
+  "date": null,
+  "deviceId": null,
+  "featuredText": null,
+  "filename": null,
+  "id": null,
+  "isFeatured": null,
+  "maintainerId": null,
+  "md5": null,
+  "size": null,
+  "type": null,
+  "variant": null,
+  "version": null,
+  "bugs": null,
+  "changelog": null,
+  "mirrors": null,
+  "notes": null,
+  "recoveryImg": null,
+  "url": null,
+} satisfies ListResponseReleaseResponseDataInner
+
+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 ListResponseReleaseResponseDataInner
+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

@@ -6,8 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`data` | [Array<ShortDeviceResponse>](ShortDeviceResponse.md)
 `count` | number
+`data` | [Array<ListResponseShortDeviceResponseDataInner>](ListResponseShortDeviceResponseDataInner.md)
 
 ## Example
 
@@ -16,8 +16,8 @@ import type { ListResponseShortDeviceResponse } from '@orangefox-recovery/foxint
 
 // TODO: Update the object below with actual values
 const example = {
-  "data": null,
   "count": null,
+  "data": null,
 } satisfies ListResponseShortDeviceResponse
 
 console.log(example)

package/docs/ListResponseShortDeviceResponseDataInner.md

@@ -0,0 +1,56 @@
+
+# ListResponseShortDeviceResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`legacyId` | string
+`codename` | string
+`codenames` | Array<string>
+`featuredText` | string
+`fullName` | string
+`id` | string
+`isFeatured` | boolean
+`modelName` | string
+`modelNames` | Array<string>
+`oemName` | string
+`supported` | boolean
+`url` | string
+
+## Example
+
+```typescript
+import type { ListResponseShortDeviceResponseDataInner } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "legacyId": null,
+  "codename": null,
+  "codenames": null,
+  "featuredText": null,
+  "fullName": null,
+  "id": null,
+  "isFeatured": null,
+  "modelName": null,
+  "modelNames": null,
+  "oemName": null,
+  "supported": null,
+  "url": null,
+} satisfies ListResponseShortDeviceResponseDataInner
+
+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 ListResponseShortDeviceResponseDataInner
+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 → ListResponseString.md}

@@ -1,24 +1,24 @@
 
-# ListResponseStr
+# ListResponseString
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | Array<string>
 `count` | number
+`data` | Array<string>
 
 ## Example
 
 ```typescript
-import type { ListResponseStr } from '@orangefox-recovery/foxinternalclient'
+import type { ListResponseString } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
-  "data": null,
   "count": null,
-} satisfies ListResponseStr
+  "data": null,
+} satisfies ListResponseString
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ListResponseStr
+const exampleParsed = JSON.parse(exampleJSON) as ListResponseString
 console.log(exampleParsed)
 ```
 

package/docs/ListResponseUserShortResponse.md

@@ -6,8 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`data` | [Array<UserShortResponse>](UserShortResponse.md)
 `count` | number
+`data` | [Array<ListResponseUserShortResponseDataInner>](ListResponseUserShortResponseDataInner.md)
 
 ## Example
 
@@ -16,8 +16,8 @@ import type { ListResponseUserShortResponse } from '@orangefox-recovery/foxinter
 
 // TODO: Update the object below with actual values
 const example = {
-  "data": null,
   "count": null,
+  "data": null,
 } satisfies ListResponseUserShortResponse
 
 console.log(example)

package/docs/ListResponseUserShortResponseDataInner.md

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

@@ -7,9 +7,9 @@
 Name | Type
 ------------ | -------------
 `logs` | [Array<LogResponse>](LogResponse.md)
-`total` | number
 `page` | number
 `perPage` | number
+`total` | number
 
 ## Example
 
@@ -19,9 +19,9 @@ 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,
+  "total": null,
 } satisfies LogListResponse
 
 console.log(example)

package/docs/LogResponse.md

@@ -6,15 +6,15 @@
 
 Name | Type
 ------------ | -------------
-`id` | string
-`user` | [MaintainerShortModel](MaintainerShortModel.md)
-`timestamp` | Date
 `action` | string
-`ip` | string
+`data` | object
 `deviceId` | string
+`id` | string
+`ip` | string
 `releaseId` | string
+`timestamp` | string
+`user` | [MaintainerShortResponse](MaintainerShortResponse.md)
 `userId` | string
-`data` | { [key: string]: any; }
 
 ## Example
 
@@ -23,15 +23,15 @@ 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,
+  "data": null,
   "deviceId": null,
+  "id": null,
+  "ip": null,
   "releaseId": null,
+  "timestamp": null,
+  "user": null,
   "userId": null,
-  "data": null,
 } satisfies LogResponse
 
 console.log(example)

package/docs/{UserMail.md → LoginForm.md}

@@ -1,22 +1,25 @@
 
-# UserMail
+# LoginForm
 
+Login form (OAuth2 password grant style).
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`password` | string
 `username` | string
 
 ## Example
 
 ```typescript
-import type { UserMail } from '@orangefox-recovery/foxinternalclient'
+import type { LoginForm } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
+  "password": null,
   "username": null,
-} satisfies UserMail
+} satisfies LoginForm
 
 console.log(example)
 
@@ -25,7 +28,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as UserMail
+const exampleParsed = JSON.parse(exampleJSON) as LoginForm
 console.log(exampleParsed)
 ```
 

package/docs/{MaintainerShortModel.md → MaintainerShortResponse.md}

@@ -1,11 +1,12 @@
 
-# MaintainerShortModel
+# MaintainerShortResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`legacyId` | string
 `id` | string
 `name` | string
 `username` | string
@@ -13,14 +14,15 @@ Name | Type
 ## Example
 
 ```typescript
-import type { MaintainerShortModel } from '@orangefox-recovery/foxinternalclient'
+import type { MaintainerShortResponse } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "name": null,
-  "username": null,
-} satisfies MaintainerShortModel
+  "legacyId": 507f1f77bcf86cd799439011,
+  "id": abc123,
+  "name": John Doe,
+  "username": johndoe,
+} satisfies MaintainerShortResponse
 
 console.log(example)
 
@@ -29,7 +31,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as MaintainerShortModel
+const exampleParsed = JSON.parse(exampleJSON) as MaintainerShortResponse
 console.log(exampleParsed)
 ```
 

package/docs/NewBuildTaskBody.md

@@ -1,16 +1,18 @@
 
 # NewBuildTaskBody
 
+Body for creating a new build task
 
 ## Properties
 
 Name | Type
 ------------ | -------------
+`additionalEnv` | Array<string>
 `deviceId` | string
 `treeBranch` | string
-`type` | [ReleaseType](ReleaseType.md)
+`type` | string
 `variant` | string
-`additionalEnv` | Array<string>
+`version` | string
 
 ## Example
 
@@ -19,11 +21,12 @@ import type { NewBuildTaskBody } from '@orangefox-recovery/foxinternalclient'
 
 // TODO: Update the object below with actual values
 const example = {
+  "additionalEnv": null,
   "deviceId": null,
   "treeBranch": null,
   "type": null,
   "variant": null,
-  "additionalEnv": null,
+  "version": null,
 } satisfies NewBuildTaskBody
 
 console.log(example)

package/docs/NewDeviceBody.md

@@ -1,15 +1,16 @@
 
 # NewDeviceBody
 
+Body for creating a new device
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`oemName` | string
 `codenames` | Array<string>
-`modelNames` | Array<string>
 `maintainer` | string
+`modelNames` | Array<string>
+`oemName` | string
 
 ## Example
 
@@ -18,10 +19,10 @@ 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,
+  "modelNames": null,
+  "oemName": null,
 } satisfies NewDeviceBody
 
 console.log(example)

package/docs/NewReportRequest.md

@@ -0,0 +1,42 @@
+
+# NewReportRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`details` | string
+`dmesg` | string
+`logcat` | string
+`logs` | { [key: string]: string; }
+`screenshots` | Array<string>
+
+## Example
+
+```typescript
+import type { NewReportRequest } from '@orangefox-recovery/foxinternalclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "details": null,
+  "dmesg": null,
+  "logcat": null,
+  "logs": null,
+  "screenshots": null,
+} satisfies NewReportRequest
+
+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 NewReportRequest
+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)
+
+