@orangefox-recovery/foxinternalclient 5.2.3 → 5.2.5

package/dist/esm/api.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.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).
@@ -41,6 +41,7 @@ export declare const BuildStatusEnum: {
     readonly Pending: "pending";
     readonly Running: "running";
     readonly Cancelling: "cancelling";
+    readonly Uploading: "uploading";
     readonly Success: "success";
     readonly Cancelled: "cancelled";
     readonly Failed: "failed";
@@ -66,10 +67,10 @@ export interface BuildTaskResponse {
     'started_by_id': string;
     /**
      *
-     * @type {string}
+     * @type {ShortDeviceResponse}
      * @memberof BuildTaskResponse
      */
-    'device_id': string;
+    'device': ShortDeviceResponse;
     /**
      *
      * @type {BuildStatusEnum}
@@ -78,12 +79,22 @@ export interface BuildTaskResponse {
     'status': BuildStatusEnum;
     /**
      *
-     * @type {{ [key: string]: any; }}
+     * @type {string}
      * @memberof BuildTaskResponse
      */
-    'info': {
-        [key: string]: any;
-    };
+    'version'?: string;
+    /**
+     *
+     * @type {ReleaseType}
+     * @memberof BuildTaskResponse
+     */
+    'type'?: ReleaseType;
+    /**
+     *
+     * @type {string}
+     * @memberof BuildTaskResponse
+     */
+    'variant'?: string;
     /**
      *
      * @type {string}
@@ -96,6 +107,12 @@ export interface BuildTaskResponse {
      * @memberof BuildTaskResponse
      */
     'finished_at'?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BuildTaskResponse
+     */
+    'has_artifact': boolean;
     /**
      *
      * @type {{ [key: string]: any; }}
@@ -131,10 +148,10 @@ export interface BuildTaskShortResponse {
     'started_by_id': string;
     /**
      *
-     * @type {string}
+     * @type {ShortDeviceResponse}
      * @memberof BuildTaskShortResponse
      */
-    'device_id': string;
+    'device': ShortDeviceResponse;
     /**
      *
      * @type {BuildStatusEnum}
@@ -143,12 +160,22 @@ export interface BuildTaskShortResponse {
     'status': BuildStatusEnum;
     /**
      *
-     * @type {{ [key: string]: any; }}
+     * @type {string}
      * @memberof BuildTaskShortResponse
      */
-    'info': {
-        [key: string]: any;
-    };
+    'version'?: string;
+    /**
+     *
+     * @type {ReleaseType}
+     * @memberof BuildTaskShortResponse
+     */
+    'type'?: ReleaseType;
+    /**
+     *
+     * @type {string}
+     * @memberof BuildTaskShortResponse
+     */
+    'variant'?: string;
     /**
      *
      * @type {string}
@@ -161,6 +188,12 @@ export interface BuildTaskShortResponse {
      * @memberof BuildTaskShortResponse
      */
     'finished_at'?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BuildTaskShortResponse
+     */
+    'has_artifact': boolean;
 }
 /**
  *
@@ -492,6 +525,25 @@ export interface HTTPValidationError {
      */
     'detail'?: Array<ValidationError>;
 }
+/**
+ *
+ * @export
+ * @interface ListResponseBuildTaskShortResponse
+ */
+export interface ListResponseBuildTaskShortResponse {
+    /**
+     *
+     * @type {Array<BuildTaskShortResponse>}
+     * @memberof ListResponseBuildTaskShortResponse
+     */
+    'data': Array<BuildTaskShortResponse>;
+    /**
+     *
+     * @type {number}
+     * @memberof ListResponseBuildTaskShortResponse
+     */
+    'count': number;
+}
 /**
  *
  * @export
@@ -1870,7 +1922,7 @@ export declare const FoxFactoryApiAxiosParamCreator: (configuration?: Configurat
      */
     cancelTaskFactoryTaskIdCancelPost: (taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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.
      * @summary Delete Task
      * @param {string} taskId
      * @param {*} [options] Override http request option.
@@ -1878,7 +1930,15 @@ export declare const FoxFactoryApiAxiosParamCreator: (configuration?: Configurat
      */
     deleteTaskFactoryTaskIdDelete: (taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * 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}
+     */
+    downloadArtifactFactoryTaskIdArtifactGet: (taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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}
@@ -1917,6 +1977,24 @@ export declare const FoxFactoryApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     updateTaskFactoryTaskIdPatch: (taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Endpoint for FoxFactory worker to update its status.
+     * @summary Update Worker Status
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkerStatusFactoryUpdateStatusPost: (body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 {File} artifact
+     * @param {string} md5Hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadArtifactFactoryTaskIdArtifactPost: (taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * FoxFactoryApi - functional programming interface
@@ -1932,7 +2010,7 @@ export declare const FoxFactoryApiFp: (configuration?: Configuration) => {
      */
     cancelTaskFactoryTaskIdCancelPost(taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildTaskResponse>>;
     /**
-     * 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.
      * @summary Delete Task
      * @param {string} taskId
      * @param {*} [options] Override http request option.
@@ -1940,7 +2018,15 @@ export declare const FoxFactoryApiFp: (configuration?: Configuration) => {
      */
     deleteTaskFactoryTaskIdDelete(taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<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}
+     */
+    downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<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}
@@ -1961,7 +2047,7 @@ export declare const FoxFactoryApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BuildTaskShortResponse>>>;
+    listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<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
@@ -1979,6 +2065,24 @@ export declare const FoxFactoryApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
+    /**
+     * Endpoint for FoxFactory worker to update its status.
+     * @summary Update Worker Status
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<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 {File} artifact
+     * @param {string} md5Hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
 };
 /**
  * FoxFactoryApi - factory interface
@@ -1994,7 +2098,7 @@ export declare const FoxFactoryApiFactory: (configuration?: Configuration, baseP
      */
     cancelTaskFactoryTaskIdCancelPost(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildTaskResponse>;
     /**
-     * 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.
      * @summary Delete Task
      * @param {string} taskId
      * @param {*} [options] Override http request option.
@@ -2002,7 +2106,15 @@ export declare const FoxFactoryApiFactory: (configuration?: Configuration, baseP
      */
     deleteTaskFactoryTaskIdDelete(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<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}
+     */
+    downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<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}
@@ -2023,7 +2135,7 @@ export declare const FoxFactoryApiFactory: (configuration?: Configuration, baseP
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<BuildTaskShortResponse>>;
+    listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<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
@@ -2041,6 +2153,24 @@ export declare const FoxFactoryApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
+    /**
+     * Endpoint for FoxFactory worker to update its status.
+     * @summary Update Worker Status
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<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 {File} artifact
+     * @param {string} md5Hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
 };
 /**
  * FoxFactoryApi - interface
@@ -2058,7 +2188,7 @@ export interface FoxFactoryApiInterface {
      */
     cancelTaskFactoryTaskIdCancelPost(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildTaskResponse>;
     /**
-     * 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.
      * @summary Delete Task
      * @param {string} taskId
      * @param {*} [options] Override http request option.
@@ -2067,7 +2197,16 @@ export interface FoxFactoryApiInterface {
      */
     deleteTaskFactoryTaskIdDelete(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<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
+     */
+    downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<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}
@@ -2091,7 +2230,7 @@ export interface FoxFactoryApiInterface {
      * @throws {RequiredError}
      * @memberof FoxFactoryApiInterface
      */
-    listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<BuildTaskShortResponse>>;
+    listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<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
@@ -2111,6 +2250,26 @@ export interface FoxFactoryApiInterface {
      * @memberof FoxFactoryApiInterface
      */
     updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<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
+     */
+    updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<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 {File} artifact
+     * @param {string} md5Hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApiInterface
+     */
+    uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
 }
 /**
  * FoxFactoryApi - object-oriented interface
@@ -2129,7 +2288,7 @@ export declare class FoxFactoryApi extends BaseAPI implements FoxFactoryApiInter
      */
     cancelTaskFactoryTaskIdCancelPost(taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BuildTaskResponse, any>>;
     /**
-     * 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.
      * @summary Delete Task
      * @param {string} taskId
      * @param {*} [options] Override http request option.
@@ -2138,7 +2297,16 @@ export declare class FoxFactoryApi extends BaseAPI implements FoxFactoryApiInter
      */
     deleteTaskFactoryTaskIdDelete(taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, 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
+     * @summary Download Artifact
+     * @param {string} taskId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApi
+     */
+    downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, 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}
@@ -2162,7 +2330,7 @@ export declare class FoxFactoryApi extends BaseAPI implements FoxFactoryApiInter
      * @throws {RequiredError}
      * @memberof FoxFactoryApi
      */
-    listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BuildTaskShortResponse[], any>>;
+    listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseBuildTaskShortResponse, any>>;
     /**
      * 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
@@ -2182,6 +2350,26 @@ export declare class FoxFactoryApi extends BaseAPI implements FoxFactoryApiInter
      * @memberof FoxFactoryApi
      */
     updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
+    /**
+     * Endpoint for FoxFactory worker to update its status.
+     * @summary Update Worker Status
+     * @param {string} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApi
+     */
+    updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, 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 {File} artifact
+     * @param {string} md5Hash
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FoxFactoryApi
+     */
+    uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
 }
 /**
  * GitlabApi - axios parameter creator