@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/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.3
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -347,10 +347,10 @@ export interface ReleaseResponse {
|
|
|
347
347
|
'device_id': string;
|
|
348
348
|
/**
|
|
349
349
|
*
|
|
350
|
-
* @type {
|
|
350
|
+
* @type {number}
|
|
351
351
|
* @memberof ReleaseResponse
|
|
352
352
|
*/
|
|
353
|
-
'date':
|
|
353
|
+
'date': number;
|
|
354
354
|
/**
|
|
355
355
|
*
|
|
356
356
|
* @type {string}
|
|
@@ -590,10 +590,10 @@ export interface ShortReleaseResponse {
|
|
|
590
590
|
'device_id': string;
|
|
591
591
|
/**
|
|
592
592
|
*
|
|
593
|
-
* @type {
|
|
593
|
+
* @type {number}
|
|
594
594
|
* @memberof ShortReleaseResponse
|
|
595
595
|
*/
|
|
596
|
-
'date':
|
|
596
|
+
'date': number;
|
|
597
597
|
/**
|
|
598
598
|
*
|
|
599
599
|
* @type {string}
|
|
@@ -669,13 +669,13 @@ export const DeviceApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
669
669
|
/**
|
|
670
670
|
* 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.
|
|
671
671
|
* @summary Get Device
|
|
672
|
-
* @param { | null} [deviceId]
|
|
673
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
672
|
+
* @param {string | null} [deviceId]
|
|
673
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
674
674
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
675
675
|
* @param {*} [options] Override http request option.
|
|
676
676
|
* @throws {RequiredError}
|
|
677
677
|
*/
|
|
678
|
-
getDevice: async (deviceId?:
|
|
678
|
+
getDevice: async (deviceId?: string | null, id?: string | null, codename?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
679
679
|
const localVarPath = `/devices/get`;
|
|
680
680
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
681
681
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -689,15 +689,11 @@ export const DeviceApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
689
689
|
const localVarQueryParameter = {} as any;
|
|
690
690
|
|
|
691
691
|
if (deviceId !== undefined) {
|
|
692
|
-
|
|
693
|
-
localVarQueryParameter[key] = value;
|
|
694
|
-
}
|
|
692
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
695
693
|
}
|
|
696
694
|
|
|
697
695
|
if (id !== undefined) {
|
|
698
|
-
|
|
699
|
-
localVarQueryParameter[key] = value;
|
|
700
|
-
}
|
|
696
|
+
localVarQueryParameter['_id'] = id;
|
|
701
697
|
}
|
|
702
698
|
|
|
703
699
|
if (codename !== undefined) {
|
|
@@ -753,8 +749,8 @@ export const DeviceApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
753
749
|
/**
|
|
754
750
|
* 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.
|
|
755
751
|
* @summary Get Devices
|
|
756
|
-
* @param {Array<
|
|
757
|
-
* @param {Array<
|
|
752
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
753
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
758
754
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
759
755
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
760
756
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -767,7 +763,7 @@ export const DeviceApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
767
763
|
* @param {*} [options] Override http request option.
|
|
768
764
|
* @throws {RequiredError}
|
|
769
765
|
*/
|
|
770
|
-
getDevices: async (id?: Array<
|
|
766
|
+
getDevices: async (id?: Array<string>, id2?: Array<string>, 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> => {
|
|
771
767
|
const localVarPath = `/devices/`;
|
|
772
768
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
773
769
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -878,13 +874,13 @@ export const DeviceApiFp = function(configuration?: Configuration) {
|
|
|
878
874
|
/**
|
|
879
875
|
* 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.
|
|
880
876
|
* @summary Get Device
|
|
881
|
-
* @param { | null} [deviceId]
|
|
882
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
877
|
+
* @param {string | null} [deviceId]
|
|
878
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
883
879
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
884
880
|
* @param {*} [options] Override http request option.
|
|
885
881
|
* @throws {RequiredError}
|
|
886
882
|
*/
|
|
887
|
-
async getDevice(deviceId?:
|
|
883
|
+
async getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>> {
|
|
888
884
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDevice(deviceId, id, codename, options);
|
|
889
885
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
890
886
|
const localVarOperationServerBasePath = operationServerMap['DeviceApi.getDevice']?.[localVarOperationServerIndex]?.url;
|
|
@@ -907,8 +903,8 @@ export const DeviceApiFp = function(configuration?: Configuration) {
|
|
|
907
903
|
/**
|
|
908
904
|
* 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.
|
|
909
905
|
* @summary Get Devices
|
|
910
|
-
* @param {Array<
|
|
911
|
-
* @param {Array<
|
|
906
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
907
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
912
908
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
913
909
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
914
910
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -921,7 +917,7 @@ export const DeviceApiFp = function(configuration?: Configuration) {
|
|
|
921
917
|
* @param {*} [options] Override http request option.
|
|
922
918
|
* @throws {RequiredError}
|
|
923
919
|
*/
|
|
924
|
-
async getDevices(id?: Array<
|
|
920
|
+
async getDevices(id?: Array<string>, id2?: Array<string>, 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>> {
|
|
925
921
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options);
|
|
926
922
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
927
923
|
const localVarOperationServerBasePath = operationServerMap['DeviceApi.getDevices']?.[localVarOperationServerIndex]?.url;
|
|
@@ -952,13 +948,13 @@ export const DeviceApiFactory = function (configuration?: Configuration, basePat
|
|
|
952
948
|
/**
|
|
953
949
|
* 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.
|
|
954
950
|
* @summary Get Device
|
|
955
|
-
* @param { | null} [deviceId]
|
|
956
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
951
|
+
* @param {string | null} [deviceId]
|
|
952
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
957
953
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
958
954
|
* @param {*} [options] Override http request option.
|
|
959
955
|
* @throws {RequiredError}
|
|
960
956
|
*/
|
|
961
|
-
getDevice(deviceId?:
|
|
957
|
+
getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse> {
|
|
962
958
|
return localVarFp.getDevice(deviceId, id, codename, options).then((request) => request(axios, basePath));
|
|
963
959
|
},
|
|
964
960
|
/**
|
|
@@ -975,8 +971,8 @@ export const DeviceApiFactory = function (configuration?: Configuration, basePat
|
|
|
975
971
|
/**
|
|
976
972
|
* 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.
|
|
977
973
|
* @summary Get Devices
|
|
978
|
-
* @param {Array<
|
|
979
|
-
* @param {Array<
|
|
974
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
975
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
980
976
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
981
977
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
982
978
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -989,7 +985,7 @@ export const DeviceApiFactory = function (configuration?: Configuration, basePat
|
|
|
989
985
|
* @param {*} [options] Override http request option.
|
|
990
986
|
* @throws {RequiredError}
|
|
991
987
|
*/
|
|
992
|
-
getDevices(id?: Array<
|
|
988
|
+
getDevices(id?: Array<string>, id2?: Array<string>, 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> {
|
|
993
989
|
return localVarFp.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(axios, basePath));
|
|
994
990
|
},
|
|
995
991
|
/**
|
|
@@ -1013,14 +1009,14 @@ export interface DeviceApiInterface {
|
|
|
1013
1009
|
/**
|
|
1014
1010
|
* 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.
|
|
1015
1011
|
* @summary Get Device
|
|
1016
|
-
* @param { | null} [deviceId]
|
|
1017
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
1012
|
+
* @param {string | null} [deviceId]
|
|
1013
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
1018
1014
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
1019
1015
|
* @param {*} [options] Override http request option.
|
|
1020
1016
|
* @throws {RequiredError}
|
|
1021
1017
|
* @memberof DeviceApiInterface
|
|
1022
1018
|
*/
|
|
1023
|
-
getDevice(deviceId?:
|
|
1019
|
+
getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
|
|
1024
1020
|
|
|
1025
1021
|
/**
|
|
1026
1022
|
* Gets device info using device ID.
|
|
@@ -1036,8 +1032,8 @@ export interface DeviceApiInterface {
|
|
|
1036
1032
|
/**
|
|
1037
1033
|
* 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.
|
|
1038
1034
|
* @summary Get Devices
|
|
1039
|
-
* @param {Array<
|
|
1040
|
-
* @param {Array<
|
|
1035
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
1036
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
1041
1037
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
1042
1038
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
1043
1039
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -1051,7 +1047,7 @@ export interface DeviceApiInterface {
|
|
|
1051
1047
|
* @throws {RequiredError}
|
|
1052
1048
|
* @memberof DeviceApiInterface
|
|
1053
1049
|
*/
|
|
1054
|
-
getDevices(id?: Array<
|
|
1050
|
+
getDevices(id?: Array<string>, id2?: Array<string>, 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>;
|
|
1055
1051
|
|
|
1056
1052
|
/**
|
|
1057
1053
|
* Lists all OEM names
|
|
@@ -1074,14 +1070,14 @@ export class DeviceApi extends BaseAPI implements DeviceApiInterface {
|
|
|
1074
1070
|
/**
|
|
1075
1071
|
* 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.
|
|
1076
1072
|
* @summary Get Device
|
|
1077
|
-
* @param { | null} [deviceId]
|
|
1078
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
1073
|
+
* @param {string | null} [deviceId]
|
|
1074
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
1079
1075
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
1080
1076
|
* @param {*} [options] Override http request option.
|
|
1081
1077
|
* @throws {RequiredError}
|
|
1082
1078
|
* @memberof DeviceApi
|
|
1083
1079
|
*/
|
|
1084
|
-
public getDevice(deviceId?:
|
|
1080
|
+
public getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig) {
|
|
1085
1081
|
return DeviceApiFp(this.configuration).getDevice(deviceId, id, codename, options).then((request) => request(this.axios, this.basePath));
|
|
1086
1082
|
}
|
|
1087
1083
|
|
|
@@ -1101,8 +1097,8 @@ export class DeviceApi extends BaseAPI implements DeviceApiInterface {
|
|
|
1101
1097
|
/**
|
|
1102
1098
|
* 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.
|
|
1103
1099
|
* @summary Get Devices
|
|
1104
|
-
* @param {Array<
|
|
1105
|
-
* @param {Array<
|
|
1100
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
1101
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
1106
1102
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
1107
1103
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
1108
1104
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -1116,7 +1112,7 @@ export class DeviceApi extends BaseAPI implements DeviceApiInterface {
|
|
|
1116
1112
|
* @throws {RequiredError}
|
|
1117
1113
|
* @memberof DeviceApi
|
|
1118
1114
|
*/
|
|
1119
|
-
public getDevices(id?: Array<
|
|
1115
|
+
public getDevices(id?: Array<string>, id2?: Array<string>, 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) {
|
|
1120
1116
|
return DeviceApiFp(this.configuration).getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1121
1117
|
}
|
|
1122
1118
|
|
|
@@ -1143,14 +1139,14 @@ export const ReleaseApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1143
1139
|
/**
|
|
1144
1140
|
* 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!
|
|
1145
1141
|
* @summary Get Release
|
|
1146
|
-
* @param { | null} [releaseId] Release ID
|
|
1147
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
1142
|
+
* @param {string | null} [releaseId] Release ID
|
|
1143
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
1148
1144
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1149
1145
|
* @param {string | null} [filename]
|
|
1150
1146
|
* @param {*} [options] Override http request option.
|
|
1151
1147
|
* @throws {RequiredError}
|
|
1152
1148
|
*/
|
|
1153
|
-
getRelease: async (releaseId?:
|
|
1149
|
+
getRelease: async (releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1154
1150
|
const localVarPath = `/releases/get`;
|
|
1155
1151
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1156
1152
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1164,15 +1160,11 @@ export const ReleaseApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1164
1160
|
const localVarQueryParameter = {} as any;
|
|
1165
1161
|
|
|
1166
1162
|
if (releaseId !== undefined) {
|
|
1167
|
-
|
|
1168
|
-
localVarQueryParameter[key] = value;
|
|
1169
|
-
}
|
|
1163
|
+
localVarQueryParameter['release_id'] = releaseId;
|
|
1170
1164
|
}
|
|
1171
1165
|
|
|
1172
1166
|
if (id !== undefined) {
|
|
1173
|
-
|
|
1174
|
-
localVarQueryParameter[key] = value;
|
|
1175
|
-
}
|
|
1167
|
+
localVarQueryParameter['_id'] = id;
|
|
1176
1168
|
}
|
|
1177
1169
|
|
|
1178
1170
|
if (buildId !== undefined) {
|
|
@@ -1197,12 +1189,12 @@ export const ReleaseApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1197
1189
|
/**
|
|
1198
1190
|
* Gets release information using the release ID, nothing to discuss really.
|
|
1199
1191
|
* @summary Get Release Short
|
|
1200
|
-
* @param {
|
|
1192
|
+
* @param {string} releaseId
|
|
1201
1193
|
* @param {*} [options] Override http request option.
|
|
1202
1194
|
* @deprecated
|
|
1203
1195
|
* @throws {RequiredError}
|
|
1204
1196
|
*/
|
|
1205
|
-
getReleaseDeprecated: async (releaseId:
|
|
1197
|
+
getReleaseDeprecated: async (releaseId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1206
1198
|
// verify required parameter 'releaseId' is not null or undefined
|
|
1207
1199
|
assertParamExists('getReleaseDeprecated', 'releaseId', releaseId)
|
|
1208
1200
|
const localVarPath = `/releases/{release_id}`
|
|
@@ -1232,17 +1224,17 @@ export const ReleaseApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1232
1224
|
/**
|
|
1233
1225
|
* 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.
|
|
1234
1226
|
* @summary Get Releases
|
|
1235
|
-
* @param {Array<
|
|
1236
|
-
* @param {Array<
|
|
1227
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
1228
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1237
1229
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1238
|
-
* @param {Array<
|
|
1239
|
-
* @param {Array<
|
|
1230
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1231
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1240
1232
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
1241
1233
|
* @param {Array<string>} [version] Filter by release version
|
|
1242
1234
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1243
1235
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
1244
1236
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1245
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
1237
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1246
1238
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1247
1239
|
* @param {ReleasesSort} [sort] Sort mode
|
|
1248
1240
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -1251,7 +1243,7 @@ export const ReleaseApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1251
1243
|
* @param {*} [options] Override http request option.
|
|
1252
1244
|
* @throws {RequiredError}
|
|
1253
1245
|
*/
|
|
1254
|
-
getReleases: async (id?: Array<
|
|
1246
|
+
getReleases: async (id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1255
1247
|
const localVarPath = `/releases/`;
|
|
1256
1248
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1257
1249
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -1305,9 +1297,7 @@ export const ReleaseApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1305
1297
|
}
|
|
1306
1298
|
|
|
1307
1299
|
if (afterReleaseId !== undefined) {
|
|
1308
|
-
|
|
1309
|
-
localVarQueryParameter[key] = value;
|
|
1310
|
-
}
|
|
1300
|
+
localVarQueryParameter['after_release_id'] = afterReleaseId;
|
|
1311
1301
|
}
|
|
1312
1302
|
|
|
1313
1303
|
if (afterDate !== undefined) {
|
|
@@ -1344,8 +1334,8 @@ export const ReleaseApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1344
1334
|
/**
|
|
1345
1335
|
* 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!
|
|
1346
1336
|
* @summary Get Updates
|
|
1347
|
-
* @param {
|
|
1348
|
-
* @param {Array<
|
|
1337
|
+
* @param {string} lastKnownId
|
|
1338
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1349
1339
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1350
1340
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1351
1341
|
* @param {number | null} [skip] Skip query results
|
|
@@ -1354,7 +1344,7 @@ export const ReleaseApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
1354
1344
|
* @deprecated
|
|
1355
1345
|
* @throws {RequiredError}
|
|
1356
1346
|
*/
|
|
1357
|
-
getUpdatesDeprecated: async (lastKnownId:
|
|
1347
|
+
getUpdatesDeprecated: async (lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1358
1348
|
// verify required parameter 'lastKnownId' is not null or undefined
|
|
1359
1349
|
assertParamExists('getUpdatesDeprecated', 'lastKnownId', lastKnownId)
|
|
1360
1350
|
const localVarPath = `/updates/{last_known_id}`
|
|
@@ -1414,14 +1404,14 @@ export const ReleaseApiFp = function(configuration?: Configuration) {
|
|
|
1414
1404
|
/**
|
|
1415
1405
|
* 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!
|
|
1416
1406
|
* @summary Get Release
|
|
1417
|
-
* @param { | null} [releaseId] Release ID
|
|
1418
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
1407
|
+
* @param {string | null} [releaseId] Release ID
|
|
1408
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
1419
1409
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1420
1410
|
* @param {string | null} [filename]
|
|
1421
1411
|
* @param {*} [options] Override http request option.
|
|
1422
1412
|
* @throws {RequiredError}
|
|
1423
1413
|
*/
|
|
1424
|
-
async getRelease(releaseId?:
|
|
1414
|
+
async getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>> {
|
|
1425
1415
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getRelease(releaseId, id, buildId, filename, options);
|
|
1426
1416
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1427
1417
|
const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getRelease']?.[localVarOperationServerIndex]?.url;
|
|
@@ -1430,12 +1420,12 @@ export const ReleaseApiFp = function(configuration?: Configuration) {
|
|
|
1430
1420
|
/**
|
|
1431
1421
|
* Gets release information using the release ID, nothing to discuss really.
|
|
1432
1422
|
* @summary Get Release Short
|
|
1433
|
-
* @param {
|
|
1423
|
+
* @param {string} releaseId
|
|
1434
1424
|
* @param {*} [options] Override http request option.
|
|
1435
1425
|
* @deprecated
|
|
1436
1426
|
* @throws {RequiredError}
|
|
1437
1427
|
*/
|
|
1438
|
-
async getReleaseDeprecated(releaseId:
|
|
1428
|
+
async getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>> {
|
|
1439
1429
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getReleaseDeprecated(releaseId, options);
|
|
1440
1430
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1441
1431
|
const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getReleaseDeprecated']?.[localVarOperationServerIndex]?.url;
|
|
@@ -1444,17 +1434,17 @@ export const ReleaseApiFp = function(configuration?: Configuration) {
|
|
|
1444
1434
|
/**
|
|
1445
1435
|
* 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.
|
|
1446
1436
|
* @summary Get Releases
|
|
1447
|
-
* @param {Array<
|
|
1448
|
-
* @param {Array<
|
|
1437
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
1438
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1449
1439
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1450
|
-
* @param {Array<
|
|
1451
|
-
* @param {Array<
|
|
1440
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1441
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1452
1442
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
1453
1443
|
* @param {Array<string>} [version] Filter by release version
|
|
1454
1444
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1455
1445
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
1456
1446
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1457
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
1447
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1458
1448
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1459
1449
|
* @param {ReleasesSort} [sort] Sort mode
|
|
1460
1450
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -1463,7 +1453,7 @@ export const ReleaseApiFp = function(configuration?: Configuration) {
|
|
|
1463
1453
|
* @param {*} [options] Override http request option.
|
|
1464
1454
|
* @throws {RequiredError}
|
|
1465
1455
|
*/
|
|
1466
|
-
async getReleases(id?: Array<
|
|
1456
|
+
async getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseGetReleases>> {
|
|
1467
1457
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options);
|
|
1468
1458
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1469
1459
|
const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getReleases']?.[localVarOperationServerIndex]?.url;
|
|
@@ -1472,8 +1462,8 @@ export const ReleaseApiFp = function(configuration?: Configuration) {
|
|
|
1472
1462
|
/**
|
|
1473
1463
|
* 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!
|
|
1474
1464
|
* @summary Get Updates
|
|
1475
|
-
* @param {
|
|
1476
|
-
* @param {Array<
|
|
1465
|
+
* @param {string} lastKnownId
|
|
1466
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1477
1467
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1478
1468
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1479
1469
|
* @param {number | null} [skip] Skip query results
|
|
@@ -1482,7 +1472,7 @@ export const ReleaseApiFp = function(configuration?: Configuration) {
|
|
|
1482
1472
|
* @deprecated
|
|
1483
1473
|
* @throws {RequiredError}
|
|
1484
1474
|
*/
|
|
1485
|
-
async getUpdatesDeprecated(lastKnownId:
|
|
1475
|
+
async getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseShortReleaseResponse>> {
|
|
1486
1476
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options);
|
|
1487
1477
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1488
1478
|
const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getUpdatesDeprecated']?.[localVarOperationServerIndex]?.url;
|
|
@@ -1501,41 +1491,41 @@ export const ReleaseApiFactory = function (configuration?: Configuration, basePa
|
|
|
1501
1491
|
/**
|
|
1502
1492
|
* 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!
|
|
1503
1493
|
* @summary Get Release
|
|
1504
|
-
* @param { | null} [releaseId] Release ID
|
|
1505
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
1494
|
+
* @param {string | null} [releaseId] Release ID
|
|
1495
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
1506
1496
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1507
1497
|
* @param {string | null} [filename]
|
|
1508
1498
|
* @param {*} [options] Override http request option.
|
|
1509
1499
|
* @throws {RequiredError}
|
|
1510
1500
|
*/
|
|
1511
|
-
getRelease(releaseId?:
|
|
1501
|
+
getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse> {
|
|
1512
1502
|
return localVarFp.getRelease(releaseId, id, buildId, filename, options).then((request) => request(axios, basePath));
|
|
1513
1503
|
},
|
|
1514
1504
|
/**
|
|
1515
1505
|
* Gets release information using the release ID, nothing to discuss really.
|
|
1516
1506
|
* @summary Get Release Short
|
|
1517
|
-
* @param {
|
|
1507
|
+
* @param {string} releaseId
|
|
1518
1508
|
* @param {*} [options] Override http request option.
|
|
1519
1509
|
* @deprecated
|
|
1520
1510
|
* @throws {RequiredError}
|
|
1521
1511
|
*/
|
|
1522
|
-
getReleaseDeprecated(releaseId:
|
|
1512
|
+
getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse> {
|
|
1523
1513
|
return localVarFp.getReleaseDeprecated(releaseId, options).then((request) => request(axios, basePath));
|
|
1524
1514
|
},
|
|
1525
1515
|
/**
|
|
1526
1516
|
* 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.
|
|
1527
1517
|
* @summary Get Releases
|
|
1528
|
-
* @param {Array<
|
|
1529
|
-
* @param {Array<
|
|
1518
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
1519
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1530
1520
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1531
|
-
* @param {Array<
|
|
1532
|
-
* @param {Array<
|
|
1521
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1522
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1533
1523
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
1534
1524
|
* @param {Array<string>} [version] Filter by release version
|
|
1535
1525
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1536
1526
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
1537
1527
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1538
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
1528
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1539
1529
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1540
1530
|
* @param {ReleasesSort} [sort] Sort mode
|
|
1541
1531
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -1544,14 +1534,14 @@ export const ReleaseApiFactory = function (configuration?: Configuration, basePa
|
|
|
1544
1534
|
* @param {*} [options] Override http request option.
|
|
1545
1535
|
* @throws {RequiredError}
|
|
1546
1536
|
*/
|
|
1547
|
-
getReleases(id?: Array<
|
|
1537
|
+
getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ResponseGetReleases> {
|
|
1548
1538
|
return localVarFp.getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options).then((request) => request(axios, basePath));
|
|
1549
1539
|
},
|
|
1550
1540
|
/**
|
|
1551
1541
|
* 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!
|
|
1552
1542
|
* @summary Get Updates
|
|
1553
|
-
* @param {
|
|
1554
|
-
* @param {Array<
|
|
1543
|
+
* @param {string} lastKnownId
|
|
1544
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1555
1545
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1556
1546
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1557
1547
|
* @param {number | null} [skip] Skip query results
|
|
@@ -1560,7 +1550,7 @@ export const ReleaseApiFactory = function (configuration?: Configuration, basePa
|
|
|
1560
1550
|
* @deprecated
|
|
1561
1551
|
* @throws {RequiredError}
|
|
1562
1552
|
*/
|
|
1563
|
-
getUpdatesDeprecated(lastKnownId:
|
|
1553
|
+
getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse> {
|
|
1564
1554
|
return localVarFp.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(axios, basePath));
|
|
1565
1555
|
},
|
|
1566
1556
|
};
|
|
@@ -1575,41 +1565,41 @@ export interface ReleaseApiInterface {
|
|
|
1575
1565
|
/**
|
|
1576
1566
|
* 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!
|
|
1577
1567
|
* @summary Get Release
|
|
1578
|
-
* @param { | null} [releaseId] Release ID
|
|
1579
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
1568
|
+
* @param {string | null} [releaseId] Release ID
|
|
1569
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
1580
1570
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1581
1571
|
* @param {string | null} [filename]
|
|
1582
1572
|
* @param {*} [options] Override http request option.
|
|
1583
1573
|
* @throws {RequiredError}
|
|
1584
1574
|
* @memberof ReleaseApiInterface
|
|
1585
1575
|
*/
|
|
1586
|
-
getRelease(releaseId?:
|
|
1576
|
+
getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
|
|
1587
1577
|
|
|
1588
1578
|
/**
|
|
1589
1579
|
* Gets release information using the release ID, nothing to discuss really.
|
|
1590
1580
|
* @summary Get Release Short
|
|
1591
|
-
* @param {
|
|
1581
|
+
* @param {string} releaseId
|
|
1592
1582
|
* @param {*} [options] Override http request option.
|
|
1593
1583
|
* @deprecated
|
|
1594
1584
|
* @throws {RequiredError}
|
|
1595
1585
|
* @memberof ReleaseApiInterface
|
|
1596
1586
|
*/
|
|
1597
|
-
getReleaseDeprecated(releaseId:
|
|
1587
|
+
getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
|
|
1598
1588
|
|
|
1599
1589
|
/**
|
|
1600
1590
|
* 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.
|
|
1601
1591
|
* @summary Get Releases
|
|
1602
|
-
* @param {Array<
|
|
1603
|
-
* @param {Array<
|
|
1592
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
1593
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1604
1594
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1605
|
-
* @param {Array<
|
|
1606
|
-
* @param {Array<
|
|
1595
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1596
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1607
1597
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
1608
1598
|
* @param {Array<string>} [version] Filter by release version
|
|
1609
1599
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1610
1600
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
1611
1601
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1612
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
1602
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1613
1603
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1614
1604
|
* @param {ReleasesSort} [sort] Sort mode
|
|
1615
1605
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -1619,13 +1609,13 @@ export interface ReleaseApiInterface {
|
|
|
1619
1609
|
* @throws {RequiredError}
|
|
1620
1610
|
* @memberof ReleaseApiInterface
|
|
1621
1611
|
*/
|
|
1622
|
-
getReleases(id?: Array<
|
|
1612
|
+
getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ResponseGetReleases>;
|
|
1623
1613
|
|
|
1624
1614
|
/**
|
|
1625
1615
|
* 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!
|
|
1626
1616
|
* @summary Get Updates
|
|
1627
|
-
* @param {
|
|
1628
|
-
* @param {Array<
|
|
1617
|
+
* @param {string} lastKnownId
|
|
1618
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1629
1619
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1630
1620
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1631
1621
|
* @param {number | null} [skip] Skip query results
|
|
@@ -1635,7 +1625,7 @@ export interface ReleaseApiInterface {
|
|
|
1635
1625
|
* @throws {RequiredError}
|
|
1636
1626
|
* @memberof ReleaseApiInterface
|
|
1637
1627
|
*/
|
|
1638
|
-
getUpdatesDeprecated(lastKnownId:
|
|
1628
|
+
getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse>;
|
|
1639
1629
|
|
|
1640
1630
|
}
|
|
1641
1631
|
|
|
@@ -1649,45 +1639,45 @@ export class ReleaseApi extends BaseAPI implements ReleaseApiInterface {
|
|
|
1649
1639
|
/**
|
|
1650
1640
|
* 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!
|
|
1651
1641
|
* @summary Get Release
|
|
1652
|
-
* @param { | null} [releaseId] Release ID
|
|
1653
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
1642
|
+
* @param {string | null} [releaseId] Release ID
|
|
1643
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
1654
1644
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1655
1645
|
* @param {string | null} [filename]
|
|
1656
1646
|
* @param {*} [options] Override http request option.
|
|
1657
1647
|
* @throws {RequiredError}
|
|
1658
1648
|
* @memberof ReleaseApi
|
|
1659
1649
|
*/
|
|
1660
|
-
public getRelease(releaseId?:
|
|
1650
|
+
public getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig) {
|
|
1661
1651
|
return ReleaseApiFp(this.configuration).getRelease(releaseId, id, buildId, filename, options).then((request) => request(this.axios, this.basePath));
|
|
1662
1652
|
}
|
|
1663
1653
|
|
|
1664
1654
|
/**
|
|
1665
1655
|
* Gets release information using the release ID, nothing to discuss really.
|
|
1666
1656
|
* @summary Get Release Short
|
|
1667
|
-
* @param {
|
|
1657
|
+
* @param {string} releaseId
|
|
1668
1658
|
* @param {*} [options] Override http request option.
|
|
1669
1659
|
* @deprecated
|
|
1670
1660
|
* @throws {RequiredError}
|
|
1671
1661
|
* @memberof ReleaseApi
|
|
1672
1662
|
*/
|
|
1673
|
-
public getReleaseDeprecated(releaseId:
|
|
1663
|
+
public getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig) {
|
|
1674
1664
|
return ReleaseApiFp(this.configuration).getReleaseDeprecated(releaseId, options).then((request) => request(this.axios, this.basePath));
|
|
1675
1665
|
}
|
|
1676
1666
|
|
|
1677
1667
|
/**
|
|
1678
1668
|
* 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.
|
|
1679
1669
|
* @summary Get Releases
|
|
1680
|
-
* @param {Array<
|
|
1681
|
-
* @param {Array<
|
|
1670
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
1671
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1682
1672
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1683
|
-
* @param {Array<
|
|
1684
|
-
* @param {Array<
|
|
1673
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1674
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1685
1675
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
1686
1676
|
* @param {Array<string>} [version] Filter by release version
|
|
1687
1677
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1688
1678
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
1689
1679
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1690
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
1680
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1691
1681
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1692
1682
|
* @param {ReleasesSort} [sort] Sort mode
|
|
1693
1683
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -1697,15 +1687,15 @@ export class ReleaseApi extends BaseAPI implements ReleaseApiInterface {
|
|
|
1697
1687
|
* @throws {RequiredError}
|
|
1698
1688
|
* @memberof ReleaseApi
|
|
1699
1689
|
*/
|
|
1700
|
-
public getReleases(id?: Array<
|
|
1690
|
+
public getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) {
|
|
1701
1691
|
return ReleaseApiFp(this.configuration).getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1702
1692
|
}
|
|
1703
1693
|
|
|
1704
1694
|
/**
|
|
1705
1695
|
* 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!
|
|
1706
1696
|
* @summary Get Updates
|
|
1707
|
-
* @param {
|
|
1708
|
-
* @param {Array<
|
|
1697
|
+
* @param {string} lastKnownId
|
|
1698
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1709
1699
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1710
1700
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1711
1701
|
* @param {number | null} [skip] Skip query results
|
|
@@ -1715,7 +1705,7 @@ export class ReleaseApi extends BaseAPI implements ReleaseApiInterface {
|
|
|
1715
1705
|
* @throws {RequiredError}
|
|
1716
1706
|
* @memberof ReleaseApi
|
|
1717
1707
|
*/
|
|
1718
|
-
public getUpdatesDeprecated(lastKnownId:
|
|
1708
|
+
public getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) {
|
|
1719
1709
|
return ReleaseApiFp(this.configuration).getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1720
1710
|
}
|
|
1721
1711
|
}
|