@orangefox-recovery/foxinternalclient 5.2.5 → 5.2.7

package/docs/FoxFactoryApi.md

@@ -1,540 +0,0 @@
-# FoxFactoryApi
-
-All URIs are relative to *https://api.orangefox.download*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**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()
-
-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
-
-```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.cancelTaskFactoryTaskIdCancelPost(
-    taskId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **taskId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**BuildTaskResponse**
-
-### Authorization
-
-No authorization required
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **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. Also deletes any associated artifact files.
-
-### 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.deleteTaskFactoryTaskIdDelete(
-    taskId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **taskId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**boolean**
-
-### Authorization
-
-No authorization required
-
-### 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#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 |
-|-------------|-------------|------------------|
-|**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)
-
-# **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
-
-```typescript
-import {
-    FoxFactoryApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new FoxFactoryApi(configuration);
-
-const { status, data } = await apiInstance.factoryStatusFactoryStatusGet();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**FFStatusResponse**
-
-### Authorization
-
-No authorization required
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **getTaskFactoryTaskIdGet**
-> BuildTaskResponse getTaskFactoryTaskIdGet()
-
-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
-
-```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.getTaskFactoryTaskIdGet(
-    taskId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **taskId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**BuildTaskResponse**
-
-### Authorization
-
-No authorization required
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **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
-
-### Example
-
-```typescript
-import {
-    FoxFactoryApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new FoxFactoryApi(configuration);
-
-let deviceId: string; // (optional) (default to undefined)
-
-const { status, data } = await apiInstance.listTasksFactoryGet(
-    deviceId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **deviceId** | [**string**] |  | (optional) defaults to undefined|
-
-
-### Return type
-
-**ListResponseBuildTaskShortResponse**
-
-### Authorization
-
-No authorization required
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **newTaskFactoryPost**
-> boolean newTaskFactoryPost(newBuildTaskBody)
-
-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
-
-```typescript
-import {
-    FoxFactoryApi,
-    Configuration,
-    NewBuildTaskBody
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new FoxFactoryApi(configuration);
-
-let newBuildTaskBody: NewBuildTaskBody; //
-
-const { status, data } = await apiInstance.newTaskFactoryPost(
-    newBuildTaskBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **newBuildTaskBody** | **NewBuildTaskBody**|  | |
-
-
-### Return type
-
-**boolean**
-
-### 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)
-
-# **updateTaskFactoryTaskIdPatch**
-> boolean updateTaskFactoryTaskIdPatch(taskUpdateBody)
-
-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
-
-```typescript
-import {
-    FoxFactoryApi,
-    Configuration,
-    TaskUpdateBody
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new FoxFactoryApi(configuration);
-
-let taskId: string; // (default to undefined)
-let taskUpdateBody: TaskUpdateBody; //
-
-const { status, data } = await apiInstance.updateTaskFactoryTaskIdPatch(
-    taskId,
-    taskUpdateBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **taskUpdateBody** | **TaskUpdateBody**|  | |
-| **taskId** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**boolean**
-
-### 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)
-
-# **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/GitlabApi.md

@@ -1,62 +0,0 @@
-# GitlabApi
-
-All URIs are relative to *https://api.orangefox.download*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost**](#deviceaddgitlabrepogitlabdevicedeviceidgitlabpost) | **POST** /gitlab/device/{device_id}/gitlab | Device Add Gitlab Repo|
-
-# **deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost**
-> boolean deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost()
-
-
-### Example
-
-```typescript
-import {
-    GitlabApi,
-    Configuration
-} from '@orangefox-recovery/foxinternalclient';
-
-const configuration = new Configuration();
-const apiInstance = new GitlabApi(configuration);
-
-let deviceId: string; // (default to undefined)
-let glProjectUrl: string; // (default to undefined)
-
-const { status, data } = await apiInstance.deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost(
-    deviceId,
-    glProjectUrl
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **deviceId** | [**string**] |  | defaults to undefined|
-| **glProjectUrl** | [**string**] |  | defaults to undefined|
-
-
-### Return type
-
-**boolean**
-
-### Authorization
-
-No authorization required
-
-### 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#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/GlobalStatsAggregationModel.md

@@ -1,26 +0,0 @@
-# GlobalStatsAggregationModel
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**count** | **number** |  | [default to undefined]
-**deviceCount** | **number** |  | [default to undefined]
-**releaseCount** | **number** |  | [default to undefined]
-**days** | **{ [key: string]: number; }** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { GlobalStatsAggregationModel } from '@orangefox-recovery/foxinternalclient';
-
-const instance: GlobalStatsAggregationModel = {
-    count,
-    deviceCount,
-    releaseCount,
-    days,
-};
-```
-
-[[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/docs/HTTPValidationError.md

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