@orangefox-recovery/foxclient 6.1.0 → 6.2.0

package/docs/ListResponseCatalogReleaseResponse.md

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

@@ -0,0 +1,46 @@
+
+# ListResponseCatalogReleaseResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`artifacts` | [Array<ArtifactResponse>](ArtifactResponse.md)
+`changelog` | string
+`changelogI18n` | string
+`channel` | string
+`id` | string
+`packageId` | string
+`version` | string
+
+## Example
+
+```typescript
+import type { ListResponseCatalogReleaseResponseDataInner } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "artifacts": null,
+  "changelog": null,
+  "changelogI18n": null,
+  "channel": null,
+  "id": null,
+  "packageId": null,
+  "version": null,
+} satisfies ListResponseCatalogReleaseResponseDataInner
+
+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 ListResponseCatalogReleaseResponseDataInner
+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/ListResponsePackageResponse.md

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

@@ -0,0 +1,44 @@
+
+# ListResponsePackageResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`descriptionI18n` | string
+`kind` | [PackageKind](PackageKind.md)
+`name` | string
+`nameI18n` | string
+`id` | string
+
+## Example
+
+```typescript
+import type { ListResponsePackageResponseDataInner } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "descriptionI18n": null,
+  "kind": null,
+  "name": null,
+  "nameI18n": null,
+  "id": null,
+} satisfies ListResponsePackageResponseDataInner
+
+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 ListResponsePackageResponseDataInner
+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/PackageInput.md

@@ -0,0 +1,42 @@
+
+# PackageInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`descriptionI18n` | string
+`kind` | [PackageKind](PackageKind.md)
+`name` | string
+`nameI18n` | string
+
+## Example
+
+```typescript
+import type { PackageInput } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "descriptionI18n": null,
+  "kind": null,
+  "name": null,
+  "nameI18n": null,
+} satisfies PackageInput
+
+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 PackageInput
+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/PackageKind.md

@@ -0,0 +1,32 @@
+
+# PackageKind
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { PackageKind } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies PackageKind
+
+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 PackageKind
+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/PackageResponse.md

@@ -0,0 +1,44 @@
+
+# PackageResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`descriptionI18n` | string
+`kind` | [PackageKind](PackageKind.md)
+`name` | string
+`nameI18n` | string
+`id` | string
+
+## Example
+
+```typescript
+import type { PackageResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "descriptionI18n": null,
+  "kind": null,
+  "name": null,
+  "nameI18n": null,
+  "id": null,
+} satisfies PackageResponse
+
+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 PackageResponse
+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/ReleaseApi.md

@@ -8,7 +8,7 @@ All URIs are relative to *https://api.orangefox.download*
 | [**getRelease**](ReleaseApi.md#getrelease) | **GET** /releases/get | GET /releases/get - Get a single release. |
 | [**getReleaseById**](ReleaseApi.md#getreleasebyid) | **GET** /releases/{release_id} | GET /releases/{release_id} - Get release by ID (deprecated). |
 | [**getUpdatesAfter**](ReleaseApi.md#getupdatesafter) | **GET** /updates/{last_known_id} | GET /updates/{last_known_id} - Get releases after a given release ID (deprecated). |
-| [**listReleases**](ReleaseApi.md#listreleases) | **GET** /releases | Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters. |
+| [**listReleases**](ReleaseApi.md#listreleases) | **GET** /releases | GET /releases/ - List releases with filters. |
 
 
 
@@ -302,7 +302,7 @@ No authorization required
 
 > ReleaseListResponse listReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit)
 
-Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
+GET /releases/ - List releases with filters.
 
 ### Example
 
@@ -342,8 +342,8 @@ async function example() {
     afterReleaseId: afterReleaseId_example,
     // number (optional)
     afterDate: 789,
-    // string (optional)
-    sort: sort_example,
+    // ReleaseSort (optional)
+    sort: ...,
     // boolean (optional)
     group: true,
     // number (optional)
@@ -381,7 +381,7 @@ example().catch(console.error);
 | **freezed** | `boolean` |  | [Optional] [Defaults to `undefined`] |
 | **afterReleaseId** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **afterDate** | `number` |  | [Optional] [Defaults to `undefined`] |
-| **sort** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **sort** | `ReleaseSort` |  | [Optional] [Defaults to `undefined`] [Enum: date_asc, date_desc] |
 | **group** | `boolean` |  | [Optional] [Defaults to `undefined`] |
 | **skip** | `number` |  | [Optional] [Defaults to `undefined`] |
 | **limit** | `number` |  | [Optional] [Defaults to `undefined`] |

package/docs/ReleaseGroupsResponse.md

@@ -1,12 +1,14 @@
 
 # ReleaseGroupsResponse
 
+`GET /releases?group=true` — releases bucketed by version.  `data` is an [`IndexMap`], not a `HashMap`: serde emits a map in iteration order, and `HashMap`\'s is randomised per process, so the version groups came back in a different order on every request and the `sort` parameter had no effect on them whatsoever. Insertion order follows the cursor, so the groups now appear in the order the query asked for.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `data` | { [key: string]: Array<ReleaseResponse>; }
+`hasMore` | boolean
 
 ## Example
 
@@ -16,6 +18,7 @@ import type { ReleaseGroupsResponse } from '@orangefox-recovery/foxclient'
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
+  "hasMore": null,
 } satisfies ReleaseGroupsResponse
 
 console.log(example)

package/docs/ReleaseSort.md

@@ -0,0 +1,33 @@
+
+# ReleaseSort
+
+Sort modes accepted by `GET /releases?sort=`.  A typed enum rather than a free string: an unrecognised value used to fall through to the default arm, so `?sort=date_ascending` quietly returned the *opposite* order rather than reporting the typo. It also restores the enum the previous Python implementation published, which generated clients had been offering as a checked type.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ReleaseSort } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ReleaseSort
+
+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 ReleaseSort
+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/foxclient",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "OpenAPI client for @orangefox-recovery/foxclient",
   "author": "OpenAPI-Generator",
   "repository": {
@@ -15,7 +15,7 @@
     "prepare": "npm run build"
   },
   "devDependencies": {
-    "typescript": "^4.0 || ^5.0"
+    "typescript": "^7.0.2"
   },
   "exports": {
     ".": {