@orangefox-recovery/foxinternalclient 5.2.1 → 5.2.2
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 +2 -2
- package/api.ts +275 -293
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +265 -265
- package/dist/api.js +135 -153
- 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 +265 -265
- package/dist/esm/api.js +135 -153
- 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/DeviceApi.md +9 -11
- package/docs/FoxFactoryApi.md +11 -12
- package/docs/InternalApi.md +25 -28
- package/docs/NewBuildTaskBody.md +1 -1
- package/docs/NewDeviceBody.md +1 -1
- package/docs/ReleaseApi.md +22 -25
- 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.2
|
|
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.2
|
|
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.2
|
|
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.2
|
|
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.2
|
|
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.2
|
|
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.2
|
|
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.2
|
|
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.2
|
|
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.2
|
|
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/DeviceApi.md
CHANGED
|
@@ -19,16 +19,14 @@ Extended get device method, including the ability to get a device using device c
|
|
|
19
19
|
```typescript
|
|
20
20
|
import {
|
|
21
21
|
DeviceApi,
|
|
22
|
-
Configuration
|
|
23
|
-
,
|
|
24
|
-
|
|
22
|
+
Configuration
|
|
25
23
|
} from '@orangefox-recovery/foxinternalclient';
|
|
26
24
|
|
|
27
25
|
const configuration = new Configuration();
|
|
28
26
|
const apiInstance = new DeviceApi(configuration);
|
|
29
27
|
|
|
30
|
-
let deviceId: ; // (optional) (default to undefined)
|
|
31
|
-
let id: ; //Filter by Device ID (deprecated) (optional) (default to undefined)
|
|
28
|
+
let deviceId: string; // (optional) (default to undefined)
|
|
29
|
+
let id: string; //Filter by Device ID (deprecated) (optional) (default to undefined)
|
|
32
30
|
let codename: string; //Not recommended to use when you can (optional) (default to undefined)
|
|
33
31
|
|
|
34
32
|
const { status, data } = await apiInstance.getDevice(
|
|
@@ -42,8 +40,8 @@ const { status, data } = await apiInstance.getDevice(
|
|
|
42
40
|
|
|
43
41
|
|Name | Type | Description | Notes|
|
|
44
42
|
|------------- | ------------- | ------------- | -------------|
|
|
45
|
-
| **deviceId** |
|
|
46
|
-
| **id** |
|
|
43
|
+
| **deviceId** | [**string**] | | (optional) defaults to undefined|
|
|
44
|
+
| **id** | [**string**] | Filter by Device ID (deprecated) | (optional) defaults to undefined|
|
|
47
45
|
| **codename** | [**string**] | Not recommended to use when you can | (optional) defaults to undefined|
|
|
48
46
|
|
|
49
47
|
|
|
@@ -140,8 +138,8 @@ import {
|
|
|
140
138
|
const configuration = new Configuration();
|
|
141
139
|
const apiInstance = new DeviceApi(configuration);
|
|
142
140
|
|
|
143
|
-
let id: Array<
|
|
144
|
-
let id2: Array<
|
|
141
|
+
let id: Array<string>; //Filter by Device IDs (optional) (default to undefined)
|
|
142
|
+
let id2: Array<string>; //Filter by Device IDs (deprecated) (optional) (default to undefined)
|
|
145
143
|
let oemName: Array<string>; //Filter by OEM names (optional) (default to undefined)
|
|
146
144
|
let codename: Array<string>; //Filter by device codenames (optional) (default to undefined)
|
|
147
145
|
let modelName: Array<string>; //Filter by model names (optional) (default to undefined)
|
|
@@ -171,8 +169,8 @@ const { status, data } = await apiInstance.getDevices(
|
|
|
171
169
|
|
|
172
170
|
|Name | Type | Description | Notes|
|
|
173
171
|
|------------- | ------------- | ------------- | -------------|
|
|
174
|
-
| **id** | **Array<
|
|
175
|
-
| **id2** | **Array<
|
|
172
|
+
| **id** | **Array<string>** | Filter by Device IDs | (optional) defaults to undefined|
|
|
173
|
+
| **id2** | **Array<string>** | Filter by Device IDs (deprecated) | (optional) defaults to undefined|
|
|
176
174
|
| **oemName** | **Array<string>** | Filter by OEM names | (optional) defaults to undefined|
|
|
177
175
|
| **codename** | **Array<string>** | Filter by device codenames | (optional) defaults to undefined|
|
|
178
176
|
| **modelName** | **Array<string>** | Filter by model names | (optional) defaults to undefined|
|
package/docs/FoxFactoryApi.md
CHANGED
|
@@ -28,7 +28,7 @@ import {
|
|
|
28
28
|
const configuration = new Configuration();
|
|
29
29
|
const apiInstance = new FoxFactoryApi(configuration);
|
|
30
30
|
|
|
31
|
-
let taskId:
|
|
31
|
+
let taskId: string; // (default to undefined)
|
|
32
32
|
|
|
33
33
|
const { status, data } = await apiInstance.cancelTaskFactoryTaskIdCancelPost(
|
|
34
34
|
taskId
|
|
@@ -39,7 +39,7 @@ const { status, data } = await apiInstance.cancelTaskFactoryTaskIdCancelPost(
|
|
|
39
39
|
|
|
40
40
|
|Name | Type | Description | Notes|
|
|
41
41
|
|------------- | ------------- | ------------- | -------------|
|
|
42
|
-
| **taskId** | **
|
|
42
|
+
| **taskId** | [**string**] | | defaults to undefined|
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
### Return type
|
|
@@ -80,7 +80,7 @@ import {
|
|
|
80
80
|
const configuration = new Configuration();
|
|
81
81
|
const apiInstance = new FoxFactoryApi(configuration);
|
|
82
82
|
|
|
83
|
-
let taskId:
|
|
83
|
+
let taskId: string; // (default to undefined)
|
|
84
84
|
|
|
85
85
|
const { status, data } = await apiInstance.deleteTaskFactoryTaskIdDelete(
|
|
86
86
|
taskId
|
|
@@ -91,7 +91,7 @@ const { status, data } = await apiInstance.deleteTaskFactoryTaskIdDelete(
|
|
|
91
91
|
|
|
92
92
|
|Name | Type | Description | Notes|
|
|
93
93
|
|------------- | ------------- | ------------- | -------------|
|
|
94
|
-
| **taskId** | **
|
|
94
|
+
| **taskId** | [**string**] | | defaults to undefined|
|
|
95
95
|
|
|
96
96
|
|
|
97
97
|
### Return type
|
|
@@ -175,7 +175,7 @@ import {
|
|
|
175
175
|
const configuration = new Configuration();
|
|
176
176
|
const apiInstance = new FoxFactoryApi(configuration);
|
|
177
177
|
|
|
178
|
-
let taskId:
|
|
178
|
+
let taskId: string; // (default to undefined)
|
|
179
179
|
|
|
180
180
|
const { status, data } = await apiInstance.getTaskFactoryTaskIdGet(
|
|
181
181
|
taskId
|
|
@@ -186,7 +186,7 @@ const { status, data } = await apiInstance.getTaskFactoryTaskIdGet(
|
|
|
186
186
|
|
|
187
187
|
|Name | Type | Description | Notes|
|
|
188
188
|
|------------- | ------------- | ------------- | -------------|
|
|
189
|
-
| **taskId** | **
|
|
189
|
+
| **taskId** | [**string**] | | defaults to undefined|
|
|
190
190
|
|
|
191
191
|
|
|
192
192
|
### Return type
|
|
@@ -221,14 +221,13 @@ Get a list of all build tasks. This endpoint retrieves all build tasks from the
|
|
|
221
221
|
```typescript
|
|
222
222
|
import {
|
|
223
223
|
FoxFactoryApi,
|
|
224
|
-
Configuration
|
|
225
|
-
|
|
224
|
+
Configuration
|
|
226
225
|
} from '@orangefox-recovery/foxinternalclient';
|
|
227
226
|
|
|
228
227
|
const configuration = new Configuration();
|
|
229
228
|
const apiInstance = new FoxFactoryApi(configuration);
|
|
230
229
|
|
|
231
|
-
let deviceId: ; // (optional) (default to undefined)
|
|
230
|
+
let deviceId: string; // (optional) (default to undefined)
|
|
232
231
|
|
|
233
232
|
const { status, data } = await apiInstance.listTasksFactoryGet(
|
|
234
233
|
deviceId
|
|
@@ -239,7 +238,7 @@ const { status, data } = await apiInstance.listTasksFactoryGet(
|
|
|
239
238
|
|
|
240
239
|
|Name | Type | Description | Notes|
|
|
241
240
|
|------------- | ------------- | ------------- | -------------|
|
|
242
|
-
| **deviceId** |
|
|
241
|
+
| **deviceId** | [**string**] | | (optional) defaults to undefined|
|
|
243
242
|
|
|
244
243
|
|
|
245
244
|
### Return type
|
|
@@ -334,7 +333,7 @@ import {
|
|
|
334
333
|
const configuration = new Configuration();
|
|
335
334
|
const apiInstance = new FoxFactoryApi(configuration);
|
|
336
335
|
|
|
337
|
-
let taskId:
|
|
336
|
+
let taskId: string; // (default to undefined)
|
|
338
337
|
let taskUpdateBody: TaskUpdateBody; //
|
|
339
338
|
|
|
340
339
|
const { status, data } = await apiInstance.updateTaskFactoryTaskIdPatch(
|
|
@@ -348,7 +347,7 @@ const { status, data } = await apiInstance.updateTaskFactoryTaskIdPatch(
|
|
|
348
347
|
|Name | Type | Description | Notes|
|
|
349
348
|
|------------- | ------------- | ------------- | -------------|
|
|
350
349
|
| **taskUpdateBody** | **TaskUpdateBody**| | |
|
|
351
|
-
| **taskId** | **
|
|
350
|
+
| **taskId** | [**string**] | | defaults to undefined|
|
|
352
351
|
|
|
353
352
|
|
|
354
353
|
### Return type
|
package/docs/InternalApi.md
CHANGED
|
@@ -91,7 +91,7 @@ import {
|
|
|
91
91
|
const configuration = new Configuration();
|
|
92
92
|
const apiInstance = new InternalApi(configuration);
|
|
93
93
|
|
|
94
|
-
let releaseId:
|
|
94
|
+
let releaseId: string; // (default to undefined)
|
|
95
95
|
|
|
96
96
|
const { status, data } = await apiInstance.delReleaseInternalReleasesReleaseIdDelete(
|
|
97
97
|
releaseId
|
|
@@ -102,7 +102,7 @@ const { status, data } = await apiInstance.delReleaseInternalReleasesReleaseIdDe
|
|
|
102
102
|
|
|
103
103
|
|Name | Type | Description | Notes|
|
|
104
104
|
|------------- | ------------- | ------------- | -------------|
|
|
105
|
-
| **releaseId** | **
|
|
105
|
+
| **releaseId** | [**string**] | | defaults to undefined|
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
### Return type
|
|
@@ -142,7 +142,7 @@ import {
|
|
|
142
142
|
const configuration = new Configuration();
|
|
143
143
|
const apiInstance = new InternalApi(configuration);
|
|
144
144
|
|
|
145
|
-
let userId:
|
|
145
|
+
let userId: string; // (default to undefined)
|
|
146
146
|
|
|
147
147
|
const { status, data } = await apiInstance.deleteUserInternalUsersUserIdDelete(
|
|
148
148
|
userId
|
|
@@ -153,7 +153,7 @@ const { status, data } = await apiInstance.deleteUserInternalUsersUserIdDelete(
|
|
|
153
153
|
|
|
154
154
|
|Name | Type | Description | Notes|
|
|
155
155
|
|------------- | ------------- | ------------- | -------------|
|
|
156
|
-
| **userId** | **
|
|
156
|
+
| **userId** | [**string**] | | defaults to undefined|
|
|
157
157
|
|
|
158
158
|
|
|
159
159
|
### Return type
|
|
@@ -195,7 +195,7 @@ import {
|
|
|
195
195
|
const configuration = new Configuration();
|
|
196
196
|
const apiInstance = new InternalApi(configuration);
|
|
197
197
|
|
|
198
|
-
let releaseId:
|
|
198
|
+
let releaseId: string; // (default to undefined)
|
|
199
199
|
let releaseUpdateBody: ReleaseUpdateBody; //
|
|
200
200
|
|
|
201
201
|
const { status, data } = await apiInstance.editReleaseInternalReleasesReleaseIdPut(
|
|
@@ -209,7 +209,7 @@ const { status, data } = await apiInstance.editReleaseInternalReleasesReleaseIdP
|
|
|
209
209
|
|Name | Type | Description | Notes|
|
|
210
210
|
|------------- | ------------- | ------------- | -------------|
|
|
211
211
|
| **releaseUpdateBody** | **ReleaseUpdateBody**| | |
|
|
212
|
-
| **releaseId** | **
|
|
212
|
+
| **releaseId** | [**string**] | | defaults to undefined|
|
|
213
213
|
|
|
214
214
|
|
|
215
215
|
### Return type
|
|
@@ -249,7 +249,7 @@ import {
|
|
|
249
249
|
const configuration = new Configuration();
|
|
250
250
|
const apiInstance = new InternalApi(configuration);
|
|
251
251
|
|
|
252
|
-
let deviceId:
|
|
252
|
+
let deviceId: string; // (default to undefined)
|
|
253
253
|
|
|
254
254
|
const { status, data } = await apiInstance.getDeviceInfoInternalDevicesDeviceIdGet(
|
|
255
255
|
deviceId
|
|
@@ -260,7 +260,7 @@ const { status, data } = await apiInstance.getDeviceInfoInternalDevicesDeviceIdG
|
|
|
260
260
|
|
|
261
261
|
|Name | Type | Description | Notes|
|
|
262
262
|
|------------- | ------------- | ------------- | -------------|
|
|
263
|
-
| **deviceId** | **
|
|
263
|
+
| **deviceId** | [**string**] | | defaults to undefined|
|
|
264
264
|
|
|
265
265
|
|
|
266
266
|
### Return type
|
|
@@ -295,10 +295,7 @@ Get a paginated list of logs with optional filtering.
|
|
|
295
295
|
```typescript
|
|
296
296
|
import {
|
|
297
297
|
InternalApi,
|
|
298
|
-
Configuration
|
|
299
|
-
,
|
|
300
|
-
,
|
|
301
|
-
|
|
298
|
+
Configuration
|
|
302
299
|
} from '@orangefox-recovery/foxinternalclient';
|
|
303
300
|
|
|
304
301
|
const configuration = new Configuration();
|
|
@@ -306,9 +303,9 @@ const apiInstance = new InternalApi(configuration);
|
|
|
306
303
|
|
|
307
304
|
let page: number; // (optional) (default to 1)
|
|
308
305
|
let perPage: number; // (optional) (default to 20)
|
|
309
|
-
let deviceId: ; // (optional) (default to undefined)
|
|
310
|
-
let releaseId: ; // (optional) (default to undefined)
|
|
311
|
-
let userId: ; // (optional) (default to undefined)
|
|
306
|
+
let deviceId: string; // (optional) (default to undefined)
|
|
307
|
+
let releaseId: string; // (optional) (default to undefined)
|
|
308
|
+
let userId: string; // (optional) (default to undefined)
|
|
312
309
|
let hideVerbose: boolean; // (optional) (default to undefined)
|
|
313
310
|
|
|
314
311
|
const { status, data } = await apiInstance.getLogsInternalLogsGet(
|
|
@@ -327,9 +324,9 @@ const { status, data } = await apiInstance.getLogsInternalLogsGet(
|
|
|
327
324
|
|------------- | ------------- | ------------- | -------------|
|
|
328
325
|
| **page** | [**number**] | | (optional) defaults to 1|
|
|
329
326
|
| **perPage** | [**number**] | | (optional) defaults to 20|
|
|
330
|
-
| **deviceId** |
|
|
331
|
-
| **releaseId** |
|
|
332
|
-
| **userId** |
|
|
327
|
+
| **deviceId** | [**string**] | | (optional) defaults to undefined|
|
|
328
|
+
| **releaseId** | [**string**] | | (optional) defaults to undefined|
|
|
329
|
+
| **userId** | [**string**] | | (optional) defaults to undefined|
|
|
333
330
|
| **hideVerbose** | [**boolean**] | | (optional) defaults to undefined|
|
|
334
331
|
|
|
335
332
|
|
|
@@ -371,7 +368,7 @@ import {
|
|
|
371
368
|
const configuration = new Configuration();
|
|
372
369
|
const apiInstance = new InternalApi(configuration);
|
|
373
370
|
|
|
374
|
-
let releaseId:
|
|
371
|
+
let releaseId: string; // (default to undefined)
|
|
375
372
|
|
|
376
373
|
const { status, data } = await apiInstance.getReleaseInfoInternalReleasesReleaseIdGet(
|
|
377
374
|
releaseId
|
|
@@ -382,7 +379,7 @@ const { status, data } = await apiInstance.getReleaseInfoInternalReleasesRelease
|
|
|
382
379
|
|
|
383
380
|
|Name | Type | Description | Notes|
|
|
384
381
|
|------------- | ------------- | ------------- | -------------|
|
|
385
|
-
| **releaseId** | **
|
|
382
|
+
| **releaseId** | [**string**] | | defaults to undefined|
|
|
386
383
|
|
|
387
384
|
|
|
388
385
|
### Return type
|
|
@@ -423,7 +420,7 @@ import {
|
|
|
423
420
|
const configuration = new Configuration();
|
|
424
421
|
const apiInstance = new InternalApi(configuration);
|
|
425
422
|
|
|
426
|
-
let releaseId:
|
|
423
|
+
let releaseId: string; // (default to undefined)
|
|
427
424
|
|
|
428
425
|
const { status, data } = await apiInstance.getReleaseZipInternalReleasesReleaseIdDlGet(
|
|
429
426
|
releaseId
|
|
@@ -434,7 +431,7 @@ const { status, data } = await apiInstance.getReleaseZipInternalReleasesReleaseI
|
|
|
434
431
|
|
|
435
432
|
|Name | Type | Description | Notes|
|
|
436
433
|
|------------- | ------------- | ------------- | -------------|
|
|
437
|
-
| **releaseId** | **
|
|
434
|
+
| **releaseId** | [**string**] | | defaults to undefined|
|
|
438
435
|
|
|
439
436
|
|
|
440
437
|
### Return type
|
|
@@ -744,7 +741,7 @@ import {
|
|
|
744
741
|
const configuration = new Configuration();
|
|
745
742
|
const apiInstance = new InternalApi(configuration);
|
|
746
743
|
|
|
747
|
-
let deviceId:
|
|
744
|
+
let deviceId: string; // (default to undefined)
|
|
748
745
|
let releaseZip: File; // (default to undefined)
|
|
749
746
|
let md5: string; // (default to undefined)
|
|
750
747
|
let changelog: Array<string>; // (default to undefined)
|
|
@@ -767,7 +764,7 @@ const { status, data } = await apiInstance.newReleaseInternalReleasesPost(
|
|
|
767
764
|
|
|
768
765
|
|Name | Type | Description | Notes|
|
|
769
766
|
|------------- | ------------- | ------------- | -------------|
|
|
770
|
-
| **deviceId** | **
|
|
767
|
+
| **deviceId** | [**string**] | | defaults to undefined|
|
|
771
768
|
| **releaseZip** | [**File**] | | defaults to undefined|
|
|
772
769
|
| **md5** | [**string**] | | defaults to undefined|
|
|
773
770
|
| **changelog** | **Array<string>** | | defaults to undefined|
|
|
@@ -865,7 +862,7 @@ import {
|
|
|
865
862
|
const configuration = new Configuration();
|
|
866
863
|
const apiInstance = new InternalApi(configuration);
|
|
867
864
|
|
|
868
|
-
let deviceId:
|
|
865
|
+
let deviceId: string; // (default to undefined)
|
|
869
866
|
let deviceUpdateBody: DeviceUpdateBody; //
|
|
870
867
|
|
|
871
868
|
const { status, data } = await apiInstance.updateDeviceInternalDevicesDeviceIdPut(
|
|
@@ -879,7 +876,7 @@ const { status, data } = await apiInstance.updateDeviceInternalDevicesDeviceIdPu
|
|
|
879
876
|
|Name | Type | Description | Notes|
|
|
880
877
|
|------------- | ------------- | ------------- | -------------|
|
|
881
878
|
| **deviceUpdateBody** | **DeviceUpdateBody**| | |
|
|
882
|
-
| **deviceId** | **
|
|
879
|
+
| **deviceId** | [**string**] | | defaults to undefined|
|
|
883
880
|
|
|
884
881
|
|
|
885
882
|
### Return type
|
|
@@ -920,7 +917,7 @@ import {
|
|
|
920
917
|
const configuration = new Configuration();
|
|
921
918
|
const apiInstance = new InternalApi(configuration);
|
|
922
919
|
|
|
923
|
-
let userId:
|
|
920
|
+
let userId: string; // (default to undefined)
|
|
924
921
|
let userUpdateBody: UserUpdateBody; //
|
|
925
922
|
|
|
926
923
|
const { status, data } = await apiInstance.updateUserInternalUsersUserIdPut(
|
|
@@ -934,7 +931,7 @@ const { status, data } = await apiInstance.updateUserInternalUsersUserIdPut(
|
|
|
934
931
|
|Name | Type | Description | Notes|
|
|
935
932
|
|------------- | ------------- | ------------- | -------------|
|
|
936
933
|
| **userUpdateBody** | **UserUpdateBody**| | |
|
|
937
|
-
| **userId** | **
|
|
934
|
+
| **userId** | [**string**] | | defaults to undefined|
|
|
938
935
|
|
|
939
936
|
|
|
940
937
|
### Return type
|
package/docs/NewBuildTaskBody.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**device_id** | **
|
|
8
|
+
**device_id** | **string** | | [default to undefined]
|
|
9
9
|
**tree_branch** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**type** | [**ReleaseType**](ReleaseType.md) | | [optional] [default to undefined]
|
|
11
11
|
**variant** | **string** | | [optional] [default to 'default']
|
package/docs/NewDeviceBody.md
CHANGED
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**oem_name** | **string** | | [default to undefined]
|
|
9
9
|
**codenames** | **Array<string>** | | [default to undefined]
|
|
10
10
|
**model_names** | **Array<string>** | | [default to undefined]
|
|
11
|
-
**maintainer** | **
|
|
11
|
+
**maintainer** | **string** | | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/ReleaseApi.md
CHANGED
|
@@ -19,16 +19,14 @@ Extended get device method, including the ability to get a device using device c
|
|
|
19
19
|
```typescript
|
|
20
20
|
import {
|
|
21
21
|
ReleaseApi,
|
|
22
|
-
Configuration
|
|
23
|
-
,
|
|
24
|
-
|
|
22
|
+
Configuration
|
|
25
23
|
} from '@orangefox-recovery/foxinternalclient';
|
|
26
24
|
|
|
27
25
|
const configuration = new Configuration();
|
|
28
26
|
const apiInstance = new ReleaseApi(configuration);
|
|
29
27
|
|
|
30
|
-
let releaseId: ; //Release ID (optional) (default to undefined)
|
|
31
|
-
let id: ; //Release ID (deprecated) (optional) (default to undefined)
|
|
28
|
+
let releaseId: string; //Release ID (optional) (default to undefined)
|
|
29
|
+
let id: string; //Release ID (deprecated) (optional) (default to undefined)
|
|
32
30
|
let buildId: string; //Build ID, `ro.build.fox_id` prop (optional) (default to undefined)
|
|
33
31
|
let filename: string; // (optional) (default to undefined)
|
|
34
32
|
|
|
@@ -44,8 +42,8 @@ const { status, data } = await apiInstance.getRelease(
|
|
|
44
42
|
|
|
45
43
|
|Name | Type | Description | Notes|
|
|
46
44
|
|------------- | ------------- | ------------- | -------------|
|
|
47
|
-
| **releaseId** |
|
|
48
|
-
| **id** |
|
|
45
|
+
| **releaseId** | [**string**] | Release ID | (optional) defaults to undefined|
|
|
46
|
+
| **id** | [**string**] | Release ID (deprecated) | (optional) defaults to undefined|
|
|
49
47
|
| **buildId** | [**string**] | Build ID, `ro.build.fox_id` prop | (optional) defaults to undefined|
|
|
50
48
|
| **filename** | [**string**] | | (optional) defaults to undefined|
|
|
51
49
|
|
|
@@ -88,7 +86,7 @@ import {
|
|
|
88
86
|
const configuration = new Configuration();
|
|
89
87
|
const apiInstance = new ReleaseApi(configuration);
|
|
90
88
|
|
|
91
|
-
let releaseId:
|
|
89
|
+
let releaseId: string; // (default to undefined)
|
|
92
90
|
|
|
93
91
|
const { status, data } = await apiInstance.getReleaseDeprecated(
|
|
94
92
|
releaseId
|
|
@@ -99,7 +97,7 @@ const { status, data } = await apiInstance.getReleaseDeprecated(
|
|
|
99
97
|
|
|
100
98
|
|Name | Type | Description | Notes|
|
|
101
99
|
|------------- | ------------- | ------------- | -------------|
|
|
102
|
-
| **releaseId** | **
|
|
100
|
+
| **releaseId** | [**string**] | | defaults to undefined|
|
|
103
101
|
|
|
104
102
|
|
|
105
103
|
### Return type
|
|
@@ -134,24 +132,23 @@ Lists releases. This method contains a bunch of different parameters to filter
|
|
|
134
132
|
```typescript
|
|
135
133
|
import {
|
|
136
134
|
ReleaseApi,
|
|
137
|
-
Configuration
|
|
138
|
-
|
|
135
|
+
Configuration
|
|
139
136
|
} from '@orangefox-recovery/foxinternalclient';
|
|
140
137
|
|
|
141
138
|
const configuration = new Configuration();
|
|
142
139
|
const apiInstance = new ReleaseApi(configuration);
|
|
143
140
|
|
|
144
|
-
let id: Array<
|
|
145
|
-
let id2: Array<
|
|
141
|
+
let id: Array<string>; //Filter by Release IDs (optional) (default to undefined)
|
|
142
|
+
let id2: Array<string>; //Filter by Release IDs (deprecated) (optional) (default to undefined)
|
|
146
143
|
let buildId: Array<string>; //Filter by Build IDs (optional) (default to undefined)
|
|
147
|
-
let deviceId: Array<
|
|
148
|
-
let maintainerId: Array<
|
|
144
|
+
let deviceId: Array<string>; //Filter by Device IDs (optional) (default to undefined)
|
|
145
|
+
let maintainerId: Array<string>; //Filter by Maintainer IDs (optional) (default to undefined)
|
|
149
146
|
let codename: Array<string>; //Filter by device codenames (optional) (default to undefined)
|
|
150
147
|
let version: Array<string>; //Filter by release version (optional) (default to undefined)
|
|
151
148
|
let type: Array<ReleaseType>; //Filter by release type (optional) (default to undefined)
|
|
152
149
|
let archived: boolean; //Filter by the archived status (optional) (default to undefined)
|
|
153
150
|
let freezed: boolean; //Filter by the freezed status (optional) (default to undefined)
|
|
154
|
-
let afterReleaseId: ; //Show releases after the provided one (optional) (default to undefined)
|
|
151
|
+
let afterReleaseId: string; //Show releases after the provided one (optional) (default to undefined)
|
|
155
152
|
let afterDate: number; //Show releases after the provided timestamp (optional) (default to undefined)
|
|
156
153
|
let sort: ReleasesSort; //Sort mode (optional) (default to undefined)
|
|
157
154
|
let group: boolean; //Group releases by version + variant. This will change the response! (optional) (default to undefined)
|
|
@@ -182,17 +179,17 @@ const { status, data } = await apiInstance.getReleases(
|
|
|
182
179
|
|
|
183
180
|
|Name | Type | Description | Notes|
|
|
184
181
|
|------------- | ------------- | ------------- | -------------|
|
|
185
|
-
| **id** | **Array<
|
|
186
|
-
| **id2** | **Array<
|
|
182
|
+
| **id** | **Array<string>** | Filter by Release IDs | (optional) defaults to undefined|
|
|
183
|
+
| **id2** | **Array<string>** | Filter by Release IDs (deprecated) | (optional) defaults to undefined|
|
|
187
184
|
| **buildId** | **Array<string>** | Filter by Build IDs | (optional) defaults to undefined|
|
|
188
|
-
| **deviceId** | **Array<
|
|
189
|
-
| **maintainerId** | **Array<
|
|
185
|
+
| **deviceId** | **Array<string>** | Filter by Device IDs | (optional) defaults to undefined|
|
|
186
|
+
| **maintainerId** | **Array<string>** | Filter by Maintainer IDs | (optional) defaults to undefined|
|
|
190
187
|
| **codename** | **Array<string>** | Filter by device codenames | (optional) defaults to undefined|
|
|
191
188
|
| **version** | **Array<string>** | Filter by release version | (optional) defaults to undefined|
|
|
192
189
|
| **type** | **Array<ReleaseType>** | Filter by release type | (optional) defaults to undefined|
|
|
193
190
|
| **archived** | [**boolean**] | Filter by the archived status | (optional) defaults to undefined|
|
|
194
191
|
| **freezed** | [**boolean**] | Filter by the freezed status | (optional) defaults to undefined|
|
|
195
|
-
| **afterReleaseId** |
|
|
192
|
+
| **afterReleaseId** | [**string**] | Show releases after the provided one | (optional) defaults to undefined|
|
|
196
193
|
| **afterDate** | [**number**] | Show releases after the provided timestamp | (optional) defaults to undefined|
|
|
197
194
|
| **sort** | **ReleasesSort** | Sort mode | (optional) defaults to undefined|
|
|
198
195
|
| **group** | [**boolean**] | Group releases by version + variant. This will change the response! | (optional) defaults to undefined|
|
|
@@ -239,8 +236,8 @@ import {
|
|
|
239
236
|
const configuration = new Configuration();
|
|
240
237
|
const apiInstance = new ReleaseApi(configuration);
|
|
241
238
|
|
|
242
|
-
let lastKnownId:
|
|
243
|
-
let deviceId: Array<
|
|
239
|
+
let lastKnownId: string; // (default to undefined)
|
|
240
|
+
let deviceId: Array<string>; //Filter by device ID (optional) (default to undefined)
|
|
244
241
|
let type: Array<ReleaseType>; //Filter by release type (optional) (default to undefined)
|
|
245
242
|
let releaseType: Array<ReleaseType>; //Filter by release type (legacy) (optional) (default to undefined)
|
|
246
243
|
let skip: number; //Skip query results (optional) (default to undefined)
|
|
@@ -260,8 +257,8 @@ const { status, data } = await apiInstance.getUpdatesDeprecated(
|
|
|
260
257
|
|
|
261
258
|
|Name | Type | Description | Notes|
|
|
262
259
|
|------------- | ------------- | ------------- | -------------|
|
|
263
|
-
| **lastKnownId** | **
|
|
264
|
-
| **deviceId** | **Array<
|
|
260
|
+
| **lastKnownId** | [**string**] | | defaults to undefined|
|
|
261
|
+
| **deviceId** | **Array<string>** | Filter by device ID | (optional) defaults to undefined|
|
|
265
262
|
| **type** | **Array<ReleaseType>** | Filter by release type | (optional) defaults to undefined|
|
|
266
263
|
| **releaseType** | **Array<ReleaseType>** | Filter by release type (legacy) | (optional) defaults to undefined|
|
|
267
264
|
| **skip** | [**number**] | Skip query results | (optional) defaults to undefined|
|
package/index.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.2
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|