@orangefox-recovery/foxclient 6.0.10 → 6.1.1

package/dist/models/index.js

@@ -24,6 +24,10 @@ __exportStar(require("./ListResponseReleaseResponseDataInner"), exports);
 __exportStar(require("./ListResponseShortDeviceResponse"), exports);
 __exportStar(require("./ListResponseShortDeviceResponseDataInner"), exports);
 __exportStar(require("./ListResponseString"), exports);
+__exportStar(require("./ListResponseWikiPageShortResponse"), exports);
+__exportStar(require("./ListResponseWikiPageShortResponseDataInner"), exports);
+__exportStar(require("./ListResponseWikiSiteResponse"), exports);
+__exportStar(require("./ListResponseWikiSiteResponseDataInner"), exports);
 __exportStar(require("./MaintainerShortResponse"), exports);
 __exportStar(require("./NewReportRequest"), exports);
 __exportStar(require("./PasteInput"), exports);
@@ -32,6 +36,7 @@ __exportStar(require("./RecoveryImgResponse"), exports);
 __exportStar(require("./ReleaseGroupsResponse"), exports);
 __exportStar(require("./ReleaseListResponse"), exports);
 __exportStar(require("./ReleaseResponse"), exports);
+__exportStar(require("./ReleaseSort"), exports);
 __exportStar(require("./ShortDeviceResponse"), exports);
 __exportStar(require("./ShortReleaseResponse"), exports);
 __exportStar(require("./TokenResponse"), exports);
@@ -41,3 +46,6 @@ __exportStar(require("./UptimeMonitor"), exports);
 __exportStar(require("./UptimeMonitorGroup"), exports);
 __exportStar(require("./UptimeMonitors"), exports);
 __exportStar(require("./UptimeResponse"), exports);
+__exportStar(require("./WikiPageResponse"), exports);
+__exportStar(require("./WikiPageShortResponse"), exports);
+__exportStar(require("./WikiSiteResponse"), exports);

package/dist/runtime.d.ts

@@ -2,7 +2,7 @@
  * 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: 6.0.10
+ * The version of the OpenAPI document: 6.1.1
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime.js

@@ -5,7 +5,7 @@
  * 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: 6.0.10
+ * The version of the OpenAPI document: 6.1.1
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/ListResponseReleaseResponse.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `count` | number
 `data` | [Array<ListResponseReleaseResponseDataInner>](ListResponseReleaseResponseDataInner.md)
+`hasMore` | boolean
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { ListResponseReleaseResponse } from '@orangefox-recovery/foxclient'
 const example = {
   "count": null,
   "data": null,
+  "hasMore": null,
 } satisfies ListResponseReleaseResponse
 
 console.log(example)

package/docs/ListResponseShortDeviceResponse.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `count` | number
 `data` | [Array<ListResponseShortDeviceResponseDataInner>](ListResponseShortDeviceResponseDataInner.md)
+`hasMore` | boolean
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { ListResponseShortDeviceResponse } from '@orangefox-recovery/foxcli
 const example = {
   "count": null,
   "data": null,
+  "hasMore": null,
 } satisfies ListResponseShortDeviceResponse
 
 console.log(example)

package/docs/ListResponseString.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `count` | number
 `data` | Array<string>
+`hasMore` | boolean
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { ListResponseString } from '@orangefox-recovery/foxclient'
 const example = {
   "count": null,
   "data": null,
+  "hasMore": null,
 } satisfies ListResponseString
 
 console.log(example)

package/docs/ListResponseWikiPageShortResponse.md

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

@@ -0,0 +1,57 @@
+
+# ListResponseWikiPageShortResponseDataInner
+
+A page without its body. FoxWiki fetches the whole set of these once and builds its navigation tree from them, so this must stay cheap.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`draft` | boolean
+`fileName` | string
+`icon` | string
+`id` | string
+`image` | string
+`lastUpdated` | string
+`noindex` | boolean
+`parentPath` | string
+`path` | string
+`title` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { ListResponseWikiPageShortResponseDataInner } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "draft": null,
+  "fileName": null,
+  "icon": null,
+  "id": null,
+  "image": null,
+  "lastUpdated": null,
+  "noindex": null,
+  "parentPath": null,
+  "path": null,
+  "title": null,
+  "type": null,
+} satisfies ListResponseWikiPageShortResponseDataInner
+
+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 ListResponseWikiPageShortResponseDataInner
+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/ListResponseWikiSiteResponse.md

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

@@ -0,0 +1,48 @@
+
+# ListResponseWikiSiteResponseDataInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`defaultPage` | string
+`description` | string
+`devicePages` | string
+`id` | string
+`name` | string
+`slug` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { ListResponseWikiSiteResponseDataInner } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "defaultPage": null,
+  "description": null,
+  "devicePages": null,
+  "id": null,
+  "name": null,
+  "slug": null,
+  "updatedAt": null,
+} satisfies ListResponseWikiSiteResponseDataInner
+
+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 ListResponseWikiSiteResponseDataInner
+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

@@ -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/ReleaseListResponse.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `count` | number
 `data` | { [key: string]: Array<ReleaseResponse>; }
+`hasMore` | boolean
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { ReleaseListResponse } from '@orangefox-recovery/foxclient'
 const example = {
   "count": null,
   "data": null,
+  "hasMore": null,
 } satisfies ReleaseListResponse
 
 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)
+
+