@orangefox-recovery/foxinternalclient 5.2.5 → 5.2.7

package/dist/esm/apis/FoxFactoryApi.d.ts

@@ -0,0 +1,298 @@
+/**
+ * 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.7
+ * Contact: admin@orangefox.tech
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { BuildTaskResponse, FFStatusResponse, ListResponseBuildTaskShortResponse, NewBuildTaskBody, TaskUpdateBody } from '../models/index';
+export interface CancelTaskFactoryTaskIdCancelPostRequest {
+    taskId: string;
+}
+export interface DeleteTaskFactoryTaskIdDeleteRequest {
+    taskId: string;
+}
+export interface DownloadArtifactFactoryTaskIdArtifactGetRequest {
+    taskId: string;
+}
+export interface GetTaskFactoryTaskIdGetRequest {
+    taskId: string;
+}
+export interface ListTasksFactoryGetRequest {
+    deviceId?: string | null;
+}
+export interface NewTaskFactoryPostRequest {
+    newBuildTaskBody: NewBuildTaskBody;
+}
+export interface UpdateTaskFactoryTaskIdPatchRequest {
+    taskId: string;
+    taskUpdateBody: TaskUpdateBody;
+}
+export interface UpdateWorkerStatusFactoryUpdateStatusPostRequest {
+    body: string;
+}
+export interface UploadArtifactFactoryTaskIdArtifactPostRequest {
+    taskId: string;
+    artifact: Blob;
+    md5Hash: string;
+}
+/**
+ * FoxFactoryApi - interface
+ *
+ * @export
+ * @interface FoxFactoryApiInterface
+ */
+export interface FoxFactoryApiInterface {
+    /**
+     * 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.
+     * @summary Cancel Task
+     * @param {string} taskId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    cancelTaskFactoryTaskIdCancelPostRaw(requestParameters: CancelTaskFactoryTaskIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuildTaskResponse>>;
+    /**
+     * 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.
+     * Cancel Task
+     */
+    cancelTaskFactoryTaskIdCancelPost(requestParameters: CancelTaskFactoryTaskIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuildTaskResponse>;
+    /**
+     * 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.
+     * @summary Delete Task
+     * @param {string} taskId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    deleteTaskFactoryTaskIdDeleteRaw(requestParameters: DeleteTaskFactoryTaskIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * 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.
+     * Delete Task
+     */
+    deleteTaskFactoryTaskIdDelete(requestParameters: DeleteTaskFactoryTaskIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * 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
+     * @summary Download Artifact
+     * @param {string} taskId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    downloadArtifactFactoryTaskIdArtifactGetRaw(requestParameters: DownloadArtifactFactoryTaskIdArtifactGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
+    /**
+     * 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
+     * Download Artifact
+     */
+    downloadArtifactFactoryTaskIdArtifactGet(requestParameters: DownloadArtifactFactoryTaskIdArtifactGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * 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.
+     * @summary Factory Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    factoryStatusFactoryStatusGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FFStatusResponse>>;
+    /**
+     * 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.
+     * Factory Status
+     */
+    factoryStatusFactoryStatusGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FFStatusResponse>;
+    /**
+     * 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.
+     * @summary Get Task
+     * @param {string} taskId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    getTaskFactoryTaskIdGetRaw(requestParameters: GetTaskFactoryTaskIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuildTaskResponse>>;
+    /**
+     * 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.
+     * Get Task
+     */
+    getTaskFactoryTaskIdGet(requestParameters: GetTaskFactoryTaskIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuildTaskResponse>;
+    /**
+     * 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
+     * @summary List Tasks
+     * @param {string} [deviceId]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    listTasksFactoryGetRaw(requestParameters: ListTasksFactoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseBuildTaskShortResponse>>;
+    /**
+     * 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
+     * List Tasks
+     */
+    listTasksFactoryGet(requestParameters: ListTasksFactoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseBuildTaskShortResponse>;
+    /**
+     * 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.
+     * @summary New Task
+     * @param {NewBuildTaskBody} newBuildTaskBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    newTaskFactoryPostRaw(requestParameters: NewTaskFactoryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * 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.
+     * New Task
+     */
+    newTaskFactoryPost(requestParameters: NewTaskFactoryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * 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.
+     * @summary Update Task
+     * @param {string} taskId
+     * @param {TaskUpdateBody} taskUpdateBody
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    updateTaskFactoryTaskIdPatchRaw(requestParameters: UpdateTaskFactoryTaskIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * 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.
+     * Update Task
+     */
+    updateTaskFactoryTaskIdPatch(requestParameters: UpdateTaskFactoryTaskIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Endpoint for FoxFactory worker to update its status.
+     * @summary Update Worker Status
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    updateWorkerStatusFactoryUpdateStatusPostRaw(requestParameters: UpdateWorkerStatusFactoryUpdateStatusPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
+    /**
+     * Endpoint for FoxFactory worker to update its status.
+     * Update Worker Status
+     */
+    updateWorkerStatusFactoryUpdateStatusPost(requestParameters: UpdateWorkerStatusFactoryUpdateStatusPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * 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
+     * @summary Upload Artifact
+     * @param {string} taskId
+     * @param {Blob} artifact
+     * @param {string} md5Hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    uploadArtifactFactoryTaskIdArtifactPostRaw(requestParameters: UploadArtifactFactoryTaskIdArtifactPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * 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
+     * Upload Artifact
+     */
+    uploadArtifactFactoryTaskIdArtifactPost(requestParameters: UploadArtifactFactoryTaskIdArtifactPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+}
+/**
+ *
+ */
+export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactoryApiInterface {
+    /**
+     * 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.
+     * Cancel Task
+     */
+    cancelTaskFactoryTaskIdCancelPostRaw(requestParameters: CancelTaskFactoryTaskIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuildTaskResponse>>;
+    /**
+     * 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.
+     * Cancel Task
+     */
+    cancelTaskFactoryTaskIdCancelPost(requestParameters: CancelTaskFactoryTaskIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuildTaskResponse>;
+    /**
+     * 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.
+     * Delete Task
+     */
+    deleteTaskFactoryTaskIdDeleteRaw(requestParameters: DeleteTaskFactoryTaskIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * 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.
+     * Delete Task
+     */
+    deleteTaskFactoryTaskIdDelete(requestParameters: DeleteTaskFactoryTaskIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * 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
+     * Download Artifact
+     */
+    downloadArtifactFactoryTaskIdArtifactGetRaw(requestParameters: DownloadArtifactFactoryTaskIdArtifactGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
+    /**
+     * 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
+     * Download Artifact
+     */
+    downloadArtifactFactoryTaskIdArtifactGet(requestParameters: DownloadArtifactFactoryTaskIdArtifactGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * 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.
+     * Factory Status
+     */
+    factoryStatusFactoryStatusGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FFStatusResponse>>;
+    /**
+     * 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.
+     * Factory Status
+     */
+    factoryStatusFactoryStatusGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FFStatusResponse>;
+    /**
+     * 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.
+     * Get Task
+     */
+    getTaskFactoryTaskIdGetRaw(requestParameters: GetTaskFactoryTaskIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BuildTaskResponse>>;
+    /**
+     * 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.
+     * Get Task
+     */
+    getTaskFactoryTaskIdGet(requestParameters: GetTaskFactoryTaskIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuildTaskResponse>;
+    /**
+     * 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
+     * List Tasks
+     */
+    listTasksFactoryGetRaw(requestParameters: ListTasksFactoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseBuildTaskShortResponse>>;
+    /**
+     * 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
+     * List Tasks
+     */
+    listTasksFactoryGet(requestParameters?: ListTasksFactoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseBuildTaskShortResponse>;
+    /**
+     * 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.
+     * New Task
+     */
+    newTaskFactoryPostRaw(requestParameters: NewTaskFactoryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * 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.
+     * New Task
+     */
+    newTaskFactoryPost(requestParameters: NewTaskFactoryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * 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.
+     * Update Task
+     */
+    updateTaskFactoryTaskIdPatchRaw(requestParameters: UpdateTaskFactoryTaskIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * 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.
+     * Update Task
+     */
+    updateTaskFactoryTaskIdPatch(requestParameters: UpdateTaskFactoryTaskIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Endpoint for FoxFactory worker to update its status.
+     * Update Worker Status
+     */
+    updateWorkerStatusFactoryUpdateStatusPostRaw(requestParameters: UpdateWorkerStatusFactoryUpdateStatusPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
+    /**
+     * Endpoint for FoxFactory worker to update its status.
+     * Update Worker Status
+     */
+    updateWorkerStatusFactoryUpdateStatusPost(requestParameters: UpdateWorkerStatusFactoryUpdateStatusPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * 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
+     * Upload Artifact
+     */
+    uploadArtifactFactoryTaskIdArtifactPostRaw(requestParameters: UploadArtifactFactoryTaskIdArtifactPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * 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
+     * Upload Artifact
+     */
+    uploadArtifactFactoryTaskIdArtifactPost(requestParameters: UploadArtifactFactoryTaskIdArtifactPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+}