@orangefox-recovery/foxclient 6.1.1 → 6.2.0

package/docs/ArtifactFormat.md

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

@@ -0,0 +1,48 @@
+
+# ArtifactInput
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`compatibility` | [Compatibility](Compatibility.md)
+`downloadUrl` | string
+`filename` | string
+`format` | [ArtifactFormat](ArtifactFormat.md)
+`notes` | string
+`notesI18n` | string
+`sha256` | string
+`size` | number
+
+## Example
+
+```typescript
+import type { ArtifactInput } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "compatibility": null,
+  "downloadUrl": null,
+  "filename": null,
+  "format": null,
+  "notes": null,
+  "notesI18n": null,
+  "sha256": null,
+  "size": null,
+} satisfies ArtifactInput
+
+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 ArtifactInput
+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/ArtifactResponse.md

@@ -0,0 +1,50 @@
+
+# ArtifactResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`compatibility` | [Compatibility](Compatibility.md)
+`downloadUrl` | string
+`filename` | string
+`format` | [ArtifactFormat](ArtifactFormat.md)
+`notes` | string
+`notesI18n` | string
+`sha256` | string
+`size` | number
+`id` | string
+
+## Example
+
+```typescript
+import type { ArtifactResponse } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "compatibility": null,
+  "downloadUrl": null,
+  "filename": null,
+  "format": null,
+  "notes": null,
+  "notesI18n": null,
+  "sha256": null,
+  "size": null,
+  "id": null,
+} satisfies ArtifactResponse
+
+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 ArtifactResponse
+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/CatalogApi.md

@@ -0,0 +1,319 @@
+# CatalogApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**catalogGetPackage**](CatalogApi.md#cataloggetpackage) | **GET** /v1/packages/{package_id} |  |
+| [**catalogGetRelease**](CatalogApi.md#cataloggetrelease) | **GET** /v1/releases/{release_id} |  |
+| [**catalogListPackages**](CatalogApi.md#cataloglistpackages) | **GET** /v1/packages |  |
+| [**catalogListReleases**](CatalogApi.md#cataloglistreleases) | **GET** /v1/packages/{package_id}/releases |  |
+
+
+
+## catalogGetPackage
+
+> PackageResponse catalogGetPackage(packageId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CatalogApi,
+} from '@orangefox-recovery/foxclient';
+import type { CatalogGetPackageRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new CatalogApi();
+
+  const body = {
+    // string | Package ObjectId
+    packageId: packageId_example,
+  } satisfies CatalogGetPackageRequest;
+
+  try {
+    const data = await api.catalogGetPackage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **packageId** | `string` | Package ObjectId | [Defaults to `undefined`] |
+
+### Return type
+
+[**PackageResponse**](PackageResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Package |  -  |
+| **400** | Invalid ObjectId |  -  |
+| **404** | Package not found |  -  |
+| **500** | Database error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## catalogGetRelease
+
+> CatalogReleaseResponse catalogGetRelease(releaseId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CatalogApi,
+} from '@orangefox-recovery/foxclient';
+import type { CatalogGetReleaseRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new CatalogApi();
+
+  const body = {
+    // string | Catalog release ObjectId
+    releaseId: releaseId_example,
+  } satisfies CatalogGetReleaseRequest;
+
+  try {
+    const data = await api.catalogGetRelease(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **releaseId** | `string` | Catalog release ObjectId | [Defaults to `undefined`] |
+
+### Return type
+
+[**CatalogReleaseResponse**](CatalogReleaseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Immutable catalog release |  -  |
+| **400** | Invalid ObjectId |  -  |
+| **404** | Release not found |  -  |
+| **500** | Database error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## catalogListPackages
+
+> ListResponsePackageResponse catalogListPackages(kind, arch, device, recoveryApi, channel, skip, limit)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CatalogApi,
+} from '@orangefox-recovery/foxclient';
+import type { CatalogListPackagesRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new CatalogApi();
+
+  const body = {
+    // PackageKind (optional)
+    kind: ...,
+    // string (optional)
+    arch: arch_example,
+    // string (optional)
+    device: device_example,
+    // number (optional)
+    recoveryApi: 56,
+    // string (optional)
+    channel: channel_example,
+    // number (optional)
+    skip: 789,
+    // number (optional)
+    limit: 789,
+  } satisfies CatalogListPackagesRequest;
+
+  try {
+    const data = await api.catalogListPackages(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **kind** | `PackageKind` |  | [Optional] [Defaults to `undefined`] [Enum: tool, rom] |
+| **arch** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **device** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **recoveryApi** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **channel** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **skip** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListResponsePackageResponse**](ListResponsePackageResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Packages matching a single release and artifact |  -  |
+| **400** | Invalid query |  -  |
+| **500** | Database error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## catalogListReleases
+
+> ListResponseCatalogReleaseResponse catalogListReleases(packageId, arch, device, recoveryApi, channel, skip, limit)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CatalogApi,
+} from '@orangefox-recovery/foxclient';
+import type { CatalogListReleasesRequest } from '@orangefox-recovery/foxclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxclient SDK...");
+  const api = new CatalogApi();
+
+  const body = {
+    // string | Package ObjectId
+    packageId: packageId_example,
+    // string (optional)
+    arch: arch_example,
+    // string (optional)
+    device: device_example,
+    // number (optional)
+    recoveryApi: 56,
+    // string (optional)
+    channel: channel_example,
+    // number (optional)
+    skip: 789,
+    // number (optional)
+    limit: 789,
+  } satisfies CatalogListReleasesRequest;
+
+  try {
+    const data = await api.catalogListReleases(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **packageId** | `string` | Package ObjectId | [Defaults to `undefined`] |
+| **arch** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **device** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **recoveryApi** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **channel** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **skip** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListResponseCatalogReleaseResponse**](ListResponseCatalogReleaseResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Releases containing only matching artifacts |  -  |
+| **400** | Invalid query or ObjectId |  -  |
+| **404** | Package not found |  -  |
+| **500** | Database 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/CatalogReleaseResponse.md

@@ -0,0 +1,46 @@
+
+# CatalogReleaseResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`artifacts` | [Array<ArtifactResponse>](ArtifactResponse.md)
+`changelog` | string
+`changelogI18n` | string
+`channel` | string
+`id` | string
+`packageId` | string
+`version` | string
+
+## Example
+
+```typescript
+import type { CatalogReleaseResponse } 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 CatalogReleaseResponse
+
+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 CatalogReleaseResponse
+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/Compatibility.md

@@ -0,0 +1,40 @@
+
+# Compatibility
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`arch` | string
+`devices` | Array<string>
+`minRecoveryApi` | number
+`runtime` | string
+
+## Example
+
+```typescript
+import type { Compatibility } from '@orangefox-recovery/foxclient'
+
+// TODO: Update the object below with actual values
+const example = {
+  "arch": null,
+  "devices": null,
+  "minRecoveryApi": null,
+  "runtime": null,
+} satisfies Compatibility
+
+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 Compatibility
+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/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)
+
+