@orangefox-recovery/foxinternalclient 5.2.1 → 5.2.3
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 +281 -299
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +271 -271
- 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 +271 -271
- 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/docs/ReleaseInternalResponse.md +1 -1
- package/docs/ReleaseResponse.md +1 -1
- package/docs/ShortReleaseResponse.md +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.3
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -77,8 +77,8 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
77
77
|
/**
|
|
78
78
|
* Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
79
79
|
* @summary Get Device
|
|
80
|
-
* @param { | null} [deviceId]
|
|
81
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
80
|
+
* @param {string | null} [deviceId]
|
|
81
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
82
82
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
83
83
|
* @param {*} [options] Override http request option.
|
|
84
84
|
* @throws {RequiredError}
|
|
@@ -95,14 +95,10 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
95
95
|
const localVarHeaderParameter = {};
|
|
96
96
|
const localVarQueryParameter = {};
|
|
97
97
|
if (deviceId !== undefined) {
|
|
98
|
-
|
|
99
|
-
localVarQueryParameter[key] = value;
|
|
100
|
-
}
|
|
98
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
101
99
|
}
|
|
102
100
|
if (id !== undefined) {
|
|
103
|
-
|
|
104
|
-
localVarQueryParameter[key] = value;
|
|
105
|
-
}
|
|
101
|
+
localVarQueryParameter['_id'] = id;
|
|
106
102
|
}
|
|
107
103
|
if (codename !== undefined) {
|
|
108
104
|
localVarQueryParameter['codename'] = codename;
|
|
@@ -148,8 +144,8 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
148
144
|
/**
|
|
149
145
|
* Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
|
|
150
146
|
* @summary Get Devices
|
|
151
|
-
* @param {Array<
|
|
152
|
-
* @param {Array<
|
|
147
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
148
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
153
149
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
154
150
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
155
151
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -251,8 +247,8 @@ export const DeviceApiFp = function (configuration) {
|
|
|
251
247
|
/**
|
|
252
248
|
* Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
253
249
|
* @summary Get Device
|
|
254
|
-
* @param { | null} [deviceId]
|
|
255
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
250
|
+
* @param {string | null} [deviceId]
|
|
251
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
256
252
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
257
253
|
* @param {*} [options] Override http request option.
|
|
258
254
|
* @throws {RequiredError}
|
|
@@ -286,8 +282,8 @@ export const DeviceApiFp = function (configuration) {
|
|
|
286
282
|
/**
|
|
287
283
|
* Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
|
|
288
284
|
* @summary Get Devices
|
|
289
|
-
* @param {Array<
|
|
290
|
-
* @param {Array<
|
|
285
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
286
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
291
287
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
292
288
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
293
289
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -336,8 +332,8 @@ export const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
336
332
|
/**
|
|
337
333
|
* Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
338
334
|
* @summary Get Device
|
|
339
|
-
* @param { | null} [deviceId]
|
|
340
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
335
|
+
* @param {string | null} [deviceId]
|
|
336
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
341
337
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
342
338
|
* @param {*} [options] Override http request option.
|
|
343
339
|
* @throws {RequiredError}
|
|
@@ -359,8 +355,8 @@ export const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
359
355
|
/**
|
|
360
356
|
* Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
|
|
361
357
|
* @summary Get Devices
|
|
362
|
-
* @param {Array<
|
|
363
|
-
* @param {Array<
|
|
358
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
359
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
364
360
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
365
361
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
366
362
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -397,8 +393,8 @@ export class DeviceApi extends BaseAPI {
|
|
|
397
393
|
/**
|
|
398
394
|
* Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
399
395
|
* @summary Get Device
|
|
400
|
-
* @param { | null} [deviceId]
|
|
401
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
396
|
+
* @param {string | null} [deviceId]
|
|
397
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
402
398
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
403
399
|
* @param {*} [options] Override http request option.
|
|
404
400
|
* @throws {RequiredError}
|
|
@@ -422,8 +418,8 @@ export class DeviceApi extends BaseAPI {
|
|
|
422
418
|
/**
|
|
423
419
|
* Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
|
|
424
420
|
* @summary Get Devices
|
|
425
|
-
* @param {Array<
|
|
426
|
-
* @param {Array<
|
|
421
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
422
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
427
423
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
428
424
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
429
425
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -460,7 +456,7 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
460
456
|
/**
|
|
461
457
|
* Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
462
458
|
* @summary Cancel Task
|
|
463
|
-
* @param {
|
|
459
|
+
* @param {string} taskId
|
|
464
460
|
* @param {*} [options] Override http request option.
|
|
465
461
|
* @throws {RequiredError}
|
|
466
462
|
*/
|
|
@@ -489,7 +485,7 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
489
485
|
/**
|
|
490
486
|
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
491
487
|
* @summary Delete Task
|
|
492
|
-
* @param {
|
|
488
|
+
* @param {string} taskId
|
|
493
489
|
* @param {*} [options] Override http request option.
|
|
494
490
|
* @throws {RequiredError}
|
|
495
491
|
*/
|
|
@@ -543,7 +539,7 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
543
539
|
/**
|
|
544
540
|
* Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
|
|
545
541
|
* @summary Get Task
|
|
546
|
-
* @param {
|
|
542
|
+
* @param {string} taskId
|
|
547
543
|
* @param {*} [options] Override http request option.
|
|
548
544
|
* @throws {RequiredError}
|
|
549
545
|
*/
|
|
@@ -572,7 +568,7 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
572
568
|
/**
|
|
573
569
|
* Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
|
|
574
570
|
* @summary List Tasks
|
|
575
|
-
* @param { | null} [deviceId]
|
|
571
|
+
* @param {string | null} [deviceId]
|
|
576
572
|
* @param {*} [options] Override http request option.
|
|
577
573
|
* @throws {RequiredError}
|
|
578
574
|
*/
|
|
@@ -588,9 +584,7 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
588
584
|
const localVarHeaderParameter = {};
|
|
589
585
|
const localVarQueryParameter = {};
|
|
590
586
|
if (deviceId !== undefined) {
|
|
591
|
-
|
|
592
|
-
localVarQueryParameter[key] = value;
|
|
593
|
-
}
|
|
587
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
594
588
|
}
|
|
595
589
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
596
590
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -633,7 +627,7 @@ export const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
633
627
|
/**
|
|
634
628
|
* Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated. Allowed only for foxworker users.
|
|
635
629
|
* @summary Update Task
|
|
636
|
-
* @param {
|
|
630
|
+
* @param {string} taskId
|
|
637
631
|
* @param {TaskUpdateBody} taskUpdateBody
|
|
638
632
|
* @param {*} [options] Override http request option.
|
|
639
633
|
* @throws {RequiredError}
|
|
@@ -676,7 +670,7 @@ export const FoxFactoryApiFp = function (configuration) {
|
|
|
676
670
|
/**
|
|
677
671
|
* Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
678
672
|
* @summary Cancel Task
|
|
679
|
-
* @param {
|
|
673
|
+
* @param {string} taskId
|
|
680
674
|
* @param {*} [options] Override http request option.
|
|
681
675
|
* @throws {RequiredError}
|
|
682
676
|
*/
|
|
@@ -692,7 +686,7 @@ export const FoxFactoryApiFp = function (configuration) {
|
|
|
692
686
|
/**
|
|
693
687
|
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
694
688
|
* @summary Delete Task
|
|
695
|
-
* @param {
|
|
689
|
+
* @param {string} taskId
|
|
696
690
|
* @param {*} [options] Override http request option.
|
|
697
691
|
* @throws {RequiredError}
|
|
698
692
|
*/
|
|
@@ -723,7 +717,7 @@ export const FoxFactoryApiFp = function (configuration) {
|
|
|
723
717
|
/**
|
|
724
718
|
* Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
|
|
725
719
|
* @summary Get Task
|
|
726
|
-
* @param {
|
|
720
|
+
* @param {string} taskId
|
|
727
721
|
* @param {*} [options] Override http request option.
|
|
728
722
|
* @throws {RequiredError}
|
|
729
723
|
*/
|
|
@@ -739,7 +733,7 @@ export const FoxFactoryApiFp = function (configuration) {
|
|
|
739
733
|
/**
|
|
740
734
|
* Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
|
|
741
735
|
* @summary List Tasks
|
|
742
|
-
* @param { | null} [deviceId]
|
|
736
|
+
* @param {string | null} [deviceId]
|
|
743
737
|
* @param {*} [options] Override http request option.
|
|
744
738
|
* @throws {RequiredError}
|
|
745
739
|
*/
|
|
@@ -771,7 +765,7 @@ export const FoxFactoryApiFp = function (configuration) {
|
|
|
771
765
|
/**
|
|
772
766
|
* Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated. Allowed only for foxworker users.
|
|
773
767
|
* @summary Update Task
|
|
774
|
-
* @param {
|
|
768
|
+
* @param {string} taskId
|
|
775
769
|
* @param {TaskUpdateBody} taskUpdateBody
|
|
776
770
|
* @param {*} [options] Override http request option.
|
|
777
771
|
* @throws {RequiredError}
|
|
@@ -797,7 +791,7 @@ export const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
797
791
|
/**
|
|
798
792
|
* Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
799
793
|
* @summary Cancel Task
|
|
800
|
-
* @param {
|
|
794
|
+
* @param {string} taskId
|
|
801
795
|
* @param {*} [options] Override http request option.
|
|
802
796
|
* @throws {RequiredError}
|
|
803
797
|
*/
|
|
@@ -807,7 +801,7 @@ export const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
807
801
|
/**
|
|
808
802
|
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
809
803
|
* @summary Delete Task
|
|
810
|
-
* @param {
|
|
804
|
+
* @param {string} taskId
|
|
811
805
|
* @param {*} [options] Override http request option.
|
|
812
806
|
* @throws {RequiredError}
|
|
813
807
|
*/
|
|
@@ -826,7 +820,7 @@ export const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
826
820
|
/**
|
|
827
821
|
* Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
|
|
828
822
|
* @summary Get Task
|
|
829
|
-
* @param {
|
|
823
|
+
* @param {string} taskId
|
|
830
824
|
* @param {*} [options] Override http request option.
|
|
831
825
|
* @throws {RequiredError}
|
|
832
826
|
*/
|
|
@@ -836,7 +830,7 @@ export const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
836
830
|
/**
|
|
837
831
|
* Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
|
|
838
832
|
* @summary List Tasks
|
|
839
|
-
* @param { | null} [deviceId]
|
|
833
|
+
* @param {string | null} [deviceId]
|
|
840
834
|
* @param {*} [options] Override http request option.
|
|
841
835
|
* @throws {RequiredError}
|
|
842
836
|
*/
|
|
@@ -856,7 +850,7 @@ export const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
856
850
|
/**
|
|
857
851
|
* Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated. Allowed only for foxworker users.
|
|
858
852
|
* @summary Update Task
|
|
859
|
-
* @param {
|
|
853
|
+
* @param {string} taskId
|
|
860
854
|
* @param {TaskUpdateBody} taskUpdateBody
|
|
861
855
|
* @param {*} [options] Override http request option.
|
|
862
856
|
* @throws {RequiredError}
|
|
@@ -876,7 +870,7 @@ export class FoxFactoryApi extends BaseAPI {
|
|
|
876
870
|
/**
|
|
877
871
|
* Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
878
872
|
* @summary Cancel Task
|
|
879
|
-
* @param {
|
|
873
|
+
* @param {string} taskId
|
|
880
874
|
* @param {*} [options] Override http request option.
|
|
881
875
|
* @throws {RequiredError}
|
|
882
876
|
* @memberof FoxFactoryApi
|
|
@@ -887,7 +881,7 @@ export class FoxFactoryApi extends BaseAPI {
|
|
|
887
881
|
/**
|
|
888
882
|
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
889
883
|
* @summary Delete Task
|
|
890
|
-
* @param {
|
|
884
|
+
* @param {string} taskId
|
|
891
885
|
* @param {*} [options] Override http request option.
|
|
892
886
|
* @throws {RequiredError}
|
|
893
887
|
* @memberof FoxFactoryApi
|
|
@@ -908,7 +902,7 @@ export class FoxFactoryApi extends BaseAPI {
|
|
|
908
902
|
/**
|
|
909
903
|
* Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
|
|
910
904
|
* @summary Get Task
|
|
911
|
-
* @param {
|
|
905
|
+
* @param {string} taskId
|
|
912
906
|
* @param {*} [options] Override http request option.
|
|
913
907
|
* @throws {RequiredError}
|
|
914
908
|
* @memberof FoxFactoryApi
|
|
@@ -919,7 +913,7 @@ export class FoxFactoryApi extends BaseAPI {
|
|
|
919
913
|
/**
|
|
920
914
|
* Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
|
|
921
915
|
* @summary List Tasks
|
|
922
|
-
* @param { | null} [deviceId]
|
|
916
|
+
* @param {string | null} [deviceId]
|
|
923
917
|
* @param {*} [options] Override http request option.
|
|
924
918
|
* @throws {RequiredError}
|
|
925
919
|
* @memberof FoxFactoryApi
|
|
@@ -941,7 +935,7 @@ export class FoxFactoryApi extends BaseAPI {
|
|
|
941
935
|
/**
|
|
942
936
|
* Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated. Allowed only for foxworker users.
|
|
943
937
|
* @summary Update Task
|
|
944
|
-
* @param {
|
|
938
|
+
* @param {string} taskId
|
|
945
939
|
* @param {TaskUpdateBody} taskUpdateBody
|
|
946
940
|
* @param {*} [options] Override http request option.
|
|
947
941
|
* @throws {RequiredError}
|
|
@@ -1099,7 +1093,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1099
1093
|
/**
|
|
1100
1094
|
* Delete release
|
|
1101
1095
|
* @summary Del Release
|
|
1102
|
-
* @param {
|
|
1096
|
+
* @param {string} releaseId
|
|
1103
1097
|
* @param {*} [options] Override http request option.
|
|
1104
1098
|
* @throws {RequiredError}
|
|
1105
1099
|
*/
|
|
@@ -1134,7 +1128,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1134
1128
|
/**
|
|
1135
1129
|
*
|
|
1136
1130
|
* @summary Delete User
|
|
1137
|
-
* @param {
|
|
1131
|
+
* @param {string} userId
|
|
1138
1132
|
* @param {*} [options] Override http request option.
|
|
1139
1133
|
* @throws {RequiredError}
|
|
1140
1134
|
*/
|
|
@@ -1169,7 +1163,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1169
1163
|
/**
|
|
1170
1164
|
* Edit Release information
|
|
1171
1165
|
* @summary Edit Release
|
|
1172
|
-
* @param {
|
|
1166
|
+
* @param {string} releaseId
|
|
1173
1167
|
* @param {ReleaseUpdateBody} releaseUpdateBody
|
|
1174
1168
|
* @param {*} [options] Override http request option.
|
|
1175
1169
|
* @throws {RequiredError}
|
|
@@ -1209,7 +1203,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1209
1203
|
/**
|
|
1210
1204
|
*
|
|
1211
1205
|
* @summary Get Device Info
|
|
1212
|
-
* @param {
|
|
1206
|
+
* @param {string} deviceId
|
|
1213
1207
|
* @param {*} [options] Override http request option.
|
|
1214
1208
|
* @throws {RequiredError}
|
|
1215
1209
|
*/
|
|
@@ -1246,9 +1240,9 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1246
1240
|
* @summary Get Logs
|
|
1247
1241
|
* @param {number} [page]
|
|
1248
1242
|
* @param {number} [perPage]
|
|
1249
|
-
* @param { | null} [deviceId]
|
|
1250
|
-
* @param { | null} [releaseId]
|
|
1251
|
-
* @param { | null} [userId]
|
|
1243
|
+
* @param {string | null} [deviceId]
|
|
1244
|
+
* @param {string | null} [releaseId]
|
|
1245
|
+
* @param {string | null} [userId]
|
|
1252
1246
|
* @param {boolean | null} [hideVerbose]
|
|
1253
1247
|
* @param {*} [options] Override http request option.
|
|
1254
1248
|
* @throws {RequiredError}
|
|
@@ -1277,19 +1271,13 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1277
1271
|
localVarQueryParameter['per_page'] = perPage;
|
|
1278
1272
|
}
|
|
1279
1273
|
if (deviceId !== undefined) {
|
|
1280
|
-
|
|
1281
|
-
localVarQueryParameter[key] = value;
|
|
1282
|
-
}
|
|
1274
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
1283
1275
|
}
|
|
1284
1276
|
if (releaseId !== undefined) {
|
|
1285
|
-
|
|
1286
|
-
localVarQueryParameter[key] = value;
|
|
1287
|
-
}
|
|
1277
|
+
localVarQueryParameter['release_id'] = releaseId;
|
|
1288
1278
|
}
|
|
1289
1279
|
if (userId !== undefined) {
|
|
1290
|
-
|
|
1291
|
-
localVarQueryParameter[key] = value;
|
|
1292
|
-
}
|
|
1280
|
+
localVarQueryParameter['user_id'] = userId;
|
|
1293
1281
|
}
|
|
1294
1282
|
if (hideVerbose !== undefined) {
|
|
1295
1283
|
localVarQueryParameter['hide_verbose'] = hideVerbose;
|
|
@@ -1305,7 +1293,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1305
1293
|
/**
|
|
1306
1294
|
* Get release information
|
|
1307
1295
|
* @summary Get Release Info
|
|
1308
|
-
* @param {
|
|
1296
|
+
* @param {string} releaseId
|
|
1309
1297
|
* @param {*} [options] Override http request option.
|
|
1310
1298
|
* @throws {RequiredError}
|
|
1311
1299
|
*/
|
|
@@ -1340,7 +1328,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1340
1328
|
/**
|
|
1341
1329
|
* Download release ZIP directly
|
|
1342
1330
|
* @summary Get Release Zip
|
|
1343
|
-
* @param {
|
|
1331
|
+
* @param {string} releaseId
|
|
1344
1332
|
* @param {*} [options] Override http request option.
|
|
1345
1333
|
* @throws {RequiredError}
|
|
1346
1334
|
*/
|
|
@@ -1583,7 +1571,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1583
1571
|
/**
|
|
1584
1572
|
*
|
|
1585
1573
|
* @summary New Release
|
|
1586
|
-
* @param {
|
|
1574
|
+
* @param {string} deviceId
|
|
1587
1575
|
* @param {File} releaseZip
|
|
1588
1576
|
* @param {string} md5
|
|
1589
1577
|
* @param {Array<string>} changelog
|
|
@@ -1620,7 +1608,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1620
1608
|
// http bearer authentication required
|
|
1621
1609
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
1622
1610
|
if (deviceId !== undefined) {
|
|
1623
|
-
localVarFormParams.append('device_id',
|
|
1611
|
+
localVarFormParams.append('device_id', deviceId);
|
|
1624
1612
|
}
|
|
1625
1613
|
if (releaseZip !== undefined) {
|
|
1626
1614
|
localVarFormParams.append('release_zip', releaseZip);
|
|
@@ -1689,7 +1677,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1689
1677
|
/**
|
|
1690
1678
|
*
|
|
1691
1679
|
* @summary Update Device
|
|
1692
|
-
* @param {
|
|
1680
|
+
* @param {string} deviceId
|
|
1693
1681
|
* @param {DeviceUpdateBody} deviceUpdateBody
|
|
1694
1682
|
* @param {*} [options] Override http request option.
|
|
1695
1683
|
* @throws {RequiredError}
|
|
@@ -1729,7 +1717,7 @@ export const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1729
1717
|
/**
|
|
1730
1718
|
*
|
|
1731
1719
|
* @summary Update User
|
|
1732
|
-
* @param {
|
|
1720
|
+
* @param {string} userId
|
|
1733
1721
|
* @param {UserUpdateBody} userUpdateBody
|
|
1734
1722
|
* @param {*} [options] Override http request option.
|
|
1735
1723
|
* @throws {RequiredError}
|
|
@@ -1794,7 +1782,7 @@ export const InternalApiFp = function (configuration) {
|
|
|
1794
1782
|
/**
|
|
1795
1783
|
* Delete release
|
|
1796
1784
|
* @summary Del Release
|
|
1797
|
-
* @param {
|
|
1785
|
+
* @param {string} releaseId
|
|
1798
1786
|
* @param {*} [options] Override http request option.
|
|
1799
1787
|
* @throws {RequiredError}
|
|
1800
1788
|
*/
|
|
@@ -1810,7 +1798,7 @@ export const InternalApiFp = function (configuration) {
|
|
|
1810
1798
|
/**
|
|
1811
1799
|
*
|
|
1812
1800
|
* @summary Delete User
|
|
1813
|
-
* @param {
|
|
1801
|
+
* @param {string} userId
|
|
1814
1802
|
* @param {*} [options] Override http request option.
|
|
1815
1803
|
* @throws {RequiredError}
|
|
1816
1804
|
*/
|
|
@@ -1826,7 +1814,7 @@ export const InternalApiFp = function (configuration) {
|
|
|
1826
1814
|
/**
|
|
1827
1815
|
* Edit Release information
|
|
1828
1816
|
* @summary Edit Release
|
|
1829
|
-
* @param {
|
|
1817
|
+
* @param {string} releaseId
|
|
1830
1818
|
* @param {ReleaseUpdateBody} releaseUpdateBody
|
|
1831
1819
|
* @param {*} [options] Override http request option.
|
|
1832
1820
|
* @throws {RequiredError}
|
|
@@ -1843,7 +1831,7 @@ export const InternalApiFp = function (configuration) {
|
|
|
1843
1831
|
/**
|
|
1844
1832
|
*
|
|
1845
1833
|
* @summary Get Device Info
|
|
1846
|
-
* @param {
|
|
1834
|
+
* @param {string} deviceId
|
|
1847
1835
|
* @param {*} [options] Override http request option.
|
|
1848
1836
|
* @throws {RequiredError}
|
|
1849
1837
|
*/
|
|
@@ -1861,9 +1849,9 @@ export const InternalApiFp = function (configuration) {
|
|
|
1861
1849
|
* @summary Get Logs
|
|
1862
1850
|
* @param {number} [page]
|
|
1863
1851
|
* @param {number} [perPage]
|
|
1864
|
-
* @param { | null} [deviceId]
|
|
1865
|
-
* @param { | null} [releaseId]
|
|
1866
|
-
* @param { | null} [userId]
|
|
1852
|
+
* @param {string | null} [deviceId]
|
|
1853
|
+
* @param {string | null} [releaseId]
|
|
1854
|
+
* @param {string | null} [userId]
|
|
1867
1855
|
* @param {boolean | null} [hideVerbose]
|
|
1868
1856
|
* @param {*} [options] Override http request option.
|
|
1869
1857
|
* @throws {RequiredError}
|
|
@@ -1880,7 +1868,7 @@ export const InternalApiFp = function (configuration) {
|
|
|
1880
1868
|
/**
|
|
1881
1869
|
* Get release information
|
|
1882
1870
|
* @summary Get Release Info
|
|
1883
|
-
* @param {
|
|
1871
|
+
* @param {string} releaseId
|
|
1884
1872
|
* @param {*} [options] Override http request option.
|
|
1885
1873
|
* @throws {RequiredError}
|
|
1886
1874
|
*/
|
|
@@ -1896,7 +1884,7 @@ export const InternalApiFp = function (configuration) {
|
|
|
1896
1884
|
/**
|
|
1897
1885
|
* Download release ZIP directly
|
|
1898
1886
|
* @summary Get Release Zip
|
|
1899
|
-
* @param {
|
|
1887
|
+
* @param {string} releaseId
|
|
1900
1888
|
* @param {*} [options] Override http request option.
|
|
1901
1889
|
* @throws {RequiredError}
|
|
1902
1890
|
*/
|
|
@@ -1998,7 +1986,7 @@ export const InternalApiFp = function (configuration) {
|
|
|
1998
1986
|
/**
|
|
1999
1987
|
*
|
|
2000
1988
|
* @summary New Release
|
|
2001
|
-
* @param {
|
|
1989
|
+
* @param {string} deviceId
|
|
2002
1990
|
* @param {File} releaseZip
|
|
2003
1991
|
* @param {string} md5
|
|
2004
1992
|
* @param {Array<string>} changelog
|
|
@@ -2036,7 +2024,7 @@ export const InternalApiFp = function (configuration) {
|
|
|
2036
2024
|
/**
|
|
2037
2025
|
*
|
|
2038
2026
|
* @summary Update Device
|
|
2039
|
-
* @param {
|
|
2027
|
+
* @param {string} deviceId
|
|
2040
2028
|
* @param {DeviceUpdateBody} deviceUpdateBody
|
|
2041
2029
|
* @param {*} [options] Override http request option.
|
|
2042
2030
|
* @throws {RequiredError}
|
|
@@ -2053,7 +2041,7 @@ export const InternalApiFp = function (configuration) {
|
|
|
2053
2041
|
/**
|
|
2054
2042
|
*
|
|
2055
2043
|
* @summary Update User
|
|
2056
|
-
* @param {
|
|
2044
|
+
* @param {string} userId
|
|
2057
2045
|
* @param {UserUpdateBody} userUpdateBody
|
|
2058
2046
|
* @param {*} [options] Override http request option.
|
|
2059
2047
|
* @throws {RequiredError}
|
|
@@ -2089,7 +2077,7 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2089
2077
|
/**
|
|
2090
2078
|
* Delete release
|
|
2091
2079
|
* @summary Del Release
|
|
2092
|
-
* @param {
|
|
2080
|
+
* @param {string} releaseId
|
|
2093
2081
|
* @param {*} [options] Override http request option.
|
|
2094
2082
|
* @throws {RequiredError}
|
|
2095
2083
|
*/
|
|
@@ -2099,7 +2087,7 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2099
2087
|
/**
|
|
2100
2088
|
*
|
|
2101
2089
|
* @summary Delete User
|
|
2102
|
-
* @param {
|
|
2090
|
+
* @param {string} userId
|
|
2103
2091
|
* @param {*} [options] Override http request option.
|
|
2104
2092
|
* @throws {RequiredError}
|
|
2105
2093
|
*/
|
|
@@ -2109,7 +2097,7 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2109
2097
|
/**
|
|
2110
2098
|
* Edit Release information
|
|
2111
2099
|
* @summary Edit Release
|
|
2112
|
-
* @param {
|
|
2100
|
+
* @param {string} releaseId
|
|
2113
2101
|
* @param {ReleaseUpdateBody} releaseUpdateBody
|
|
2114
2102
|
* @param {*} [options] Override http request option.
|
|
2115
2103
|
* @throws {RequiredError}
|
|
@@ -2120,7 +2108,7 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2120
2108
|
/**
|
|
2121
2109
|
*
|
|
2122
2110
|
* @summary Get Device Info
|
|
2123
|
-
* @param {
|
|
2111
|
+
* @param {string} deviceId
|
|
2124
2112
|
* @param {*} [options] Override http request option.
|
|
2125
2113
|
* @throws {RequiredError}
|
|
2126
2114
|
*/
|
|
@@ -2132,9 +2120,9 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2132
2120
|
* @summary Get Logs
|
|
2133
2121
|
* @param {number} [page]
|
|
2134
2122
|
* @param {number} [perPage]
|
|
2135
|
-
* @param { | null} [deviceId]
|
|
2136
|
-
* @param { | null} [releaseId]
|
|
2137
|
-
* @param { | null} [userId]
|
|
2123
|
+
* @param {string | null} [deviceId]
|
|
2124
|
+
* @param {string | null} [releaseId]
|
|
2125
|
+
* @param {string | null} [userId]
|
|
2138
2126
|
* @param {boolean | null} [hideVerbose]
|
|
2139
2127
|
* @param {*} [options] Override http request option.
|
|
2140
2128
|
* @throws {RequiredError}
|
|
@@ -2145,7 +2133,7 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2145
2133
|
/**
|
|
2146
2134
|
* Get release information
|
|
2147
2135
|
* @summary Get Release Info
|
|
2148
|
-
* @param {
|
|
2136
|
+
* @param {string} releaseId
|
|
2149
2137
|
* @param {*} [options] Override http request option.
|
|
2150
2138
|
* @throws {RequiredError}
|
|
2151
2139
|
*/
|
|
@@ -2155,7 +2143,7 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2155
2143
|
/**
|
|
2156
2144
|
* Download release ZIP directly
|
|
2157
2145
|
* @summary Get Release Zip
|
|
2158
|
-
* @param {
|
|
2146
|
+
* @param {string} releaseId
|
|
2159
2147
|
* @param {*} [options] Override http request option.
|
|
2160
2148
|
* @throws {RequiredError}
|
|
2161
2149
|
*/
|
|
@@ -2221,7 +2209,7 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2221
2209
|
/**
|
|
2222
2210
|
*
|
|
2223
2211
|
* @summary New Release
|
|
2224
|
-
* @param {
|
|
2212
|
+
* @param {string} deviceId
|
|
2225
2213
|
* @param {File} releaseZip
|
|
2226
2214
|
* @param {string} md5
|
|
2227
2215
|
* @param {Array<string>} changelog
|
|
@@ -2247,7 +2235,7 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2247
2235
|
/**
|
|
2248
2236
|
*
|
|
2249
2237
|
* @summary Update Device
|
|
2250
|
-
* @param {
|
|
2238
|
+
* @param {string} deviceId
|
|
2251
2239
|
* @param {DeviceUpdateBody} deviceUpdateBody
|
|
2252
2240
|
* @param {*} [options] Override http request option.
|
|
2253
2241
|
* @throws {RequiredError}
|
|
@@ -2258,7 +2246,7 @@ export const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2258
2246
|
/**
|
|
2259
2247
|
*
|
|
2260
2248
|
* @summary Update User
|
|
2261
|
-
* @param {
|
|
2249
|
+
* @param {string} userId
|
|
2262
2250
|
* @param {UserUpdateBody} userUpdateBody
|
|
2263
2251
|
* @param {*} [options] Override http request option.
|
|
2264
2252
|
* @throws {RequiredError}
|
|
@@ -2289,7 +2277,7 @@ export class InternalApi extends BaseAPI {
|
|
|
2289
2277
|
/**
|
|
2290
2278
|
* Delete release
|
|
2291
2279
|
* @summary Del Release
|
|
2292
|
-
* @param {
|
|
2280
|
+
* @param {string} releaseId
|
|
2293
2281
|
* @param {*} [options] Override http request option.
|
|
2294
2282
|
* @throws {RequiredError}
|
|
2295
2283
|
* @memberof InternalApi
|
|
@@ -2300,7 +2288,7 @@ export class InternalApi extends BaseAPI {
|
|
|
2300
2288
|
/**
|
|
2301
2289
|
*
|
|
2302
2290
|
* @summary Delete User
|
|
2303
|
-
* @param {
|
|
2291
|
+
* @param {string} userId
|
|
2304
2292
|
* @param {*} [options] Override http request option.
|
|
2305
2293
|
* @throws {RequiredError}
|
|
2306
2294
|
* @memberof InternalApi
|
|
@@ -2311,7 +2299,7 @@ export class InternalApi extends BaseAPI {
|
|
|
2311
2299
|
/**
|
|
2312
2300
|
* Edit Release information
|
|
2313
2301
|
* @summary Edit Release
|
|
2314
|
-
* @param {
|
|
2302
|
+
* @param {string} releaseId
|
|
2315
2303
|
* @param {ReleaseUpdateBody} releaseUpdateBody
|
|
2316
2304
|
* @param {*} [options] Override http request option.
|
|
2317
2305
|
* @throws {RequiredError}
|
|
@@ -2323,7 +2311,7 @@ export class InternalApi extends BaseAPI {
|
|
|
2323
2311
|
/**
|
|
2324
2312
|
*
|
|
2325
2313
|
* @summary Get Device Info
|
|
2326
|
-
* @param {
|
|
2314
|
+
* @param {string} deviceId
|
|
2327
2315
|
* @param {*} [options] Override http request option.
|
|
2328
2316
|
* @throws {RequiredError}
|
|
2329
2317
|
* @memberof InternalApi
|
|
@@ -2336,9 +2324,9 @@ export class InternalApi extends BaseAPI {
|
|
|
2336
2324
|
* @summary Get Logs
|
|
2337
2325
|
* @param {number} [page]
|
|
2338
2326
|
* @param {number} [perPage]
|
|
2339
|
-
* @param { | null} [deviceId]
|
|
2340
|
-
* @param { | null} [releaseId]
|
|
2341
|
-
* @param { | null} [userId]
|
|
2327
|
+
* @param {string | null} [deviceId]
|
|
2328
|
+
* @param {string | null} [releaseId]
|
|
2329
|
+
* @param {string | null} [userId]
|
|
2342
2330
|
* @param {boolean | null} [hideVerbose]
|
|
2343
2331
|
* @param {*} [options] Override http request option.
|
|
2344
2332
|
* @throws {RequiredError}
|
|
@@ -2350,7 +2338,7 @@ export class InternalApi extends BaseAPI {
|
|
|
2350
2338
|
/**
|
|
2351
2339
|
* Get release information
|
|
2352
2340
|
* @summary Get Release Info
|
|
2353
|
-
* @param {
|
|
2341
|
+
* @param {string} releaseId
|
|
2354
2342
|
* @param {*} [options] Override http request option.
|
|
2355
2343
|
* @throws {RequiredError}
|
|
2356
2344
|
* @memberof InternalApi
|
|
@@ -2361,7 +2349,7 @@ export class InternalApi extends BaseAPI {
|
|
|
2361
2349
|
/**
|
|
2362
2350
|
* Download release ZIP directly
|
|
2363
2351
|
* @summary Get Release Zip
|
|
2364
|
-
* @param {
|
|
2352
|
+
* @param {string} releaseId
|
|
2365
2353
|
* @param {*} [options] Override http request option.
|
|
2366
2354
|
* @throws {RequiredError}
|
|
2367
2355
|
* @memberof InternalApi
|
|
@@ -2433,7 +2421,7 @@ export class InternalApi extends BaseAPI {
|
|
|
2433
2421
|
/**
|
|
2434
2422
|
*
|
|
2435
2423
|
* @summary New Release
|
|
2436
|
-
* @param {
|
|
2424
|
+
* @param {string} deviceId
|
|
2437
2425
|
* @param {File} releaseZip
|
|
2438
2426
|
* @param {string} md5
|
|
2439
2427
|
* @param {Array<string>} changelog
|
|
@@ -2461,7 +2449,7 @@ export class InternalApi extends BaseAPI {
|
|
|
2461
2449
|
/**
|
|
2462
2450
|
*
|
|
2463
2451
|
* @summary Update Device
|
|
2464
|
-
* @param {
|
|
2452
|
+
* @param {string} deviceId
|
|
2465
2453
|
* @param {DeviceUpdateBody} deviceUpdateBody
|
|
2466
2454
|
* @param {*} [options] Override http request option.
|
|
2467
2455
|
* @throws {RequiredError}
|
|
@@ -2473,7 +2461,7 @@ export class InternalApi extends BaseAPI {
|
|
|
2473
2461
|
/**
|
|
2474
2462
|
*
|
|
2475
2463
|
* @summary Update User
|
|
2476
|
-
* @param {
|
|
2464
|
+
* @param {string} userId
|
|
2477
2465
|
* @param {UserUpdateBody} userUpdateBody
|
|
2478
2466
|
* @param {*} [options] Override http request option.
|
|
2479
2467
|
* @throws {RequiredError}
|
|
@@ -2492,8 +2480,8 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2492
2480
|
/**
|
|
2493
2481
|
* Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
|
|
2494
2482
|
* @summary Get Release
|
|
2495
|
-
* @param { | null} [releaseId] Release ID
|
|
2496
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
2483
|
+
* @param {string | null} [releaseId] Release ID
|
|
2484
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
2497
2485
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
2498
2486
|
* @param {string | null} [filename]
|
|
2499
2487
|
* @param {*} [options] Override http request option.
|
|
@@ -2511,14 +2499,10 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2511
2499
|
const localVarHeaderParameter = {};
|
|
2512
2500
|
const localVarQueryParameter = {};
|
|
2513
2501
|
if (releaseId !== undefined) {
|
|
2514
|
-
|
|
2515
|
-
localVarQueryParameter[key] = value;
|
|
2516
|
-
}
|
|
2502
|
+
localVarQueryParameter['release_id'] = releaseId;
|
|
2517
2503
|
}
|
|
2518
2504
|
if (id !== undefined) {
|
|
2519
|
-
|
|
2520
|
-
localVarQueryParameter[key] = value;
|
|
2521
|
-
}
|
|
2505
|
+
localVarQueryParameter['_id'] = id;
|
|
2522
2506
|
}
|
|
2523
2507
|
if (buildId !== undefined) {
|
|
2524
2508
|
localVarQueryParameter['build_id'] = buildId;
|
|
@@ -2537,7 +2521,7 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2537
2521
|
/**
|
|
2538
2522
|
* Gets release information using the release ID, nothing to discuss really.
|
|
2539
2523
|
* @summary Get Release Short
|
|
2540
|
-
* @param {
|
|
2524
|
+
* @param {string} releaseId
|
|
2541
2525
|
* @param {*} [options] Override http request option.
|
|
2542
2526
|
* @deprecated
|
|
2543
2527
|
* @throws {RequiredError}
|
|
@@ -2567,17 +2551,17 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2567
2551
|
/**
|
|
2568
2552
|
* Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
|
|
2569
2553
|
* @summary Get Releases
|
|
2570
|
-
* @param {Array<
|
|
2571
|
-
* @param {Array<
|
|
2554
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
2555
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
2572
2556
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
2573
|
-
* @param {Array<
|
|
2574
|
-
* @param {Array<
|
|
2557
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
2558
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
2575
2559
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
2576
2560
|
* @param {Array<string>} [version] Filter by release version
|
|
2577
2561
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2578
2562
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
2579
2563
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
2580
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
2564
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
2581
2565
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
2582
2566
|
* @param {ReleasesSort} [sort] Sort mode
|
|
2583
2567
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -2628,9 +2612,7 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2628
2612
|
localVarQueryParameter['freezed'] = freezed;
|
|
2629
2613
|
}
|
|
2630
2614
|
if (afterReleaseId !== undefined) {
|
|
2631
|
-
|
|
2632
|
-
localVarQueryParameter[key] = value;
|
|
2633
|
-
}
|
|
2615
|
+
localVarQueryParameter['after_release_id'] = afterReleaseId;
|
|
2634
2616
|
}
|
|
2635
2617
|
if (afterDate !== undefined) {
|
|
2636
2618
|
localVarQueryParameter['after_date'] = afterDate;
|
|
@@ -2658,8 +2640,8 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2658
2640
|
/**
|
|
2659
2641
|
* Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
|
|
2660
2642
|
* @summary Get Updates
|
|
2661
|
-
* @param {
|
|
2662
|
-
* @param {Array<
|
|
2643
|
+
* @param {string} lastKnownId
|
|
2644
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
2663
2645
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2664
2646
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
2665
2647
|
* @param {number | null} [skip] Skip query results
|
|
@@ -2717,8 +2699,8 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
2717
2699
|
/**
|
|
2718
2700
|
* Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
|
|
2719
2701
|
* @summary Get Release
|
|
2720
|
-
* @param { | null} [releaseId] Release ID
|
|
2721
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
2702
|
+
* @param {string | null} [releaseId] Release ID
|
|
2703
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
2722
2704
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
2723
2705
|
* @param {string | null} [filename]
|
|
2724
2706
|
* @param {*} [options] Override http request option.
|
|
@@ -2736,7 +2718,7 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
2736
2718
|
/**
|
|
2737
2719
|
* Gets release information using the release ID, nothing to discuss really.
|
|
2738
2720
|
* @summary Get Release Short
|
|
2739
|
-
* @param {
|
|
2721
|
+
* @param {string} releaseId
|
|
2740
2722
|
* @param {*} [options] Override http request option.
|
|
2741
2723
|
* @deprecated
|
|
2742
2724
|
* @throws {RequiredError}
|
|
@@ -2753,17 +2735,17 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
2753
2735
|
/**
|
|
2754
2736
|
* Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
|
|
2755
2737
|
* @summary Get Releases
|
|
2756
|
-
* @param {Array<
|
|
2757
|
-
* @param {Array<
|
|
2738
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
2739
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
2758
2740
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
2759
|
-
* @param {Array<
|
|
2760
|
-
* @param {Array<
|
|
2741
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
2742
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
2761
2743
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
2762
2744
|
* @param {Array<string>} [version] Filter by release version
|
|
2763
2745
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2764
2746
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
2765
2747
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
2766
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
2748
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
2767
2749
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
2768
2750
|
* @param {ReleasesSort} [sort] Sort mode
|
|
2769
2751
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -2784,8 +2766,8 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
2784
2766
|
/**
|
|
2785
2767
|
* Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
|
|
2786
2768
|
* @summary Get Updates
|
|
2787
|
-
* @param {
|
|
2788
|
-
* @param {Array<
|
|
2769
|
+
* @param {string} lastKnownId
|
|
2770
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
2789
2771
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2790
2772
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
2791
2773
|
* @param {number | null} [skip] Skip query results
|
|
@@ -2815,8 +2797,8 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
2815
2797
|
/**
|
|
2816
2798
|
* Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
|
|
2817
2799
|
* @summary Get Release
|
|
2818
|
-
* @param { | null} [releaseId] Release ID
|
|
2819
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
2800
|
+
* @param {string | null} [releaseId] Release ID
|
|
2801
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
2820
2802
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
2821
2803
|
* @param {string | null} [filename]
|
|
2822
2804
|
* @param {*} [options] Override http request option.
|
|
@@ -2828,7 +2810,7 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
2828
2810
|
/**
|
|
2829
2811
|
* Gets release information using the release ID, nothing to discuss really.
|
|
2830
2812
|
* @summary Get Release Short
|
|
2831
|
-
* @param {
|
|
2813
|
+
* @param {string} releaseId
|
|
2832
2814
|
* @param {*} [options] Override http request option.
|
|
2833
2815
|
* @deprecated
|
|
2834
2816
|
* @throws {RequiredError}
|
|
@@ -2839,17 +2821,17 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
2839
2821
|
/**
|
|
2840
2822
|
* Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
|
|
2841
2823
|
* @summary Get Releases
|
|
2842
|
-
* @param {Array<
|
|
2843
|
-
* @param {Array<
|
|
2824
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
2825
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
2844
2826
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
2845
|
-
* @param {Array<
|
|
2846
|
-
* @param {Array<
|
|
2827
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
2828
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
2847
2829
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
2848
2830
|
* @param {Array<string>} [version] Filter by release version
|
|
2849
2831
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2850
2832
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
2851
2833
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
2852
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
2834
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
2853
2835
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
2854
2836
|
* @param {ReleasesSort} [sort] Sort mode
|
|
2855
2837
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -2864,8 +2846,8 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
2864
2846
|
/**
|
|
2865
2847
|
* Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
|
|
2866
2848
|
* @summary Get Updates
|
|
2867
|
-
* @param {
|
|
2868
|
-
* @param {Array<
|
|
2849
|
+
* @param {string} lastKnownId
|
|
2850
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
2869
2851
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2870
2852
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
2871
2853
|
* @param {number | null} [skip] Skip query results
|
|
@@ -2889,8 +2871,8 @@ export class ReleaseApi extends BaseAPI {
|
|
|
2889
2871
|
/**
|
|
2890
2872
|
* Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
|
|
2891
2873
|
* @summary Get Release
|
|
2892
|
-
* @param { | null} [releaseId] Release ID
|
|
2893
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
2874
|
+
* @param {string | null} [releaseId] Release ID
|
|
2875
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
2894
2876
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
2895
2877
|
* @param {string | null} [filename]
|
|
2896
2878
|
* @param {*} [options] Override http request option.
|
|
@@ -2903,7 +2885,7 @@ export class ReleaseApi extends BaseAPI {
|
|
|
2903
2885
|
/**
|
|
2904
2886
|
* Gets release information using the release ID, nothing to discuss really.
|
|
2905
2887
|
* @summary Get Release Short
|
|
2906
|
-
* @param {
|
|
2888
|
+
* @param {string} releaseId
|
|
2907
2889
|
* @param {*} [options] Override http request option.
|
|
2908
2890
|
* @deprecated
|
|
2909
2891
|
* @throws {RequiredError}
|
|
@@ -2915,17 +2897,17 @@ export class ReleaseApi extends BaseAPI {
|
|
|
2915
2897
|
/**
|
|
2916
2898
|
* Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
|
|
2917
2899
|
* @summary Get Releases
|
|
2918
|
-
* @param {Array<
|
|
2919
|
-
* @param {Array<
|
|
2900
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
2901
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
2920
2902
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
2921
|
-
* @param {Array<
|
|
2922
|
-
* @param {Array<
|
|
2903
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
2904
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
2923
2905
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
2924
2906
|
* @param {Array<string>} [version] Filter by release version
|
|
2925
2907
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2926
2908
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
2927
2909
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
2928
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
2910
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
2929
2911
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
2930
2912
|
* @param {ReleasesSort} [sort] Sort mode
|
|
2931
2913
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -2941,8 +2923,8 @@ export class ReleaseApi extends BaseAPI {
|
|
|
2941
2923
|
/**
|
|
2942
2924
|
* Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
|
|
2943
2925
|
* @summary Get Updates
|
|
2944
|
-
* @param {
|
|
2945
|
-
* @param {Array<
|
|
2926
|
+
* @param {string} lastKnownId
|
|
2927
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
2946
2928
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2947
2929
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
2948
2930
|
* @param {number | null} [skip] Skip query results
|