@orangefox-recovery/foxclient 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 +110 -120
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +105 -105
- package/dist/api.js +62 -72
- 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 +105 -105
- package/dist/esm/api.js +62 -72
- 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/ReleaseApi.md +22 -25
- 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).
|
|
@@ -57,8 +57,8 @@ const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
57
57
|
/**
|
|
58
58
|
* 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.
|
|
59
59
|
* @summary Get Device
|
|
60
|
-
* @param { | null} [deviceId]
|
|
61
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
60
|
+
* @param {string | null} [deviceId]
|
|
61
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
62
62
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
@@ -75,14 +75,10 @@ const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
75
75
|
const localVarHeaderParameter = {};
|
|
76
76
|
const localVarQueryParameter = {};
|
|
77
77
|
if (deviceId !== undefined) {
|
|
78
|
-
|
|
79
|
-
localVarQueryParameter[key] = value;
|
|
80
|
-
}
|
|
78
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
81
79
|
}
|
|
82
80
|
if (id !== undefined) {
|
|
83
|
-
|
|
84
|
-
localVarQueryParameter[key] = value;
|
|
85
|
-
}
|
|
81
|
+
localVarQueryParameter['_id'] = id;
|
|
86
82
|
}
|
|
87
83
|
if (codename !== undefined) {
|
|
88
84
|
localVarQueryParameter['codename'] = codename;
|
|
@@ -128,8 +124,8 @@ const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
128
124
|
/**
|
|
129
125
|
* 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.
|
|
130
126
|
* @summary Get Devices
|
|
131
|
-
* @param {Array<
|
|
132
|
-
* @param {Array<
|
|
127
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
128
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
133
129
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
134
130
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
135
131
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -232,8 +228,8 @@ const DeviceApiFp = function (configuration) {
|
|
|
232
228
|
/**
|
|
233
229
|
* 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.
|
|
234
230
|
* @summary Get Device
|
|
235
|
-
* @param { | null} [deviceId]
|
|
236
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
231
|
+
* @param {string | null} [deviceId]
|
|
232
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
237
233
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
238
234
|
* @param {*} [options] Override http request option.
|
|
239
235
|
* @throws {RequiredError}
|
|
@@ -267,8 +263,8 @@ const DeviceApiFp = function (configuration) {
|
|
|
267
263
|
/**
|
|
268
264
|
* 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.
|
|
269
265
|
* @summary Get Devices
|
|
270
|
-
* @param {Array<
|
|
271
|
-
* @param {Array<
|
|
266
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
267
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
272
268
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
273
269
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
274
270
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -318,8 +314,8 @@ const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
318
314
|
/**
|
|
319
315
|
* 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.
|
|
320
316
|
* @summary Get Device
|
|
321
|
-
* @param { | null} [deviceId]
|
|
322
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
317
|
+
* @param {string | null} [deviceId]
|
|
318
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
323
319
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
324
320
|
* @param {*} [options] Override http request option.
|
|
325
321
|
* @throws {RequiredError}
|
|
@@ -341,8 +337,8 @@ const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
341
337
|
/**
|
|
342
338
|
* 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.
|
|
343
339
|
* @summary Get Devices
|
|
344
|
-
* @param {Array<
|
|
345
|
-
* @param {Array<
|
|
340
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
341
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
346
342
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
347
343
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
348
344
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -380,8 +376,8 @@ class DeviceApi extends base_1.BaseAPI {
|
|
|
380
376
|
/**
|
|
381
377
|
* 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.
|
|
382
378
|
* @summary Get Device
|
|
383
|
-
* @param { | null} [deviceId]
|
|
384
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
379
|
+
* @param {string | null} [deviceId]
|
|
380
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
385
381
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
386
382
|
* @param {*} [options] Override http request option.
|
|
387
383
|
* @throws {RequiredError}
|
|
@@ -405,8 +401,8 @@ class DeviceApi extends base_1.BaseAPI {
|
|
|
405
401
|
/**
|
|
406
402
|
* 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.
|
|
407
403
|
* @summary Get Devices
|
|
408
|
-
* @param {Array<
|
|
409
|
-
* @param {Array<
|
|
404
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
405
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
410
406
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
411
407
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
412
408
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -444,8 +440,8 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
444
440
|
/**
|
|
445
441
|
* 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!
|
|
446
442
|
* @summary Get Release
|
|
447
|
-
* @param { | null} [releaseId] Release ID
|
|
448
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
443
|
+
* @param {string | null} [releaseId] Release ID
|
|
444
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
449
445
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
450
446
|
* @param {string | null} [filename]
|
|
451
447
|
* @param {*} [options] Override http request option.
|
|
@@ -463,14 +459,10 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
463
459
|
const localVarHeaderParameter = {};
|
|
464
460
|
const localVarQueryParameter = {};
|
|
465
461
|
if (releaseId !== undefined) {
|
|
466
|
-
|
|
467
|
-
localVarQueryParameter[key] = value;
|
|
468
|
-
}
|
|
462
|
+
localVarQueryParameter['release_id'] = releaseId;
|
|
469
463
|
}
|
|
470
464
|
if (id !== undefined) {
|
|
471
|
-
|
|
472
|
-
localVarQueryParameter[key] = value;
|
|
473
|
-
}
|
|
465
|
+
localVarQueryParameter['_id'] = id;
|
|
474
466
|
}
|
|
475
467
|
if (buildId !== undefined) {
|
|
476
468
|
localVarQueryParameter['build_id'] = buildId;
|
|
@@ -489,7 +481,7 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
489
481
|
/**
|
|
490
482
|
* Gets release information using the release ID, nothing to discuss really.
|
|
491
483
|
* @summary Get Release Short
|
|
492
|
-
* @param {
|
|
484
|
+
* @param {string} releaseId
|
|
493
485
|
* @param {*} [options] Override http request option.
|
|
494
486
|
* @deprecated
|
|
495
487
|
* @throws {RequiredError}
|
|
@@ -519,17 +511,17 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
519
511
|
/**
|
|
520
512
|
* 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.
|
|
521
513
|
* @summary Get Releases
|
|
522
|
-
* @param {Array<
|
|
523
|
-
* @param {Array<
|
|
514
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
515
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
524
516
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
525
|
-
* @param {Array<
|
|
526
|
-
* @param {Array<
|
|
517
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
518
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
527
519
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
528
520
|
* @param {Array<string>} [version] Filter by release version
|
|
529
521
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
530
522
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
531
523
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
532
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
524
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
533
525
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
534
526
|
* @param {ReleasesSort} [sort] Sort mode
|
|
535
527
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -580,9 +572,7 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
580
572
|
localVarQueryParameter['freezed'] = freezed;
|
|
581
573
|
}
|
|
582
574
|
if (afterReleaseId !== undefined) {
|
|
583
|
-
|
|
584
|
-
localVarQueryParameter[key] = value;
|
|
585
|
-
}
|
|
575
|
+
localVarQueryParameter['after_release_id'] = afterReleaseId;
|
|
586
576
|
}
|
|
587
577
|
if (afterDate !== undefined) {
|
|
588
578
|
localVarQueryParameter['after_date'] = afterDate;
|
|
@@ -610,8 +600,8 @@ const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
610
600
|
/**
|
|
611
601
|
* 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!
|
|
612
602
|
* @summary Get Updates
|
|
613
|
-
* @param {
|
|
614
|
-
* @param {Array<
|
|
603
|
+
* @param {string} lastKnownId
|
|
604
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
615
605
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
616
606
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
617
607
|
* @param {number | null} [skip] Skip query results
|
|
@@ -670,8 +660,8 @@ const ReleaseApiFp = function (configuration) {
|
|
|
670
660
|
/**
|
|
671
661
|
* 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!
|
|
672
662
|
* @summary Get Release
|
|
673
|
-
* @param { | null} [releaseId] Release ID
|
|
674
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
663
|
+
* @param {string | null} [releaseId] Release ID
|
|
664
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
675
665
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
676
666
|
* @param {string | null} [filename]
|
|
677
667
|
* @param {*} [options] Override http request option.
|
|
@@ -689,7 +679,7 @@ const ReleaseApiFp = function (configuration) {
|
|
|
689
679
|
/**
|
|
690
680
|
* Gets release information using the release ID, nothing to discuss really.
|
|
691
681
|
* @summary Get Release Short
|
|
692
|
-
* @param {
|
|
682
|
+
* @param {string} releaseId
|
|
693
683
|
* @param {*} [options] Override http request option.
|
|
694
684
|
* @deprecated
|
|
695
685
|
* @throws {RequiredError}
|
|
@@ -706,17 +696,17 @@ const ReleaseApiFp = function (configuration) {
|
|
|
706
696
|
/**
|
|
707
697
|
* 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.
|
|
708
698
|
* @summary Get Releases
|
|
709
|
-
* @param {Array<
|
|
710
|
-
* @param {Array<
|
|
699
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
700
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
711
701
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
712
|
-
* @param {Array<
|
|
713
|
-
* @param {Array<
|
|
702
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
703
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
714
704
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
715
705
|
* @param {Array<string>} [version] Filter by release version
|
|
716
706
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
717
707
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
718
708
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
719
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
709
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
720
710
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
721
711
|
* @param {ReleasesSort} [sort] Sort mode
|
|
722
712
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -737,8 +727,8 @@ const ReleaseApiFp = function (configuration) {
|
|
|
737
727
|
/**
|
|
738
728
|
* 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!
|
|
739
729
|
* @summary Get Updates
|
|
740
|
-
* @param {
|
|
741
|
-
* @param {Array<
|
|
730
|
+
* @param {string} lastKnownId
|
|
731
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
742
732
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
743
733
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
744
734
|
* @param {number | null} [skip] Skip query results
|
|
@@ -769,8 +759,8 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
769
759
|
/**
|
|
770
760
|
* 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!
|
|
771
761
|
* @summary Get Release
|
|
772
|
-
* @param { | null} [releaseId] Release ID
|
|
773
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
762
|
+
* @param {string | null} [releaseId] Release ID
|
|
763
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
774
764
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
775
765
|
* @param {string | null} [filename]
|
|
776
766
|
* @param {*} [options] Override http request option.
|
|
@@ -782,7 +772,7 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
782
772
|
/**
|
|
783
773
|
* Gets release information using the release ID, nothing to discuss really.
|
|
784
774
|
* @summary Get Release Short
|
|
785
|
-
* @param {
|
|
775
|
+
* @param {string} releaseId
|
|
786
776
|
* @param {*} [options] Override http request option.
|
|
787
777
|
* @deprecated
|
|
788
778
|
* @throws {RequiredError}
|
|
@@ -793,17 +783,17 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
793
783
|
/**
|
|
794
784
|
* 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.
|
|
795
785
|
* @summary Get Releases
|
|
796
|
-
* @param {Array<
|
|
797
|
-
* @param {Array<
|
|
786
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
787
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
798
788
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
799
|
-
* @param {Array<
|
|
800
|
-
* @param {Array<
|
|
789
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
790
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
801
791
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
802
792
|
* @param {Array<string>} [version] Filter by release version
|
|
803
793
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
804
794
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
805
795
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
806
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
796
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
807
797
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
808
798
|
* @param {ReleasesSort} [sort] Sort mode
|
|
809
799
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -818,8 +808,8 @@ const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
818
808
|
/**
|
|
819
809
|
* 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!
|
|
820
810
|
* @summary Get Updates
|
|
821
|
-
* @param {
|
|
822
|
-
* @param {Array<
|
|
811
|
+
* @param {string} lastKnownId
|
|
812
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
823
813
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
824
814
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
825
815
|
* @param {number | null} [skip] Skip query results
|
|
@@ -844,8 +834,8 @@ class ReleaseApi extends base_1.BaseAPI {
|
|
|
844
834
|
/**
|
|
845
835
|
* 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!
|
|
846
836
|
* @summary Get Release
|
|
847
|
-
* @param { | null} [releaseId] Release ID
|
|
848
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
837
|
+
* @param {string | null} [releaseId] Release ID
|
|
838
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
849
839
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
850
840
|
* @param {string | null} [filename]
|
|
851
841
|
* @param {*} [options] Override http request option.
|
|
@@ -858,7 +848,7 @@ class ReleaseApi extends base_1.BaseAPI {
|
|
|
858
848
|
/**
|
|
859
849
|
* Gets release information using the release ID, nothing to discuss really.
|
|
860
850
|
* @summary Get Release Short
|
|
861
|
-
* @param {
|
|
851
|
+
* @param {string} releaseId
|
|
862
852
|
* @param {*} [options] Override http request option.
|
|
863
853
|
* @deprecated
|
|
864
854
|
* @throws {RequiredError}
|
|
@@ -870,17 +860,17 @@ class ReleaseApi extends base_1.BaseAPI {
|
|
|
870
860
|
/**
|
|
871
861
|
* 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.
|
|
872
862
|
* @summary Get Releases
|
|
873
|
-
* @param {Array<
|
|
874
|
-
* @param {Array<
|
|
863
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
864
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
875
865
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
876
|
-
* @param {Array<
|
|
877
|
-
* @param {Array<
|
|
866
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
867
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
878
868
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
879
869
|
* @param {Array<string>} [version] Filter by release version
|
|
880
870
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
881
871
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
882
872
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
883
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
873
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
884
874
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
885
875
|
* @param {ReleasesSort} [sort] Sort mode
|
|
886
876
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -896,8 +886,8 @@ class ReleaseApi extends base_1.BaseAPI {
|
|
|
896
886
|
/**
|
|
897
887
|
* 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!
|
|
898
888
|
* @summary Get Updates
|
|
899
|
-
* @param {
|
|
900
|
-
* @param {Array<
|
|
889
|
+
* @param {string} lastKnownId
|
|
890
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
901
891
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
902
892
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
903
893
|
* @param {number | null} [skip] Skip query results
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.3
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.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).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.3
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.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).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.3
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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).
|