@orangefox-recovery/foxinternalclient 5.2.3 → 5.2.5

package/docs/FoxFactoryApi.md

@@ -6,11 +6,14 @@ All URIs are relative to *https://api.orangefox.download*
 |------------- | ------------- | -------------|
 |[**cancelTaskFactoryTaskIdCancelPost**](#canceltaskfactorytaskidcancelpost) | **POST** /factory/{task_id}/cancel | Cancel Task|
 |[**deleteTaskFactoryTaskIdDelete**](#deletetaskfactorytaskiddelete) | **DELETE** /factory/{task_id} | Delete Task|
+|[**downloadArtifactFactoryTaskIdArtifactGet**](#downloadartifactfactorytaskidartifactget) | **GET** /factory/{task_id}/artifact | Download Artifact|
 |[**factoryStatusFactoryStatusGet**](#factorystatusfactorystatusget) | **GET** /factory/status | Factory Status|
 |[**getTaskFactoryTaskIdGet**](#gettaskfactorytaskidget) | **GET** /factory/{task_id} | Get Task|
 |[**listTasksFactoryGet**](#listtasksfactoryget) | **GET** /factory/ | List Tasks|
 |[**newTaskFactoryPost**](#newtaskfactorypost) | **POST** /factory/ | New Task|
 |[**updateTaskFactoryTaskIdPatch**](#updatetaskfactorytaskidpatch) | **PATCH** /factory/{task_id} | Update Task|
+|[**updateWorkerStatusFactoryUpdateStatusPost**](#updateworkerstatusfactoryupdatestatuspost) | **POST** /factory/update_status | Update Worker Status|
+|[**uploadArtifactFactoryTaskIdArtifactPost**](#uploadartifactfactorytaskidartifactpost) | **POST** /factory/{task_id}/artifact | Upload Artifact|
 
 # **cancelTaskFactoryTaskIdCancelPost**
 > BuildTaskResponse cancelTaskFactoryTaskIdCancelPost()
@@ -67,7 +70,7 @@ No authorization required
 # **deleteTaskFactoryTaskIdDelete**
 > boolean deleteTaskFactoryTaskIdDelete()
 
-Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
+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
 
@@ -108,6 +111,58 @@ No authorization required
  - **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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **downloadArtifactFactoryTaskIdArtifactGet**
+> any downloadArtifactFactoryTaskIdArtifactGet()
+
+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
+
+```typescript
+import {
+    FoxFactoryApi,
+    Configuration
+} from '@orangefox-recovery/foxinternalclient';
+
+const configuration = new Configuration();
+const apiInstance = new FoxFactoryApi(configuration);
+
+let taskId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.downloadArtifactFactoryTaskIdArtifactGet(
+    taskId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -119,6 +174,7 @@ No authorization required
 # **factoryStatusFactoryStatusGet**
 > FFStatusResponse factoryStatusFactoryStatusGet()
 
+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
 
@@ -212,7 +268,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **listTasksFactoryGet**
-> Array<BuildTaskShortResponse> listTasksFactoryGet()
+> ListResponseBuildTaskShortResponse listTasksFactoryGet()
 
 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
 
@@ -243,7 +299,7 @@ const { status, data } = await apiInstance.listTasksFactoryGet(
 
 ### Return type
 
-**Array<BuildTaskShortResponse>**
+**ListResponseBuildTaskShortResponse**
 
 ### Authorization
 
@@ -372,3 +428,113 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **updateWorkerStatusFactoryUpdateStatusPost**
+> any updateWorkerStatusFactoryUpdateStatusPost(body)
+
+Endpoint for FoxFactory worker to update its status.
+
+### Example
+
+```typescript
+import {
+    FoxFactoryApi,
+    Configuration
+} from '@orangefox-recovery/foxinternalclient';
+
+const configuration = new Configuration();
+const apiInstance = new FoxFactoryApi(configuration);
+
+let body: string; //
+
+const { status, data } = await apiInstance.updateWorkerStatusFactoryUpdateStatusPost(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+No authorization required
+
+### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **uploadArtifactFactoryTaskIdArtifactPost**
+> boolean uploadArtifactFactoryTaskIdArtifactPost()
+
+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
+
+```typescript
+import {
+    FoxFactoryApi,
+    Configuration
+} from '@orangefox-recovery/foxinternalclient';
+
+const configuration = new Configuration();
+const apiInstance = new FoxFactoryApi(configuration);
+
+let taskId: string; // (default to undefined)
+let artifact: File; // (default to undefined)
+let md5Hash: string; // (default to undefined)
+
+const { status, data } = await apiInstance.uploadArtifactFactoryTaskIdArtifactPost(
+    taskId,
+    artifact,
+    md5Hash
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] |  | defaults to undefined|
+| **artifact** | [**File**] |  | defaults to undefined|
+| **md5Hash** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+No authorization required
+
+### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/ListResponseBuildTaskShortResponse.md

@@ -0,0 +1,22 @@
+# ListResponseBuildTaskShortResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<BuildTaskShortResponse>**](BuildTaskShortResponse.md) |  | [default to undefined]
+**count** | **number** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { ListResponseBuildTaskShortResponse } from '@orangefox-recovery/foxinternalclient';
+
+const instance: ListResponseBuildTaskShortResponse = {
+    data,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orangefox-recovery/foxinternalclient",
-  "version": "5.2.3",
+  "version": "5.2.5",
   "description": "OpenAPI client for @orangefox-recovery/foxinternalclient",
   "author": "OpenAPI-Generator Contributors",
   "repository": {