@orangefox-recovery/foxinternalclient 5.2.4 → 5.2.6
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 +3 -0
- package/README.md +11 -2
- package/api.ts +897 -62
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +462 -25
- package/dist/api.js +614 -10
- 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 +462 -25
- package/dist/esm/api.js +609 -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 +11 -5
- package/docs/BuildTaskShortResponse.md +10 -4
- package/docs/FoxFactoryApi.md +174 -8
- package/docs/InternalApi.md +114 -0
- package/docs/PasteApi.md +117 -0
- package/docs/PasteInput.md +26 -0
- package/docs/PasteOutput.md +26 -0
- package/index.ts +1 -1
- package/package.json +1 -1
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.6
|
|
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.6
|
|
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.6
|
|
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.6
|
|
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.6
|
|
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.6
|
|
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.6
|
|
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.6
|
|
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.6
|
|
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.6
|
|
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,12 +7,15 @@ 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]
|
|
15
|
-
**
|
|
17
|
+
**has_artifact** | **boolean** | | [default to undefined]
|
|
18
|
+
**environment** | **{ [key: string]: string; }** | | [optional] [default to undefined]
|
|
16
19
|
**logs** | **Array<string>** | | [optional] [default to undefined]
|
|
17
20
|
|
|
18
21
|
## Example
|
|
@@ -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
|
|
package/docs/FoxFactoryApi.md
CHANGED
|
@@ -6,11 +6,14 @@ All URIs are relative to *https://api.orangefox.download*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**cancelTaskFactoryTaskIdCancelPost**](#canceltaskfactorytaskidcancelpost) | **POST** /factory/{task_id}/cancel | Cancel Task|
|
|
8
8
|
|[**deleteTaskFactoryTaskIdDelete**](#deletetaskfactorytaskiddelete) | **DELETE** /factory/{task_id} | Delete Task|
|
|
9
|
+
|[**downloadArtifactFactoryTaskIdArtifactGet**](#downloadartifactfactorytaskidartifactget) | **GET** /factory/{task_id}/artifact | Download Artifact|
|
|
9
10
|
|[**factoryStatusFactoryStatusGet**](#factorystatusfactorystatusget) | **GET** /factory/status | Factory Status|
|
|
10
11
|
|[**getTaskFactoryTaskIdGet**](#gettaskfactorytaskidget) | **GET** /factory/{task_id} | Get Task|
|
|
11
12
|
|[**listTasksFactoryGet**](#listtasksfactoryget) | **GET** /factory/ | List Tasks|
|
|
12
13
|
|[**newTaskFactoryPost**](#newtaskfactorypost) | **POST** /factory/ | New Task|
|
|
13
14
|
|[**updateTaskFactoryTaskIdPatch**](#updatetaskfactorytaskidpatch) | **PATCH** /factory/{task_id} | Update Task|
|
|
15
|
+
|[**updateWorkerStatusFactoryUpdateStatusPost**](#updateworkerstatusfactoryupdatestatuspost) | **POST** /factory/update_status | Update Worker Status|
|
|
16
|
+
|[**uploadArtifactFactoryTaskIdArtifactPost**](#uploadartifactfactorytaskidartifactpost) | **POST** /factory/{task_id}/artifact | Upload Artifact|
|
|
14
17
|
|
|
15
18
|
# **cancelTaskFactoryTaskIdCancelPost**
|
|
16
19
|
> BuildTaskResponse cancelTaskFactoryTaskIdCancelPost()
|
|
@@ -48,7 +51,7 @@ const { status, data } = await apiInstance.cancelTaskFactoryTaskIdCancelPost(
|
|
|
48
51
|
|
|
49
52
|
### Authorization
|
|
50
53
|
|
|
51
|
-
|
|
54
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
52
55
|
|
|
53
56
|
### HTTP request headers
|
|
54
57
|
|
|
@@ -67,7 +70,7 @@ No authorization required
|
|
|
67
70
|
# **deleteTaskFactoryTaskIdDelete**
|
|
68
71
|
> boolean deleteTaskFactoryTaskIdDelete()
|
|
69
72
|
|
|
70
|
-
Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
73
|
+
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.
|
|
71
74
|
|
|
72
75
|
### Example
|
|
73
76
|
|
|
@@ -100,7 +103,59 @@ const { status, data } = await apiInstance.deleteTaskFactoryTaskIdDelete(
|
|
|
100
103
|
|
|
101
104
|
### Authorization
|
|
102
105
|
|
|
103
|
-
|
|
106
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
107
|
+
|
|
108
|
+
### HTTP request headers
|
|
109
|
+
|
|
110
|
+
- **Content-Type**: Not defined
|
|
111
|
+
- **Accept**: application/json
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
### HTTP response details
|
|
115
|
+
| Status code | Description | Response headers |
|
|
116
|
+
|-------------|-------------|------------------|
|
|
117
|
+
|**200** | Successful Response | - |
|
|
118
|
+
|**422** | Validation Error | - |
|
|
119
|
+
|
|
120
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
121
|
+
|
|
122
|
+
# **downloadArtifactFactoryTaskIdArtifactGet**
|
|
123
|
+
> any downloadArtifactFactoryTaskIdArtifactGet()
|
|
124
|
+
|
|
125
|
+
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
|
|
126
|
+
|
|
127
|
+
### Example
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
import {
|
|
131
|
+
FoxFactoryApi,
|
|
132
|
+
Configuration
|
|
133
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
134
|
+
|
|
135
|
+
const configuration = new Configuration();
|
|
136
|
+
const apiInstance = new FoxFactoryApi(configuration);
|
|
137
|
+
|
|
138
|
+
let taskId: string; // (default to undefined)
|
|
139
|
+
|
|
140
|
+
const { status, data } = await apiInstance.downloadArtifactFactoryTaskIdArtifactGet(
|
|
141
|
+
taskId
|
|
142
|
+
);
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Parameters
|
|
146
|
+
|
|
147
|
+
|Name | Type | Description | Notes|
|
|
148
|
+
|------------- | ------------- | ------------- | -------------|
|
|
149
|
+
| **taskId** | [**string**] | | defaults to undefined|
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
### Return type
|
|
153
|
+
|
|
154
|
+
**any**
|
|
155
|
+
|
|
156
|
+
### Authorization
|
|
157
|
+
|
|
158
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
104
159
|
|
|
105
160
|
### HTTP request headers
|
|
106
161
|
|
|
@@ -119,6 +174,7 @@ No authorization required
|
|
|
119
174
|
# **factoryStatusFactoryStatusGet**
|
|
120
175
|
> FFStatusResponse factoryStatusFactoryStatusGet()
|
|
121
176
|
|
|
177
|
+
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.
|
|
122
178
|
|
|
123
179
|
### Example
|
|
124
180
|
|
|
@@ -144,7 +200,7 @@ This endpoint does not have any parameters.
|
|
|
144
200
|
|
|
145
201
|
### Authorization
|
|
146
202
|
|
|
147
|
-
|
|
203
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
148
204
|
|
|
149
205
|
### HTTP request headers
|
|
150
206
|
|
|
@@ -195,7 +251,7 @@ const { status, data } = await apiInstance.getTaskFactoryTaskIdGet(
|
|
|
195
251
|
|
|
196
252
|
### Authorization
|
|
197
253
|
|
|
198
|
-
|
|
254
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
199
255
|
|
|
200
256
|
### HTTP request headers
|
|
201
257
|
|
|
@@ -247,7 +303,7 @@ const { status, data } = await apiInstance.listTasksFactoryGet(
|
|
|
247
303
|
|
|
248
304
|
### Authorization
|
|
249
305
|
|
|
250
|
-
|
|
306
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
251
307
|
|
|
252
308
|
### HTTP request headers
|
|
253
309
|
|
|
@@ -300,7 +356,7 @@ const { status, data } = await apiInstance.newTaskFactoryPost(
|
|
|
300
356
|
|
|
301
357
|
### Authorization
|
|
302
358
|
|
|
303
|
-
|
|
359
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
304
360
|
|
|
305
361
|
### HTTP request headers
|
|
306
362
|
|
|
@@ -356,7 +412,7 @@ const { status, data } = await apiInstance.updateTaskFactoryTaskIdPatch(
|
|
|
356
412
|
|
|
357
413
|
### Authorization
|
|
358
414
|
|
|
359
|
-
|
|
415
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
360
416
|
|
|
361
417
|
### HTTP request headers
|
|
362
418
|
|
|
@@ -372,3 +428,113 @@ No authorization required
|
|
|
372
428
|
|
|
373
429
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
374
430
|
|
|
431
|
+
# **updateWorkerStatusFactoryUpdateStatusPost**
|
|
432
|
+
> any updateWorkerStatusFactoryUpdateStatusPost(body)
|
|
433
|
+
|
|
434
|
+
Endpoint for FoxFactory worker to update its status.
|
|
435
|
+
|
|
436
|
+
### Example
|
|
437
|
+
|
|
438
|
+
```typescript
|
|
439
|
+
import {
|
|
440
|
+
FoxFactoryApi,
|
|
441
|
+
Configuration
|
|
442
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
443
|
+
|
|
444
|
+
const configuration = new Configuration();
|
|
445
|
+
const apiInstance = new FoxFactoryApi(configuration);
|
|
446
|
+
|
|
447
|
+
let body: string; //
|
|
448
|
+
|
|
449
|
+
const { status, data } = await apiInstance.updateWorkerStatusFactoryUpdateStatusPost(
|
|
450
|
+
body
|
|
451
|
+
);
|
|
452
|
+
```
|
|
453
|
+
|
|
454
|
+
### Parameters
|
|
455
|
+
|
|
456
|
+
|Name | Type | Description | Notes|
|
|
457
|
+
|------------- | ------------- | ------------- | -------------|
|
|
458
|
+
| **body** | **string**| | |
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
### Return type
|
|
462
|
+
|
|
463
|
+
**any**
|
|
464
|
+
|
|
465
|
+
### Authorization
|
|
466
|
+
|
|
467
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
468
|
+
|
|
469
|
+
### HTTP request headers
|
|
470
|
+
|
|
471
|
+
- **Content-Type**: application/json
|
|
472
|
+
- **Accept**: application/json
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
### HTTP response details
|
|
476
|
+
| Status code | Description | Response headers |
|
|
477
|
+
|-------------|-------------|------------------|
|
|
478
|
+
|**200** | Successful Response | - |
|
|
479
|
+
|**422** | Validation Error | - |
|
|
480
|
+
|
|
481
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
482
|
+
|
|
483
|
+
# **uploadArtifactFactoryTaskIdArtifactPost**
|
|
484
|
+
> boolean uploadArtifactFactoryTaskIdArtifactPost()
|
|
485
|
+
|
|
486
|
+
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
|
|
487
|
+
|
|
488
|
+
### Example
|
|
489
|
+
|
|
490
|
+
```typescript
|
|
491
|
+
import {
|
|
492
|
+
FoxFactoryApi,
|
|
493
|
+
Configuration
|
|
494
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
495
|
+
|
|
496
|
+
const configuration = new Configuration();
|
|
497
|
+
const apiInstance = new FoxFactoryApi(configuration);
|
|
498
|
+
|
|
499
|
+
let taskId: string; // (default to undefined)
|
|
500
|
+
let artifact: File; // (default to undefined)
|
|
501
|
+
let md5Hash: string; // (default to undefined)
|
|
502
|
+
|
|
503
|
+
const { status, data } = await apiInstance.uploadArtifactFactoryTaskIdArtifactPost(
|
|
504
|
+
taskId,
|
|
505
|
+
artifact,
|
|
506
|
+
md5Hash
|
|
507
|
+
);
|
|
508
|
+
```
|
|
509
|
+
|
|
510
|
+
### Parameters
|
|
511
|
+
|
|
512
|
+
|Name | Type | Description | Notes|
|
|
513
|
+
|------------- | ------------- | ------------- | -------------|
|
|
514
|
+
| **taskId** | [**string**] | | defaults to undefined|
|
|
515
|
+
| **artifact** | [**File**] | | defaults to undefined|
|
|
516
|
+
| **md5Hash** | [**string**] | | defaults to undefined|
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
### Return type
|
|
520
|
+
|
|
521
|
+
**boolean**
|
|
522
|
+
|
|
523
|
+
### Authorization
|
|
524
|
+
|
|
525
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
526
|
+
|
|
527
|
+
### HTTP request headers
|
|
528
|
+
|
|
529
|
+
- **Content-Type**: multipart/form-data
|
|
530
|
+
- **Accept**: application/json
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
### HTTP response details
|
|
534
|
+
| Status code | Description | Response headers |
|
|
535
|
+
|-------------|-------------|------------------|
|
|
536
|
+
|**200** | Successful Response | - |
|
|
537
|
+
|**422** | Validation Error | - |
|
|
538
|
+
|
|
539
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
540
|
+
|
package/docs/InternalApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.orangefox.download*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**changePasswordProfileChangePasswordPost**](#changepasswordprofilechangepasswordpost) | **POST** /profile/change_password | Change Password|
|
|
8
8
|
|[**delReleaseInternalReleasesReleaseIdDelete**](#delreleaseinternalreleasesreleaseiddelete) | **DELETE** /internal/releases/{release_id} | Del Release|
|
|
9
|
+
|[**deletePasteInternalPastePasteIdDelete**](#deletepasteinternalpastepasteiddelete) | **DELETE** /internal/paste/{paste_id} | Delete Paste|
|
|
9
10
|
|[**deleteUserInternalUsersUserIdDelete**](#deleteuserinternalusersuseriddelete) | **DELETE** /internal/users/{user_id} | Delete User|
|
|
10
11
|
|[**editReleaseInternalReleasesReleaseIdPut**](#editreleaseinternalreleasesreleaseidput) | **PUT** /internal/releases/{release_id} | Edit Release|
|
|
11
12
|
|[**getDeviceInfoInternalDevicesDeviceIdGet**](#getdeviceinfointernaldevicesdeviceidget) | **GET** /internal/devices/{device_id} | Get Device Info|
|
|
@@ -20,6 +21,7 @@ All URIs are relative to *https://api.orangefox.download*
|
|
|
20
21
|
|[**newReleaseInternalReleasesPost**](#newreleaseinternalreleasespost) | **POST** /internal/releases/ | New Release|
|
|
21
22
|
|[**renewAuthRenewPost**](#renewauthrenewpost) | **POST** /auth/renew | Renew|
|
|
22
23
|
|[**updateDeviceInternalDevicesDeviceIdPut**](#updatedeviceinternaldevicesdeviceidput) | **PUT** /internal/devices/{device_id} | Update Device|
|
|
24
|
+
|[**updatePasteInternalPastePasteIdPut**](#updatepasteinternalpastepasteidput) | **PUT** /internal/paste/{paste_id} | Update Paste|
|
|
23
25
|
|[**updateUserInternalUsersUserIdPut**](#updateuserinternalusersuseridput) | **PUT** /internal/users/{user_id} | Update User|
|
|
24
26
|
|
|
25
27
|
# **changePasswordProfileChangePasswordPost**
|
|
@@ -127,6 +129,60 @@ const { status, data } = await apiInstance.delReleaseInternalReleasesReleaseIdDe
|
|
|
127
129
|
|
|
128
130
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
129
131
|
|
|
132
|
+
# **deletePasteInternalPastePasteIdDelete**
|
|
133
|
+
> deletePasteInternalPastePasteIdDelete()
|
|
134
|
+
|
|
135
|
+
Delete a paste by ID. Requires admin permissions.
|
|
136
|
+
|
|
137
|
+
### Example
|
|
138
|
+
|
|
139
|
+
```typescript
|
|
140
|
+
import {
|
|
141
|
+
InternalApi,
|
|
142
|
+
Configuration
|
|
143
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
144
|
+
|
|
145
|
+
const configuration = new Configuration();
|
|
146
|
+
const apiInstance = new InternalApi(configuration);
|
|
147
|
+
|
|
148
|
+
let pasteId: string; // (default to undefined)
|
|
149
|
+
|
|
150
|
+
const { status, data } = await apiInstance.deletePasteInternalPastePasteIdDelete(
|
|
151
|
+
pasteId
|
|
152
|
+
);
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
|Name | Type | Description | Notes|
|
|
158
|
+
|------------- | ------------- | ------------- | -------------|
|
|
159
|
+
| **pasteId** | [**string**] | | defaults to undefined|
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
### Return type
|
|
163
|
+
|
|
164
|
+
void (empty response body)
|
|
165
|
+
|
|
166
|
+
### Authorization
|
|
167
|
+
|
|
168
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
169
|
+
|
|
170
|
+
### HTTP request headers
|
|
171
|
+
|
|
172
|
+
- **Content-Type**: Not defined
|
|
173
|
+
- **Accept**: application/json
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
### HTTP response details
|
|
177
|
+
| Status code | Description | Response headers |
|
|
178
|
+
|-------------|-------------|------------------|
|
|
179
|
+
|**204** | Successful Response | - |
|
|
180
|
+
|**404** | Item not found | - |
|
|
181
|
+
|**429** | Too many requests | - |
|
|
182
|
+
|**422** | Validation Error | - |
|
|
183
|
+
|
|
184
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
185
|
+
|
|
130
186
|
# **deleteUserInternalUsersUserIdDelete**
|
|
131
187
|
> boolean deleteUserInternalUsersUserIdDelete()
|
|
132
188
|
|
|
@@ -901,6 +957,64 @@ const { status, data } = await apiInstance.updateDeviceInternalDevicesDeviceIdPu
|
|
|
901
957
|
|
|
902
958
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
903
959
|
|
|
960
|
+
# **updatePasteInternalPastePasteIdPut**
|
|
961
|
+
> PasteOutput updatePasteInternalPastePasteIdPut(pasteInput)
|
|
962
|
+
|
|
963
|
+
Update a paste by ID. Requires admin permissions.
|
|
964
|
+
|
|
965
|
+
### Example
|
|
966
|
+
|
|
967
|
+
```typescript
|
|
968
|
+
import {
|
|
969
|
+
InternalApi,
|
|
970
|
+
Configuration,
|
|
971
|
+
PasteInput
|
|
972
|
+
} from '@orangefox-recovery/foxinternalclient';
|
|
973
|
+
|
|
974
|
+
const configuration = new Configuration();
|
|
975
|
+
const apiInstance = new InternalApi(configuration);
|
|
976
|
+
|
|
977
|
+
let pasteId: string; // (default to undefined)
|
|
978
|
+
let pasteInput: PasteInput; //
|
|
979
|
+
|
|
980
|
+
const { status, data } = await apiInstance.updatePasteInternalPastePasteIdPut(
|
|
981
|
+
pasteId,
|
|
982
|
+
pasteInput
|
|
983
|
+
);
|
|
984
|
+
```
|
|
985
|
+
|
|
986
|
+
### Parameters
|
|
987
|
+
|
|
988
|
+
|Name | Type | Description | Notes|
|
|
989
|
+
|------------- | ------------- | ------------- | -------------|
|
|
990
|
+
| **pasteInput** | **PasteInput**| | |
|
|
991
|
+
| **pasteId** | [**string**] | | defaults to undefined|
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
### Return type
|
|
995
|
+
|
|
996
|
+
**PasteOutput**
|
|
997
|
+
|
|
998
|
+
### Authorization
|
|
999
|
+
|
|
1000
|
+
[oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
|
|
1001
|
+
|
|
1002
|
+
### HTTP request headers
|
|
1003
|
+
|
|
1004
|
+
- **Content-Type**: application/json
|
|
1005
|
+
- **Accept**: application/json
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
### HTTP response details
|
|
1009
|
+
| Status code | Description | Response headers |
|
|
1010
|
+
|-------------|-------------|------------------|
|
|
1011
|
+
|**200** | Successful Response | - |
|
|
1012
|
+
|**404** | Item not found | - |
|
|
1013
|
+
|**429** | Too many requests | - |
|
|
1014
|
+
|**422** | Validation Error | - |
|
|
1015
|
+
|
|
1016
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1017
|
+
|
|
904
1018
|
# **updateUserInternalUsersUserIdPut**
|
|
905
1019
|
> boolean updateUserInternalUsersUserIdPut(userUpdateBody)
|
|
906
1020
|
|