@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/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Fox API
|
|
6
6
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.2.
|
|
8
|
+
* The version of the OpenAPI document: 5.2.3
|
|
9
9
|
* Contact: admin@orangefox.tech
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -80,8 +80,8 @@ const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
80
80
|
/**
|
|
81
81
|
* 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.
|
|
82
82
|
* @summary Get Device
|
|
83
|
-
* @param { | null} [deviceId]
|
|
84
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
83
|
+
* @param {string | null} [deviceId]
|
|
84
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
85
85
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
86
86
|
* @param {*} [options] Override http request option.
|
|
87
87
|
* @throws {RequiredError}
|
|
@@ -98,14 +98,10 @@ const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
98
98
|
const localVarHeaderParameter = {};
|
|
99
99
|
const localVarQueryParameter = {};
|
|
100
100
|
if (deviceId !== undefined) {
|
|
101
|
-
|
|
102
|
-
localVarQueryParameter[key] = value;
|
|
103
|
-
}
|
|
101
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
104
102
|
}
|
|
105
103
|
if (id !== undefined) {
|
|
106
|
-
|
|
107
|
-
localVarQueryParameter[key] = value;
|
|
108
|
-
}
|
|
104
|
+
localVarQueryParameter['_id'] = id;
|
|
109
105
|
}
|
|
110
106
|
if (codename !== undefined) {
|
|
111
107
|
localVarQueryParameter['codename'] = codename;
|
|
@@ -151,8 +147,8 @@ const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
151
147
|
/**
|
|
152
148
|
* 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.
|
|
153
149
|
* @summary Get Devices
|
|
154
|
-
* @param {Array<
|
|
155
|
-
* @param {Array<
|
|
150
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
151
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
156
152
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
157
153
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
158
154
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -255,8 +251,8 @@ const DeviceApiFp = function (configuration) {
|
|
|
255
251
|
/**
|
|
256
252
|
* 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.
|
|
257
253
|
* @summary Get Device
|
|
258
|
-
* @param { | null} [deviceId]
|
|
259
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
254
|
+
* @param {string | null} [deviceId]
|
|
255
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
260
256
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
261
257
|
* @param {*} [options] Override http request option.
|
|
262
258
|
* @throws {RequiredError}
|
|
@@ -290,8 +286,8 @@ const DeviceApiFp = function (configuration) {
|
|
|
290
286
|
/**
|
|
291
287
|
* 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.
|
|
292
288
|
* @summary Get Devices
|
|
293
|
-
* @param {Array<
|
|
294
|
-
* @param {Array<
|
|
289
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
290
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
295
291
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
296
292
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
297
293
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -341,8 +337,8 @@ const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
341
337
|
/**
|
|
342
338
|
* 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.
|
|
343
339
|
* @summary Get Device
|
|
344
|
-
* @param { | null} [deviceId]
|
|
345
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
340
|
+
* @param {string | null} [deviceId]
|
|
341
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
346
342
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
347
343
|
* @param {*} [options] Override http request option.
|
|
348
344
|
* @throws {RequiredError}
|
|
@@ -364,8 +360,8 @@ const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
364
360
|
/**
|
|
365
361
|
* 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.
|
|
366
362
|
* @summary Get Devices
|
|
367
|
-
* @param {Array<
|
|
368
|
-
* @param {Array<
|
|
363
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
364
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
369
365
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
370
366
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
371
367
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -403,8 +399,8 @@ class DeviceApi extends base_1.BaseAPI {
|
|
|
403
399
|
/**
|
|
404
400
|
* 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.
|
|
405
401
|
* @summary Get Device
|
|
406
|
-
* @param { | null} [deviceId]
|
|
407
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
402
|
+
* @param {string | null} [deviceId]
|
|
403
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
408
404
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
409
405
|
* @param {*} [options] Override http request option.
|
|
410
406
|
* @throws {RequiredError}
|
|
@@ -428,8 +424,8 @@ class DeviceApi extends base_1.BaseAPI {
|
|
|
428
424
|
/**
|
|
429
425
|
* 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.
|
|
430
426
|
* @summary Get Devices
|
|
431
|
-
* @param {Array<
|
|
432
|
-
* @param {Array<
|
|
427
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
428
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
433
429
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
434
430
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
435
431
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -467,7 +463,7 @@ const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
467
463
|
/**
|
|
468
464
|
* 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.
|
|
469
465
|
* @summary Cancel Task
|
|
470
|
-
* @param {
|
|
466
|
+
* @param {string} taskId
|
|
471
467
|
* @param {*} [options] Override http request option.
|
|
472
468
|
* @throws {RequiredError}
|
|
473
469
|
*/
|
|
@@ -496,7 +492,7 @@ const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
496
492
|
/**
|
|
497
493
|
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
498
494
|
* @summary Delete Task
|
|
499
|
-
* @param {
|
|
495
|
+
* @param {string} taskId
|
|
500
496
|
* @param {*} [options] Override http request option.
|
|
501
497
|
* @throws {RequiredError}
|
|
502
498
|
*/
|
|
@@ -550,7 +546,7 @@ const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
550
546
|
/**
|
|
551
547
|
* 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.
|
|
552
548
|
* @summary Get Task
|
|
553
|
-
* @param {
|
|
549
|
+
* @param {string} taskId
|
|
554
550
|
* @param {*} [options] Override http request option.
|
|
555
551
|
* @throws {RequiredError}
|
|
556
552
|
*/
|
|
@@ -579,7 +575,7 @@ const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
579
575
|
/**
|
|
580
576
|
* 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
|
|
581
577
|
* @summary List Tasks
|
|
582
|
-
* @param { | null} [deviceId]
|
|
578
|
+
* @param {string | null} [deviceId]
|
|
583
579
|
* @param {*} [options] Override http request option.
|
|
584
580
|
* @throws {RequiredError}
|
|
585
581
|
*/
|
|
@@ -595,9 +591,7 @@ const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
595
591
|
const localVarHeaderParameter = {};
|
|
596
592
|
const localVarQueryParameter = {};
|
|
597
593
|
if (deviceId !== undefined) {
|
|
598
|
-
|
|
599
|
-
localVarQueryParameter[key] = value;
|
|
600
|
-
}
|
|
594
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
601
595
|
}
|
|
602
596
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
603
597
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -640,7 +634,7 @@ const FoxFactoryApiAxiosParamCreator = function (configuration) {
|
|
|
640
634
|
/**
|
|
641
635
|
* 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.
|
|
642
636
|
* @summary Update Task
|
|
643
|
-
* @param {
|
|
637
|
+
* @param {string} taskId
|
|
644
638
|
* @param {TaskUpdateBody} taskUpdateBody
|
|
645
639
|
* @param {*} [options] Override http request option.
|
|
646
640
|
* @throws {RequiredError}
|
|
@@ -684,7 +678,7 @@ const FoxFactoryApiFp = function (configuration) {
|
|
|
684
678
|
/**
|
|
685
679
|
* 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.
|
|
686
680
|
* @summary Cancel Task
|
|
687
|
-
* @param {
|
|
681
|
+
* @param {string} taskId
|
|
688
682
|
* @param {*} [options] Override http request option.
|
|
689
683
|
* @throws {RequiredError}
|
|
690
684
|
*/
|
|
@@ -700,7 +694,7 @@ const FoxFactoryApiFp = function (configuration) {
|
|
|
700
694
|
/**
|
|
701
695
|
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
702
696
|
* @summary Delete Task
|
|
703
|
-
* @param {
|
|
697
|
+
* @param {string} taskId
|
|
704
698
|
* @param {*} [options] Override http request option.
|
|
705
699
|
* @throws {RequiredError}
|
|
706
700
|
*/
|
|
@@ -731,7 +725,7 @@ const FoxFactoryApiFp = function (configuration) {
|
|
|
731
725
|
/**
|
|
732
726
|
* 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.
|
|
733
727
|
* @summary Get Task
|
|
734
|
-
* @param {
|
|
728
|
+
* @param {string} taskId
|
|
735
729
|
* @param {*} [options] Override http request option.
|
|
736
730
|
* @throws {RequiredError}
|
|
737
731
|
*/
|
|
@@ -747,7 +741,7 @@ const FoxFactoryApiFp = function (configuration) {
|
|
|
747
741
|
/**
|
|
748
742
|
* 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
|
|
749
743
|
* @summary List Tasks
|
|
750
|
-
* @param { | null} [deviceId]
|
|
744
|
+
* @param {string | null} [deviceId]
|
|
751
745
|
* @param {*} [options] Override http request option.
|
|
752
746
|
* @throws {RequiredError}
|
|
753
747
|
*/
|
|
@@ -779,7 +773,7 @@ const FoxFactoryApiFp = function (configuration) {
|
|
|
779
773
|
/**
|
|
780
774
|
* 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.
|
|
781
775
|
* @summary Update Task
|
|
782
|
-
* @param {
|
|
776
|
+
* @param {string} taskId
|
|
783
777
|
* @param {TaskUpdateBody} taskUpdateBody
|
|
784
778
|
* @param {*} [options] Override http request option.
|
|
785
779
|
* @throws {RequiredError}
|
|
@@ -806,7 +800,7 @@ const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
806
800
|
/**
|
|
807
801
|
* 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.
|
|
808
802
|
* @summary Cancel Task
|
|
809
|
-
* @param {
|
|
803
|
+
* @param {string} taskId
|
|
810
804
|
* @param {*} [options] Override http request option.
|
|
811
805
|
* @throws {RequiredError}
|
|
812
806
|
*/
|
|
@@ -816,7 +810,7 @@ const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
816
810
|
/**
|
|
817
811
|
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
818
812
|
* @summary Delete Task
|
|
819
|
-
* @param {
|
|
813
|
+
* @param {string} taskId
|
|
820
814
|
* @param {*} [options] Override http request option.
|
|
821
815
|
* @throws {RequiredError}
|
|
822
816
|
*/
|
|
@@ -835,7 +829,7 @@ const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
835
829
|
/**
|
|
836
830
|
* 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.
|
|
837
831
|
* @summary Get Task
|
|
838
|
-
* @param {
|
|
832
|
+
* @param {string} taskId
|
|
839
833
|
* @param {*} [options] Override http request option.
|
|
840
834
|
* @throws {RequiredError}
|
|
841
835
|
*/
|
|
@@ -845,7 +839,7 @@ const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
845
839
|
/**
|
|
846
840
|
* 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
|
|
847
841
|
* @summary List Tasks
|
|
848
|
-
* @param { | null} [deviceId]
|
|
842
|
+
* @param {string | null} [deviceId]
|
|
849
843
|
* @param {*} [options] Override http request option.
|
|
850
844
|
* @throws {RequiredError}
|
|
851
845
|
*/
|
|
@@ -865,7 +859,7 @@ const FoxFactoryApiFactory = function (configuration, basePath, axios) {
|
|
|
865
859
|
/**
|
|
866
860
|
* 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.
|
|
867
861
|
* @summary Update Task
|
|
868
|
-
* @param {
|
|
862
|
+
* @param {string} taskId
|
|
869
863
|
* @param {TaskUpdateBody} taskUpdateBody
|
|
870
864
|
* @param {*} [options] Override http request option.
|
|
871
865
|
* @throws {RequiredError}
|
|
@@ -886,7 +880,7 @@ class FoxFactoryApi extends base_1.BaseAPI {
|
|
|
886
880
|
/**
|
|
887
881
|
* 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.
|
|
888
882
|
* @summary Cancel Task
|
|
889
|
-
* @param {
|
|
883
|
+
* @param {string} taskId
|
|
890
884
|
* @param {*} [options] Override http request option.
|
|
891
885
|
* @throws {RequiredError}
|
|
892
886
|
* @memberof FoxFactoryApi
|
|
@@ -897,7 +891,7 @@ class FoxFactoryApi extends base_1.BaseAPI {
|
|
|
897
891
|
/**
|
|
898
892
|
* Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised.
|
|
899
893
|
* @summary Delete Task
|
|
900
|
-
* @param {
|
|
894
|
+
* @param {string} taskId
|
|
901
895
|
* @param {*} [options] Override http request option.
|
|
902
896
|
* @throws {RequiredError}
|
|
903
897
|
* @memberof FoxFactoryApi
|
|
@@ -918,7 +912,7 @@ class FoxFactoryApi extends base_1.BaseAPI {
|
|
|
918
912
|
/**
|
|
919
913
|
* 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.
|
|
920
914
|
* @summary Get Task
|
|
921
|
-
* @param {
|
|
915
|
+
* @param {string} taskId
|
|
922
916
|
* @param {*} [options] Override http request option.
|
|
923
917
|
* @throws {RequiredError}
|
|
924
918
|
* @memberof FoxFactoryApi
|
|
@@ -929,7 +923,7 @@ class FoxFactoryApi extends base_1.BaseAPI {
|
|
|
929
923
|
/**
|
|
930
924
|
* 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
|
|
931
925
|
* @summary List Tasks
|
|
932
|
-
* @param { | null} [deviceId]
|
|
926
|
+
* @param {string | null} [deviceId]
|
|
933
927
|
* @param {*} [options] Override http request option.
|
|
934
928
|
* @throws {RequiredError}
|
|
935
929
|
* @memberof FoxFactoryApi
|
|
@@ -951,7 +945,7 @@ class FoxFactoryApi extends base_1.BaseAPI {
|
|
|
951
945
|
/**
|
|
952
946
|
* 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.
|
|
953
947
|
* @summary Update Task
|
|
954
|
-
* @param {
|
|
948
|
+
* @param {string} taskId
|
|
955
949
|
* @param {TaskUpdateBody} taskUpdateBody
|
|
956
950
|
* @param {*} [options] Override http request option.
|
|
957
951
|
* @throws {RequiredError}
|
|
@@ -1114,7 +1108,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1114
1108
|
/**
|
|
1115
1109
|
* Delete release
|
|
1116
1110
|
* @summary Del Release
|
|
1117
|
-
* @param {
|
|
1111
|
+
* @param {string} releaseId
|
|
1118
1112
|
* @param {*} [options] Override http request option.
|
|
1119
1113
|
* @throws {RequiredError}
|
|
1120
1114
|
*/
|
|
@@ -1149,7 +1143,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1149
1143
|
/**
|
|
1150
1144
|
*
|
|
1151
1145
|
* @summary Delete User
|
|
1152
|
-
* @param {
|
|
1146
|
+
* @param {string} userId
|
|
1153
1147
|
* @param {*} [options] Override http request option.
|
|
1154
1148
|
* @throws {RequiredError}
|
|
1155
1149
|
*/
|
|
@@ -1184,7 +1178,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1184
1178
|
/**
|
|
1185
1179
|
* Edit Release information
|
|
1186
1180
|
* @summary Edit Release
|
|
1187
|
-
* @param {
|
|
1181
|
+
* @param {string} releaseId
|
|
1188
1182
|
* @param {ReleaseUpdateBody} releaseUpdateBody
|
|
1189
1183
|
* @param {*} [options] Override http request option.
|
|
1190
1184
|
* @throws {RequiredError}
|
|
@@ -1224,7 +1218,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1224
1218
|
/**
|
|
1225
1219
|
*
|
|
1226
1220
|
* @summary Get Device Info
|
|
1227
|
-
* @param {
|
|
1221
|
+
* @param {string} deviceId
|
|
1228
1222
|
* @param {*} [options] Override http request option.
|
|
1229
1223
|
* @throws {RequiredError}
|
|
1230
1224
|
*/
|
|
@@ -1261,9 +1255,9 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1261
1255
|
* @summary Get Logs
|
|
1262
1256
|
* @param {number} [page]
|
|
1263
1257
|
* @param {number} [perPage]
|
|
1264
|
-
* @param { | null} [deviceId]
|
|
1265
|
-
* @param { | null} [releaseId]
|
|
1266
|
-
* @param { | null} [userId]
|
|
1258
|
+
* @param {string | null} [deviceId]
|
|
1259
|
+
* @param {string | null} [releaseId]
|
|
1260
|
+
* @param {string | null} [userId]
|
|
1267
1261
|
* @param {boolean | null} [hideVerbose]
|
|
1268
1262
|
* @param {*} [options] Override http request option.
|
|
1269
1263
|
* @throws {RequiredError}
|
|
@@ -1292,19 +1286,13 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1292
1286
|
localVarQueryParameter['per_page'] = perPage;
|
|
1293
1287
|
}
|
|
1294
1288
|
if (deviceId !== undefined) {
|
|
1295
|
-
|
|
1296
|
-
localVarQueryParameter[key] = value;
|
|
1297
|
-
}
|
|
1289
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
1298
1290
|
}
|
|
1299
1291
|
if (releaseId !== undefined) {
|
|
1300
|
-
|
|
1301
|
-
localVarQueryParameter[key] = value;
|
|
1302
|
-
}
|
|
1292
|
+
localVarQueryParameter['release_id'] = releaseId;
|
|
1303
1293
|
}
|
|
1304
1294
|
if (userId !== undefined) {
|
|
1305
|
-
|
|
1306
|
-
localVarQueryParameter[key] = value;
|
|
1307
|
-
}
|
|
1295
|
+
localVarQueryParameter['user_id'] = userId;
|
|
1308
1296
|
}
|
|
1309
1297
|
if (hideVerbose !== undefined) {
|
|
1310
1298
|
localVarQueryParameter['hide_verbose'] = hideVerbose;
|
|
@@ -1320,7 +1308,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1320
1308
|
/**
|
|
1321
1309
|
* Get release information
|
|
1322
1310
|
* @summary Get Release Info
|
|
1323
|
-
* @param {
|
|
1311
|
+
* @param {string} releaseId
|
|
1324
1312
|
* @param {*} [options] Override http request option.
|
|
1325
1313
|
* @throws {RequiredError}
|
|
1326
1314
|
*/
|
|
@@ -1355,7 +1343,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1355
1343
|
/**
|
|
1356
1344
|
* Download release ZIP directly
|
|
1357
1345
|
* @summary Get Release Zip
|
|
1358
|
-
* @param {
|
|
1346
|
+
* @param {string} releaseId
|
|
1359
1347
|
* @param {*} [options] Override http request option.
|
|
1360
1348
|
* @throws {RequiredError}
|
|
1361
1349
|
*/
|
|
@@ -1598,7 +1586,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1598
1586
|
/**
|
|
1599
1587
|
*
|
|
1600
1588
|
* @summary New Release
|
|
1601
|
-
* @param {
|
|
1589
|
+
* @param {string} deviceId
|
|
1602
1590
|
* @param {File} releaseZip
|
|
1603
1591
|
* @param {string} md5
|
|
1604
1592
|
* @param {Array<string>} changelog
|
|
@@ -1635,7 +1623,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1635
1623
|
// http bearer authentication required
|
|
1636
1624
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
1637
1625
|
if (deviceId !== undefined) {
|
|
1638
|
-
localVarFormParams.append('device_id',
|
|
1626
|
+
localVarFormParams.append('device_id', deviceId);
|
|
1639
1627
|
}
|
|
1640
1628
|
if (releaseZip !== undefined) {
|
|
1641
1629
|
localVarFormParams.append('release_zip', releaseZip);
|
|
@@ -1704,7 +1692,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1704
1692
|
/**
|
|
1705
1693
|
*
|
|
1706
1694
|
* @summary Update Device
|
|
1707
|
-
* @param {
|
|
1695
|
+
* @param {string} deviceId
|
|
1708
1696
|
* @param {DeviceUpdateBody} deviceUpdateBody
|
|
1709
1697
|
* @param {*} [options] Override http request option.
|
|
1710
1698
|
* @throws {RequiredError}
|
|
@@ -1744,7 +1732,7 @@ const InternalApiAxiosParamCreator = function (configuration) {
|
|
|
1744
1732
|
/**
|
|
1745
1733
|
*
|
|
1746
1734
|
* @summary Update User
|
|
1747
|
-
* @param {
|
|
1735
|
+
* @param {string} userId
|
|
1748
1736
|
* @param {UserUpdateBody} userUpdateBody
|
|
1749
1737
|
* @param {*} [options] Override http request option.
|
|
1750
1738
|
* @throws {RequiredError}
|
|
@@ -1810,7 +1798,7 @@ const InternalApiFp = function (configuration) {
|
|
|
1810
1798
|
/**
|
|
1811
1799
|
* Delete release
|
|
1812
1800
|
* @summary Del Release
|
|
1813
|
-
* @param {
|
|
1801
|
+
* @param {string} releaseId
|
|
1814
1802
|
* @param {*} [options] Override http request option.
|
|
1815
1803
|
* @throws {RequiredError}
|
|
1816
1804
|
*/
|
|
@@ -1826,7 +1814,7 @@ const InternalApiFp = function (configuration) {
|
|
|
1826
1814
|
/**
|
|
1827
1815
|
*
|
|
1828
1816
|
* @summary Delete User
|
|
1829
|
-
* @param {
|
|
1817
|
+
* @param {string} userId
|
|
1830
1818
|
* @param {*} [options] Override http request option.
|
|
1831
1819
|
* @throws {RequiredError}
|
|
1832
1820
|
*/
|
|
@@ -1842,7 +1830,7 @@ const InternalApiFp = function (configuration) {
|
|
|
1842
1830
|
/**
|
|
1843
1831
|
* Edit Release information
|
|
1844
1832
|
* @summary Edit Release
|
|
1845
|
-
* @param {
|
|
1833
|
+
* @param {string} releaseId
|
|
1846
1834
|
* @param {ReleaseUpdateBody} releaseUpdateBody
|
|
1847
1835
|
* @param {*} [options] Override http request option.
|
|
1848
1836
|
* @throws {RequiredError}
|
|
@@ -1859,7 +1847,7 @@ const InternalApiFp = function (configuration) {
|
|
|
1859
1847
|
/**
|
|
1860
1848
|
*
|
|
1861
1849
|
* @summary Get Device Info
|
|
1862
|
-
* @param {
|
|
1850
|
+
* @param {string} deviceId
|
|
1863
1851
|
* @param {*} [options] Override http request option.
|
|
1864
1852
|
* @throws {RequiredError}
|
|
1865
1853
|
*/
|
|
@@ -1877,9 +1865,9 @@ const InternalApiFp = function (configuration) {
|
|
|
1877
1865
|
* @summary Get Logs
|
|
1878
1866
|
* @param {number} [page]
|
|
1879
1867
|
* @param {number} [perPage]
|
|
1880
|
-
* @param { | null} [deviceId]
|
|
1881
|
-
* @param { | null} [releaseId]
|
|
1882
|
-
* @param { | null} [userId]
|
|
1868
|
+
* @param {string | null} [deviceId]
|
|
1869
|
+
* @param {string | null} [releaseId]
|
|
1870
|
+
* @param {string | null} [userId]
|
|
1883
1871
|
* @param {boolean | null} [hideVerbose]
|
|
1884
1872
|
* @param {*} [options] Override http request option.
|
|
1885
1873
|
* @throws {RequiredError}
|
|
@@ -1896,7 +1884,7 @@ const InternalApiFp = function (configuration) {
|
|
|
1896
1884
|
/**
|
|
1897
1885
|
* Get release information
|
|
1898
1886
|
* @summary Get Release Info
|
|
1899
|
-
* @param {
|
|
1887
|
+
* @param {string} releaseId
|
|
1900
1888
|
* @param {*} [options] Override http request option.
|
|
1901
1889
|
* @throws {RequiredError}
|
|
1902
1890
|
*/
|
|
@@ -1912,7 +1900,7 @@ const InternalApiFp = function (configuration) {
|
|
|
1912
1900
|
/**
|
|
1913
1901
|
* Download release ZIP directly
|
|
1914
1902
|
* @summary Get Release Zip
|
|
1915
|
-
* @param {
|
|
1903
|
+
* @param {string} releaseId
|
|
1916
1904
|
* @param {*} [options] Override http request option.
|
|
1917
1905
|
* @throws {RequiredError}
|
|
1918
1906
|
*/
|
|
@@ -2014,7 +2002,7 @@ const InternalApiFp = function (configuration) {
|
|
|
2014
2002
|
/**
|
|
2015
2003
|
*
|
|
2016
2004
|
* @summary New Release
|
|
2017
|
-
* @param {
|
|
2005
|
+
* @param {string} deviceId
|
|
2018
2006
|
* @param {File} releaseZip
|
|
2019
2007
|
* @param {string} md5
|
|
2020
2008
|
* @param {Array<string>} changelog
|
|
@@ -2052,7 +2040,7 @@ const InternalApiFp = function (configuration) {
|
|
|
2052
2040
|
/**
|
|
2053
2041
|
*
|
|
2054
2042
|
* @summary Update Device
|
|
2055
|
-
* @param {
|
|
2043
|
+
* @param {string} deviceId
|
|
2056
2044
|
* @param {DeviceUpdateBody} deviceUpdateBody
|
|
2057
2045
|
* @param {*} [options] Override http request option.
|
|
2058
2046
|
* @throws {RequiredError}
|
|
@@ -2069,7 +2057,7 @@ const InternalApiFp = function (configuration) {
|
|
|
2069
2057
|
/**
|
|
2070
2058
|
*
|
|
2071
2059
|
* @summary Update User
|
|
2072
|
-
* @param {
|
|
2060
|
+
* @param {string} userId
|
|
2073
2061
|
* @param {UserUpdateBody} userUpdateBody
|
|
2074
2062
|
* @param {*} [options] Override http request option.
|
|
2075
2063
|
* @throws {RequiredError}
|
|
@@ -2106,7 +2094,7 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2106
2094
|
/**
|
|
2107
2095
|
* Delete release
|
|
2108
2096
|
* @summary Del Release
|
|
2109
|
-
* @param {
|
|
2097
|
+
* @param {string} releaseId
|
|
2110
2098
|
* @param {*} [options] Override http request option.
|
|
2111
2099
|
* @throws {RequiredError}
|
|
2112
2100
|
*/
|
|
@@ -2116,7 +2104,7 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2116
2104
|
/**
|
|
2117
2105
|
*
|
|
2118
2106
|
* @summary Delete User
|
|
2119
|
-
* @param {
|
|
2107
|
+
* @param {string} userId
|
|
2120
2108
|
* @param {*} [options] Override http request option.
|
|
2121
2109
|
* @throws {RequiredError}
|
|
2122
2110
|
*/
|
|
@@ -2126,7 +2114,7 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2126
2114
|
/**
|
|
2127
2115
|
* Edit Release information
|
|
2128
2116
|
* @summary Edit Release
|
|
2129
|
-
* @param {
|
|
2117
|
+
* @param {string} releaseId
|
|
2130
2118
|
* @param {ReleaseUpdateBody} releaseUpdateBody
|
|
2131
2119
|
* @param {*} [options] Override http request option.
|
|
2132
2120
|
* @throws {RequiredError}
|
|
@@ -2137,7 +2125,7 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2137
2125
|
/**
|
|
2138
2126
|
*
|
|
2139
2127
|
* @summary Get Device Info
|
|
2140
|
-
* @param {
|
|
2128
|
+
* @param {string} deviceId
|
|
2141
2129
|
* @param {*} [options] Override http request option.
|
|
2142
2130
|
* @throws {RequiredError}
|
|
2143
2131
|
*/
|
|
@@ -2149,9 +2137,9 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2149
2137
|
* @summary Get Logs
|
|
2150
2138
|
* @param {number} [page]
|
|
2151
2139
|
* @param {number} [perPage]
|
|
2152
|
-
* @param { | null} [deviceId]
|
|
2153
|
-
* @param { | null} [releaseId]
|
|
2154
|
-
* @param { | null} [userId]
|
|
2140
|
+
* @param {string | null} [deviceId]
|
|
2141
|
+
* @param {string | null} [releaseId]
|
|
2142
|
+
* @param {string | null} [userId]
|
|
2155
2143
|
* @param {boolean | null} [hideVerbose]
|
|
2156
2144
|
* @param {*} [options] Override http request option.
|
|
2157
2145
|
* @throws {RequiredError}
|
|
@@ -2162,7 +2150,7 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2162
2150
|
/**
|
|
2163
2151
|
* Get release information
|
|
2164
2152
|
* @summary Get Release Info
|
|
2165
|
-
* @param {
|
|
2153
|
+
* @param {string} releaseId
|
|
2166
2154
|
* @param {*} [options] Override http request option.
|
|
2167
2155
|
* @throws {RequiredError}
|
|
2168
2156
|
*/
|
|
@@ -2172,7 +2160,7 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2172
2160
|
/**
|
|
2173
2161
|
* Download release ZIP directly
|
|
2174
2162
|
* @summary Get Release Zip
|
|
2175
|
-
* @param {
|
|
2163
|
+
* @param {string} releaseId
|
|
2176
2164
|
* @param {*} [options] Override http request option.
|
|
2177
2165
|
* @throws {RequiredError}
|
|
2178
2166
|
*/
|
|
@@ -2238,7 +2226,7 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2238
2226
|
/**
|
|
2239
2227
|
*
|
|
2240
2228
|
* @summary New Release
|
|
2241
|
-
* @param {
|
|
2229
|
+
* @param {string} deviceId
|
|
2242
2230
|
* @param {File} releaseZip
|
|
2243
2231
|
* @param {string} md5
|
|
2244
2232
|
* @param {Array<string>} changelog
|
|
@@ -2264,7 +2252,7 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2264
2252
|
/**
|
|
2265
2253
|
*
|
|
2266
2254
|
* @summary Update Device
|
|
2267
|
-
* @param {
|
|
2255
|
+
* @param {string} deviceId
|
|
2268
2256
|
* @param {DeviceUpdateBody} deviceUpdateBody
|
|
2269
2257
|
* @param {*} [options] Override http request option.
|
|
2270
2258
|
* @throws {RequiredError}
|
|
@@ -2275,7 +2263,7 @@ const InternalApiFactory = function (configuration, basePath, axios) {
|
|
|
2275
2263
|
/**
|
|
2276
2264
|
*
|
|
2277
2265
|
* @summary Update User
|
|
2278
|
-
* @param {
|
|
2266
|
+
* @param {string} userId
|
|
2279
2267
|
* @param {UserUpdateBody} userUpdateBody
|
|
2280
2268
|
* @param {*} [options] Override http request option.
|
|
2281
2269
|
* @throws {RequiredError}
|
|
@@ -2307,7 +2295,7 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2307
2295
|
/**
|
|
2308
2296
|
* Delete release
|
|
2309
2297
|
* @summary Del Release
|
|
2310
|
-
* @param {
|
|
2298
|
+
* @param {string} releaseId
|
|
2311
2299
|
* @param {*} [options] Override http request option.
|
|
2312
2300
|
* @throws {RequiredError}
|
|
2313
2301
|
* @memberof InternalApi
|
|
@@ -2318,7 +2306,7 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2318
2306
|
/**
|
|
2319
2307
|
*
|
|
2320
2308
|
* @summary Delete User
|
|
2321
|
-
* @param {
|
|
2309
|
+
* @param {string} userId
|
|
2322
2310
|
* @param {*} [options] Override http request option.
|
|
2323
2311
|
* @throws {RequiredError}
|
|
2324
2312
|
* @memberof InternalApi
|
|
@@ -2329,7 +2317,7 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2329
2317
|
/**
|
|
2330
2318
|
* Edit Release information
|
|
2331
2319
|
* @summary Edit Release
|
|
2332
|
-
* @param {
|
|
2320
|
+
* @param {string} releaseId
|
|
2333
2321
|
* @param {ReleaseUpdateBody} releaseUpdateBody
|
|
2334
2322
|
* @param {*} [options] Override http request option.
|
|
2335
2323
|
* @throws {RequiredError}
|
|
@@ -2341,7 +2329,7 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2341
2329
|
/**
|
|
2342
2330
|
*
|
|
2343
2331
|
* @summary Get Device Info
|
|
2344
|
-
* @param {
|
|
2332
|
+
* @param {string} deviceId
|
|
2345
2333
|
* @param {*} [options] Override http request option.
|
|
2346
2334
|
* @throws {RequiredError}
|
|
2347
2335
|
* @memberof InternalApi
|
|
@@ -2354,9 +2342,9 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2354
2342
|
* @summary Get Logs
|
|
2355
2343
|
* @param {number} [page]
|
|
2356
2344
|
* @param {number} [perPage]
|
|
2357
|
-
* @param { | null} [deviceId]
|
|
2358
|
-
* @param { | null} [releaseId]
|
|
2359
|
-
* @param { | null} [userId]
|
|
2345
|
+
* @param {string | null} [deviceId]
|
|
2346
|
+
* @param {string | null} [releaseId]
|
|
2347
|
+
* @param {string | null} [userId]
|
|
2360
2348
|
* @param {boolean | null} [hideVerbose]
|
|
2361
2349
|
* @param {*} [options] Override http request option.
|
|
2362
2350
|
* @throws {RequiredError}
|
|
@@ -2368,7 +2356,7 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2368
2356
|
/**
|
|
2369
2357
|
* Get release information
|
|
2370
2358
|
* @summary Get Release Info
|
|
2371
|
-
* @param {
|
|
2359
|
+
* @param {string} releaseId
|
|
2372
2360
|
* @param {*} [options] Override http request option.
|
|
2373
2361
|
* @throws {RequiredError}
|
|
2374
2362
|
* @memberof InternalApi
|
|
@@ -2379,7 +2367,7 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2379
2367
|
/**
|
|
2380
2368
|
* Download release ZIP directly
|
|
2381
2369
|
* @summary Get Release Zip
|
|
2382
|
-
* @param {
|
|
2370
|
+
* @param {string} releaseId
|
|
2383
2371
|
* @param {*} [options] Override http request option.
|
|
2384
2372
|
* @throws {RequiredError}
|
|
2385
2373
|
* @memberof InternalApi
|
|
@@ -2451,7 +2439,7 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2451
2439
|
/**
|
|
2452
2440
|
*
|
|
2453
2441
|
* @summary New Release
|
|
2454
|
-
* @param {
|
|
2442
|
+
* @param {string} deviceId
|
|
2455
2443
|
* @param {File} releaseZip
|
|
2456
2444
|
* @param {string} md5
|
|
2457
2445
|
* @param {Array<string>} changelog
|
|
@@ -2479,7 +2467,7 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2479
2467
|
/**
|
|
2480
2468
|
*
|
|
2481
2469
|
* @summary Update Device
|
|
2482
|
-
* @param {
|
|
2470
|
+
* @param {string} deviceId
|
|
2483
2471
|
* @param {DeviceUpdateBody} deviceUpdateBody
|
|
2484
2472
|
* @param {*} [options] Override http request option.
|
|
2485
2473
|
* @throws {RequiredError}
|
|
@@ -2491,7 +2479,7 @@ class InternalApi extends base_1.BaseAPI {
|
|
|
2491
2479
|
/**
|
|
2492
2480
|
*
|
|
2493
2481
|
* @summary Update User
|
|
2494
|
-
* @param {
|
|
2482
|
+
* @param {string} userId
|
|
2495
2483
|
* @param {UserUpdateBody} userUpdateBody
|
|
2496
2484
|
* @param {*} [options] Override http request option.
|
|
2497
2485
|
* @throws {RequiredError}
|
|
@@ -2511,8 +2499,8 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2511
2499
|
/**
|
|
2512
2500
|
* 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!
|
|
2513
2501
|
* @summary Get Release
|
|
2514
|
-
* @param { | null} [releaseId] Release ID
|
|
2515
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
2502
|
+
* @param {string | null} [releaseId] Release ID
|
|
2503
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
2516
2504
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
2517
2505
|
* @param {string | null} [filename]
|
|
2518
2506
|
* @param {*} [options] Override http request option.
|
|
@@ -2530,14 +2518,10 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2530
2518
|
const localVarHeaderParameter = {};
|
|
2531
2519
|
const localVarQueryParameter = {};
|
|
2532
2520
|
if (releaseId !== undefined) {
|
|
2533
|
-
|
|
2534
|
-
localVarQueryParameter[key] = value;
|
|
2535
|
-
}
|
|
2521
|
+
localVarQueryParameter['release_id'] = releaseId;
|
|
2536
2522
|
}
|
|
2537
2523
|
if (id !== undefined) {
|
|
2538
|
-
|
|
2539
|
-
localVarQueryParameter[key] = value;
|
|
2540
|
-
}
|
|
2524
|
+
localVarQueryParameter['_id'] = id;
|
|
2541
2525
|
}
|
|
2542
2526
|
if (buildId !== undefined) {
|
|
2543
2527
|
localVarQueryParameter['build_id'] = buildId;
|
|
@@ -2556,7 +2540,7 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2556
2540
|
/**
|
|
2557
2541
|
* Gets release information using the release ID, nothing to discuss really.
|
|
2558
2542
|
* @summary Get Release Short
|
|
2559
|
-
* @param {
|
|
2543
|
+
* @param {string} releaseId
|
|
2560
2544
|
* @param {*} [options] Override http request option.
|
|
2561
2545
|
* @deprecated
|
|
2562
2546
|
* @throws {RequiredError}
|
|
@@ -2586,17 +2570,17 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2586
2570
|
/**
|
|
2587
2571
|
* 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.
|
|
2588
2572
|
* @summary Get Releases
|
|
2589
|
-
* @param {Array<
|
|
2590
|
-
* @param {Array<
|
|
2573
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
2574
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
2591
2575
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
2592
|
-
* @param {Array<
|
|
2593
|
-
* @param {Array<
|
|
2576
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
2577
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
2594
2578
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
2595
2579
|
* @param {Array<string>} [version] Filter by release version
|
|
2596
2580
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2597
2581
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
2598
2582
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
2599
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
2583
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
2600
2584
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
2601
2585
|
* @param {ReleasesSort} [sort] Sort mode
|
|
2602
2586
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -2647,9 +2631,7 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2647
2631
|
localVarQueryParameter['freezed'] = freezed;
|
|
2648
2632
|
}
|
|
2649
2633
|
if (afterReleaseId !== undefined) {
|
|
2650
|
-
|
|
2651
|
-
localVarQueryParameter[key] = value;
|
|
2652
|
-
}
|
|
2634
|
+
localVarQueryParameter['after_release_id'] = afterReleaseId;
|
|
2653
2635
|
}
|
|
2654
2636
|
if (afterDate !== undefined) {
|
|
2655
2637
|
localVarQueryParameter['after_date'] = afterDate;
|
|
@@ -2677,8 +2659,8 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
2677
2659
|
/**
|
|
2678
2660
|
* 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!
|
|
2679
2661
|
* @summary Get Updates
|
|
2680
|
-
* @param {
|
|
2681
|
-
* @param {Array<
|
|
2662
|
+
* @param {string} lastKnownId
|
|
2663
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
2682
2664
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2683
2665
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
2684
2666
|
* @param {number | null} [skip] Skip query results
|
|
@@ -2737,8 +2719,8 @@ const ReleaseApiFp = function (configuration) {
|
|
|
2737
2719
|
/**
|
|
2738
2720
|
* 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!
|
|
2739
2721
|
* @summary Get Release
|
|
2740
|
-
* @param { | null} [releaseId] Release ID
|
|
2741
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
2722
|
+
* @param {string | null} [releaseId] Release ID
|
|
2723
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
2742
2724
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
2743
2725
|
* @param {string | null} [filename]
|
|
2744
2726
|
* @param {*} [options] Override http request option.
|
|
@@ -2756,7 +2738,7 @@ const ReleaseApiFp = function (configuration) {
|
|
|
2756
2738
|
/**
|
|
2757
2739
|
* Gets release information using the release ID, nothing to discuss really.
|
|
2758
2740
|
* @summary Get Release Short
|
|
2759
|
-
* @param {
|
|
2741
|
+
* @param {string} releaseId
|
|
2760
2742
|
* @param {*} [options] Override http request option.
|
|
2761
2743
|
* @deprecated
|
|
2762
2744
|
* @throws {RequiredError}
|
|
@@ -2773,17 +2755,17 @@ const ReleaseApiFp = function (configuration) {
|
|
|
2773
2755
|
/**
|
|
2774
2756
|
* 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.
|
|
2775
2757
|
* @summary Get Releases
|
|
2776
|
-
* @param {Array<
|
|
2777
|
-
* @param {Array<
|
|
2758
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
2759
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
2778
2760
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
2779
|
-
* @param {Array<
|
|
2780
|
-
* @param {Array<
|
|
2761
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
2762
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
2781
2763
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
2782
2764
|
* @param {Array<string>} [version] Filter by release version
|
|
2783
2765
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2784
2766
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
2785
2767
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
2786
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
2768
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
2787
2769
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
2788
2770
|
* @param {ReleasesSort} [sort] Sort mode
|
|
2789
2771
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -2804,8 +2786,8 @@ const ReleaseApiFp = function (configuration) {
|
|
|
2804
2786
|
/**
|
|
2805
2787
|
* 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!
|
|
2806
2788
|
* @summary Get Updates
|
|
2807
|
-
* @param {
|
|
2808
|
-
* @param {Array<
|
|
2789
|
+
* @param {string} lastKnownId
|
|
2790
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
2809
2791
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2810
2792
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
2811
2793
|
* @param {number | null} [skip] Skip query results
|
|
@@ -2836,8 +2818,8 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
2836
2818
|
/**
|
|
2837
2819
|
* 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!
|
|
2838
2820
|
* @summary Get Release
|
|
2839
|
-
* @param { | null} [releaseId] Release ID
|
|
2840
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
2821
|
+
* @param {string | null} [releaseId] Release ID
|
|
2822
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
2841
2823
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
2842
2824
|
* @param {string | null} [filename]
|
|
2843
2825
|
* @param {*} [options] Override http request option.
|
|
@@ -2849,7 +2831,7 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
2849
2831
|
/**
|
|
2850
2832
|
* Gets release information using the release ID, nothing to discuss really.
|
|
2851
2833
|
* @summary Get Release Short
|
|
2852
|
-
* @param {
|
|
2834
|
+
* @param {string} releaseId
|
|
2853
2835
|
* @param {*} [options] Override http request option.
|
|
2854
2836
|
* @deprecated
|
|
2855
2837
|
* @throws {RequiredError}
|
|
@@ -2860,17 +2842,17 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
2860
2842
|
/**
|
|
2861
2843
|
* 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.
|
|
2862
2844
|
* @summary Get Releases
|
|
2863
|
-
* @param {Array<
|
|
2864
|
-
* @param {Array<
|
|
2845
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
2846
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
2865
2847
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
2866
|
-
* @param {Array<
|
|
2867
|
-
* @param {Array<
|
|
2848
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
2849
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
2868
2850
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
2869
2851
|
* @param {Array<string>} [version] Filter by release version
|
|
2870
2852
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2871
2853
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
2872
2854
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
2873
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
2855
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
2874
2856
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
2875
2857
|
* @param {ReleasesSort} [sort] Sort mode
|
|
2876
2858
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -2885,8 +2867,8 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
2885
2867
|
/**
|
|
2886
2868
|
* 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!
|
|
2887
2869
|
* @summary Get Updates
|
|
2888
|
-
* @param {
|
|
2889
|
-
* @param {Array<
|
|
2870
|
+
* @param {string} lastKnownId
|
|
2871
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
2890
2872
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2891
2873
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
2892
2874
|
* @param {number | null} [skip] Skip query results
|
|
@@ -2911,8 +2893,8 @@ class ReleaseApi extends base_1.BaseAPI {
|
|
|
2911
2893
|
/**
|
|
2912
2894
|
* 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!
|
|
2913
2895
|
* @summary Get Release
|
|
2914
|
-
* @param { | null} [releaseId] Release ID
|
|
2915
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
2896
|
+
* @param {string | null} [releaseId] Release ID
|
|
2897
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
2916
2898
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
2917
2899
|
* @param {string | null} [filename]
|
|
2918
2900
|
* @param {*} [options] Override http request option.
|
|
@@ -2925,7 +2907,7 @@ class ReleaseApi extends base_1.BaseAPI {
|
|
|
2925
2907
|
/**
|
|
2926
2908
|
* Gets release information using the release ID, nothing to discuss really.
|
|
2927
2909
|
* @summary Get Release Short
|
|
2928
|
-
* @param {
|
|
2910
|
+
* @param {string} releaseId
|
|
2929
2911
|
* @param {*} [options] Override http request option.
|
|
2930
2912
|
* @deprecated
|
|
2931
2913
|
* @throws {RequiredError}
|
|
@@ -2937,17 +2919,17 @@ class ReleaseApi extends base_1.BaseAPI {
|
|
|
2937
2919
|
/**
|
|
2938
2920
|
* 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.
|
|
2939
2921
|
* @summary Get Releases
|
|
2940
|
-
* @param {Array<
|
|
2941
|
-
* @param {Array<
|
|
2922
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
2923
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
2942
2924
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
2943
|
-
* @param {Array<
|
|
2944
|
-
* @param {Array<
|
|
2925
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
2926
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
2945
2927
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
2946
2928
|
* @param {Array<string>} [version] Filter by release version
|
|
2947
2929
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2948
2930
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
2949
2931
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
2950
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
2932
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
2951
2933
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
2952
2934
|
* @param {ReleasesSort} [sort] Sort mode
|
|
2953
2935
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -2963,8 +2945,8 @@ class ReleaseApi extends base_1.BaseAPI {
|
|
|
2963
2945
|
/**
|
|
2964
2946
|
* 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!
|
|
2965
2947
|
* @summary Get Updates
|
|
2966
|
-
* @param {
|
|
2967
|
-
* @param {Array<
|
|
2948
|
+
* @param {string} lastKnownId
|
|
2949
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
2968
2950
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
2969
2951
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
2970
2952
|
* @param {number | null} [skip] Skip query results
|