@orangefox-recovery/foxinternalclient 5.2.3 → 5.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/README.md +6 -2
- package/api.ts +343 -22
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +215 -27
- package/dist/api.js +230 -9
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +215 -27
- package/dist/esm/api.js +230 -9
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/BuildStatusEnum.md +2 -0
- package/docs/BuildTaskResponse.md +10 -4
- package/docs/BuildTaskShortResponse.md +10 -4
- package/docs/FoxFactoryApi.md +169 -3
- package/docs/ListResponseBuildTaskShortResponse.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.5
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -35,6 +35,7 @@ export const BuildStatusEnum = {
|
|
|
35
35
|
Pending: 'pending',
|
|
36
36
|
Running: 'running',
|
|
37
37
|
Cancelling: 'cancelling',
|
|
38
|
+
Uploading: 'uploading',
|
|
38
39
|
Success: 'success',
|
|
39
40
|
Cancelled: 'cancelled',
|
|
40
41
|
Failed: 'failed'
|
|
@@ -483,7 +484,7 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
483
484
|
};
|
|
484
485
|
}),
|
|
485
486
|
/**
|
|
486
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
487
|
+
* 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.
|
|
487
488
|
* @summary Delete Task
|
|
488
489
|
* @param {string} taskId
|
|
489
490
|
* @param {*} [options] Override http request option.
|
|
@@ -512,7 +513,36 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
512
513
|
};
|
|
513
514
|
}),
|
|
514
515
|
/**
|
|
515
|
-
*
|
|
516
|
+
* 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
|
|
517
|
+
* @summary Download Artifact
|
|
518
|
+
* @param {string} taskId
|
|
519
|
+
* @param {*} [options] Override http request option.
|
|
520
|
+
* @throws {RequiredError}
|
|
521
|
+
*/
|
|
522
|
+
downloadArtifactFactoryTaskIdArtifactGet: (taskId_1, ...args_1) => __awaiter(this, [taskId_1, ...args_1], void 0, function* (taskId, options = {}) {
|
|
523
|
+
// verify required parameter 'taskId' is not null or undefined
|
|
524
|
+
assertParamExists('downloadArtifactFactoryTaskIdArtifactGet', 'taskId', taskId);
|
|
525
|
+
const localVarPath = `/factory/{task_id}/artifact`
|
|
526
|
+
.replace(`{${"task_id"}}`, encodeURIComponent(String(taskId)));
|
|
527
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
528
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
529
|
+
let baseOptions;
|
|
530
|
+
if (configuration) {
|
|
531
|
+
baseOptions = configuration.baseOptions;
|
|
532
|
+
}
|
|
533
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
534
|
+
const localVarHeaderParameter = {};
|
|
535
|
+
const localVarQueryParameter = {};
|
|
536
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
537
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
538
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
539
|
+
return {
|
|
540
|
+
url: toPathString(localVarUrlObj),
|
|
541
|
+
options: localVarRequestOptions,
|
|
542
|
+
};
|
|
543
|
+
}),
|
|
544
|
+
/**
|
|
545
|
+
* 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.
|
|
516
546
|
* @summary Factory Status
|
|
517
547
|
* @param {*} [options] Override http request option.
|
|
518
548
|
* @throws {RequiredError}
|
|
@@ -658,6 +688,80 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
658
688
|
options: localVarRequestOptions,
|
|
659
689
|
};
|
|
660
690
|
}),
|
|
691
|
+
/**
|
|
692
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
693
|
+
* @summary Update Worker Status
|
|
694
|
+
* @param {string} body
|
|
695
|
+
* @param {*} [options] Override http request option.
|
|
696
|
+
* @throws {RequiredError}
|
|
697
|
+
*/
|
|
698
|
+
updateWorkerStatusFactoryUpdateStatusPost: (body_1, ...args_1) => __awaiter(this, [body_1, ...args_1], void 0, function* (body, options = {}) {
|
|
699
|
+
// verify required parameter 'body' is not null or undefined
|
|
700
|
+
assertParamExists('updateWorkerStatusFactoryUpdateStatusPost', 'body', body);
|
|
701
|
+
const localVarPath = `/factory/update_status`;
|
|
702
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
703
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
704
|
+
let baseOptions;
|
|
705
|
+
if (configuration) {
|
|
706
|
+
baseOptions = configuration.baseOptions;
|
|
707
|
+
}
|
|
708
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
709
|
+
const localVarHeaderParameter = {};
|
|
710
|
+
const localVarQueryParameter = {};
|
|
711
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
712
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
713
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
714
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
715
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
716
|
+
return {
|
|
717
|
+
url: toPathString(localVarUrlObj),
|
|
718
|
+
options: localVarRequestOptions,
|
|
719
|
+
};
|
|
720
|
+
}),
|
|
721
|
+
/**
|
|
722
|
+
* 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
|
|
723
|
+
* @summary Upload Artifact
|
|
724
|
+
* @param {string} taskId
|
|
725
|
+
* @param {File} artifact
|
|
726
|
+
* @param {string} md5Hash
|
|
727
|
+
* @param {*} [options] Override http request option.
|
|
728
|
+
* @throws {RequiredError}
|
|
729
|
+
*/
|
|
730
|
+
uploadArtifactFactoryTaskIdArtifactPost: (taskId_1, artifact_1, md5Hash_1, ...args_1) => __awaiter(this, [taskId_1, artifact_1, md5Hash_1, ...args_1], void 0, function* (taskId, artifact, md5Hash, options = {}) {
|
|
731
|
+
// verify required parameter 'taskId' is not null or undefined
|
|
732
|
+
assertParamExists('uploadArtifactFactoryTaskIdArtifactPost', 'taskId', taskId);
|
|
733
|
+
// verify required parameter 'artifact' is not null or undefined
|
|
734
|
+
assertParamExists('uploadArtifactFactoryTaskIdArtifactPost', 'artifact', artifact);
|
|
735
|
+
// verify required parameter 'md5Hash' is not null or undefined
|
|
736
|
+
assertParamExists('uploadArtifactFactoryTaskIdArtifactPost', 'md5Hash', md5Hash);
|
|
737
|
+
const localVarPath = `/factory/{task_id}/artifact`
|
|
738
|
+
.replace(`{${"task_id"}}`, encodeURIComponent(String(taskId)));
|
|
739
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
740
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
741
|
+
let baseOptions;
|
|
742
|
+
if (configuration) {
|
|
743
|
+
baseOptions = configuration.baseOptions;
|
|
744
|
+
}
|
|
745
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
746
|
+
const localVarHeaderParameter = {};
|
|
747
|
+
const localVarQueryParameter = {};
|
|
748
|
+
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
749
|
+
if (artifact !== undefined) {
|
|
750
|
+
localVarFormParams.append('artifact', artifact);
|
|
751
|
+
}
|
|
752
|
+
if (md5Hash !== undefined) {
|
|
753
|
+
localVarFormParams.append('md5_hash', md5Hash);
|
|
754
|
+
}
|
|
755
|
+
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
756
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
757
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
758
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
759
|
+
localVarRequestOptions.data = localVarFormParams;
|
|
760
|
+
return {
|
|
761
|
+
url: toPathString(localVarUrlObj),
|
|
762
|
+
options: localVarRequestOptions,
|
|
763
|
+
};
|
|
764
|
+
}),
|
|
661
765
|
};
|
|
662
766
|
};
|
|
663
767
|
/**
|
|
@@ -684,7 +788,7 @@ export const FoxFactoryApiFp = function (configuration) {
|
|
|
684
788
|
});
|
|
685
789
|
},
|
|
686
790
|
/**
|
|
687
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
791
|
+
* 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.
|
|
688
792
|
* @summary Delete Task
|
|
689
793
|
* @param {string} taskId
|
|
690
794
|
* @param {*} [options] Override http request option.
|
|
@@ -700,7 +804,23 @@ export const FoxFactoryApiFp = function (configuration) {
|
|
|
700
804
|
});
|
|
701
805
|
},
|
|
702
806
|
/**
|
|
703
|
-
*
|
|
807
|
+
* 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
|
|
808
|
+
* @summary Download Artifact
|
|
809
|
+
* @param {string} taskId
|
|
810
|
+
* @param {*} [options] Override http request option.
|
|
811
|
+
* @throws {RequiredError}
|
|
812
|
+
*/
|
|
813
|
+
downloadArtifactFactoryTaskIdArtifactGet(taskId, options) {
|
|
814
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
815
|
+
var _a, _b, _c;
|
|
816
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadArtifactFactoryTaskIdArtifactGet(taskId, options);
|
|
817
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
818
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FoxFactoryApi.downloadArtifactFactoryTaskIdArtifactGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
819
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
820
|
+
});
|
|
821
|
+
},
|
|
822
|
+
/**
|
|
823
|
+
* 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.
|
|
704
824
|
* @summary Factory Status
|
|
705
825
|
* @param {*} [options] Override http request option.
|
|
706
826
|
* @throws {RequiredError}
|
|
@@ -779,6 +899,40 @@ export const FoxFactoryApiFp = function (configuration) {
|
|
|
779
899
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
780
900
|
});
|
|
781
901
|
},
|
|
902
|
+
/**
|
|
903
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
904
|
+
* @summary Update Worker Status
|
|
905
|
+
* @param {string} body
|
|
906
|
+
* @param {*} [options] Override http request option.
|
|
907
|
+
* @throws {RequiredError}
|
|
908
|
+
*/
|
|
909
|
+
updateWorkerStatusFactoryUpdateStatusPost(body, options) {
|
|
910
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
911
|
+
var _a, _b, _c;
|
|
912
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateWorkerStatusFactoryUpdateStatusPost(body, options);
|
|
913
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
914
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FoxFactoryApi.updateWorkerStatusFactoryUpdateStatusPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
915
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
916
|
+
});
|
|
917
|
+
},
|
|
918
|
+
/**
|
|
919
|
+
* 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
|
|
920
|
+
* @summary Upload Artifact
|
|
921
|
+
* @param {string} taskId
|
|
922
|
+
* @param {File} artifact
|
|
923
|
+
* @param {string} md5Hash
|
|
924
|
+
* @param {*} [options] Override http request option.
|
|
925
|
+
* @throws {RequiredError}
|
|
926
|
+
*/
|
|
927
|
+
uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options) {
|
|
928
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
929
|
+
var _a, _b, _c;
|
|
930
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options);
|
|
931
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
932
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['FoxFactoryApi.uploadArtifactFactoryTaskIdArtifactPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
933
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
934
|
+
});
|
|
935
|
+
},
|
|
782
936
|
};
|
|
783
937
|
};
|
|
784
938
|
/**
|
|
@@ -799,7 +953,7 @@ export const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
799
953
|
return localVarFp.cancelTaskFactoryTaskIdCancelPost(taskId, options).then((request) => request(axios, basePath));
|
|
800
954
|
},
|
|
801
955
|
/**
|
|
802
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
956
|
+
* 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.
|
|
803
957
|
* @summary Delete Task
|
|
804
958
|
* @param {string} taskId
|
|
805
959
|
* @param {*} [options] Override http request option.
|
|
@@ -809,7 +963,17 @@ export const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
809
963
|
return localVarFp.deleteTaskFactoryTaskIdDelete(taskId, options).then((request) => request(axios, basePath));
|
|
810
964
|
},
|
|
811
965
|
/**
|
|
812
|
-
*
|
|
966
|
+
* 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
|
|
967
|
+
* @summary Download Artifact
|
|
968
|
+
* @param {string} taskId
|
|
969
|
+
* @param {*} [options] Override http request option.
|
|
970
|
+
* @throws {RequiredError}
|
|
971
|
+
*/
|
|
972
|
+
downloadArtifactFactoryTaskIdArtifactGet(taskId, options) {
|
|
973
|
+
return localVarFp.downloadArtifactFactoryTaskIdArtifactGet(taskId, options).then((request) => request(axios, basePath));
|
|
974
|
+
},
|
|
975
|
+
/**
|
|
976
|
+
* 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.
|
|
813
977
|
* @summary Factory Status
|
|
814
978
|
* @param {*} [options] Override http request option.
|
|
815
979
|
* @throws {RequiredError}
|
|
@@ -858,6 +1022,28 @@ export const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
858
1022
|
updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options) {
|
|
859
1023
|
return localVarFp.updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options).then((request) => request(axios, basePath));
|
|
860
1024
|
},
|
|
1025
|
+
/**
|
|
1026
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
1027
|
+
* @summary Update Worker Status
|
|
1028
|
+
* @param {string} body
|
|
1029
|
+
* @param {*} [options] Override http request option.
|
|
1030
|
+
* @throws {RequiredError}
|
|
1031
|
+
*/
|
|
1032
|
+
updateWorkerStatusFactoryUpdateStatusPost(body, options) {
|
|
1033
|
+
return localVarFp.updateWorkerStatusFactoryUpdateStatusPost(body, options).then((request) => request(axios, basePath));
|
|
1034
|
+
},
|
|
1035
|
+
/**
|
|
1036
|
+
* 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
|
|
1037
|
+
* @summary Upload Artifact
|
|
1038
|
+
* @param {string} taskId
|
|
1039
|
+
* @param {File} artifact
|
|
1040
|
+
* @param {string} md5Hash
|
|
1041
|
+
* @param {*} [options] Override http request option.
|
|
1042
|
+
* @throws {RequiredError}
|
|
1043
|
+
*/
|
|
1044
|
+
uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options) {
|
|
1045
|
+
return localVarFp.uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options).then((request) => request(axios, basePath));
|
|
1046
|
+
},
|
|
861
1047
|
};
|
|
862
1048
|
};
|
|
863
1049
|
/**
|
|
@@ -879,7 +1065,7 @@ export class FoxFactoryApi extends BaseAPI {
|
|
|
879
1065
|
return FoxFactoryApiFp(this.configuration).cancelTaskFactoryTaskIdCancelPost(taskId, options).then((request) => request(this.axios, this.basePath));
|
|
880
1066
|
}
|
|
881
1067
|
/**
|
|
882
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
1068
|
+
* 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.
|
|
883
1069
|
* @summary Delete Task
|
|
884
1070
|
* @param {string} taskId
|
|
885
1071
|
* @param {*} [options] Override http request option.
|
|
@@ -890,7 +1076,18 @@ export class FoxFactoryApi extends BaseAPI {
|
|
|
890
1076
|
return FoxFactoryApiFp(this.configuration).deleteTaskFactoryTaskIdDelete(taskId, options).then((request) => request(this.axios, this.basePath));
|
|
891
1077
|
}
|
|
892
1078
|
/**
|
|
893
|
-
*
|
|
1079
|
+
* 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
|
|
1080
|
+
* @summary Download Artifact
|
|
1081
|
+
* @param {string} taskId
|
|
1082
|
+
* @param {*} [options] Override http request option.
|
|
1083
|
+
* @throws {RequiredError}
|
|
1084
|
+
* @memberof FoxFactoryApi
|
|
1085
|
+
*/
|
|
1086
|
+
downloadArtifactFactoryTaskIdArtifactGet(taskId, options) {
|
|
1087
|
+
return FoxFactoryApiFp(this.configuration).downloadArtifactFactoryTaskIdArtifactGet(taskId, options).then((request) => request(this.axios, this.basePath));
|
|
1088
|
+
}
|
|
1089
|
+
/**
|
|
1090
|
+
* 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.
|
|
894
1091
|
* @summary Factory Status
|
|
895
1092
|
* @param {*} [options] Override http request option.
|
|
896
1093
|
* @throws {RequiredError}
|
|
@@ -944,6 +1141,30 @@ export class FoxFactoryApi extends BaseAPI {
|
|
|
944
1141
|
updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options) {
|
|
945
1142
|
return FoxFactoryApiFp(this.configuration).updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options).then((request) => request(this.axios, this.basePath));
|
|
946
1143
|
}
|
|
1144
|
+
/**
|
|
1145
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
1146
|
+
* @summary Update Worker Status
|
|
1147
|
+
* @param {string} body
|
|
1148
|
+
* @param {*} [options] Override http request option.
|
|
1149
|
+
* @throws {RequiredError}
|
|
1150
|
+
* @memberof FoxFactoryApi
|
|
1151
|
+
*/
|
|
1152
|
+
updateWorkerStatusFactoryUpdateStatusPost(body, options) {
|
|
1153
|
+
return FoxFactoryApiFp(this.configuration).updateWorkerStatusFactoryUpdateStatusPost(body, options).then((request) => request(this.axios, this.basePath));
|
|
1154
|
+
}
|
|
1155
|
+
/**
|
|
1156
|
+
* 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
|
|
1157
|
+
* @summary Upload Artifact
|
|
1158
|
+
* @param {string} taskId
|
|
1159
|
+
* @param {File} artifact
|
|
1160
|
+
* @param {string} md5Hash
|
|
1161
|
+
* @param {*} [options] Override http request option.
|
|
1162
|
+
* @throws {RequiredError}
|
|
1163
|
+
* @memberof FoxFactoryApi
|
|
1164
|
+
*/
|
|
1165
|
+
uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options) {
|
|
1166
|
+
return FoxFactoryApiFp(this.configuration).uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options).then((request) => request(this.axios, this.basePath));
|
|
1167
|
+
}
|
|
947
1168
|
}
|
|
948
1169
|
/**
|
|
949
1170
|
* GitlabApi - axios parameter creator
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.5
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.5
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.5
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.5
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.5
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.5
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.5
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.5
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.5
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Fox API
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.2.
|
|
8
|
+
* The version of the OpenAPI document: 5.2.5
|
|
9
9
|
* Contact: admin@orangefox.tech
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/BuildStatusEnum.md
CHANGED
|
@@ -7,11 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**started_by_id** | **string** | | [default to undefined]
|
|
10
|
-
**
|
|
10
|
+
**device** | [**ShortDeviceResponse**](ShortDeviceResponse.md) | | [default to undefined]
|
|
11
11
|
**status** | [**BuildStatusEnum**](BuildStatusEnum.md) | | [default to undefined]
|
|
12
|
-
**
|
|
12
|
+
**version** | **string** | | [optional] [default to 'R12']
|
|
13
|
+
**type** | [**ReleaseType**](ReleaseType.md) | | [optional] [default to undefined]
|
|
14
|
+
**variant** | **string** | | [optional] [default to 'default']
|
|
13
15
|
**started_at** | **string** | | [default to undefined]
|
|
14
16
|
**finished_at** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**has_artifact** | **boolean** | | [default to undefined]
|
|
15
18
|
**environment** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
16
19
|
**logs** | **Array<string>** | | [optional] [default to undefined]
|
|
17
20
|
|
|
@@ -23,11 +26,14 @@ import { BuildTaskResponse } from '@orangefox-recovery/foxinternalclient';
|
|
|
23
26
|
const instance: BuildTaskResponse = {
|
|
24
27
|
id,
|
|
25
28
|
started_by_id,
|
|
26
|
-
|
|
29
|
+
device,
|
|
27
30
|
status,
|
|
28
|
-
|
|
31
|
+
version,
|
|
32
|
+
type,
|
|
33
|
+
variant,
|
|
29
34
|
started_at,
|
|
30
35
|
finished_at,
|
|
36
|
+
has_artifact,
|
|
31
37
|
environment,
|
|
32
38
|
logs,
|
|
33
39
|
};
|
|
@@ -7,11 +7,14 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | | [default to undefined]
|
|
9
9
|
**started_by_id** | **string** | | [default to undefined]
|
|
10
|
-
**
|
|
10
|
+
**device** | [**ShortDeviceResponse**](ShortDeviceResponse.md) | | [default to undefined]
|
|
11
11
|
**status** | [**BuildStatusEnum**](BuildStatusEnum.md) | | [default to undefined]
|
|
12
|
-
**
|
|
12
|
+
**version** | **string** | | [optional] [default to 'R12']
|
|
13
|
+
**type** | [**ReleaseType**](ReleaseType.md) | | [optional] [default to undefined]
|
|
14
|
+
**variant** | **string** | | [optional] [default to 'default']
|
|
13
15
|
**started_at** | **string** | | [default to undefined]
|
|
14
16
|
**finished_at** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**has_artifact** | **boolean** | | [default to undefined]
|
|
15
18
|
|
|
16
19
|
## Example
|
|
17
20
|
|
|
@@ -21,11 +24,14 @@ import { BuildTaskShortResponse } from '@orangefox-recovery/foxinternalclient';
|
|
|
21
24
|
const instance: BuildTaskShortResponse = {
|
|
22
25
|
id,
|
|
23
26
|
started_by_id,
|
|
24
|
-
|
|
27
|
+
device,
|
|
25
28
|
status,
|
|
26
|
-
|
|
29
|
+
version,
|
|
30
|
+
type,
|
|
31
|
+
variant,
|
|
27
32
|
started_at,
|
|
28
33
|
finished_at,
|
|
34
|
+
has_artifact,
|
|
29
35
|
};
|
|
30
36
|
```
|
|
31
37
|
|