@orangefox-recovery/foxclient 5.1.1 → 5.2.0
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 +8 -8
- package/api.ts +127 -189
- package/base.ts +3 -3
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +87 -77
- package/dist/api.js +109 -155
- package/dist/base.d.ts +2 -2
- package/dist/base.js +3 -3
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +87 -77
- package/dist/esm/api.js +110 -156
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +3 -3
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/DeviceApi.md +36 -36
- package/docs/ReleaseApi.md +13 -13
- package/docs/StatsApi.md +2 -2
- package/index.ts +2 -2
- package/package.json +1 -1
package/base.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Fox API
|
|
5
|
-
* Warning: Please add a custom
|
|
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 20 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.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -19,7 +19,7 @@ import type { Configuration } from './configuration';
|
|
|
19
19
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
20
20
|
import globalAxios from 'axios';
|
|
21
21
|
|
|
22
|
-
export const BASE_PATH = "
|
|
22
|
+
export const BASE_PATH = "https://api.orangefox.download".replace(/\/+$/, "");
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
25
|
*
|
package/common.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Fox API
|
|
5
|
-
* Warning: Please add a custom
|
|
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 20 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.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Fox API
|
|
5
|
-
* Warning: Please add a custom
|
|
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 20 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.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.0
|
|
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/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Fox API
|
|
3
|
-
* Warning: Please add a custom
|
|
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 20 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.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.0
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -651,26 +651,27 @@ export interface ValidationErrorLocInner {
|
|
|
651
651
|
*/
|
|
652
652
|
export declare const DeviceApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
653
653
|
/**
|
|
654
|
-
*
|
|
654
|
+
* 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.
|
|
655
655
|
* @summary Get Device
|
|
656
|
-
* @param {
|
|
656
|
+
* @param { | null} [deviceId]
|
|
657
|
+
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
658
|
+
* @param {string | null} [codename] Not recommended to use when you can
|
|
657
659
|
* @param {*} [options] Override http request option.
|
|
658
660
|
* @throws {RequiredError}
|
|
659
661
|
*/
|
|
660
|
-
|
|
662
|
+
getDeviceDevicesGetGet: (deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
661
663
|
/**
|
|
662
|
-
*
|
|
663
|
-
* @summary Get Device
|
|
664
|
-
* @param {
|
|
665
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
666
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
664
|
+
* Gets device info using device ID.
|
|
665
|
+
* @summary Get Device Short
|
|
666
|
+
* @param {string} deviceId
|
|
667
667
|
* @param {*} [options] Override http request option.
|
|
668
|
+
* @deprecated
|
|
668
669
|
* @throws {RequiredError}
|
|
669
670
|
*/
|
|
670
|
-
|
|
671
|
+
getDeviceShortDevicesDeviceIdGet: (deviceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
671
672
|
/**
|
|
672
673
|
* 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.
|
|
673
|
-
* @summary Get Devices
|
|
674
|
+
* @summary Get Devices
|
|
674
675
|
* @param {Array<any>} [id] Filter by Device IDs
|
|
675
676
|
* @param {Array<any>} [id2] Filter by Device IDs (deprecated)
|
|
676
677
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
@@ -685,7 +686,7 @@ export declare const DeviceApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
685
686
|
* @param {*} [options] Override http request option.
|
|
686
687
|
* @throws {RequiredError}
|
|
687
688
|
*/
|
|
688
|
-
|
|
689
|
+
getDevicesDevicesGet: (id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
689
690
|
/**
|
|
690
691
|
* Lists all OEM names
|
|
691
692
|
* @summary Get Oems List
|
|
@@ -700,26 +701,27 @@ export declare const DeviceApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
700
701
|
*/
|
|
701
702
|
export declare const DeviceApiFp: (configuration?: Configuration) => {
|
|
702
703
|
/**
|
|
703
|
-
*
|
|
704
|
+
* 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.
|
|
704
705
|
* @summary Get Device
|
|
705
|
-
* @param {
|
|
706
|
+
* @param { | null} [deviceId]
|
|
707
|
+
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
708
|
+
* @param {string | null} [codename] Not recommended to use when you can
|
|
706
709
|
* @param {*} [options] Override http request option.
|
|
707
710
|
* @throws {RequiredError}
|
|
708
711
|
*/
|
|
709
|
-
|
|
712
|
+
getDeviceDevicesGetGet(deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>>;
|
|
710
713
|
/**
|
|
711
|
-
*
|
|
712
|
-
* @summary Get Device
|
|
713
|
-
* @param {
|
|
714
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
715
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
714
|
+
* Gets device info using device ID.
|
|
715
|
+
* @summary Get Device Short
|
|
716
|
+
* @param {string} deviceId
|
|
716
717
|
* @param {*} [options] Override http request option.
|
|
718
|
+
* @deprecated
|
|
717
719
|
* @throws {RequiredError}
|
|
718
720
|
*/
|
|
719
|
-
|
|
721
|
+
getDeviceShortDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>>;
|
|
720
722
|
/**
|
|
721
723
|
* 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.
|
|
722
|
-
* @summary Get Devices
|
|
724
|
+
* @summary Get Devices
|
|
723
725
|
* @param {Array<any>} [id] Filter by Device IDs
|
|
724
726
|
* @param {Array<any>} [id2] Filter by Device IDs (deprecated)
|
|
725
727
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
@@ -734,7 +736,7 @@ export declare const DeviceApiFp: (configuration?: Configuration) => {
|
|
|
734
736
|
* @param {*} [options] Override http request option.
|
|
735
737
|
* @throws {RequiredError}
|
|
736
738
|
*/
|
|
737
|
-
|
|
739
|
+
getDevicesDevicesGet(id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseShortDeviceResponse>>;
|
|
738
740
|
/**
|
|
739
741
|
* Lists all OEM names
|
|
740
742
|
* @summary Get Oems List
|
|
@@ -749,26 +751,27 @@ export declare const DeviceApiFp: (configuration?: Configuration) => {
|
|
|
749
751
|
*/
|
|
750
752
|
export declare const DeviceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
751
753
|
/**
|
|
752
|
-
*
|
|
754
|
+
* 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.
|
|
753
755
|
* @summary Get Device
|
|
754
|
-
* @param {
|
|
756
|
+
* @param { | null} [deviceId]
|
|
757
|
+
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
758
|
+
* @param {string | null} [codename] Not recommended to use when you can
|
|
755
759
|
* @param {*} [options] Override http request option.
|
|
756
760
|
* @throws {RequiredError}
|
|
757
761
|
*/
|
|
758
|
-
|
|
762
|
+
getDeviceDevicesGetGet(deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
|
|
759
763
|
/**
|
|
760
|
-
*
|
|
761
|
-
* @summary Get Device
|
|
762
|
-
* @param {
|
|
763
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
764
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
764
|
+
* Gets device info using device ID.
|
|
765
|
+
* @summary Get Device Short
|
|
766
|
+
* @param {string} deviceId
|
|
765
767
|
* @param {*} [options] Override http request option.
|
|
768
|
+
* @deprecated
|
|
766
769
|
* @throws {RequiredError}
|
|
767
770
|
*/
|
|
768
|
-
|
|
771
|
+
getDeviceShortDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
|
|
769
772
|
/**
|
|
770
773
|
* 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.
|
|
771
|
-
* @summary Get Devices
|
|
774
|
+
* @summary Get Devices
|
|
772
775
|
* @param {Array<any>} [id] Filter by Device IDs
|
|
773
776
|
* @param {Array<any>} [id2] Filter by Device IDs (deprecated)
|
|
774
777
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
@@ -783,7 +786,7 @@ export declare const DeviceApiFactory: (configuration?: Configuration, basePath?
|
|
|
783
786
|
* @param {*} [options] Override http request option.
|
|
784
787
|
* @throws {RequiredError}
|
|
785
788
|
*/
|
|
786
|
-
|
|
789
|
+
getDevicesDevicesGet(id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortDeviceResponse>;
|
|
787
790
|
/**
|
|
788
791
|
* Lists all OEM names
|
|
789
792
|
* @summary Get Oems List
|
|
@@ -799,28 +802,29 @@ export declare const DeviceApiFactory: (configuration?: Configuration, basePath?
|
|
|
799
802
|
*/
|
|
800
803
|
export interface DeviceApiInterface {
|
|
801
804
|
/**
|
|
802
|
-
*
|
|
805
|
+
* 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.
|
|
803
806
|
* @summary Get Device
|
|
804
|
-
* @param {
|
|
807
|
+
* @param { | null} [deviceId]
|
|
808
|
+
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
809
|
+
* @param {string | null} [codename] Not recommended to use when you can
|
|
805
810
|
* @param {*} [options] Override http request option.
|
|
806
811
|
* @throws {RequiredError}
|
|
807
812
|
* @memberof DeviceApiInterface
|
|
808
813
|
*/
|
|
809
|
-
|
|
814
|
+
getDeviceDevicesGetGet(deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
|
|
810
815
|
/**
|
|
811
|
-
*
|
|
812
|
-
* @summary Get Device
|
|
813
|
-
* @param {
|
|
814
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
815
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
816
|
+
* Gets device info using device ID.
|
|
817
|
+
* @summary Get Device Short
|
|
818
|
+
* @param {string} deviceId
|
|
816
819
|
* @param {*} [options] Override http request option.
|
|
820
|
+
* @deprecated
|
|
817
821
|
* @throws {RequiredError}
|
|
818
822
|
* @memberof DeviceApiInterface
|
|
819
823
|
*/
|
|
820
|
-
|
|
824
|
+
getDeviceShortDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
|
|
821
825
|
/**
|
|
822
826
|
* 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.
|
|
823
|
-
* @summary Get Devices
|
|
827
|
+
* @summary Get Devices
|
|
824
828
|
* @param {Array<any>} [id] Filter by Device IDs
|
|
825
829
|
* @param {Array<any>} [id2] Filter by Device IDs (deprecated)
|
|
826
830
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
@@ -836,7 +840,7 @@ export interface DeviceApiInterface {
|
|
|
836
840
|
* @throws {RequiredError}
|
|
837
841
|
* @memberof DeviceApiInterface
|
|
838
842
|
*/
|
|
839
|
-
|
|
843
|
+
getDevicesDevicesGet(id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortDeviceResponse>;
|
|
840
844
|
/**
|
|
841
845
|
* Lists all OEM names
|
|
842
846
|
* @summary Get Oems List
|
|
@@ -854,28 +858,29 @@ export interface DeviceApiInterface {
|
|
|
854
858
|
*/
|
|
855
859
|
export declare class DeviceApi extends BaseAPI implements DeviceApiInterface {
|
|
856
860
|
/**
|
|
857
|
-
*
|
|
861
|
+
* 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.
|
|
858
862
|
* @summary Get Device
|
|
859
|
-
* @param {
|
|
863
|
+
* @param { | null} [deviceId]
|
|
864
|
+
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
865
|
+
* @param {string | null} [codename] Not recommended to use when you can
|
|
860
866
|
* @param {*} [options] Override http request option.
|
|
861
867
|
* @throws {RequiredError}
|
|
862
868
|
* @memberof DeviceApi
|
|
863
869
|
*/
|
|
864
|
-
|
|
870
|
+
getDeviceDevicesGetGet(deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceResponse, any>>;
|
|
865
871
|
/**
|
|
866
|
-
*
|
|
867
|
-
* @summary Get Device
|
|
868
|
-
* @param {
|
|
869
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
870
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
872
|
+
* Gets device info using device ID.
|
|
873
|
+
* @summary Get Device Short
|
|
874
|
+
* @param {string} deviceId
|
|
871
875
|
* @param {*} [options] Override http request option.
|
|
876
|
+
* @deprecated
|
|
872
877
|
* @throws {RequiredError}
|
|
873
878
|
* @memberof DeviceApi
|
|
874
879
|
*/
|
|
875
|
-
|
|
880
|
+
getDeviceShortDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceResponse, any>>;
|
|
876
881
|
/**
|
|
877
882
|
* 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.
|
|
878
|
-
* @summary Get Devices
|
|
883
|
+
* @summary Get Devices
|
|
879
884
|
* @param {Array<any>} [id] Filter by Device IDs
|
|
880
885
|
* @param {Array<any>} [id2] Filter by Device IDs (deprecated)
|
|
881
886
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
@@ -891,7 +896,7 @@ export declare class DeviceApi extends BaseAPI implements DeviceApiInterface {
|
|
|
891
896
|
* @throws {RequiredError}
|
|
892
897
|
* @memberof DeviceApi
|
|
893
898
|
*/
|
|
894
|
-
|
|
899
|
+
getDevicesDevicesGet(id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseShortDeviceResponse, any>>;
|
|
895
900
|
/**
|
|
896
901
|
* Lists all OEM names
|
|
897
902
|
* @summary Get Oems List
|
|
@@ -908,7 +913,7 @@ export declare class DeviceApi extends BaseAPI implements DeviceApiInterface {
|
|
|
908
913
|
export declare const ReleaseApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
909
914
|
/**
|
|
910
915
|
* 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!
|
|
911
|
-
* @summary Get Release
|
|
916
|
+
* @summary Get Release
|
|
912
917
|
* @param { | null} [releaseId] Release ID
|
|
913
918
|
* @param { | null} [id] Release ID (deprecated)
|
|
914
919
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
@@ -916,15 +921,16 @@ export declare const ReleaseApiAxiosParamCreator: (configuration?: Configuration
|
|
|
916
921
|
* @param {*} [options] Override http request option.
|
|
917
922
|
* @throws {RequiredError}
|
|
918
923
|
*/
|
|
919
|
-
|
|
924
|
+
getReleaseReleasesGetGet: (releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
920
925
|
/**
|
|
921
926
|
* Gets release information using the release ID, nothing to discuss really.
|
|
922
|
-
* @summary Get Release
|
|
927
|
+
* @summary Get Release Short
|
|
923
928
|
* @param {any} releaseId
|
|
924
929
|
* @param {*} [options] Override http request option.
|
|
930
|
+
* @deprecated
|
|
925
931
|
* @throws {RequiredError}
|
|
926
932
|
*/
|
|
927
|
-
|
|
933
|
+
getReleaseShortReleasesReleaseIdGet: (releaseId: any, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
928
934
|
/**
|
|
929
935
|
* 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.
|
|
930
936
|
* @summary Get Releases
|
|
@@ -970,7 +976,7 @@ export declare const ReleaseApiAxiosParamCreator: (configuration?: Configuration
|
|
|
970
976
|
export declare const ReleaseApiFp: (configuration?: Configuration) => {
|
|
971
977
|
/**
|
|
972
978
|
* 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!
|
|
973
|
-
* @summary Get Release
|
|
979
|
+
* @summary Get Release
|
|
974
980
|
* @param { | null} [releaseId] Release ID
|
|
975
981
|
* @param { | null} [id] Release ID (deprecated)
|
|
976
982
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
@@ -978,15 +984,16 @@ export declare const ReleaseApiFp: (configuration?: Configuration) => {
|
|
|
978
984
|
* @param {*} [options] Override http request option.
|
|
979
985
|
* @throws {RequiredError}
|
|
980
986
|
*/
|
|
981
|
-
|
|
987
|
+
getReleaseReleasesGetGet(releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>>;
|
|
982
988
|
/**
|
|
983
989
|
* Gets release information using the release ID, nothing to discuss really.
|
|
984
|
-
* @summary Get Release
|
|
990
|
+
* @summary Get Release Short
|
|
985
991
|
* @param {any} releaseId
|
|
986
992
|
* @param {*} [options] Override http request option.
|
|
993
|
+
* @deprecated
|
|
987
994
|
* @throws {RequiredError}
|
|
988
995
|
*/
|
|
989
|
-
|
|
996
|
+
getReleaseShortReleasesReleaseIdGet(releaseId: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>>;
|
|
990
997
|
/**
|
|
991
998
|
* 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.
|
|
992
999
|
* @summary Get Releases
|
|
@@ -1032,7 +1039,7 @@ export declare const ReleaseApiFp: (configuration?: Configuration) => {
|
|
|
1032
1039
|
export declare const ReleaseApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1033
1040
|
/**
|
|
1034
1041
|
* 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!
|
|
1035
|
-
* @summary Get Release
|
|
1042
|
+
* @summary Get Release
|
|
1036
1043
|
* @param { | null} [releaseId] Release ID
|
|
1037
1044
|
* @param { | null} [id] Release ID (deprecated)
|
|
1038
1045
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
@@ -1040,15 +1047,16 @@ export declare const ReleaseApiFactory: (configuration?: Configuration, basePath
|
|
|
1040
1047
|
* @param {*} [options] Override http request option.
|
|
1041
1048
|
* @throws {RequiredError}
|
|
1042
1049
|
*/
|
|
1043
|
-
|
|
1050
|
+
getReleaseReleasesGetGet(releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
|
|
1044
1051
|
/**
|
|
1045
1052
|
* Gets release information using the release ID, nothing to discuss really.
|
|
1046
|
-
* @summary Get Release
|
|
1053
|
+
* @summary Get Release Short
|
|
1047
1054
|
* @param {any} releaseId
|
|
1048
1055
|
* @param {*} [options] Override http request option.
|
|
1056
|
+
* @deprecated
|
|
1049
1057
|
* @throws {RequiredError}
|
|
1050
1058
|
*/
|
|
1051
|
-
|
|
1059
|
+
getReleaseShortReleasesReleaseIdGet(releaseId: any, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
|
|
1052
1060
|
/**
|
|
1053
1061
|
* 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.
|
|
1054
1062
|
* @summary Get Releases
|
|
@@ -1095,7 +1103,7 @@ export declare const ReleaseApiFactory: (configuration?: Configuration, basePath
|
|
|
1095
1103
|
export interface ReleaseApiInterface {
|
|
1096
1104
|
/**
|
|
1097
1105
|
* 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!
|
|
1098
|
-
* @summary Get Release
|
|
1106
|
+
* @summary Get Release
|
|
1099
1107
|
* @param { | null} [releaseId] Release ID
|
|
1100
1108
|
* @param { | null} [id] Release ID (deprecated)
|
|
1101
1109
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
@@ -1104,16 +1112,17 @@ export interface ReleaseApiInterface {
|
|
|
1104
1112
|
* @throws {RequiredError}
|
|
1105
1113
|
* @memberof ReleaseApiInterface
|
|
1106
1114
|
*/
|
|
1107
|
-
|
|
1115
|
+
getReleaseReleasesGetGet(releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
|
|
1108
1116
|
/**
|
|
1109
1117
|
* Gets release information using the release ID, nothing to discuss really.
|
|
1110
|
-
* @summary Get Release
|
|
1118
|
+
* @summary Get Release Short
|
|
1111
1119
|
* @param {any} releaseId
|
|
1112
1120
|
* @param {*} [options] Override http request option.
|
|
1121
|
+
* @deprecated
|
|
1113
1122
|
* @throws {RequiredError}
|
|
1114
1123
|
* @memberof ReleaseApiInterface
|
|
1115
1124
|
*/
|
|
1116
|
-
|
|
1125
|
+
getReleaseShortReleasesReleaseIdGet(releaseId: any, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
|
|
1117
1126
|
/**
|
|
1118
1127
|
* 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.
|
|
1119
1128
|
* @summary Get Releases
|
|
@@ -1163,7 +1172,7 @@ export interface ReleaseApiInterface {
|
|
|
1163
1172
|
export declare class ReleaseApi extends BaseAPI implements ReleaseApiInterface {
|
|
1164
1173
|
/**
|
|
1165
1174
|
* 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!
|
|
1166
|
-
* @summary Get Release
|
|
1175
|
+
* @summary Get Release
|
|
1167
1176
|
* @param { | null} [releaseId] Release ID
|
|
1168
1177
|
* @param { | null} [id] Release ID (deprecated)
|
|
1169
1178
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
@@ -1172,16 +1181,17 @@ export declare class ReleaseApi extends BaseAPI implements ReleaseApiInterface {
|
|
|
1172
1181
|
* @throws {RequiredError}
|
|
1173
1182
|
* @memberof ReleaseApi
|
|
1174
1183
|
*/
|
|
1175
|
-
|
|
1184
|
+
getReleaseReleasesGetGet(releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleaseResponse, any>>;
|
|
1176
1185
|
/**
|
|
1177
1186
|
* Gets release information using the release ID, nothing to discuss really.
|
|
1178
|
-
* @summary Get Release
|
|
1187
|
+
* @summary Get Release Short
|
|
1179
1188
|
* @param {any} releaseId
|
|
1180
1189
|
* @param {*} [options] Override http request option.
|
|
1190
|
+
* @deprecated
|
|
1181
1191
|
* @throws {RequiredError}
|
|
1182
1192
|
* @memberof ReleaseApi
|
|
1183
1193
|
*/
|
|
1184
|
-
|
|
1194
|
+
getReleaseShortReleasesReleaseIdGet(releaseId: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleaseResponse, any>>;
|
|
1185
1195
|
/**
|
|
1186
1196
|
* 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.
|
|
1187
1197
|
* @summary Get Releases
|