@orangefox-recovery/foxinternalclient 5.2.4 → 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/README.md +5 -2
- package/api.ts +321 -19
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +192 -23
- 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 +192 -23
- 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 +167 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @orangefox-recovery/foxinternalclient@5.2.
|
|
1
|
+
## @orangefox-recovery/foxinternalclient@5.2.5
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @orangefox-recovery/foxinternalclient@5.2.
|
|
39
|
+
npm install @orangefox-recovery/foxinternalclient@5.2.5 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -57,11 +57,14 @@ Class | Method | HTTP request | Description
|
|
|
57
57
|
*DeviceApi* | [**getOems**](docs/DeviceApi.md#getoems) | **GET** /oems/ | Get Oems
|
|
58
58
|
*FoxFactoryApi* | [**cancelTaskFactoryTaskIdCancelPost**](docs/FoxFactoryApi.md#canceltaskfactorytaskidcancelpost) | **POST** /factory/{task_id}/cancel | Cancel Task
|
|
59
59
|
*FoxFactoryApi* | [**deleteTaskFactoryTaskIdDelete**](docs/FoxFactoryApi.md#deletetaskfactorytaskiddelete) | **DELETE** /factory/{task_id} | Delete Task
|
|
60
|
+
*FoxFactoryApi* | [**downloadArtifactFactoryTaskIdArtifactGet**](docs/FoxFactoryApi.md#downloadartifactfactorytaskidartifactget) | **GET** /factory/{task_id}/artifact | Download Artifact
|
|
60
61
|
*FoxFactoryApi* | [**factoryStatusFactoryStatusGet**](docs/FoxFactoryApi.md#factorystatusfactorystatusget) | **GET** /factory/status | Factory Status
|
|
61
62
|
*FoxFactoryApi* | [**getTaskFactoryTaskIdGet**](docs/FoxFactoryApi.md#gettaskfactorytaskidget) | **GET** /factory/{task_id} | Get Task
|
|
62
63
|
*FoxFactoryApi* | [**listTasksFactoryGet**](docs/FoxFactoryApi.md#listtasksfactoryget) | **GET** /factory/ | List Tasks
|
|
63
64
|
*FoxFactoryApi* | [**newTaskFactoryPost**](docs/FoxFactoryApi.md#newtaskfactorypost) | **POST** /factory/ | New Task
|
|
64
65
|
*FoxFactoryApi* | [**updateTaskFactoryTaskIdPatch**](docs/FoxFactoryApi.md#updatetaskfactorytaskidpatch) | **PATCH** /factory/{task_id} | Update Task
|
|
66
|
+
*FoxFactoryApi* | [**updateWorkerStatusFactoryUpdateStatusPost**](docs/FoxFactoryApi.md#updateworkerstatusfactoryupdatestatuspost) | **POST** /factory/update_status | Update Worker Status
|
|
67
|
+
*FoxFactoryApi* | [**uploadArtifactFactoryTaskIdArtifactPost**](docs/FoxFactoryApi.md#uploadartifactfactorytaskidartifactpost) | **POST** /factory/{task_id}/artifact | Upload Artifact
|
|
65
68
|
*GitlabApi* | [**deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost**](docs/GitlabApi.md#deviceaddgitlabrepogitlabdevicedeviceidgitlabpost) | **POST** /gitlab/device/{device_id}/gitlab | Device Add Gitlab Repo
|
|
66
69
|
*InternalApi* | [**changePasswordProfileChangePasswordPost**](docs/InternalApi.md#changepasswordprofilechangepasswordpost) | **POST** /profile/change_password | Change Password
|
|
67
70
|
*InternalApi* | [**delReleaseInternalReleasesReleaseIdDelete**](docs/InternalApi.md#delreleaseinternalreleasesreleaseiddelete) | **DELETE** /internal/releases/{release_id} | Del Release
|
package/api.ts
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).
|
|
@@ -52,6 +52,7 @@ export const BuildStatusEnum = {
|
|
|
52
52
|
Pending: 'pending',
|
|
53
53
|
Running: 'running',
|
|
54
54
|
Cancelling: 'cancelling',
|
|
55
|
+
Uploading: 'uploading',
|
|
55
56
|
Success: 'success',
|
|
56
57
|
Cancelled: 'cancelled',
|
|
57
58
|
Failed: 'failed'
|
|
@@ -80,10 +81,10 @@ export interface BuildTaskResponse {
|
|
|
80
81
|
'started_by_id': string;
|
|
81
82
|
/**
|
|
82
83
|
*
|
|
83
|
-
* @type {
|
|
84
|
+
* @type {ShortDeviceResponse}
|
|
84
85
|
* @memberof BuildTaskResponse
|
|
85
86
|
*/
|
|
86
|
-
'
|
|
87
|
+
'device': ShortDeviceResponse;
|
|
87
88
|
/**
|
|
88
89
|
*
|
|
89
90
|
* @type {BuildStatusEnum}
|
|
@@ -92,10 +93,22 @@ export interface BuildTaskResponse {
|
|
|
92
93
|
'status': BuildStatusEnum;
|
|
93
94
|
/**
|
|
94
95
|
*
|
|
95
|
-
* @type {
|
|
96
|
+
* @type {string}
|
|
96
97
|
* @memberof BuildTaskResponse
|
|
97
98
|
*/
|
|
98
|
-
'
|
|
99
|
+
'version'?: string;
|
|
100
|
+
/**
|
|
101
|
+
*
|
|
102
|
+
* @type {ReleaseType}
|
|
103
|
+
* @memberof BuildTaskResponse
|
|
104
|
+
*/
|
|
105
|
+
'type'?: ReleaseType;
|
|
106
|
+
/**
|
|
107
|
+
*
|
|
108
|
+
* @type {string}
|
|
109
|
+
* @memberof BuildTaskResponse
|
|
110
|
+
*/
|
|
111
|
+
'variant'?: string;
|
|
99
112
|
/**
|
|
100
113
|
*
|
|
101
114
|
* @type {string}
|
|
@@ -108,6 +121,12 @@ export interface BuildTaskResponse {
|
|
|
108
121
|
* @memberof BuildTaskResponse
|
|
109
122
|
*/
|
|
110
123
|
'finished_at'?: string | null;
|
|
124
|
+
/**
|
|
125
|
+
*
|
|
126
|
+
* @type {boolean}
|
|
127
|
+
* @memberof BuildTaskResponse
|
|
128
|
+
*/
|
|
129
|
+
'has_artifact': boolean;
|
|
111
130
|
/**
|
|
112
131
|
*
|
|
113
132
|
* @type {{ [key: string]: any; }}
|
|
@@ -143,10 +162,10 @@ export interface BuildTaskShortResponse {
|
|
|
143
162
|
'started_by_id': string;
|
|
144
163
|
/**
|
|
145
164
|
*
|
|
146
|
-
* @type {
|
|
165
|
+
* @type {ShortDeviceResponse}
|
|
147
166
|
* @memberof BuildTaskShortResponse
|
|
148
167
|
*/
|
|
149
|
-
'
|
|
168
|
+
'device': ShortDeviceResponse;
|
|
150
169
|
/**
|
|
151
170
|
*
|
|
152
171
|
* @type {BuildStatusEnum}
|
|
@@ -155,10 +174,22 @@ export interface BuildTaskShortResponse {
|
|
|
155
174
|
'status': BuildStatusEnum;
|
|
156
175
|
/**
|
|
157
176
|
*
|
|
158
|
-
* @type {
|
|
177
|
+
* @type {string}
|
|
178
|
+
* @memberof BuildTaskShortResponse
|
|
179
|
+
*/
|
|
180
|
+
'version'?: string;
|
|
181
|
+
/**
|
|
182
|
+
*
|
|
183
|
+
* @type {ReleaseType}
|
|
184
|
+
* @memberof BuildTaskShortResponse
|
|
185
|
+
*/
|
|
186
|
+
'type'?: ReleaseType;
|
|
187
|
+
/**
|
|
188
|
+
*
|
|
189
|
+
* @type {string}
|
|
159
190
|
* @memberof BuildTaskShortResponse
|
|
160
191
|
*/
|
|
161
|
-
'
|
|
192
|
+
'variant'?: string;
|
|
162
193
|
/**
|
|
163
194
|
*
|
|
164
195
|
* @type {string}
|
|
@@ -171,6 +202,12 @@ export interface BuildTaskShortResponse {
|
|
|
171
202
|
* @memberof BuildTaskShortResponse
|
|
172
203
|
*/
|
|
173
204
|
'finished_at'?: string | null;
|
|
205
|
+
/**
|
|
206
|
+
*
|
|
207
|
+
* @type {boolean}
|
|
208
|
+
* @memberof BuildTaskShortResponse
|
|
209
|
+
*/
|
|
210
|
+
'has_artifact': boolean;
|
|
174
211
|
}
|
|
175
212
|
|
|
176
213
|
|
|
@@ -2140,7 +2177,7 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration?: Configur
|
|
|
2140
2177
|
};
|
|
2141
2178
|
},
|
|
2142
2179
|
/**
|
|
2143
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
2180
|
+
* 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.
|
|
2144
2181
|
* @summary Delete Task
|
|
2145
2182
|
* @param {string} taskId
|
|
2146
2183
|
* @param {*} [options] Override http request option.
|
|
@@ -2174,7 +2211,41 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration?: Configur
|
|
|
2174
2211
|
};
|
|
2175
2212
|
},
|
|
2176
2213
|
/**
|
|
2177
|
-
*
|
|
2214
|
+
* 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
|
|
2215
|
+
* @summary Download Artifact
|
|
2216
|
+
* @param {string} taskId
|
|
2217
|
+
* @param {*} [options] Override http request option.
|
|
2218
|
+
* @throws {RequiredError}
|
|
2219
|
+
*/
|
|
2220
|
+
downloadArtifactFactoryTaskIdArtifactGet: async (taskId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2221
|
+
// verify required parameter 'taskId' is not null or undefined
|
|
2222
|
+
assertParamExists('downloadArtifactFactoryTaskIdArtifactGet', 'taskId', taskId)
|
|
2223
|
+
const localVarPath = `/factory/{task_id}/artifact`
|
|
2224
|
+
.replace(`{${"task_id"}}`, encodeURIComponent(String(taskId)));
|
|
2225
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2226
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2227
|
+
let baseOptions;
|
|
2228
|
+
if (configuration) {
|
|
2229
|
+
baseOptions = configuration.baseOptions;
|
|
2230
|
+
}
|
|
2231
|
+
|
|
2232
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2233
|
+
const localVarHeaderParameter = {} as any;
|
|
2234
|
+
const localVarQueryParameter = {} as any;
|
|
2235
|
+
|
|
2236
|
+
|
|
2237
|
+
|
|
2238
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2239
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2240
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2241
|
+
|
|
2242
|
+
return {
|
|
2243
|
+
url: toPathString(localVarUrlObj),
|
|
2244
|
+
options: localVarRequestOptions,
|
|
2245
|
+
};
|
|
2246
|
+
},
|
|
2247
|
+
/**
|
|
2248
|
+
* 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.
|
|
2178
2249
|
* @summary Factory Status
|
|
2179
2250
|
* @param {*} [options] Override http request option.
|
|
2180
2251
|
* @throws {RequiredError}
|
|
@@ -2343,6 +2414,94 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration?: Configur
|
|
|
2343
2414
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2344
2415
|
localVarRequestOptions.data = serializeDataIfNeeded(taskUpdateBody, localVarRequestOptions, configuration)
|
|
2345
2416
|
|
|
2417
|
+
return {
|
|
2418
|
+
url: toPathString(localVarUrlObj),
|
|
2419
|
+
options: localVarRequestOptions,
|
|
2420
|
+
};
|
|
2421
|
+
},
|
|
2422
|
+
/**
|
|
2423
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
2424
|
+
* @summary Update Worker Status
|
|
2425
|
+
* @param {string} body
|
|
2426
|
+
* @param {*} [options] Override http request option.
|
|
2427
|
+
* @throws {RequiredError}
|
|
2428
|
+
*/
|
|
2429
|
+
updateWorkerStatusFactoryUpdateStatusPost: async (body: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2430
|
+
// verify required parameter 'body' is not null or undefined
|
|
2431
|
+
assertParamExists('updateWorkerStatusFactoryUpdateStatusPost', 'body', body)
|
|
2432
|
+
const localVarPath = `/factory/update_status`;
|
|
2433
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2434
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2435
|
+
let baseOptions;
|
|
2436
|
+
if (configuration) {
|
|
2437
|
+
baseOptions = configuration.baseOptions;
|
|
2438
|
+
}
|
|
2439
|
+
|
|
2440
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2441
|
+
const localVarHeaderParameter = {} as any;
|
|
2442
|
+
const localVarQueryParameter = {} as any;
|
|
2443
|
+
|
|
2444
|
+
|
|
2445
|
+
|
|
2446
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2447
|
+
|
|
2448
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2449
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2450
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2451
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
2452
|
+
|
|
2453
|
+
return {
|
|
2454
|
+
url: toPathString(localVarUrlObj),
|
|
2455
|
+
options: localVarRequestOptions,
|
|
2456
|
+
};
|
|
2457
|
+
},
|
|
2458
|
+
/**
|
|
2459
|
+
* 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
|
|
2460
|
+
* @summary Upload Artifact
|
|
2461
|
+
* @param {string} taskId
|
|
2462
|
+
* @param {File} artifact
|
|
2463
|
+
* @param {string} md5Hash
|
|
2464
|
+
* @param {*} [options] Override http request option.
|
|
2465
|
+
* @throws {RequiredError}
|
|
2466
|
+
*/
|
|
2467
|
+
uploadArtifactFactoryTaskIdArtifactPost: async (taskId: string, artifact: File, md5Hash: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2468
|
+
// verify required parameter 'taskId' is not null or undefined
|
|
2469
|
+
assertParamExists('uploadArtifactFactoryTaskIdArtifactPost', 'taskId', taskId)
|
|
2470
|
+
// verify required parameter 'artifact' is not null or undefined
|
|
2471
|
+
assertParamExists('uploadArtifactFactoryTaskIdArtifactPost', 'artifact', artifact)
|
|
2472
|
+
// verify required parameter 'md5Hash' is not null or undefined
|
|
2473
|
+
assertParamExists('uploadArtifactFactoryTaskIdArtifactPost', 'md5Hash', md5Hash)
|
|
2474
|
+
const localVarPath = `/factory/{task_id}/artifact`
|
|
2475
|
+
.replace(`{${"task_id"}}`, encodeURIComponent(String(taskId)));
|
|
2476
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2477
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2478
|
+
let baseOptions;
|
|
2479
|
+
if (configuration) {
|
|
2480
|
+
baseOptions = configuration.baseOptions;
|
|
2481
|
+
}
|
|
2482
|
+
|
|
2483
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2484
|
+
const localVarHeaderParameter = {} as any;
|
|
2485
|
+
const localVarQueryParameter = {} as any;
|
|
2486
|
+
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
|
|
2487
|
+
|
|
2488
|
+
|
|
2489
|
+
if (artifact !== undefined) {
|
|
2490
|
+
localVarFormParams.append('artifact', artifact as any);
|
|
2491
|
+
}
|
|
2492
|
+
|
|
2493
|
+
if (md5Hash !== undefined) {
|
|
2494
|
+
localVarFormParams.append('md5_hash', md5Hash as any);
|
|
2495
|
+
}
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
|
|
2499
|
+
|
|
2500
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2501
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2502
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2503
|
+
localVarRequestOptions.data = localVarFormParams;
|
|
2504
|
+
|
|
2346
2505
|
return {
|
|
2347
2506
|
url: toPathString(localVarUrlObj),
|
|
2348
2507
|
options: localVarRequestOptions,
|
|
@@ -2372,7 +2531,7 @@ export const FoxFactoryApiFp = function(configuration?: Configuration) {
|
|
|
2372
2531
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2373
2532
|
},
|
|
2374
2533
|
/**
|
|
2375
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
2534
|
+
* 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.
|
|
2376
2535
|
* @summary Delete Task
|
|
2377
2536
|
* @param {string} taskId
|
|
2378
2537
|
* @param {*} [options] Override http request option.
|
|
@@ -2385,7 +2544,20 @@ export const FoxFactoryApiFp = function(configuration?: Configuration) {
|
|
|
2385
2544
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2386
2545
|
},
|
|
2387
2546
|
/**
|
|
2388
|
-
*
|
|
2547
|
+
* 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
|
|
2548
|
+
* @summary Download Artifact
|
|
2549
|
+
* @param {string} taskId
|
|
2550
|
+
* @param {*} [options] Override http request option.
|
|
2551
|
+
* @throws {RequiredError}
|
|
2552
|
+
*/
|
|
2553
|
+
async downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
2554
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadArtifactFactoryTaskIdArtifactGet(taskId, options);
|
|
2555
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2556
|
+
const localVarOperationServerBasePath = operationServerMap['FoxFactoryApi.downloadArtifactFactoryTaskIdArtifactGet']?.[localVarOperationServerIndex]?.url;
|
|
2557
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2558
|
+
},
|
|
2559
|
+
/**
|
|
2560
|
+
* 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.
|
|
2389
2561
|
* @summary Factory Status
|
|
2390
2562
|
* @param {*} [options] Override http request option.
|
|
2391
2563
|
* @throws {RequiredError}
|
|
@@ -2449,6 +2621,34 @@ export const FoxFactoryApiFp = function(configuration?: Configuration) {
|
|
|
2449
2621
|
const localVarOperationServerBasePath = operationServerMap['FoxFactoryApi.updateTaskFactoryTaskIdPatch']?.[localVarOperationServerIndex]?.url;
|
|
2450
2622
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2451
2623
|
},
|
|
2624
|
+
/**
|
|
2625
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
2626
|
+
* @summary Update Worker Status
|
|
2627
|
+
* @param {string} body
|
|
2628
|
+
* @param {*} [options] Override http request option.
|
|
2629
|
+
* @throws {RequiredError}
|
|
2630
|
+
*/
|
|
2631
|
+
async updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
|
|
2632
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateWorkerStatusFactoryUpdateStatusPost(body, options);
|
|
2633
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2634
|
+
const localVarOperationServerBasePath = operationServerMap['FoxFactoryApi.updateWorkerStatusFactoryUpdateStatusPost']?.[localVarOperationServerIndex]?.url;
|
|
2635
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2636
|
+
},
|
|
2637
|
+
/**
|
|
2638
|
+
* 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
|
|
2639
|
+
* @summary Upload Artifact
|
|
2640
|
+
* @param {string} taskId
|
|
2641
|
+
* @param {File} artifact
|
|
2642
|
+
* @param {string} md5Hash
|
|
2643
|
+
* @param {*} [options] Override http request option.
|
|
2644
|
+
* @throws {RequiredError}
|
|
2645
|
+
*/
|
|
2646
|
+
async uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>> {
|
|
2647
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options);
|
|
2648
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2649
|
+
const localVarOperationServerBasePath = operationServerMap['FoxFactoryApi.uploadArtifactFactoryTaskIdArtifactPost']?.[localVarOperationServerIndex]?.url;
|
|
2650
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2651
|
+
},
|
|
2452
2652
|
}
|
|
2453
2653
|
};
|
|
2454
2654
|
|
|
@@ -2470,7 +2670,7 @@ export const FoxFactoryApiFactory = function (configuration?: Configuration, bas
|
|
|
2470
2670
|
return localVarFp.cancelTaskFactoryTaskIdCancelPost(taskId, options).then((request) => request(axios, basePath));
|
|
2471
2671
|
},
|
|
2472
2672
|
/**
|
|
2473
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
2673
|
+
* 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.
|
|
2474
2674
|
* @summary Delete Task
|
|
2475
2675
|
* @param {string} taskId
|
|
2476
2676
|
* @param {*} [options] Override http request option.
|
|
@@ -2480,7 +2680,17 @@ export const FoxFactoryApiFactory = function (configuration?: Configuration, bas
|
|
|
2480
2680
|
return localVarFp.deleteTaskFactoryTaskIdDelete(taskId, options).then((request) => request(axios, basePath));
|
|
2481
2681
|
},
|
|
2482
2682
|
/**
|
|
2483
|
-
*
|
|
2683
|
+
* 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
|
|
2684
|
+
* @summary Download Artifact
|
|
2685
|
+
* @param {string} taskId
|
|
2686
|
+
* @param {*} [options] Override http request option.
|
|
2687
|
+
* @throws {RequiredError}
|
|
2688
|
+
*/
|
|
2689
|
+
downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<any> {
|
|
2690
|
+
return localVarFp.downloadArtifactFactoryTaskIdArtifactGet(taskId, options).then((request) => request(axios, basePath));
|
|
2691
|
+
},
|
|
2692
|
+
/**
|
|
2693
|
+
* 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.
|
|
2484
2694
|
* @summary Factory Status
|
|
2485
2695
|
* @param {*} [options] Override http request option.
|
|
2486
2696
|
* @throws {RequiredError}
|
|
@@ -2529,6 +2739,28 @@ export const FoxFactoryApiFactory = function (configuration?: Configuration, bas
|
|
|
2529
2739
|
updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean> {
|
|
2530
2740
|
return localVarFp.updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options).then((request) => request(axios, basePath));
|
|
2531
2741
|
},
|
|
2742
|
+
/**
|
|
2743
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
2744
|
+
* @summary Update Worker Status
|
|
2745
|
+
* @param {string} body
|
|
2746
|
+
* @param {*} [options] Override http request option.
|
|
2747
|
+
* @throws {RequiredError}
|
|
2748
|
+
*/
|
|
2749
|
+
updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<any> {
|
|
2750
|
+
return localVarFp.updateWorkerStatusFactoryUpdateStatusPost(body, options).then((request) => request(axios, basePath));
|
|
2751
|
+
},
|
|
2752
|
+
/**
|
|
2753
|
+
* 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
|
|
2754
|
+
* @summary Upload Artifact
|
|
2755
|
+
* @param {string} taskId
|
|
2756
|
+
* @param {File} artifact
|
|
2757
|
+
* @param {string} md5Hash
|
|
2758
|
+
* @param {*} [options] Override http request option.
|
|
2759
|
+
* @throws {RequiredError}
|
|
2760
|
+
*/
|
|
2761
|
+
uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean> {
|
|
2762
|
+
return localVarFp.uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options).then((request) => request(axios, basePath));
|
|
2763
|
+
},
|
|
2532
2764
|
};
|
|
2533
2765
|
};
|
|
2534
2766
|
|
|
@@ -2549,7 +2781,7 @@ export interface FoxFactoryApiInterface {
|
|
|
2549
2781
|
cancelTaskFactoryTaskIdCancelPost(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildTaskResponse>;
|
|
2550
2782
|
|
|
2551
2783
|
/**
|
|
2552
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
2784
|
+
* 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.
|
|
2553
2785
|
* @summary Delete Task
|
|
2554
2786
|
* @param {string} taskId
|
|
2555
2787
|
* @param {*} [options] Override http request option.
|
|
@@ -2559,7 +2791,17 @@ export interface FoxFactoryApiInterface {
|
|
|
2559
2791
|
deleteTaskFactoryTaskIdDelete(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
|
|
2560
2792
|
|
|
2561
2793
|
/**
|
|
2562
|
-
*
|
|
2794
|
+
* 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
|
|
2795
|
+
* @summary Download Artifact
|
|
2796
|
+
* @param {string} taskId
|
|
2797
|
+
* @param {*} [options] Override http request option.
|
|
2798
|
+
* @throws {RequiredError}
|
|
2799
|
+
* @memberof FoxFactoryApiInterface
|
|
2800
|
+
*/
|
|
2801
|
+
downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
2802
|
+
|
|
2803
|
+
/**
|
|
2804
|
+
* 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.
|
|
2563
2805
|
* @summary Factory Status
|
|
2564
2806
|
* @param {*} [options] Override http request option.
|
|
2565
2807
|
* @throws {RequiredError}
|
|
@@ -2608,6 +2850,28 @@ export interface FoxFactoryApiInterface {
|
|
|
2608
2850
|
*/
|
|
2609
2851
|
updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
|
|
2610
2852
|
|
|
2853
|
+
/**
|
|
2854
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
2855
|
+
* @summary Update Worker Status
|
|
2856
|
+
* @param {string} body
|
|
2857
|
+
* @param {*} [options] Override http request option.
|
|
2858
|
+
* @throws {RequiredError}
|
|
2859
|
+
* @memberof FoxFactoryApiInterface
|
|
2860
|
+
*/
|
|
2861
|
+
updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
|
|
2862
|
+
|
|
2863
|
+
/**
|
|
2864
|
+
* 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
|
|
2865
|
+
* @summary Upload Artifact
|
|
2866
|
+
* @param {string} taskId
|
|
2867
|
+
* @param {File} artifact
|
|
2868
|
+
* @param {string} md5Hash
|
|
2869
|
+
* @param {*} [options] Override http request option.
|
|
2870
|
+
* @throws {RequiredError}
|
|
2871
|
+
* @memberof FoxFactoryApiInterface
|
|
2872
|
+
*/
|
|
2873
|
+
uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
|
|
2874
|
+
|
|
2611
2875
|
}
|
|
2612
2876
|
|
|
2613
2877
|
/**
|
|
@@ -2630,7 +2894,7 @@ export class FoxFactoryApi extends BaseAPI implements FoxFactoryApiInterface {
|
|
|
2630
2894
|
}
|
|
2631
2895
|
|
|
2632
2896
|
/**
|
|
2633
|
-
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
2897
|
+
* 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.
|
|
2634
2898
|
* @summary Delete Task
|
|
2635
2899
|
* @param {string} taskId
|
|
2636
2900
|
* @param {*} [options] Override http request option.
|
|
@@ -2642,7 +2906,19 @@ export class FoxFactoryApi extends BaseAPI implements FoxFactoryApiInterface {
|
|
|
2642
2906
|
}
|
|
2643
2907
|
|
|
2644
2908
|
/**
|
|
2645
|
-
*
|
|
2909
|
+
* 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
|
|
2910
|
+
* @summary Download Artifact
|
|
2911
|
+
* @param {string} taskId
|
|
2912
|
+
* @param {*} [options] Override http request option.
|
|
2913
|
+
* @throws {RequiredError}
|
|
2914
|
+
* @memberof FoxFactoryApi
|
|
2915
|
+
*/
|
|
2916
|
+
public downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig) {
|
|
2917
|
+
return FoxFactoryApiFp(this.configuration).downloadArtifactFactoryTaskIdArtifactGet(taskId, options).then((request) => request(this.axios, this.basePath));
|
|
2918
|
+
}
|
|
2919
|
+
|
|
2920
|
+
/**
|
|
2921
|
+
* 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.
|
|
2646
2922
|
* @summary Factory Status
|
|
2647
2923
|
* @param {*} [options] Override http request option.
|
|
2648
2924
|
* @throws {RequiredError}
|
|
@@ -2700,6 +2976,32 @@ export class FoxFactoryApi extends BaseAPI implements FoxFactoryApiInterface {
|
|
|
2700
2976
|
public updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig) {
|
|
2701
2977
|
return FoxFactoryApiFp(this.configuration).updateTaskFactoryTaskIdPatch(taskId, taskUpdateBody, options).then((request) => request(this.axios, this.basePath));
|
|
2702
2978
|
}
|
|
2979
|
+
|
|
2980
|
+
/**
|
|
2981
|
+
* Endpoint for FoxFactory worker to update its status.
|
|
2982
|
+
* @summary Update Worker Status
|
|
2983
|
+
* @param {string} body
|
|
2984
|
+
* @param {*} [options] Override http request option.
|
|
2985
|
+
* @throws {RequiredError}
|
|
2986
|
+
* @memberof FoxFactoryApi
|
|
2987
|
+
*/
|
|
2988
|
+
public updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig) {
|
|
2989
|
+
return FoxFactoryApiFp(this.configuration).updateWorkerStatusFactoryUpdateStatusPost(body, options).then((request) => request(this.axios, this.basePath));
|
|
2990
|
+
}
|
|
2991
|
+
|
|
2992
|
+
/**
|
|
2993
|
+
* 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
|
|
2994
|
+
* @summary Upload Artifact
|
|
2995
|
+
* @param {string} taskId
|
|
2996
|
+
* @param {File} artifact
|
|
2997
|
+
* @param {string} md5Hash
|
|
2998
|
+
* @param {*} [options] Override http request option.
|
|
2999
|
+
* @throws {RequiredError}
|
|
3000
|
+
* @memberof FoxFactoryApi
|
|
3001
|
+
*/
|
|
3002
|
+
public uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig) {
|
|
3003
|
+
return FoxFactoryApiFp(this.configuration).uploadArtifactFactoryTaskIdArtifactPost(taskId, artifact, md5Hash, options).then((request) => request(this.axios, this.basePath));
|
|
3004
|
+
}
|
|
2703
3005
|
}
|
|
2704
3006
|
|
|
2705
3007
|
|
package/base.ts
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/common.ts
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/configuration.ts
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).
|