@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/api.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).
|
|
@@ -38,6 +38,7 @@ exports.BuildStatusEnum = {
|
|
|
38
38
|
Pending: 'pending',
|
|
39
39
|
Running: 'running',
|
|
40
40
|
Cancelling: 'cancelling',
|
|
41
|
+
Uploading: 'uploading',
|
|
41
42
|
Success: 'success',
|
|
42
43
|
Cancelled: 'cancelled',
|
|
43
44
|
Failed: 'failed'
|
|
@@ -490,7 +491,7 @@ const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
490
491
|
};
|
|
491
492
|
}),
|
|
492
493
|
/**
|
|
493
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
494
|
+
* 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.
|
|
494
495
|
* @summary Delete Task
|
|
495
496
|
* @param {string} taskId
|
|
496
497
|
* @param {*} [options] Override http request option.
|
|
@@ -519,7 +520,36 @@ const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
519
520
|
};
|
|
520
521
|
}),
|
|
521
522
|
/**
|
|
522
|
-
*
|
|
523
|
+
* 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
|
|
524
|
+
* @summary Download Artifact
|
|
525
|
+
* @param {string} taskId
|
|
526
|
+
* @param {*} [options] Override http request option.
|
|
527
|
+
* @throws {RequiredError}
|
|
528
|
+
*/
|
|
529
|
+
downloadArtifactFactoryTaskIdArtifactGet: (taskId_1, ...args_1) => __awaiter(this, [taskId_1, ...args_1], void 0, function* (taskId, options = {}) {
|
|
530
|
+
// verify required parameter 'taskId' is not null or undefined
|
|
531
|
+
(0, common_1.assertParamExists)('downloadArtifactFactoryTaskIdArtifactGet', 'taskId', taskId);
|
|
532
|
+
const localVarPath = `/factory/{task_id}/artifact`
|
|
533
|
+
.replace(`{${"task_id"}}`, encodeURIComponent(String(taskId)));
|
|
534
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
535
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
536
|
+
let baseOptions;
|
|
537
|
+
if (configuration) {
|
|
538
|
+
baseOptions = configuration.baseOptions;
|
|
539
|
+
}
|
|
540
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
541
|
+
const localVarHeaderParameter = {};
|
|
542
|
+
const localVarQueryParameter = {};
|
|
543
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
544
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
545
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
546
|
+
return {
|
|
547
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
548
|
+
options: localVarRequestOptions,
|
|
549
|
+
};
|
|
550
|
+
}),
|
|
551
|
+
/**
|
|
552
|
+
* 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.
|
|
523
553
|
* @summary Factory Status
|
|
524
554
|
* @param {*} [options] Override http request option.
|
|
525
555
|
* @throws {RequiredError}
|
|
@@ -665,6 +695,80 @@ const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
665
695
|
options: localVarRequestOptions,
|
|
666
696
|
};
|
|
667
697
|
}),
|
|
698
|
+
/**
|
|
699
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
700
|
+
* @summary Update Worker Status
|
|
701
|
+
* @param {string} body
|
|
702
|
+
* @param {*} [options] Override http request option.
|
|
703
|
+
* @throws {RequiredError}
|
|
704
|
+
*/
|
|
705
|
+
updateWorkerStatusFactoryUpdateStatusPost: (body_1, ...args_1) => __awaiter(this, [body_1, ...args_1], void 0, function* (body, options = {}) {
|
|
706
|
+
// verify required parameter 'body' is not null or undefined
|
|
707
|
+
(0, common_1.assertParamExists)('updateWorkerStatusFactoryUpdateStatusPost', 'body', body);
|
|
708
|
+
const localVarPath = `/factory/update_status`;
|
|
709
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
710
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
711
|
+
let baseOptions;
|
|
712
|
+
if (configuration) {
|
|
713
|
+
baseOptions = configuration.baseOptions;
|
|
714
|
+
}
|
|
715
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
716
|
+
const localVarHeaderParameter = {};
|
|
717
|
+
const localVarQueryParameter = {};
|
|
718
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
719
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
720
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
721
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
722
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
723
|
+
return {
|
|
724
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
725
|
+
options: localVarRequestOptions,
|
|
726
|
+
};
|
|
727
|
+
}),
|
|
728
|
+
/**
|
|
729
|
+
* 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
|
|
730
|
+
* @summary Upload Artifact
|
|
731
|
+
* @param {string} taskId
|
|
732
|
+
* @param {File} artifact
|
|
733
|
+
* @param {string} md5Hash
|
|
734
|
+
* @param {*} [options] Override http request option.
|
|
735
|
+
* @throws {RequiredError}
|
|
736
|
+
*/
|
|
737
|
+
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 = {}) {
|
|
738
|
+
// verify required parameter 'taskId' is not null or undefined
|
|
739
|
+
(0, common_1.assertParamExists)('uploadArtifactFactoryTaskIdArtifactPost', 'taskId', taskId);
|
|
740
|
+
// verify required parameter 'artifact' is not null or undefined
|
|
741
|
+
(0, common_1.assertParamExists)('uploadArtifactFactoryTaskIdArtifactPost', 'artifact', artifact);
|
|
742
|
+
// verify required parameter 'md5Hash' is not null or undefined
|
|
743
|
+
(0, common_1.assertParamExists)('uploadArtifactFactoryTaskIdArtifactPost', 'md5Hash', md5Hash);
|
|
744
|
+
const localVarPath = `/factory/{task_id}/artifact`
|
|
745
|
+
.replace(`{${"task_id"}}`, encodeURIComponent(String(taskId)));
|
|
746
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
747
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
748
|
+
let baseOptions;
|
|
749
|
+
if (configuration) {
|
|
750
|
+
baseOptions = configuration.baseOptions;
|
|
751
|
+
}
|
|
752
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
753
|
+
const localVarHeaderParameter = {};
|
|
754
|
+
const localVarQueryParameter = {};
|
|
755
|
+
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
756
|
+
if (artifact !== undefined) {
|
|
757
|
+
localVarFormParams.append('artifact', artifact);
|
|
758
|
+
}
|
|
759
|
+
if (md5Hash !== undefined) {
|
|
760
|
+
localVarFormParams.append('md5_hash', md5Hash);
|
|
761
|
+
}
|
|
762
|
+
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
763
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
764
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
765
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
766
|
+
localVarRequestOptions.data = localVarFormParams;
|
|
767
|
+
return {
|
|
768
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
769
|
+
options: localVarRequestOptions,
|
|
770
|
+
};
|
|
771
|
+
}),
|
|
668
772
|
};
|
|
669
773
|
};
|
|
670
774
|
exports.FoxFactoryApiAxiosParamCreator = FoxFactoryApiAxiosParamCreator;
|
|
@@ -692,7 +796,7 @@ const FoxFactoryApiFp = function (configuration) {
|
|
|
692
796
|
});
|
|
693
797
|
},
|
|
694
798
|
/**
|
|
695
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
799
|
+
* 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.
|
|
696
800
|
* @summary Delete Task
|
|
697
801
|
* @param {string} taskId
|
|
698
802
|
* @param {*} [options] Override http request option.
|
|
@@ -708,7 +812,23 @@ const FoxFactoryApiFp = function (configuration) {
|
|
|
708
812
|
});
|
|
709
813
|
},
|
|
710
814
|
/**
|
|
711
|
-
*
|
|
815
|
+
* 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
|
|
816
|
+
* @summary Download Artifact
|
|
817
|
+
* @param {string} taskId
|
|
818
|
+
* @param {*} [options] Override http request option.
|
|
819
|
+
* @throws {RequiredError}
|
|
820
|
+
*/
|
|
821
|
+
downloadArtifactFactoryTaskIdArtifactGet(taskId, options) {
|
|
822
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
823
|
+
var _a, _b, _c;
|
|
824
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadArtifactFactoryTaskIdArtifactGet(taskId, options);
|
|
825
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
826
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FoxFactoryApi.downloadArtifactFactoryTaskIdArtifactGet']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
827
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
828
|
+
});
|
|
829
|
+
},
|
|
830
|
+
/**
|
|
831
|
+
* 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.
|
|
712
832
|
* @summary Factory Status
|
|
713
833
|
* @param {*} [options] Override http request option.
|
|
714
834
|
* @throws {RequiredError}
|
|
@@ -787,6 +907,40 @@ const FoxFactoryApiFp = function (configuration) {
|
|
|
787
907
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
788
908
|
});
|
|
789
909
|
},
|
|
910
|
+
/**
|
|
911
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
912
|
+
* @summary Update Worker Status
|
|
913
|
+
* @param {string} body
|
|
914
|
+
* @param {*} [options] Override http request option.
|
|
915
|
+
* @throws {RequiredError}
|
|
916
|
+
*/
|
|
917
|
+
updateWorkerStatusFactoryUpdateStatusPost(body, options) {
|
|
918
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
919
|
+
var _a, _b, _c;
|
|
920
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateWorkerStatusFactoryUpdateStatusPost(body, options);
|
|
921
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
922
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FoxFactoryApi.updateWorkerStatusFactoryUpdateStatusPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
923
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
924
|
+
});
|
|
925
|
+
},
|
|
926
|
+
/**
|
|
927
|
+
* 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
|
|
928
|
+
* @summary Upload Artifact
|
|
929
|
+
* @param {string} taskId
|
|
930
|
+
* @param {File} artifact
|
|
931
|
+
* @param {string} md5Hash
|
|
932
|
+
* @param {*} [options] Override http request option.
|
|
933
|
+
* @throws {RequiredError}
|
|
934
|
+
*/
|
|
935
|
+
uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options) {
|
|
936
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
937
|
+
var _a, _b, _c;
|
|
938
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options);
|
|
939
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
940
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FoxFactoryApi.uploadArtifactFactoryTaskIdArtifactPost']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
941
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
942
|
+
});
|
|
943
|
+
},
|
|
790
944
|
};
|
|
791
945
|
};
|
|
792
946
|
exports.FoxFactoryApiFp = FoxFactoryApiFp;
|
|
@@ -808,7 +962,7 @@ const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
808
962
|
return localVarFp.cancelTaskFactoryTaskIdCancelPost(taskId, options).then((request) => request(axios, basePath));
|
|
809
963
|
},
|
|
810
964
|
/**
|
|
811
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
965
|
+
* 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.
|
|
812
966
|
* @summary Delete Task
|
|
813
967
|
* @param {string} taskId
|
|
814
968
|
* @param {*} [options] Override http request option.
|
|
@@ -818,7 +972,17 @@ const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
818
972
|
return localVarFp.deleteTaskFactoryTaskIdDelete(taskId, options).then((request) => request(axios, basePath));
|
|
819
973
|
},
|
|
820
974
|
/**
|
|
821
|
-
*
|
|
975
|
+
* 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
|
|
976
|
+
* @summary Download Artifact
|
|
977
|
+
* @param {string} taskId
|
|
978
|
+
* @param {*} [options] Override http request option.
|
|
979
|
+
* @throws {RequiredError}
|
|
980
|
+
*/
|
|
981
|
+
downloadArtifactFactoryTaskIdArtifactGet(taskId, options) {
|
|
982
|
+
return localVarFp.downloadArtifactFactoryTaskIdArtifactGet(taskId, options).then((request) => request(axios, basePath));
|
|
983
|
+
},
|
|
984
|
+
/**
|
|
985
|
+
* 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.
|
|
822
986
|
* @summary Factory Status
|
|
823
987
|
* @param {*} [options] Override http request option.
|
|
824
988
|
* @throws {RequiredError}
|
|
@@ -867,6 +1031,28 @@ const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
867
1031
|
updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options) {
|
|
868
1032
|
return localVarFp.updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options).then((request) => request(axios, basePath));
|
|
869
1033
|
},
|
|
1034
|
+
/**
|
|
1035
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
1036
|
+
* @summary Update Worker Status
|
|
1037
|
+
* @param {string} body
|
|
1038
|
+
* @param {*} [options] Override http request option.
|
|
1039
|
+
* @throws {RequiredError}
|
|
1040
|
+
*/
|
|
1041
|
+
updateWorkerStatusFactoryUpdateStatusPost(body, options) {
|
|
1042
|
+
return localVarFp.updateWorkerStatusFactoryUpdateStatusPost(body, options).then((request) => request(axios, basePath));
|
|
1043
|
+
},
|
|
1044
|
+
/**
|
|
1045
|
+
* 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
|
|
1046
|
+
* @summary Upload Artifact
|
|
1047
|
+
* @param {string} taskId
|
|
1048
|
+
* @param {File} artifact
|
|
1049
|
+
* @param {string} md5Hash
|
|
1050
|
+
* @param {*} [options] Override http request option.
|
|
1051
|
+
* @throws {RequiredError}
|
|
1052
|
+
*/
|
|
1053
|
+
uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options) {
|
|
1054
|
+
return localVarFp.uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options).then((request) => request(axios, basePath));
|
|
1055
|
+
},
|
|
870
1056
|
};
|
|
871
1057
|
};
|
|
872
1058
|
exports.FoxFactoryApiFactory = FoxFactoryApiFactory;
|
|
@@ -889,7 +1075,7 @@ class FoxFactoryApi extends base_1.BaseAPI {
|
|
|
889
1075
|
return (0, exports.FoxFactoryApiFp)(this.configuration).cancelTaskFactoryTaskIdCancelPost(taskId, options).then((request) => request(this.axios, this.basePath));
|
|
890
1076
|
}
|
|
891
1077
|
/**
|
|
892
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
1078
|
+
* 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.
|
|
893
1079
|
* @summary Delete Task
|
|
894
1080
|
* @param {string} taskId
|
|
895
1081
|
* @param {*} [options] Override http request option.
|
|
@@ -900,7 +1086,18 @@ class FoxFactoryApi extends base_1.BaseAPI {
|
|
|
900
1086
|
return (0, exports.FoxFactoryApiFp)(this.configuration).deleteTaskFactoryTaskIdDelete(taskId, options).then((request) => request(this.axios, this.basePath));
|
|
901
1087
|
}
|
|
902
1088
|
/**
|
|
903
|
-
*
|
|
1089
|
+
* 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
|
|
1090
|
+
* @summary Download Artifact
|
|
1091
|
+
* @param {string} taskId
|
|
1092
|
+
* @param {*} [options] Override http request option.
|
|
1093
|
+
* @throws {RequiredError}
|
|
1094
|
+
* @memberof FoxFactoryApi
|
|
1095
|
+
*/
|
|
1096
|
+
downloadArtifactFactoryTaskIdArtifactGet(taskId, options) {
|
|
1097
|
+
return (0, exports.FoxFactoryApiFp)(this.configuration).downloadArtifactFactoryTaskIdArtifactGet(taskId, options).then((request) => request(this.axios, this.basePath));
|
|
1098
|
+
}
|
|
1099
|
+
/**
|
|
1100
|
+
* 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.
|
|
904
1101
|
* @summary Factory Status
|
|
905
1102
|
* @param {*} [options] Override http request option.
|
|
906
1103
|
* @throws {RequiredError}
|
|
@@ -954,6 +1151,30 @@ class FoxFactoryApi extends base_1.BaseAPI {
|
|
|
954
1151
|
updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options) {
|
|
955
1152
|
return (0, exports.FoxFactoryApiFp)(this.configuration).updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options).then((request) => request(this.axios, this.basePath));
|
|
956
1153
|
}
|
|
1154
|
+
/**
|
|
1155
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
1156
|
+
* @summary Update Worker Status
|
|
1157
|
+
* @param {string} body
|
|
1158
|
+
* @param {*} [options] Override http request option.
|
|
1159
|
+
* @throws {RequiredError}
|
|
1160
|
+
* @memberof FoxFactoryApi
|
|
1161
|
+
*/
|
|
1162
|
+
updateWorkerStatusFactoryUpdateStatusPost(body, options) {
|
|
1163
|
+
return (0, exports.FoxFactoryApiFp)(this.configuration).updateWorkerStatusFactoryUpdateStatusPost(body, options).then((request) => request(this.axios, this.basePath));
|
|
1164
|
+
}
|
|
1165
|
+
/**
|
|
1166
|
+
* 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
|
|
1167
|
+
* @summary Upload Artifact
|
|
1168
|
+
* @param {string} taskId
|
|
1169
|
+
* @param {File} artifact
|
|
1170
|
+
* @param {string} md5Hash
|
|
1171
|
+
* @param {*} [options] Override http request option.
|
|
1172
|
+
* @throws {RequiredError}
|
|
1173
|
+
* @memberof FoxFactoryApi
|
|
1174
|
+
*/
|
|
1175
|
+
uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options) {
|
|
1176
|
+
return (0, exports.FoxFactoryApiFp)(this.configuration).uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options).then((request) => request(this.axios, this.basePath));
|
|
1177
|
+
}
|
|
957
1178
|
}
|
|
958
1179
|
exports.FoxFactoryApi = FoxFactoryApi;
|
|
959
1180
|
/**
|
package/dist/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/base.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/dist/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/common.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/dist/configuration.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/configuration.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).
|