@orangefox-recovery/foxclient 5.2.1 → 5.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +106 -116
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +101 -101
- 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 +101 -101
- 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/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.2
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -54,8 +54,8 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
54
54
|
/**
|
|
55
55
|
* 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.
|
|
56
56
|
* @summary Get Device
|
|
57
|
-
* @param { | null} [deviceId]
|
|
58
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
57
|
+
* @param {string | null} [deviceId]
|
|
58
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
59
59
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
60
60
|
* @param {*} [options] Override http request option.
|
|
61
61
|
* @throws {RequiredError}
|
|
@@ -72,14 +72,10 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
72
72
|
const localVarHeaderParameter = {};
|
|
73
73
|
const localVarQueryParameter = {};
|
|
74
74
|
if (deviceId !== undefined) {
|
|
75
|
-
|
|
76
|
-
localVarQueryParameter[key] = value;
|
|
77
|
-
}
|
|
75
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
78
76
|
}
|
|
79
77
|
if (id !== undefined) {
|
|
80
|
-
|
|
81
|
-
localVarQueryParameter[key] = value;
|
|
82
|
-
}
|
|
78
|
+
localVarQueryParameter['_id'] = id;
|
|
83
79
|
}
|
|
84
80
|
if (codename !== undefined) {
|
|
85
81
|
localVarQueryParameter['codename'] = codename;
|
|
@@ -125,8 +121,8 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
125
121
|
/**
|
|
126
122
|
* 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.
|
|
127
123
|
* @summary Get Devices
|
|
128
|
-
* @param {Array<
|
|
129
|
-
* @param {Array<
|
|
124
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
125
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
130
126
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
131
127
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
132
128
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -228,8 +224,8 @@ export const DeviceApiFp = function (configuration) {
|
|
|
228
224
|
/**
|
|
229
225
|
* 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.
|
|
230
226
|
* @summary Get Device
|
|
231
|
-
* @param { | null} [deviceId]
|
|
232
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
227
|
+
* @param {string | null} [deviceId]
|
|
228
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
233
229
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
234
230
|
* @param {*} [options] Override http request option.
|
|
235
231
|
* @throws {RequiredError}
|
|
@@ -263,8 +259,8 @@ export const DeviceApiFp = function (configuration) {
|
|
|
263
259
|
/**
|
|
264
260
|
* 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.
|
|
265
261
|
* @summary Get Devices
|
|
266
|
-
* @param {Array<
|
|
267
|
-
* @param {Array<
|
|
262
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
263
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
268
264
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
269
265
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
270
266
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -313,8 +309,8 @@ export const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
313
309
|
/**
|
|
314
310
|
* 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.
|
|
315
311
|
* @summary Get Device
|
|
316
|
-
* @param { | null} [deviceId]
|
|
317
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
312
|
+
* @param {string | null} [deviceId]
|
|
313
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
318
314
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
319
315
|
* @param {*} [options] Override http request option.
|
|
320
316
|
* @throws {RequiredError}
|
|
@@ -336,8 +332,8 @@ export const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
336
332
|
/**
|
|
337
333
|
* 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.
|
|
338
334
|
* @summary Get Devices
|
|
339
|
-
* @param {Array<
|
|
340
|
-
* @param {Array<
|
|
335
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
336
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
341
337
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
342
338
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
343
339
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -374,8 +370,8 @@ export class DeviceApi extends BaseAPI {
|
|
|
374
370
|
/**
|
|
375
371
|
* 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.
|
|
376
372
|
* @summary Get Device
|
|
377
|
-
* @param { | null} [deviceId]
|
|
378
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
373
|
+
* @param {string | null} [deviceId]
|
|
374
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
379
375
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
380
376
|
* @param {*} [options] Override http request option.
|
|
381
377
|
* @throws {RequiredError}
|
|
@@ -399,8 +395,8 @@ export class DeviceApi extends BaseAPI {
|
|
|
399
395
|
/**
|
|
400
396
|
* 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.
|
|
401
397
|
* @summary Get Devices
|
|
402
|
-
* @param {Array<
|
|
403
|
-
* @param {Array<
|
|
398
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
399
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
404
400
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
405
401
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
406
402
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -437,8 +433,8 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
437
433
|
/**
|
|
438
434
|
* 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!
|
|
439
435
|
* @summary Get Release
|
|
440
|
-
* @param { | null} [releaseId] Release ID
|
|
441
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
436
|
+
* @param {string | null} [releaseId] Release ID
|
|
437
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
442
438
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
443
439
|
* @param {string | null} [filename]
|
|
444
440
|
* @param {*} [options] Override http request option.
|
|
@@ -456,14 +452,10 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
456
452
|
const localVarHeaderParameter = {};
|
|
457
453
|
const localVarQueryParameter = {};
|
|
458
454
|
if (releaseId !== undefined) {
|
|
459
|
-
|
|
460
|
-
localVarQueryParameter[key] = value;
|
|
461
|
-
}
|
|
455
|
+
localVarQueryParameter['release_id'] = releaseId;
|
|
462
456
|
}
|
|
463
457
|
if (id !== undefined) {
|
|
464
|
-
|
|
465
|
-
localVarQueryParameter[key] = value;
|
|
466
|
-
}
|
|
458
|
+
localVarQueryParameter['_id'] = id;
|
|
467
459
|
}
|
|
468
460
|
if (buildId !== undefined) {
|
|
469
461
|
localVarQueryParameter['build_id'] = buildId;
|
|
@@ -482,7 +474,7 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
482
474
|
/**
|
|
483
475
|
* Gets release information using the release ID, nothing to discuss really.
|
|
484
476
|
* @summary Get Release Short
|
|
485
|
-
* @param {
|
|
477
|
+
* @param {string} releaseId
|
|
486
478
|
* @param {*} [options] Override http request option.
|
|
487
479
|
* @deprecated
|
|
488
480
|
* @throws {RequiredError}
|
|
@@ -512,17 +504,17 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
512
504
|
/**
|
|
513
505
|
* 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.
|
|
514
506
|
* @summary Get Releases
|
|
515
|
-
* @param {Array<
|
|
516
|
-
* @param {Array<
|
|
507
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
508
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
517
509
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
518
|
-
* @param {Array<
|
|
519
|
-
* @param {Array<
|
|
510
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
511
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
520
512
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
521
513
|
* @param {Array<string>} [version] Filter by release version
|
|
522
514
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
523
515
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
524
516
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
525
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
517
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
526
518
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
527
519
|
* @param {ReleasesSort} [sort] Sort mode
|
|
528
520
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -573,9 +565,7 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
573
565
|
localVarQueryParameter['freezed'] = freezed;
|
|
574
566
|
}
|
|
575
567
|
if (afterReleaseId !== undefined) {
|
|
576
|
-
|
|
577
|
-
localVarQueryParameter[key] = value;
|
|
578
|
-
}
|
|
568
|
+
localVarQueryParameter['after_release_id'] = afterReleaseId;
|
|
579
569
|
}
|
|
580
570
|
if (afterDate !== undefined) {
|
|
581
571
|
localVarQueryParameter['after_date'] = afterDate;
|
|
@@ -603,8 +593,8 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
603
593
|
/**
|
|
604
594
|
* 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!
|
|
605
595
|
* @summary Get Updates
|
|
606
|
-
* @param {
|
|
607
|
-
* @param {Array<
|
|
596
|
+
* @param {string} lastKnownId
|
|
597
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
608
598
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
609
599
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
610
600
|
* @param {number | null} [skip] Skip query results
|
|
@@ -662,8 +652,8 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
662
652
|
/**
|
|
663
653
|
* 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!
|
|
664
654
|
* @summary Get Release
|
|
665
|
-
* @param { | null} [releaseId] Release ID
|
|
666
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
655
|
+
* @param {string | null} [releaseId] Release ID
|
|
656
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
667
657
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
668
658
|
* @param {string | null} [filename]
|
|
669
659
|
* @param {*} [options] Override http request option.
|
|
@@ -681,7 +671,7 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
681
671
|
/**
|
|
682
672
|
* Gets release information using the release ID, nothing to discuss really.
|
|
683
673
|
* @summary Get Release Short
|
|
684
|
-
* @param {
|
|
674
|
+
* @param {string} releaseId
|
|
685
675
|
* @param {*} [options] Override http request option.
|
|
686
676
|
* @deprecated
|
|
687
677
|
* @throws {RequiredError}
|
|
@@ -698,17 +688,17 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
698
688
|
/**
|
|
699
689
|
* 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.
|
|
700
690
|
* @summary Get Releases
|
|
701
|
-
* @param {Array<
|
|
702
|
-
* @param {Array<
|
|
691
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
692
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
703
693
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
704
|
-
* @param {Array<
|
|
705
|
-
* @param {Array<
|
|
694
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
695
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
706
696
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
707
697
|
* @param {Array<string>} [version] Filter by release version
|
|
708
698
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
709
699
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
710
700
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
711
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
701
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
712
702
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
713
703
|
* @param {ReleasesSort} [sort] Sort mode
|
|
714
704
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -729,8 +719,8 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
729
719
|
/**
|
|
730
720
|
* 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!
|
|
731
721
|
* @summary Get Updates
|
|
732
|
-
* @param {
|
|
733
|
-
* @param {Array<
|
|
722
|
+
* @param {string} lastKnownId
|
|
723
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
734
724
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
735
725
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
736
726
|
* @param {number | null} [skip] Skip query results
|
|
@@ -760,8 +750,8 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
760
750
|
/**
|
|
761
751
|
* 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!
|
|
762
752
|
* @summary Get Release
|
|
763
|
-
* @param { | null} [releaseId] Release ID
|
|
764
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
753
|
+
* @param {string | null} [releaseId] Release ID
|
|
754
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
765
755
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
766
756
|
* @param {string | null} [filename]
|
|
767
757
|
* @param {*} [options] Override http request option.
|
|
@@ -773,7 +763,7 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
773
763
|
/**
|
|
774
764
|
* Gets release information using the release ID, nothing to discuss really.
|
|
775
765
|
* @summary Get Release Short
|
|
776
|
-
* @param {
|
|
766
|
+
* @param {string} releaseId
|
|
777
767
|
* @param {*} [options] Override http request option.
|
|
778
768
|
* @deprecated
|
|
779
769
|
* @throws {RequiredError}
|
|
@@ -784,17 +774,17 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
784
774
|
/**
|
|
785
775
|
* 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.
|
|
786
776
|
* @summary Get Releases
|
|
787
|
-
* @param {Array<
|
|
788
|
-
* @param {Array<
|
|
777
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
778
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
789
779
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
790
|
-
* @param {Array<
|
|
791
|
-
* @param {Array<
|
|
780
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
781
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
792
782
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
793
783
|
* @param {Array<string>} [version] Filter by release version
|
|
794
784
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
795
785
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
796
786
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
797
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
787
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
798
788
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
799
789
|
* @param {ReleasesSort} [sort] Sort mode
|
|
800
790
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -809,8 +799,8 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
809
799
|
/**
|
|
810
800
|
* 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!
|
|
811
801
|
* @summary Get Updates
|
|
812
|
-
* @param {
|
|
813
|
-
* @param {Array<
|
|
802
|
+
* @param {string} lastKnownId
|
|
803
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
814
804
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
815
805
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
816
806
|
* @param {number | null} [skip] Skip query results
|
|
@@ -834,8 +824,8 @@ export class ReleaseApi extends BaseAPI {
|
|
|
834
824
|
/**
|
|
835
825
|
* 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!
|
|
836
826
|
* @summary Get Release
|
|
837
|
-
* @param { | null} [releaseId] Release ID
|
|
838
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
827
|
+
* @param {string | null} [releaseId] Release ID
|
|
828
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
839
829
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
840
830
|
* @param {string | null} [filename]
|
|
841
831
|
* @param {*} [options] Override http request option.
|
|
@@ -848,7 +838,7 @@ export class ReleaseApi extends BaseAPI {
|
|
|
848
838
|
/**
|
|
849
839
|
* Gets release information using the release ID, nothing to discuss really.
|
|
850
840
|
* @summary Get Release Short
|
|
851
|
-
* @param {
|
|
841
|
+
* @param {string} releaseId
|
|
852
842
|
* @param {*} [options] Override http request option.
|
|
853
843
|
* @deprecated
|
|
854
844
|
* @throws {RequiredError}
|
|
@@ -860,17 +850,17 @@ export class ReleaseApi extends BaseAPI {
|
|
|
860
850
|
/**
|
|
861
851
|
* 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.
|
|
862
852
|
* @summary Get Releases
|
|
863
|
-
* @param {Array<
|
|
864
|
-
* @param {Array<
|
|
853
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
854
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
865
855
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
866
|
-
* @param {Array<
|
|
867
|
-
* @param {Array<
|
|
856
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
857
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
868
858
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
869
859
|
* @param {Array<string>} [version] Filter by release version
|
|
870
860
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
871
861
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
872
862
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
873
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
863
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
874
864
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
875
865
|
* @param {ReleasesSort} [sort] Sort mode
|
|
876
866
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -886,8 +876,8 @@ export class ReleaseApi extends BaseAPI {
|
|
|
886
876
|
/**
|
|
887
877
|
* 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!
|
|
888
878
|
* @summary Get Updates
|
|
889
|
-
* @param {
|
|
890
|
-
* @param {Array<
|
|
879
|
+
* @param {string} lastKnownId
|
|
880
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
891
881
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
892
882
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
893
883
|
* @param {number | null} [skip] Skip query results
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.2
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.2
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.2
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.2
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.2
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.2
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.2
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.2
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.2.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.2
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Fox API
|
|
6
6
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.2.
|
|
8
|
+
* The version of the OpenAPI document: 5.2.2
|
|
9
9
|
* Contact: admin@orangefox.tech
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/DeviceApi.md
CHANGED
|
@@ -19,16 +19,14 @@ Extended get device method, including the ability to get a device using device c
|
|
|
19
19
|
```typescript
|
|
20
20
|
import {
|
|
21
21
|
DeviceApi,
|
|
22
|
-
Configuration
|
|
23
|
-
,
|
|
24
|
-
|
|
22
|
+
Configuration
|
|
25
23
|
} from '@orangefox-recovery/foxclient';
|
|
26
24
|
|
|
27
25
|
const configuration = new Configuration();
|
|
28
26
|
const apiInstance = new DeviceApi(configuration);
|
|
29
27
|
|
|
30
|
-
let deviceId: ; // (optional) (default to undefined)
|
|
31
|
-
let id: ; //Filter by Device ID (deprecated) (optional) (default to undefined)
|
|
28
|
+
let deviceId: string; // (optional) (default to undefined)
|
|
29
|
+
let id: string; //Filter by Device ID (deprecated) (optional) (default to undefined)
|
|
32
30
|
let codename: string; //Not recommended to use when you can (optional) (default to undefined)
|
|
33
31
|
|
|
34
32
|
const { status, data } = await apiInstance.getDevice(
|
|
@@ -42,8 +40,8 @@ const { status, data } = await apiInstance.getDevice(
|
|
|
42
40
|
|
|
43
41
|
|Name | Type | Description | Notes|
|
|
44
42
|
|------------- | ------------- | ------------- | -------------|
|
|
45
|
-
| **deviceId** |
|
|
46
|
-
| **id** |
|
|
43
|
+
| **deviceId** | [**string**] | | (optional) defaults to undefined|
|
|
44
|
+
| **id** | [**string**] | Filter by Device ID (deprecated) | (optional) defaults to undefined|
|
|
47
45
|
| **codename** | [**string**] | Not recommended to use when you can | (optional) defaults to undefined|
|
|
48
46
|
|
|
49
47
|
|
|
@@ -140,8 +138,8 @@ import {
|
|
|
140
138
|
const configuration = new Configuration();
|
|
141
139
|
const apiInstance = new DeviceApi(configuration);
|
|
142
140
|
|
|
143
|
-
let id: Array<
|
|
144
|
-
let id2: Array<
|
|
141
|
+
let id: Array<string>; //Filter by Device IDs (optional) (default to undefined)
|
|
142
|
+
let id2: Array<string>; //Filter by Device IDs (deprecated) (optional) (default to undefined)
|
|
145
143
|
let oemName: Array<string>; //Filter by OEM names (optional) (default to undefined)
|
|
146
144
|
let codename: Array<string>; //Filter by device codenames (optional) (default to undefined)
|
|
147
145
|
let modelName: Array<string>; //Filter by model names (optional) (default to undefined)
|
|
@@ -171,8 +169,8 @@ const { status, data } = await apiInstance.getDevices(
|
|
|
171
169
|
|
|
172
170
|
|Name | Type | Description | Notes|
|
|
173
171
|
|------------- | ------------- | ------------- | -------------|
|
|
174
|
-
| **id** | **Array<
|
|
175
|
-
| **id2** | **Array<
|
|
172
|
+
| **id** | **Array<string>** | Filter by Device IDs | (optional) defaults to undefined|
|
|
173
|
+
| **id2** | **Array<string>** | Filter by Device IDs (deprecated) | (optional) defaults to undefined|
|
|
176
174
|
| **oemName** | **Array<string>** | Filter by OEM names | (optional) defaults to undefined|
|
|
177
175
|
| **codename** | **Array<string>** | Filter by device codenames | (optional) defaults to undefined|
|
|
178
176
|
| **modelName** | **Array<string>** | Filter by model names | (optional) defaults to undefined|
|