@orangefox-recovery/foxclient 5.2.0 → 5.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -1
- package/README.md +12 -12
- package/api.ts +170 -180
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +126 -126
- package/dist/api.js +142 -152
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- 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 +126 -126
- package/dist/esm/api.js +142 -152
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- 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 +25 -27
- package/docs/ReleaseApi.md +39 -42
- package/docs/{ResponseGetReleasesReleasesGet.md → ResponseGetReleases.md} +3 -3
- package/docs/StatsApi.md +4 -4
- package/index.ts +2 -2
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Fox API
|
|
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
|
|
5
|
+
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.2.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.2
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -54,13 +54,13 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
54
54
|
/**
|
|
55
55
|
* Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
56
56
|
* @summary Get Device
|
|
57
|
-
* @param { | null} [deviceId]
|
|
58
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
57
|
+
* @param {string | null} [deviceId]
|
|
58
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
59
59
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
60
60
|
* @param {*} [options] Override http request option.
|
|
61
61
|
* @throws {RequiredError}
|
|
62
62
|
*/
|
|
63
|
-
|
|
63
|
+
getDevice: (deviceId_1, id_1, codename_1, ...args_1) => __awaiter(this, [deviceId_1, id_1, codename_1, ...args_1], void 0, function* (deviceId, id, codename, options = {}) {
|
|
64
64
|
const localVarPath = `/devices/get`;
|
|
65
65
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
66
66
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -72,14 +72,10 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
72
72
|
const localVarHeaderParameter = {};
|
|
73
73
|
const localVarQueryParameter = {};
|
|
74
74
|
if (deviceId !== undefined) {
|
|
75
|
-
|
|
76
|
-
localVarQueryParameter[key] = value;
|
|
77
|
-
}
|
|
75
|
+
localVarQueryParameter['device_id'] = deviceId;
|
|
78
76
|
}
|
|
79
77
|
if (id !== undefined) {
|
|
80
|
-
|
|
81
|
-
localVarQueryParameter[key] = value;
|
|
82
|
-
}
|
|
78
|
+
localVarQueryParameter['_id'] = id;
|
|
83
79
|
}
|
|
84
80
|
if (codename !== undefined) {
|
|
85
81
|
localVarQueryParameter['codename'] = codename;
|
|
@@ -100,9 +96,9 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
100
96
|
* @deprecated
|
|
101
97
|
* @throws {RequiredError}
|
|
102
98
|
*/
|
|
103
|
-
|
|
99
|
+
getDeviceDeprecated: (deviceId_1, ...args_1) => __awaiter(this, [deviceId_1, ...args_1], void 0, function* (deviceId, options = {}) {
|
|
104
100
|
// verify required parameter 'deviceId' is not null or undefined
|
|
105
|
-
assertParamExists('
|
|
101
|
+
assertParamExists('getDeviceDeprecated', 'deviceId', deviceId);
|
|
106
102
|
const localVarPath = `/devices/{device_id}`
|
|
107
103
|
.replace(`{${"device_id"}}`, encodeURIComponent(String(deviceId)));
|
|
108
104
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -125,8 +121,8 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
125
121
|
/**
|
|
126
122
|
* Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
|
|
127
123
|
* @summary Get Devices
|
|
128
|
-
* @param {Array<
|
|
129
|
-
* @param {Array<
|
|
124
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
125
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
130
126
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
131
127
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
132
128
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -139,7 +135,7 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
139
135
|
* @param {*} [options] Override http request option.
|
|
140
136
|
* @throws {RequiredError}
|
|
141
137
|
*/
|
|
142
|
-
|
|
138
|
+
getDevices: (id_1, id2_1, oemName_1, codename_1, modelName_1, supported_1, maintainer_1, freezed_1, hasReleases_1, skip_1, limit_1, ...args_1) => __awaiter(this, [id_1, id2_1, oemName_1, codename_1, modelName_1, supported_1, maintainer_1, freezed_1, hasReleases_1, skip_1, limit_1, ...args_1], void 0, function* (id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options = {}) {
|
|
143
139
|
const localVarPath = `/devices/`;
|
|
144
140
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
145
141
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -193,11 +189,11 @@ export const DeviceApiAxiosParamCreator = function (configuration) {
|
|
|
193
189
|
}),
|
|
194
190
|
/**
|
|
195
191
|
* Lists all OEM names
|
|
196
|
-
* @summary Get Oems
|
|
192
|
+
* @summary Get Oems
|
|
197
193
|
* @param {*} [options] Override http request option.
|
|
198
194
|
* @throws {RequiredError}
|
|
199
195
|
*/
|
|
200
|
-
|
|
196
|
+
getOems: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
201
197
|
const localVarPath = `/oems/`;
|
|
202
198
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
203
199
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -228,18 +224,18 @@ export const DeviceApiFp = function (configuration) {
|
|
|
228
224
|
/**
|
|
229
225
|
* Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
230
226
|
* @summary Get Device
|
|
231
|
-
* @param { | null} [deviceId]
|
|
232
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
227
|
+
* @param {string | null} [deviceId]
|
|
228
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
233
229
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
234
230
|
* @param {*} [options] Override http request option.
|
|
235
231
|
* @throws {RequiredError}
|
|
236
232
|
*/
|
|
237
|
-
|
|
233
|
+
getDevice(deviceId, id, codename, options) {
|
|
238
234
|
return __awaiter(this, void 0, void 0, function* () {
|
|
239
235
|
var _a, _b, _c;
|
|
240
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
236
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDevice(deviceId, id, codename, options);
|
|
241
237
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
242
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DeviceApi.
|
|
238
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DeviceApi.getDevice']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
243
239
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
244
240
|
});
|
|
245
241
|
},
|
|
@@ -251,20 +247,20 @@ export const DeviceApiFp = function (configuration) {
|
|
|
251
247
|
* @deprecated
|
|
252
248
|
* @throws {RequiredError}
|
|
253
249
|
*/
|
|
254
|
-
|
|
250
|
+
getDeviceDeprecated(deviceId, options) {
|
|
255
251
|
return __awaiter(this, void 0, void 0, function* () {
|
|
256
252
|
var _a, _b, _c;
|
|
257
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
253
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeviceDeprecated(deviceId, options);
|
|
258
254
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
259
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DeviceApi.
|
|
255
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DeviceApi.getDeviceDeprecated']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
260
256
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
261
257
|
});
|
|
262
258
|
},
|
|
263
259
|
/**
|
|
264
260
|
* Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
|
|
265
261
|
* @summary Get Devices
|
|
266
|
-
* @param {Array<
|
|
267
|
-
* @param {Array<
|
|
262
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
263
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
268
264
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
269
265
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
270
266
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -277,27 +273,27 @@ export const DeviceApiFp = function (configuration) {
|
|
|
277
273
|
* @param {*} [options] Override http request option.
|
|
278
274
|
* @throws {RequiredError}
|
|
279
275
|
*/
|
|
280
|
-
|
|
276
|
+
getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
|
|
281
277
|
return __awaiter(this, void 0, void 0, function* () {
|
|
282
278
|
var _a, _b, _c;
|
|
283
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
279
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options);
|
|
284
280
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
285
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DeviceApi.
|
|
281
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DeviceApi.getDevices']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
286
282
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
287
283
|
});
|
|
288
284
|
},
|
|
289
285
|
/**
|
|
290
286
|
* Lists all OEM names
|
|
291
|
-
* @summary Get Oems
|
|
287
|
+
* @summary Get Oems
|
|
292
288
|
* @param {*} [options] Override http request option.
|
|
293
289
|
* @throws {RequiredError}
|
|
294
290
|
*/
|
|
295
|
-
|
|
291
|
+
getOems(options) {
|
|
296
292
|
return __awaiter(this, void 0, void 0, function* () {
|
|
297
293
|
var _a, _b, _c;
|
|
298
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
294
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getOems(options);
|
|
299
295
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
300
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DeviceApi.
|
|
296
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DeviceApi.getOems']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
301
297
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
302
298
|
});
|
|
303
299
|
},
|
|
@@ -313,14 +309,14 @@ export const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
313
309
|
/**
|
|
314
310
|
* Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
315
311
|
* @summary Get Device
|
|
316
|
-
* @param { | null} [deviceId]
|
|
317
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
312
|
+
* @param {string | null} [deviceId]
|
|
313
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
318
314
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
319
315
|
* @param {*} [options] Override http request option.
|
|
320
316
|
* @throws {RequiredError}
|
|
321
317
|
*/
|
|
322
|
-
|
|
323
|
-
return localVarFp.
|
|
318
|
+
getDevice(deviceId, id, codename, options) {
|
|
319
|
+
return localVarFp.getDevice(deviceId, id, codename, options).then((request) => request(axios, basePath));
|
|
324
320
|
},
|
|
325
321
|
/**
|
|
326
322
|
* Gets device info using device ID.
|
|
@@ -330,14 +326,14 @@ export const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
330
326
|
* @deprecated
|
|
331
327
|
* @throws {RequiredError}
|
|
332
328
|
*/
|
|
333
|
-
|
|
334
|
-
return localVarFp.
|
|
329
|
+
getDeviceDeprecated(deviceId, options) {
|
|
330
|
+
return localVarFp.getDeviceDeprecated(deviceId, options).then((request) => request(axios, basePath));
|
|
335
331
|
},
|
|
336
332
|
/**
|
|
337
333
|
* Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
|
|
338
334
|
* @summary Get Devices
|
|
339
|
-
* @param {Array<
|
|
340
|
-
* @param {Array<
|
|
335
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
336
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
341
337
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
342
338
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
343
339
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -350,17 +346,17 @@ export const DeviceApiFactory = function (configuration, basePath, axios) {
|
|
|
350
346
|
* @param {*} [options] Override http request option.
|
|
351
347
|
* @throws {RequiredError}
|
|
352
348
|
*/
|
|
353
|
-
|
|
354
|
-
return localVarFp.
|
|
349
|
+
getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
|
|
350
|
+
return localVarFp.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(axios, basePath));
|
|
355
351
|
},
|
|
356
352
|
/**
|
|
357
353
|
* Lists all OEM names
|
|
358
|
-
* @summary Get Oems
|
|
354
|
+
* @summary Get Oems
|
|
359
355
|
* @param {*} [options] Override http request option.
|
|
360
356
|
* @throws {RequiredError}
|
|
361
357
|
*/
|
|
362
|
-
|
|
363
|
-
return localVarFp.
|
|
358
|
+
getOems(options) {
|
|
359
|
+
return localVarFp.getOems(options).then((request) => request(axios, basePath));
|
|
364
360
|
},
|
|
365
361
|
};
|
|
366
362
|
};
|
|
@@ -374,15 +370,15 @@ export class DeviceApi extends BaseAPI {
|
|
|
374
370
|
/**
|
|
375
371
|
* Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
376
372
|
* @summary Get Device
|
|
377
|
-
* @param { | null} [deviceId]
|
|
378
|
-
* @param { | null} [id] Filter by Device ID (deprecated)
|
|
373
|
+
* @param {string | null} [deviceId]
|
|
374
|
+
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
379
375
|
* @param {string | null} [codename] Not recommended to use when you can
|
|
380
376
|
* @param {*} [options] Override http request option.
|
|
381
377
|
* @throws {RequiredError}
|
|
382
378
|
* @memberof DeviceApi
|
|
383
379
|
*/
|
|
384
|
-
|
|
385
|
-
return DeviceApiFp(this.configuration).
|
|
380
|
+
getDevice(deviceId, id, codename, options) {
|
|
381
|
+
return DeviceApiFp(this.configuration).getDevice(deviceId, id, codename, options).then((request) => request(this.axios, this.basePath));
|
|
386
382
|
}
|
|
387
383
|
/**
|
|
388
384
|
* Gets device info using device ID.
|
|
@@ -393,14 +389,14 @@ export class DeviceApi extends BaseAPI {
|
|
|
393
389
|
* @throws {RequiredError}
|
|
394
390
|
* @memberof DeviceApi
|
|
395
391
|
*/
|
|
396
|
-
|
|
397
|
-
return DeviceApiFp(this.configuration).
|
|
392
|
+
getDeviceDeprecated(deviceId, options) {
|
|
393
|
+
return DeviceApiFp(this.configuration).getDeviceDeprecated(deviceId, options).then((request) => request(this.axios, this.basePath));
|
|
398
394
|
}
|
|
399
395
|
/**
|
|
400
396
|
* Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
|
|
401
397
|
* @summary Get Devices
|
|
402
|
-
* @param {Array<
|
|
403
|
-
* @param {Array<
|
|
398
|
+
* @param {Array<string>} [id] Filter by Device IDs
|
|
399
|
+
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
404
400
|
* @param {Array<string>} [oemName] Filter by OEM names
|
|
405
401
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
406
402
|
* @param {Array<string>} [modelName] Filter by model names
|
|
@@ -414,18 +410,18 @@ export class DeviceApi extends BaseAPI {
|
|
|
414
410
|
* @throws {RequiredError}
|
|
415
411
|
* @memberof DeviceApi
|
|
416
412
|
*/
|
|
417
|
-
|
|
418
|
-
return DeviceApiFp(this.configuration).
|
|
413
|
+
getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
|
|
414
|
+
return DeviceApiFp(this.configuration).getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(this.axios, this.basePath));
|
|
419
415
|
}
|
|
420
416
|
/**
|
|
421
417
|
* Lists all OEM names
|
|
422
|
-
* @summary Get Oems
|
|
418
|
+
* @summary Get Oems
|
|
423
419
|
* @param {*} [options] Override http request option.
|
|
424
420
|
* @throws {RequiredError}
|
|
425
421
|
* @memberof DeviceApi
|
|
426
422
|
*/
|
|
427
|
-
|
|
428
|
-
return DeviceApiFp(this.configuration).
|
|
423
|
+
getOems(options) {
|
|
424
|
+
return DeviceApiFp(this.configuration).getOems(options).then((request) => request(this.axios, this.basePath));
|
|
429
425
|
}
|
|
430
426
|
}
|
|
431
427
|
/**
|
|
@@ -437,14 +433,14 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
437
433
|
/**
|
|
438
434
|
* Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
|
|
439
435
|
* @summary Get Release
|
|
440
|
-
* @param { | null} [releaseId] Release ID
|
|
441
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
436
|
+
* @param {string | null} [releaseId] Release ID
|
|
437
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
442
438
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
443
439
|
* @param {string | null} [filename]
|
|
444
440
|
* @param {*} [options] Override http request option.
|
|
445
441
|
* @throws {RequiredError}
|
|
446
442
|
*/
|
|
447
|
-
|
|
443
|
+
getRelease: (releaseId_1, id_1, buildId_1, filename_1, ...args_1) => __awaiter(this, [releaseId_1, id_1, buildId_1, filename_1, ...args_1], void 0, function* (releaseId, id, buildId, filename, options = {}) {
|
|
448
444
|
const localVarPath = `/releases/get`;
|
|
449
445
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
450
446
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -456,14 +452,10 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
456
452
|
const localVarHeaderParameter = {};
|
|
457
453
|
const localVarQueryParameter = {};
|
|
458
454
|
if (releaseId !== undefined) {
|
|
459
|
-
|
|
460
|
-
localVarQueryParameter[key] = value;
|
|
461
|
-
}
|
|
455
|
+
localVarQueryParameter['release_id'] = releaseId;
|
|
462
456
|
}
|
|
463
457
|
if (id !== undefined) {
|
|
464
|
-
|
|
465
|
-
localVarQueryParameter[key] = value;
|
|
466
|
-
}
|
|
458
|
+
localVarQueryParameter['_id'] = id;
|
|
467
459
|
}
|
|
468
460
|
if (buildId !== undefined) {
|
|
469
461
|
localVarQueryParameter['build_id'] = buildId;
|
|
@@ -482,14 +474,14 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
482
474
|
/**
|
|
483
475
|
* Gets release information using the release ID, nothing to discuss really.
|
|
484
476
|
* @summary Get Release Short
|
|
485
|
-
* @param {
|
|
477
|
+
* @param {string} releaseId
|
|
486
478
|
* @param {*} [options] Override http request option.
|
|
487
479
|
* @deprecated
|
|
488
480
|
* @throws {RequiredError}
|
|
489
481
|
*/
|
|
490
|
-
|
|
482
|
+
getReleaseDeprecated: (releaseId_1, ...args_1) => __awaiter(this, [releaseId_1, ...args_1], void 0, function* (releaseId, options = {}) {
|
|
491
483
|
// verify required parameter 'releaseId' is not null or undefined
|
|
492
|
-
assertParamExists('
|
|
484
|
+
assertParamExists('getReleaseDeprecated', 'releaseId', releaseId);
|
|
493
485
|
const localVarPath = `/releases/{release_id}`
|
|
494
486
|
.replace(`{${"release_id"}}`, encodeURIComponent(String(releaseId)));
|
|
495
487
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -512,17 +504,17 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
512
504
|
/**
|
|
513
505
|
* Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
|
|
514
506
|
* @summary Get Releases
|
|
515
|
-
* @param {Array<
|
|
516
|
-
* @param {Array<
|
|
507
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
508
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
517
509
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
518
|
-
* @param {Array<
|
|
519
|
-
* @param {Array<
|
|
510
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
511
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
520
512
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
521
513
|
* @param {Array<string>} [version] Filter by release version
|
|
522
514
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
523
515
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
524
516
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
525
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
517
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
526
518
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
527
519
|
* @param {ReleasesSort} [sort] Sort mode
|
|
528
520
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -531,7 +523,7 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
531
523
|
* @param {*} [options] Override http request option.
|
|
532
524
|
* @throws {RequiredError}
|
|
533
525
|
*/
|
|
534
|
-
|
|
526
|
+
getReleases: (id_1, id2_1, buildId_1, deviceId_1, maintainerId_1, codename_1, version_1, type_1, archived_1, freezed_1, afterReleaseId_1, afterDate_1, sort_1, group_1, skip_1, limit_1, ...args_1) => __awaiter(this, [id_1, id2_1, buildId_1, deviceId_1, maintainerId_1, codename_1, version_1, type_1, archived_1, freezed_1, afterReleaseId_1, afterDate_1, sort_1, group_1, skip_1, limit_1, ...args_1], void 0, function* (id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options = {}) {
|
|
535
527
|
const localVarPath = `/releases/`;
|
|
536
528
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
537
529
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -573,9 +565,7 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
573
565
|
localVarQueryParameter['freezed'] = freezed;
|
|
574
566
|
}
|
|
575
567
|
if (afterReleaseId !== undefined) {
|
|
576
|
-
|
|
577
|
-
localVarQueryParameter[key] = value;
|
|
578
|
-
}
|
|
568
|
+
localVarQueryParameter['after_release_id'] = afterReleaseId;
|
|
579
569
|
}
|
|
580
570
|
if (afterDate !== undefined) {
|
|
581
571
|
localVarQueryParameter['after_date'] = afterDate;
|
|
@@ -603,8 +593,8 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
603
593
|
/**
|
|
604
594
|
* Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
|
|
605
595
|
* @summary Get Updates
|
|
606
|
-
* @param {
|
|
607
|
-
* @param {Array<
|
|
596
|
+
* @param {string} lastKnownId
|
|
597
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
608
598
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
609
599
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
610
600
|
* @param {number | null} [skip] Skip query results
|
|
@@ -613,9 +603,9 @@ export const ReleaseApiAxiosParamCreator = function (configuration) {
|
|
|
613
603
|
* @deprecated
|
|
614
604
|
* @throws {RequiredError}
|
|
615
605
|
*/
|
|
616
|
-
|
|
606
|
+
getUpdatesDeprecated: (lastKnownId_1, deviceId_1, type_1, releaseType_1, skip_1, limit_1, ...args_1) => __awaiter(this, [lastKnownId_1, deviceId_1, type_1, releaseType_1, skip_1, limit_1, ...args_1], void 0, function* (lastKnownId, deviceId, type, releaseType, skip, limit, options = {}) {
|
|
617
607
|
// verify required parameter 'lastKnownId' is not null or undefined
|
|
618
|
-
assertParamExists('
|
|
608
|
+
assertParamExists('getUpdatesDeprecated', 'lastKnownId', lastKnownId);
|
|
619
609
|
const localVarPath = `/updates/{last_known_id}`
|
|
620
610
|
.replace(`{${"last_known_id"}}`, encodeURIComponent(String(lastKnownId)));
|
|
621
611
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -662,53 +652,53 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
662
652
|
/**
|
|
663
653
|
* Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
|
|
664
654
|
* @summary Get Release
|
|
665
|
-
* @param { | null} [releaseId] Release ID
|
|
666
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
655
|
+
* @param {string | null} [releaseId] Release ID
|
|
656
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
667
657
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
668
658
|
* @param {string | null} [filename]
|
|
669
659
|
* @param {*} [options] Override http request option.
|
|
670
660
|
* @throws {RequiredError}
|
|
671
661
|
*/
|
|
672
|
-
|
|
662
|
+
getRelease(releaseId, id, buildId, filename, options) {
|
|
673
663
|
return __awaiter(this, void 0, void 0, function* () {
|
|
674
664
|
var _a, _b, _c;
|
|
675
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
665
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getRelease(releaseId, id, buildId, filename, options);
|
|
676
666
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
677
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReleaseApi.
|
|
667
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReleaseApi.getRelease']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
678
668
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
679
669
|
});
|
|
680
670
|
},
|
|
681
671
|
/**
|
|
682
672
|
* Gets release information using the release ID, nothing to discuss really.
|
|
683
673
|
* @summary Get Release Short
|
|
684
|
-
* @param {
|
|
674
|
+
* @param {string} releaseId
|
|
685
675
|
* @param {*} [options] Override http request option.
|
|
686
676
|
* @deprecated
|
|
687
677
|
* @throws {RequiredError}
|
|
688
678
|
*/
|
|
689
|
-
|
|
679
|
+
getReleaseDeprecated(releaseId, options) {
|
|
690
680
|
return __awaiter(this, void 0, void 0, function* () {
|
|
691
681
|
var _a, _b, _c;
|
|
692
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
682
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReleaseDeprecated(releaseId, options);
|
|
693
683
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
694
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReleaseApi.
|
|
684
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReleaseApi.getReleaseDeprecated']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
695
685
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
696
686
|
});
|
|
697
687
|
},
|
|
698
688
|
/**
|
|
699
689
|
* Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
|
|
700
690
|
* @summary Get Releases
|
|
701
|
-
* @param {Array<
|
|
702
|
-
* @param {Array<
|
|
691
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
692
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
703
693
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
704
|
-
* @param {Array<
|
|
705
|
-
* @param {Array<
|
|
694
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
695
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
706
696
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
707
697
|
* @param {Array<string>} [version] Filter by release version
|
|
708
698
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
709
699
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
710
700
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
711
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
701
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
712
702
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
713
703
|
* @param {ReleasesSort} [sort] Sort mode
|
|
714
704
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -717,20 +707,20 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
717
707
|
* @param {*} [options] Override http request option.
|
|
718
708
|
* @throws {RequiredError}
|
|
719
709
|
*/
|
|
720
|
-
|
|
710
|
+
getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options) {
|
|
721
711
|
return __awaiter(this, void 0, void 0, function* () {
|
|
722
712
|
var _a, _b, _c;
|
|
723
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
713
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options);
|
|
724
714
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
725
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReleaseApi.
|
|
715
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReleaseApi.getReleases']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
726
716
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
727
717
|
});
|
|
728
718
|
},
|
|
729
719
|
/**
|
|
730
720
|
* Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
|
|
731
721
|
* @summary Get Updates
|
|
732
|
-
* @param {
|
|
733
|
-
* @param {Array<
|
|
722
|
+
* @param {string} lastKnownId
|
|
723
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
734
724
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
735
725
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
736
726
|
* @param {number | null} [skip] Skip query results
|
|
@@ -739,12 +729,12 @@ export const ReleaseApiFp = function (configuration) {
|
|
|
739
729
|
* @deprecated
|
|
740
730
|
* @throws {RequiredError}
|
|
741
731
|
*/
|
|
742
|
-
|
|
732
|
+
getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options) {
|
|
743
733
|
return __awaiter(this, void 0, void 0, function* () {
|
|
744
734
|
var _a, _b, _c;
|
|
745
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
735
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options);
|
|
746
736
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
747
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReleaseApi.
|
|
737
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReleaseApi.getUpdatesDeprecated']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
748
738
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
749
739
|
});
|
|
750
740
|
},
|
|
@@ -760,41 +750,41 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
760
750
|
/**
|
|
761
751
|
* Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
|
|
762
752
|
* @summary Get Release
|
|
763
|
-
* @param { | null} [releaseId] Release ID
|
|
764
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
753
|
+
* @param {string | null} [releaseId] Release ID
|
|
754
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
765
755
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
766
756
|
* @param {string | null} [filename]
|
|
767
757
|
* @param {*} [options] Override http request option.
|
|
768
758
|
* @throws {RequiredError}
|
|
769
759
|
*/
|
|
770
|
-
|
|
771
|
-
return localVarFp.
|
|
760
|
+
getRelease(releaseId, id, buildId, filename, options) {
|
|
761
|
+
return localVarFp.getRelease(releaseId, id, buildId, filename, options).then((request) => request(axios, basePath));
|
|
772
762
|
},
|
|
773
763
|
/**
|
|
774
764
|
* Gets release information using the release ID, nothing to discuss really.
|
|
775
765
|
* @summary Get Release Short
|
|
776
|
-
* @param {
|
|
766
|
+
* @param {string} releaseId
|
|
777
767
|
* @param {*} [options] Override http request option.
|
|
778
768
|
* @deprecated
|
|
779
769
|
* @throws {RequiredError}
|
|
780
770
|
*/
|
|
781
|
-
|
|
782
|
-
return localVarFp.
|
|
771
|
+
getReleaseDeprecated(releaseId, options) {
|
|
772
|
+
return localVarFp.getReleaseDeprecated(releaseId, options).then((request) => request(axios, basePath));
|
|
783
773
|
},
|
|
784
774
|
/**
|
|
785
775
|
* Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
|
|
786
776
|
* @summary Get Releases
|
|
787
|
-
* @param {Array<
|
|
788
|
-
* @param {Array<
|
|
777
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
778
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
789
779
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
790
|
-
* @param {Array<
|
|
791
|
-
* @param {Array<
|
|
780
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
781
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
792
782
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
793
783
|
* @param {Array<string>} [version] Filter by release version
|
|
794
784
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
795
785
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
796
786
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
797
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
787
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
798
788
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
799
789
|
* @param {ReleasesSort} [sort] Sort mode
|
|
800
790
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -803,14 +793,14 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
803
793
|
* @param {*} [options] Override http request option.
|
|
804
794
|
* @throws {RequiredError}
|
|
805
795
|
*/
|
|
806
|
-
|
|
807
|
-
return localVarFp.
|
|
796
|
+
getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options) {
|
|
797
|
+
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));
|
|
808
798
|
},
|
|
809
799
|
/**
|
|
810
800
|
* Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
|
|
811
801
|
* @summary Get Updates
|
|
812
|
-
* @param {
|
|
813
|
-
* @param {Array<
|
|
802
|
+
* @param {string} lastKnownId
|
|
803
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
814
804
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
815
805
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
816
806
|
* @param {number | null} [skip] Skip query results
|
|
@@ -819,8 +809,8 @@ export const ReleaseApiFactory = function (configuration, basePath, axios) {
|
|
|
819
809
|
* @deprecated
|
|
820
810
|
* @throws {RequiredError}
|
|
821
811
|
*/
|
|
822
|
-
|
|
823
|
-
return localVarFp.
|
|
812
|
+
getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options) {
|
|
813
|
+
return localVarFp.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(axios, basePath));
|
|
824
814
|
},
|
|
825
815
|
};
|
|
826
816
|
};
|
|
@@ -834,43 +824,43 @@ export class ReleaseApi extends BaseAPI {
|
|
|
834
824
|
/**
|
|
835
825
|
* Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
|
|
836
826
|
* @summary Get Release
|
|
837
|
-
* @param { | null} [releaseId] Release ID
|
|
838
|
-
* @param { | null} [id] Release ID (deprecated)
|
|
827
|
+
* @param {string | null} [releaseId] Release ID
|
|
828
|
+
* @param {string | null} [id] Release ID (deprecated)
|
|
839
829
|
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
840
830
|
* @param {string | null} [filename]
|
|
841
831
|
* @param {*} [options] Override http request option.
|
|
842
832
|
* @throws {RequiredError}
|
|
843
833
|
* @memberof ReleaseApi
|
|
844
834
|
*/
|
|
845
|
-
|
|
846
|
-
return ReleaseApiFp(this.configuration).
|
|
835
|
+
getRelease(releaseId, id, buildId, filename, options) {
|
|
836
|
+
return ReleaseApiFp(this.configuration).getRelease(releaseId, id, buildId, filename, options).then((request) => request(this.axios, this.basePath));
|
|
847
837
|
}
|
|
848
838
|
/**
|
|
849
839
|
* Gets release information using the release ID, nothing to discuss really.
|
|
850
840
|
* @summary Get Release Short
|
|
851
|
-
* @param {
|
|
841
|
+
* @param {string} releaseId
|
|
852
842
|
* @param {*} [options] Override http request option.
|
|
853
843
|
* @deprecated
|
|
854
844
|
* @throws {RequiredError}
|
|
855
845
|
* @memberof ReleaseApi
|
|
856
846
|
*/
|
|
857
|
-
|
|
858
|
-
return ReleaseApiFp(this.configuration).
|
|
847
|
+
getReleaseDeprecated(releaseId, options) {
|
|
848
|
+
return ReleaseApiFp(this.configuration).getReleaseDeprecated(releaseId, options).then((request) => request(this.axios, this.basePath));
|
|
859
849
|
}
|
|
860
850
|
/**
|
|
861
851
|
* Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
|
|
862
852
|
* @summary Get Releases
|
|
863
|
-
* @param {Array<
|
|
864
|
-
* @param {Array<
|
|
853
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
854
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
865
855
|
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
866
|
-
* @param {Array<
|
|
867
|
-
* @param {Array<
|
|
856
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
857
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
868
858
|
* @param {Array<string>} [codename] Filter by device codenames
|
|
869
859
|
* @param {Array<string>} [version] Filter by release version
|
|
870
860
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
871
861
|
* @param {boolean | null} [archived] Filter by the archived status
|
|
872
862
|
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
873
|
-
* @param { | null} [afterReleaseId] Show releases after the provided one
|
|
863
|
+
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
874
864
|
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
875
865
|
* @param {ReleasesSort} [sort] Sort mode
|
|
876
866
|
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
@@ -880,14 +870,14 @@ export class ReleaseApi extends BaseAPI {
|
|
|
880
870
|
* @throws {RequiredError}
|
|
881
871
|
* @memberof ReleaseApi
|
|
882
872
|
*/
|
|
883
|
-
|
|
884
|
-
return ReleaseApiFp(this.configuration).
|
|
873
|
+
getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options) {
|
|
874
|
+
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));
|
|
885
875
|
}
|
|
886
876
|
/**
|
|
887
877
|
* Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
|
|
888
878
|
* @summary Get Updates
|
|
889
|
-
* @param {
|
|
890
|
-
* @param {Array<
|
|
879
|
+
* @param {string} lastKnownId
|
|
880
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
891
881
|
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
892
882
|
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
893
883
|
* @param {number | null} [skip] Skip query results
|
|
@@ -897,8 +887,8 @@ export class ReleaseApi extends BaseAPI {
|
|
|
897
887
|
* @throws {RequiredError}
|
|
898
888
|
* @memberof ReleaseApi
|
|
899
889
|
*/
|
|
900
|
-
|
|
901
|
-
return ReleaseApiFp(this.configuration).
|
|
890
|
+
getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options) {
|
|
891
|
+
return ReleaseApiFp(this.configuration).getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(this.axios, this.basePath));
|
|
902
892
|
}
|
|
903
893
|
}
|
|
904
894
|
/**
|
|
@@ -913,7 +903,7 @@ export const StatsApiAxiosParamCreator = function (configuration) {
|
|
|
913
903
|
* @param {*} [options] Override http request option.
|
|
914
904
|
* @throws {RequiredError}
|
|
915
905
|
*/
|
|
916
|
-
|
|
906
|
+
getPublicStats: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
917
907
|
const localVarPath = `/stats/`;
|
|
918
908
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
919
909
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -947,12 +937,12 @@ export const StatsApiFp = function (configuration) {
|
|
|
947
937
|
* @param {*} [options] Override http request option.
|
|
948
938
|
* @throws {RequiredError}
|
|
949
939
|
*/
|
|
950
|
-
|
|
940
|
+
getPublicStats(options) {
|
|
951
941
|
return __awaiter(this, void 0, void 0, function* () {
|
|
952
942
|
var _a, _b, _c;
|
|
953
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
943
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPublicStats(options);
|
|
954
944
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
955
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StatsApi.
|
|
945
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['StatsApi.getPublicStats']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
956
946
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
957
947
|
});
|
|
958
948
|
},
|
|
@@ -971,8 +961,8 @@ export const StatsApiFactory = function (configuration, basePath, axios) {
|
|
|
971
961
|
* @param {*} [options] Override http request option.
|
|
972
962
|
* @throws {RequiredError}
|
|
973
963
|
*/
|
|
974
|
-
|
|
975
|
-
return localVarFp.
|
|
964
|
+
getPublicStats(options) {
|
|
965
|
+
return localVarFp.getPublicStats(options).then((request) => request(axios, basePath));
|
|
976
966
|
},
|
|
977
967
|
};
|
|
978
968
|
};
|
|
@@ -990,7 +980,7 @@ export class StatsApi extends BaseAPI {
|
|
|
990
980
|
* @throws {RequiredError}
|
|
991
981
|
* @memberof StatsApi
|
|
992
982
|
*/
|
|
993
|
-
|
|
994
|
-
return StatsApiFp(this.configuration).
|
|
983
|
+
getPublicStats(options) {
|
|
984
|
+
return StatsApiFp(this.configuration).getPublicStats(options).then((request) => request(this.axios, this.basePath));
|
|
995
985
|
}
|
|
996
986
|
}
|