@orangefox-recovery/foxinternalclient 5.3.0 → 5.3.2

package/docs/FoxFactoryApi.md

@@ -0,0 +1,758 @@
+# FoxFactoryApi
+
+All URIs are relative to *https://api.orangefox.download*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cancelTaskFactoryTaskIdCancelPost**](FoxFactoryApi.md#canceltaskfactorytaskidcancelpost) | **POST** /factory/{task_id}/cancel | Cancel Task |
+| [**deleteTaskFactoryTaskIdDelete**](FoxFactoryApi.md#deletetaskfactorytaskiddelete) | **DELETE** /factory/{task_id} | Delete Task |
+| [**downloadArtifactFactoryTaskIdArtifactGet**](FoxFactoryApi.md#downloadartifactfactorytaskidartifactget) | **GET** /factory/{task_id}/artifact | Download Artifact |
+| [**factoryStatusFactoryStatusGet**](FoxFactoryApi.md#factorystatusfactorystatusget) | **GET** /factory/status | Factory Status |
+| [**getTaskFactoryTaskIdGet**](FoxFactoryApi.md#gettaskfactorytaskidget) | **GET** /factory/{task_id} | Get Task |
+| [**listTasksFactoryGet**](FoxFactoryApi.md#listtasksfactoryget) | **GET** /factory/ | List Tasks |
+| [**newTaskFactoryPost**](FoxFactoryApi.md#newtaskfactorypost) | **POST** /factory/ | New Task |
+| [**updateTaskFactoryTaskIdPatch**](FoxFactoryApi.md#updatetaskfactorytaskidpatch) | **PATCH** /factory/{task_id} | Update Task |
+| [**updateWorkerStatusFactoryUpdateStatusPost**](FoxFactoryApi.md#updateworkerstatusfactoryupdatestatuspost) | **POST** /factory/update_status | Update Worker Status |
+| [**uploadArtifactFactoryTaskIdArtifactPost**](FoxFactoryApi.md#uploadartifactfactorytaskidartifactpost) | **POST** /factory/{task_id}/artifact | Upload Artifact |
+
+
+
+## cancelTaskFactoryTaskIdCancelPost
+
+> BuildTaskResponse cancelTaskFactoryTaskIdCancelPost(taskId)
+
+Cancel Task
+
+Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { CancelTaskFactoryTaskIdCancelPostRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  const body = {
+    // string
+    taskId: taskId_example,
+  } satisfies CancelTaskFactoryTaskIdCancelPostRequest;
+
+  try {
+    const data = await api.cancelTaskFactoryTaskIdCancelPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**BuildTaskResponse**](BuildTaskResponse.md)
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **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)
+
+
+## deleteTaskFactoryTaskIdDelete
+
+> boolean deleteTaskFactoryTaskIdDelete(taskId)
+
+Delete Task
+
+Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised. Also deletes any associated artifact files.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { DeleteTaskFactoryTaskIdDeleteRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  const body = {
+    // string
+    taskId: taskId_example,
+  } satisfies DeleteTaskFactoryTaskIdDeleteRequest;
+
+  try {
+    const data = await api.deleteTaskFactoryTaskIdDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **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)
+
+
+## downloadArtifactFactoryTaskIdArtifactGet
+
+> any downloadArtifactFactoryTaskIdArtifactGet(taskId)
+
+Download Artifact
+
+Download the artifact file for a specific build task.  This endpoint allows maintainers and foxfactory workers to download the artifact file associated with a build task.  Parameters:     task_id: The ID of the build task
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { DownloadArtifactFactoryTaskIdArtifactGetRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  const body = {
+    // string
+    taskId: taskId_example,
+  } satisfies DownloadArtifactFactoryTaskIdArtifactGetRequest;
+
+  try {
+    const data = await api.downloadArtifactFactoryTaskIdArtifactGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**any**
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **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)
+
+
+## factoryStatusFactoryStatusGet
+
+> FFStatusResponse factoryStatusFactoryStatusGet()
+
+Factory Status
+
+Endpoint for clients to get the current status of the worker. If the last update was longer than the defined timeout, worker is considered offline.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { FactoryStatusFactoryStatusGetRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  try {
+    const data = await api.factoryStatusFactoryStatusGet();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**FFStatusResponse**](FFStatusResponse.md)
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getTaskFactoryTaskIdGet
+
+> BuildTaskResponse getTaskFactoryTaskIdGet(taskId)
+
+Get Task
+
+Retrieves the details of a specific build task.  This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { GetTaskFactoryTaskIdGetRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  const body = {
+    // string
+    taskId: taskId_example,
+  } satisfies GetTaskFactoryTaskIdGetRequest;
+
+  try {
+    const data = await api.getTaskFactoryTaskIdGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**BuildTaskResponse**](BuildTaskResponse.md)
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **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)
+
+
+## listTasksFactoryGet
+
+> ListResponseBuildTaskShortResponse listTasksFactoryGet(deviceId)
+
+List Tasks
+
+Get a list of all build tasks.  This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses.  Parameters:     device_id (ObjectId, optional): Filter tasks by device ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { ListTasksFactoryGetRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  const body = {
+    // string (optional)
+    deviceId: deviceId_example,
+  } satisfies ListTasksFactoryGetRequest;
+
+  try {
+    const data = await api.listTasksFactoryGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deviceId** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListResponseBuildTaskShortResponse**](ListResponseBuildTaskShortResponse.md)
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **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)
+
+
+## newTaskFactoryPost
+
+> boolean newTaskFactoryPost(newBuildTaskBody)
+
+New Task
+
+Handles the creation of a new build task including validations for the device existence and its connection to GitLab. It initializes a new task with a pending status and the required details, then saves it to the database before returning the task model.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { NewTaskFactoryPostRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  const body = {
+    // NewBuildTaskBody
+    newBuildTaskBody: ...,
+  } satisfies NewTaskFactoryPostRequest;
+
+  try {
+    const data = await api.newTaskFactoryPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **newBuildTaskBody** | [NewBuildTaskBody](NewBuildTaskBody.md) |  | |
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **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)
+
+
+## updateTaskFactoryTaskIdPatch
+
+> boolean updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody)
+
+Update Task
+
+Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated.  Allowed only for foxworker users.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { UpdateTaskFactoryTaskIdPatchRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  const body = {
+    // string
+    taskId: taskId_example,
+    // TaskUpdateBody
+    taskUpdateBody: ...,
+  } satisfies UpdateTaskFactoryTaskIdPatchRequest;
+
+  try {
+    const data = await api.updateTaskFactoryTaskIdPatch(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | `string` |  | [Defaults to `undefined`] |
+| **taskUpdateBody** | [TaskUpdateBody](TaskUpdateBody.md) |  | |
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **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)
+
+
+## updateWorkerStatusFactoryUpdateStatusPost
+
+> any updateWorkerStatusFactoryUpdateStatusPost(body)
+
+Update Worker Status
+
+Endpoint for FoxFactory worker to update its status.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { UpdateWorkerStatusFactoryUpdateStatusPostRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  const body = {
+    // string
+    body: ...,
+  } satisfies UpdateWorkerStatusFactoryUpdateStatusPostRequest;
+
+  try {
+    const data = await api.updateWorkerStatusFactoryUpdateStatusPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **body** | `string` |  | |
+
+### Return type
+
+**any**
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **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)
+
+
+## uploadArtifactFactoryTaskIdArtifactPost
+
+> boolean uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash)
+
+Upload Artifact
+
+Upload an artifact zip file for a specific build task.  This endpoint allows foxfactory workers to upload an artifact zip file, verifies its MD5 hash, and stores it in the appropriate directory.  Parameters:     task_id: The ID of the build task     artifact: The artifact zip file to upload     md5_hash: The expected MD5 hash of the artifact file
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FoxFactoryApi,
+} from '@orangefox-recovery/foxinternalclient';
+import type { UploadArtifactFactoryTaskIdArtifactPostRequest } from '@orangefox-recovery/foxinternalclient';
+
+async function example() {
+  console.log("🚀 Testing @orangefox-recovery/foxinternalclient SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2_password password
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FoxFactoryApi(config);
+
+  const body = {
+    // string
+    taskId: taskId_example,
+    // Blob
+    artifact: BINARY_DATA_HERE,
+    // string
+    md5Hash: md5Hash_example,
+  } satisfies UploadArtifactFactoryTaskIdArtifactPostRequest;
+
+  try {
+    const data = await api.uploadArtifactFactoryTaskIdArtifactPost(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | `string` |  | [Defaults to `undefined`] |
+| **artifact** | `Blob` |  | [Defaults to `undefined`] |
+| **md5Hash** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+[oauth2_password password](../README.md#oauth2_password-password), [bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **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)
+