@orangefox-recovery/foxinternalclient 5.3.2 → 5.4.0

package/dist/apis/FoxFactoryApi.d.ts

@@ -2,7 +2,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.3.2
+ * The version of the OpenAPI document: 5.4.0
  * Contact: admin@orangefox.tech
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,7 +38,7 @@ export interface UpdateWorkerStatusFactoryUpdateStatusPostRequest {
 }
 export interface UploadArtifactFactoryTaskIdArtifactPostRequest {
     taskId: string;
-    artifact: Blob;
+    artifact: string;
     md5Hash: string;
 }
 /**
@@ -48,6 +48,13 @@ export interface UploadArtifactFactoryTaskIdArtifactPostRequest {
  * @interface FoxFactoryApiInterface
  */
 export interface FoxFactoryApiInterface {
+    /**
+     * Creates request options for cancelTaskFactoryTaskIdCancelPost without sending the request
+     * @param {string} taskId
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    cancelTaskFactoryTaskIdCancelPostRequestOpts(requestParameters: CancelTaskFactoryTaskIdCancelPostRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -62,6 +69,13 @@ export interface FoxFactoryApiInterface {
      * Cancel Task
      */
     cancelTaskFactoryTaskIdCancelPost(requestParameters: CancelTaskFactoryTaskIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuildTaskResponse>;
+    /**
+     * Creates request options for deleteTaskFactoryTaskIdDelete without sending the request
+     * @param {string} taskId
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    deleteTaskFactoryTaskIdDeleteRequestOpts(requestParameters: DeleteTaskFactoryTaskIdDeleteRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -76,6 +90,13 @@ export interface FoxFactoryApiInterface {
      * Delete Task
      */
     deleteTaskFactoryTaskIdDelete(requestParameters: DeleteTaskFactoryTaskIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Creates request options for downloadArtifactFactoryTaskIdArtifactGet without sending the request
+     * @param {string} taskId
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    downloadArtifactFactoryTaskIdArtifactGetRequestOpts(requestParameters: DownloadArtifactFactoryTaskIdArtifactGetRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -90,6 +111,12 @@ export interface FoxFactoryApiInterface {
      * Download Artifact
      */
     downloadArtifactFactoryTaskIdArtifactGet(requestParameters: DownloadArtifactFactoryTaskIdArtifactGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * Creates request options for factoryStatusFactoryStatusGet without sending the request
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    factoryStatusFactoryStatusGetRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -103,6 +130,13 @@ export interface FoxFactoryApiInterface {
      * Factory Status
      */
     factoryStatusFactoryStatusGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FFStatusResponse>;
+    /**
+     * Creates request options for getTaskFactoryTaskIdGet without sending the request
+     * @param {string} taskId
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    getTaskFactoryTaskIdGetRequestOpts(requestParameters: GetTaskFactoryTaskIdGetRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -117,6 +151,13 @@ export interface FoxFactoryApiInterface {
      * Get Task
      */
     getTaskFactoryTaskIdGet(requestParameters: GetTaskFactoryTaskIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuildTaskResponse>;
+    /**
+     * Creates request options for listTasksFactoryGet without sending the request
+     * @param {string} [deviceId]
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    listTasksFactoryGetRequestOpts(requestParameters: ListTasksFactoryGetRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -131,6 +172,13 @@ export interface FoxFactoryApiInterface {
      * List Tasks
      */
     listTasksFactoryGet(requestParameters: ListTasksFactoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseBuildTaskShortResponse>;
+    /**
+     * Creates request options for newTaskFactoryPost without sending the request
+     * @param {NewBuildTaskBody} newBuildTaskBody
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    newTaskFactoryPostRequestOpts(requestParameters: NewTaskFactoryPostRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -145,6 +193,14 @@ export interface FoxFactoryApiInterface {
      * New Task
      */
     newTaskFactoryPost(requestParameters: NewTaskFactoryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Creates request options for updateTaskFactoryTaskIdPatch without sending the request
+     * @param {string} taskId
+     * @param {TaskUpdateBody} taskUpdateBody
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    updateTaskFactoryTaskIdPatchRequestOpts(requestParameters: UpdateTaskFactoryTaskIdPatchRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -160,6 +216,13 @@ export interface FoxFactoryApiInterface {
      * Update Task
      */
     updateTaskFactoryTaskIdPatch(requestParameters: UpdateTaskFactoryTaskIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Creates request options for updateWorkerStatusFactoryUpdateStatusPost without sending the request
+     * @param {string} body
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    updateWorkerStatusFactoryUpdateStatusPostRequestOpts(requestParameters: UpdateWorkerStatusFactoryUpdateStatusPostRequest): Promise<runtime.RequestOpts>;
     /**
      * Endpoint for FoxFactory worker to update its status.
      * @summary Update Worker Status
@@ -174,11 +237,20 @@ export interface FoxFactoryApiInterface {
      * Update Worker Status
      */
     updateWorkerStatusFactoryUpdateStatusPost(requestParameters: UpdateWorkerStatusFactoryUpdateStatusPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * Creates request options for uploadArtifactFactoryTaskIdArtifactPost without sending the request
+     * @param {string} taskId
+     * @param {string} artifact
+     * @param {string} md5Hash
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    uploadArtifactFactoryTaskIdArtifactPostRequestOpts(requestParameters: UploadArtifactFactoryTaskIdArtifactPostRequest): Promise<runtime.RequestOpts>;
     /**
      * 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} artifact
      * @param {string} md5Hash
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -195,6 +267,10 @@ export interface FoxFactoryApiInterface {
  *
  */
 export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactoryApiInterface {
+    /**
+     * Creates request options for cancelTaskFactoryTaskIdCancelPost without sending the request
+     */
+    cancelTaskFactoryTaskIdCancelPostRequestOpts(requestParameters: CancelTaskFactoryTaskIdCancelPostRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -205,6 +281,10 @@ export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactory
      * Cancel Task
      */
     cancelTaskFactoryTaskIdCancelPost(requestParameters: CancelTaskFactoryTaskIdCancelPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuildTaskResponse>;
+    /**
+     * Creates request options for deleteTaskFactoryTaskIdDelete without sending the request
+     */
+    deleteTaskFactoryTaskIdDeleteRequestOpts(requestParameters: DeleteTaskFactoryTaskIdDeleteRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -215,6 +295,10 @@ export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactory
      * Delete Task
      */
     deleteTaskFactoryTaskIdDelete(requestParameters: DeleteTaskFactoryTaskIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Creates request options for downloadArtifactFactoryTaskIdArtifactGet without sending the request
+     */
+    downloadArtifactFactoryTaskIdArtifactGetRequestOpts(requestParameters: DownloadArtifactFactoryTaskIdArtifactGetRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -225,6 +309,10 @@ export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactory
      * Download Artifact
      */
     downloadArtifactFactoryTaskIdArtifactGet(requestParameters: DownloadArtifactFactoryTaskIdArtifactGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * Creates request options for factoryStatusFactoryStatusGet without sending the request
+     */
+    factoryStatusFactoryStatusGetRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -235,6 +323,10 @@ export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactory
      * Factory Status
      */
     factoryStatusFactoryStatusGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FFStatusResponse>;
+    /**
+     * Creates request options for getTaskFactoryTaskIdGet without sending the request
+     */
+    getTaskFactoryTaskIdGetRequestOpts(requestParameters: GetTaskFactoryTaskIdGetRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -245,6 +337,10 @@ export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactory
      * Get Task
      */
     getTaskFactoryTaskIdGet(requestParameters: GetTaskFactoryTaskIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BuildTaskResponse>;
+    /**
+     * Creates request options for listTasksFactoryGet without sending the request
+     */
+    listTasksFactoryGetRequestOpts(requestParameters: ListTasksFactoryGetRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -255,6 +351,10 @@ export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactory
      * List Tasks
      */
     listTasksFactoryGet(requestParameters?: ListTasksFactoryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseBuildTaskShortResponse>;
+    /**
+     * Creates request options for newTaskFactoryPost without sending the request
+     */
+    newTaskFactoryPostRequestOpts(requestParameters: NewTaskFactoryPostRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -265,6 +365,10 @@ export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactory
      * New Task
      */
     newTaskFactoryPost(requestParameters: NewTaskFactoryPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Creates request options for updateTaskFactoryTaskIdPatch without sending the request
+     */
+    updateTaskFactoryTaskIdPatchRequestOpts(requestParameters: UpdateTaskFactoryTaskIdPatchRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -275,6 +379,10 @@ export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactory
      * Update Task
      */
     updateTaskFactoryTaskIdPatch(requestParameters: UpdateTaskFactoryTaskIdPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Creates request options for updateWorkerStatusFactoryUpdateStatusPost without sending the request
+     */
+    updateWorkerStatusFactoryUpdateStatusPostRequestOpts(requestParameters: UpdateWorkerStatusFactoryUpdateStatusPostRequest): Promise<runtime.RequestOpts>;
     /**
      * Endpoint for FoxFactory worker to update its status.
      * Update Worker Status
@@ -285,6 +393,10 @@ export declare class FoxFactoryApi extends runtime.BaseAPI implements FoxFactory
      * Update Worker Status
      */
     updateWorkerStatusFactoryUpdateStatusPost(requestParameters: UpdateWorkerStatusFactoryUpdateStatusPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
+    /**
+     * Creates request options for uploadArtifactFactoryTaskIdArtifactPost without sending the request
+     */
+    uploadArtifactFactoryTaskIdArtifactPostRequestOpts(requestParameters: UploadArtifactFactoryTaskIdArtifactPostRequest): Promise<runtime.RequestOpts>;
     /**
      * 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