@orangefox-recovery/foxclient 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/.openapi-generator/FILES +34 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +104 -0
  5. package/api.ts +1904 -0
  6. package/base.ts +86 -0
  7. package/common.ts +150 -0
  8. package/configuration.ts +115 -0
  9. package/dist/api.d.ts +1294 -0
  10. package/dist/api.js +1057 -0
  11. package/dist/base.d.ts +66 -0
  12. package/dist/base.js +65 -0
  13. package/dist/common.d.ts +65 -0
  14. package/dist/common.js +161 -0
  15. package/dist/configuration.d.ts +91 -0
  16. package/dist/configuration.js +44 -0
  17. package/dist/esm/api.d.ts +1294 -0
  18. package/dist/esm/api.js +1042 -0
  19. package/dist/esm/base.d.ts +66 -0
  20. package/dist/esm/base.js +60 -0
  21. package/dist/esm/common.d.ts +65 -0
  22. package/dist/esm/common.js +149 -0
  23. package/dist/esm/configuration.d.ts +91 -0
  24. package/dist/esm/configuration.js +40 -0
  25. package/dist/esm/index.d.ts +13 -0
  26. package/dist/esm/index.js +15 -0
  27. package/dist/index.d.ts +13 -0
  28. package/dist/index.js +31 -0
  29. package/docs/DeviceApi.md +253 -0
  30. package/docs/DeviceResponse.md +44 -0
  31. package/docs/GlobalStatsAggregationModel.md +26 -0
  32. package/docs/HTTPValidationError.md +20 -0
  33. package/docs/ListResponseReleaseResponse.md +22 -0
  34. package/docs/ListResponseShortDeviceResponse.md +22 -0
  35. package/docs/ListResponseShortReleaseResponse.md +22 -0
  36. package/docs/ListResponseStr.md +22 -0
  37. package/docs/MaintainerShortModel.md +26 -0
  38. package/docs/RecoveryImgResponse.md +22 -0
  39. package/docs/ReleaseApi.md +292 -0
  40. package/docs/ReleaseGroupsResponse.md +20 -0
  41. package/docs/ReleaseResponse.md +56 -0
  42. package/docs/ReleaseType.md +12 -0
  43. package/docs/ReleasesSort.md +10 -0
  44. package/docs/ResponseGetReleasesReleasesGet.md +22 -0
  45. package/docs/ShortDeviceResponse.md +38 -0
  46. package/docs/ShortReleaseResponse.md +44 -0
  47. package/docs/StatsApi.md +53 -0
  48. package/docs/ValidationError.md +24 -0
  49. package/docs/ValidationErrorLocInner.md +18 -0
  50. package/git_push.sh +57 -0
  51. package/index.ts +18 -0
  52. package/package.json +41 -0
  53. package/tsconfig.esm.json +7 -0
  54. package/tsconfig.json +18 -0
@@ -0,0 +1,1294 @@
1
+ /**
2
+ * Fox API
3
+ * Warning: Please add a custom \'X-FoxAPI-App=MyAppName\' header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 20 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
4
+ *
5
+ * The version of the OpenAPI document: 5.1.1
6
+ * Contact: admin@orangefox.tech
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from './configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import type { RequestArgs } from './base';
15
+ import { BaseAPI } from './base';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface DeviceResponse
20
+ */
21
+ export interface DeviceResponse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof DeviceResponse
26
+ * @deprecated
27
+ */
28
+ '_id': string;
29
+ /**
30
+ * Device codename, legacy
31
+ * @type {string}
32
+ * @memberof DeviceResponse
33
+ * @deprecated
34
+ */
35
+ 'codename': string;
36
+ /**
37
+ * Model name of device, does not include the OEM part, legacy
38
+ * @type {string}
39
+ * @memberof DeviceResponse
40
+ * @deprecated
41
+ */
42
+ 'model_name': string;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof DeviceResponse
47
+ */
48
+ 'oem_name': string;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof DeviceResponse
53
+ */
54
+ 'id': string;
55
+ /**
56
+ *
57
+ * @type {Array<string>}
58
+ * @memberof DeviceResponse
59
+ */
60
+ 'codenames': Array<string>;
61
+ /**
62
+ *
63
+ * @type {Array<string>}
64
+ * @memberof DeviceResponse
65
+ */
66
+ 'model_names': Array<string>;
67
+ /**
68
+ *
69
+ * @type {boolean}
70
+ * @memberof DeviceResponse
71
+ */
72
+ 'supported': boolean;
73
+ /**
74
+ *
75
+ * @type {MaintainerShortModel}
76
+ * @memberof DeviceResponse
77
+ */
78
+ 'maintainer': MaintainerShortModel;
79
+ /**
80
+ *
81
+ * @type {string}
82
+ * @memberof DeviceResponse
83
+ */
84
+ 'notes'?: string | null;
85
+ /**
86
+ *
87
+ * @type {string}
88
+ * @memberof DeviceResponse
89
+ */
90
+ 'device_tree'?: string | null;
91
+ /**
92
+ * Full name of device / devices, legacy
93
+ * @type {string}
94
+ * @memberof DeviceResponse
95
+ */
96
+ 'full_name': string;
97
+ /**
98
+ * URL of the device on the official website
99
+ * @type {string}
100
+ * @memberof DeviceResponse
101
+ */
102
+ 'url': string;
103
+ }
104
+ /**
105
+ *
106
+ * @export
107
+ * @interface GlobalStatsAggregationModel
108
+ */
109
+ export interface GlobalStatsAggregationModel {
110
+ /**
111
+ *
112
+ * @type {number}
113
+ * @memberof GlobalStatsAggregationModel
114
+ */
115
+ 'count': number;
116
+ /**
117
+ *
118
+ * @type {number}
119
+ * @memberof GlobalStatsAggregationModel
120
+ */
121
+ 'deviceCount': number;
122
+ /**
123
+ *
124
+ * @type {number}
125
+ * @memberof GlobalStatsAggregationModel
126
+ */
127
+ 'releaseCount': number;
128
+ /**
129
+ *
130
+ * @type {{ [key: string]: number; }}
131
+ * @memberof GlobalStatsAggregationModel
132
+ */
133
+ 'days': {
134
+ [key: string]: number;
135
+ };
136
+ }
137
+ /**
138
+ *
139
+ * @export
140
+ * @interface HTTPValidationError
141
+ */
142
+ export interface HTTPValidationError {
143
+ /**
144
+ *
145
+ * @type {Array<ValidationError>}
146
+ * @memberof HTTPValidationError
147
+ */
148
+ 'detail'?: Array<ValidationError>;
149
+ }
150
+ /**
151
+ *
152
+ * @export
153
+ * @interface ListResponseReleaseResponse
154
+ */
155
+ export interface ListResponseReleaseResponse {
156
+ /**
157
+ *
158
+ * @type {Array<ReleaseResponse>}
159
+ * @memberof ListResponseReleaseResponse
160
+ */
161
+ 'data': Array<ReleaseResponse>;
162
+ /**
163
+ *
164
+ * @type {number}
165
+ * @memberof ListResponseReleaseResponse
166
+ */
167
+ 'count': number;
168
+ }
169
+ /**
170
+ *
171
+ * @export
172
+ * @interface ListResponseShortDeviceResponse
173
+ */
174
+ export interface ListResponseShortDeviceResponse {
175
+ /**
176
+ *
177
+ * @type {Array<ShortDeviceResponse>}
178
+ * @memberof ListResponseShortDeviceResponse
179
+ */
180
+ 'data': Array<ShortDeviceResponse>;
181
+ /**
182
+ *
183
+ * @type {number}
184
+ * @memberof ListResponseShortDeviceResponse
185
+ */
186
+ 'count': number;
187
+ }
188
+ /**
189
+ *
190
+ * @export
191
+ * @interface ListResponseShortReleaseResponse
192
+ */
193
+ export interface ListResponseShortReleaseResponse {
194
+ /**
195
+ *
196
+ * @type {Array<ShortReleaseResponse>}
197
+ * @memberof ListResponseShortReleaseResponse
198
+ */
199
+ 'data': Array<ShortReleaseResponse>;
200
+ /**
201
+ *
202
+ * @type {number}
203
+ * @memberof ListResponseShortReleaseResponse
204
+ */
205
+ 'count': number;
206
+ }
207
+ /**
208
+ *
209
+ * @export
210
+ * @interface ListResponseStr
211
+ */
212
+ export interface ListResponseStr {
213
+ /**
214
+ *
215
+ * @type {Array<string>}
216
+ * @memberof ListResponseStr
217
+ */
218
+ 'data': Array<string>;
219
+ /**
220
+ *
221
+ * @type {number}
222
+ * @memberof ListResponseStr
223
+ */
224
+ 'count': number;
225
+ }
226
+ /**
227
+ *
228
+ * @export
229
+ * @interface MaintainerShortModel
230
+ */
231
+ export interface MaintainerShortModel {
232
+ /**
233
+ *
234
+ * @type {string}
235
+ * @memberof MaintainerShortModel
236
+ * @deprecated
237
+ */
238
+ '_id': string;
239
+ /**
240
+ *
241
+ * @type {string}
242
+ * @memberof MaintainerShortModel
243
+ */
244
+ 'id': string;
245
+ /**
246
+ *
247
+ * @type {string}
248
+ * @memberof MaintainerShortModel
249
+ */
250
+ 'name': string;
251
+ /**
252
+ *
253
+ * @type {string}
254
+ * @memberof MaintainerShortModel
255
+ */
256
+ 'username': string;
257
+ }
258
+ /**
259
+ *
260
+ * @export
261
+ * @interface RecoveryImgResponse
262
+ */
263
+ export interface RecoveryImgResponse {
264
+ /**
265
+ *
266
+ * @type {number}
267
+ * @memberof RecoveryImgResponse
268
+ */
269
+ 'size': number;
270
+ /**
271
+ *
272
+ * @type {string}
273
+ * @memberof RecoveryImgResponse
274
+ */
275
+ 'md5': string;
276
+ }
277
+ /**
278
+ *
279
+ * @export
280
+ * @interface ReleaseGroupsResponse
281
+ */
282
+ export interface ReleaseGroupsResponse {
283
+ /**
284
+ *
285
+ * @type {{ [key: string]: Array<ReleaseResponse>; }}
286
+ * @memberof ReleaseGroupsResponse
287
+ */
288
+ 'data': {
289
+ [key: string]: Array<ReleaseResponse>;
290
+ };
291
+ }
292
+ /**
293
+ *
294
+ * @export
295
+ * @interface ReleaseResponse
296
+ */
297
+ export interface ReleaseResponse {
298
+ /**
299
+ *
300
+ * @type {string}
301
+ * @memberof ReleaseResponse
302
+ * @deprecated
303
+ */
304
+ '_id': string;
305
+ /**
306
+ *
307
+ * @type {number}
308
+ * @memberof ReleaseResponse
309
+ * @deprecated
310
+ */
311
+ 'size': number;
312
+ /**
313
+ * Release ID, that\'s how we indentify the release in the infrastructure
314
+ * @type {string}
315
+ * @memberof ReleaseResponse
316
+ */
317
+ 'id': string;
318
+ /**
319
+ *
320
+ * @type {string}
321
+ * @memberof ReleaseResponse
322
+ */
323
+ 'build_id'?: string | null;
324
+ /**
325
+ *
326
+ * @type {string}
327
+ * @memberof ReleaseResponse
328
+ */
329
+ 'filename': string;
330
+ /**
331
+ *
332
+ * @type {string}
333
+ * @memberof ReleaseResponse
334
+ */
335
+ 'variant': string;
336
+ /**
337
+ *
338
+ * @type {string}
339
+ * @memberof ReleaseResponse
340
+ */
341
+ 'device_id': string;
342
+ /**
343
+ *
344
+ * @type {string}
345
+ * @memberof ReleaseResponse
346
+ */
347
+ 'date': string;
348
+ /**
349
+ *
350
+ * @type {string}
351
+ * @memberof ReleaseResponse
352
+ */
353
+ 'md5': string;
354
+ /**
355
+ *
356
+ * @type {string}
357
+ * @memberof ReleaseResponse
358
+ */
359
+ 'version': string;
360
+ /**
361
+ *
362
+ * @type {ReleaseType}
363
+ * @memberof ReleaseResponse
364
+ */
365
+ 'type': ReleaseType;
366
+ /**
367
+ *
368
+ * @type {string}
369
+ * @memberof ReleaseResponse
370
+ */
371
+ 'maintainer_id'?: string | null;
372
+ /**
373
+ *
374
+ * @type {boolean}
375
+ * @memberof ReleaseResponse
376
+ */
377
+ 'archived': boolean;
378
+ /**
379
+ *
380
+ * @type {RecoveryImgResponse}
381
+ * @memberof ReleaseResponse
382
+ */
383
+ 'recovery_img': RecoveryImgResponse;
384
+ /**
385
+ *
386
+ * @type {Array<string>}
387
+ * @memberof ReleaseResponse
388
+ */
389
+ 'changelog': Array<string>;
390
+ /**
391
+ *
392
+ * @type {Array<string>}
393
+ * @memberof ReleaseResponse
394
+ */
395
+ 'bugs': Array<string> | null;
396
+ /**
397
+ *
398
+ * @type {string}
399
+ * @memberof ReleaseResponse
400
+ */
401
+ 'notes': string | null;
402
+ /**
403
+ * URL of the release on the official website
404
+ * @type {string}
405
+ * @memberof ReleaseResponse
406
+ */
407
+ 'url': string;
408
+ /**
409
+ * Mirrors list (deprecated)
410
+ * @type {{ [key: string]: string; }}
411
+ * @memberof ReleaseResponse
412
+ */
413
+ 'mirrors': {
414
+ [key: string]: string;
415
+ };
416
+ }
417
+ /**
418
+ *
419
+ * @export
420
+ * @enum {string}
421
+ */
422
+ export declare const ReleaseType: {
423
+ readonly Stable: "stable";
424
+ readonly Beta: "beta";
425
+ readonly Alpha: "alpha";
426
+ };
427
+ export type ReleaseType = typeof ReleaseType[keyof typeof ReleaseType];
428
+ /**
429
+ *
430
+ * @export
431
+ * @enum {string}
432
+ */
433
+ export declare const ReleasesSort: {
434
+ readonly DateAsc: "date_asc";
435
+ readonly DateDesc: "date_desc";
436
+ };
437
+ export type ReleasesSort = typeof ReleasesSort[keyof typeof ReleasesSort];
438
+ /**
439
+ *
440
+ * @export
441
+ * @interface ResponseGetReleasesReleasesGet
442
+ */
443
+ export interface ResponseGetReleasesReleasesGet {
444
+ /**
445
+ *
446
+ * @type {{ [key: string]: Array<ReleaseResponse>; }}
447
+ * @memberof ResponseGetReleasesReleasesGet
448
+ */
449
+ 'data': {
450
+ [key: string]: Array<ReleaseResponse>;
451
+ };
452
+ /**
453
+ *
454
+ * @type {number}
455
+ * @memberof ResponseGetReleasesReleasesGet
456
+ */
457
+ 'count': number;
458
+ }
459
+ /**
460
+ *
461
+ * @export
462
+ * @interface ShortDeviceResponse
463
+ */
464
+ export interface ShortDeviceResponse {
465
+ /**
466
+ *
467
+ * @type {string}
468
+ * @memberof ShortDeviceResponse
469
+ * @deprecated
470
+ */
471
+ '_id': string;
472
+ /**
473
+ * Device codename, legacy
474
+ * @type {string}
475
+ * @memberof ShortDeviceResponse
476
+ * @deprecated
477
+ */
478
+ 'codename': string;
479
+ /**
480
+ * Model name of device, does not include the OEM part, legacy
481
+ * @type {string}
482
+ * @memberof ShortDeviceResponse
483
+ * @deprecated
484
+ */
485
+ 'model_name': string;
486
+ /**
487
+ *
488
+ * @type {string}
489
+ * @memberof ShortDeviceResponse
490
+ */
491
+ 'oem_name': string;
492
+ /**
493
+ *
494
+ * @type {string}
495
+ * @memberof ShortDeviceResponse
496
+ */
497
+ 'id': string;
498
+ /**
499
+ *
500
+ * @type {Array<string>}
501
+ * @memberof ShortDeviceResponse
502
+ */
503
+ 'codenames': Array<string>;
504
+ /**
505
+ *
506
+ * @type {Array<string>}
507
+ * @memberof ShortDeviceResponse
508
+ */
509
+ 'model_names': Array<string>;
510
+ /**
511
+ *
512
+ * @type {boolean}
513
+ * @memberof ShortDeviceResponse
514
+ */
515
+ 'supported': boolean;
516
+ /**
517
+ * Full name of device / devices, legacy
518
+ * @type {string}
519
+ * @memberof ShortDeviceResponse
520
+ */
521
+ 'full_name': string;
522
+ /**
523
+ * URL of the device on the official website
524
+ * @type {string}
525
+ * @memberof ShortDeviceResponse
526
+ */
527
+ 'url': string;
528
+ }
529
+ /**
530
+ *
531
+ * @export
532
+ * @interface ShortReleaseResponse
533
+ */
534
+ export interface ShortReleaseResponse {
535
+ /**
536
+ *
537
+ * @type {string}
538
+ * @memberof ShortReleaseResponse
539
+ * @deprecated
540
+ */
541
+ '_id': string;
542
+ /**
543
+ *
544
+ * @type {number}
545
+ * @memberof ShortReleaseResponse
546
+ * @deprecated
547
+ */
548
+ 'size': number;
549
+ /**
550
+ * Release ID, that\'s how we indentify the release in the infrastructure
551
+ * @type {string}
552
+ * @memberof ShortReleaseResponse
553
+ */
554
+ 'id': string;
555
+ /**
556
+ *
557
+ * @type {string}
558
+ * @memberof ShortReleaseResponse
559
+ */
560
+ 'build_id'?: string | null;
561
+ /**
562
+ *
563
+ * @type {string}
564
+ * @memberof ShortReleaseResponse
565
+ */
566
+ 'filename': string;
567
+ /**
568
+ *
569
+ * @type {string}
570
+ * @memberof ShortReleaseResponse
571
+ */
572
+ 'variant': string;
573
+ /**
574
+ *
575
+ * @type {string}
576
+ * @memberof ShortReleaseResponse
577
+ */
578
+ 'device_id': string;
579
+ /**
580
+ *
581
+ * @type {string}
582
+ * @memberof ShortReleaseResponse
583
+ */
584
+ 'date': string;
585
+ /**
586
+ *
587
+ * @type {string}
588
+ * @memberof ShortReleaseResponse
589
+ */
590
+ 'md5': string;
591
+ /**
592
+ *
593
+ * @type {string}
594
+ * @memberof ShortReleaseResponse
595
+ */
596
+ 'version': string;
597
+ /**
598
+ *
599
+ * @type {ReleaseType}
600
+ * @memberof ShortReleaseResponse
601
+ */
602
+ 'type': ReleaseType;
603
+ /**
604
+ *
605
+ * @type {string}
606
+ * @memberof ShortReleaseResponse
607
+ */
608
+ 'maintainer_id'?: string | null;
609
+ /**
610
+ *
611
+ * @type {boolean}
612
+ * @memberof ShortReleaseResponse
613
+ */
614
+ 'archived': boolean;
615
+ }
616
+ /**
617
+ *
618
+ * @export
619
+ * @interface ValidationError
620
+ */
621
+ export interface ValidationError {
622
+ /**
623
+ *
624
+ * @type {Array<ValidationErrorLocInner>}
625
+ * @memberof ValidationError
626
+ */
627
+ 'loc': Array<ValidationErrorLocInner>;
628
+ /**
629
+ *
630
+ * @type {string}
631
+ * @memberof ValidationError
632
+ */
633
+ 'msg': string;
634
+ /**
635
+ *
636
+ * @type {string}
637
+ * @memberof ValidationError
638
+ */
639
+ 'type': string;
640
+ }
641
+ /**
642
+ *
643
+ * @export
644
+ * @interface ValidationErrorLocInner
645
+ */
646
+ export interface ValidationErrorLocInner {
647
+ }
648
+ /**
649
+ * DeviceApi - axios parameter creator
650
+ * @export
651
+ */
652
+ export declare const DeviceApiAxiosParamCreator: (configuration?: Configuration) => {
653
+ /**
654
+ * Gets device info using device ID.
655
+ * @summary Get Device
656
+ * @param {string} deviceId
657
+ * @param {*} [options] Override http request option.
658
+ * @throws {RequiredError}
659
+ */
660
+ getDeviceDevicesDeviceIdGet: (deviceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
661
+ /**
662
+ * 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.
663
+ * @summary Get Device Extended
664
+ * @param { | null} [deviceId]
665
+ * @param { | null} [id] Filter by Device ID (deprecated)
666
+ * @param {string | null} [codename] Not recommended to use when you can
667
+ * @param {*} [options] Override http request option.
668
+ * @throws {RequiredError}
669
+ */
670
+ getDeviceExtendedDevicesGetGet: (deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
671
+ /**
672
+ * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
673
+ * @summary Get Devices List
674
+ * @param {Array<any>} [id] Filter by Device IDs
675
+ * @param {Array<any>} [id2] Filter by Device IDs (deprecated)
676
+ * @param {Array<string>} [oemName] Filter by OEM names
677
+ * @param {Array<string>} [codename] Filter by device codenames
678
+ * @param {Array<string>} [modelName] Filter by model names
679
+ * @param {boolean | null} [supported] Supported status
680
+ * @param {Array<string>} [maintainer] Filter by maintainer ID
681
+ * @param {boolean | null} [freezed] Filter by Freezed status
682
+ * @param {boolean | null} [hasReleases] Filter by has releases status
683
+ * @param {number | null} [skip] Skip query results
684
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
685
+ * @param {*} [options] Override http request option.
686
+ * @throws {RequiredError}
687
+ */
688
+ getDevicesListDevicesGet: (id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
689
+ /**
690
+ * Lists all OEM names
691
+ * @summary Get Oems List
692
+ * @param {*} [options] Override http request option.
693
+ * @throws {RequiredError}
694
+ */
695
+ getOemsListOemsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
696
+ };
697
+ /**
698
+ * DeviceApi - functional programming interface
699
+ * @export
700
+ */
701
+ export declare const DeviceApiFp: (configuration?: Configuration) => {
702
+ /**
703
+ * Gets device info using device ID.
704
+ * @summary Get Device
705
+ * @param {string} deviceId
706
+ * @param {*} [options] Override http request option.
707
+ * @throws {RequiredError}
708
+ */
709
+ getDeviceDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>>;
710
+ /**
711
+ * 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.
712
+ * @summary Get Device Extended
713
+ * @param { | null} [deviceId]
714
+ * @param { | null} [id] Filter by Device ID (deprecated)
715
+ * @param {string | null} [codename] Not recommended to use when you can
716
+ * @param {*} [options] Override http request option.
717
+ * @throws {RequiredError}
718
+ */
719
+ getDeviceExtendedDevicesGetGet(deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>>;
720
+ /**
721
+ * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
722
+ * @summary Get Devices List
723
+ * @param {Array<any>} [id] Filter by Device IDs
724
+ * @param {Array<any>} [id2] Filter by Device IDs (deprecated)
725
+ * @param {Array<string>} [oemName] Filter by OEM names
726
+ * @param {Array<string>} [codename] Filter by device codenames
727
+ * @param {Array<string>} [modelName] Filter by model names
728
+ * @param {boolean | null} [supported] Supported status
729
+ * @param {Array<string>} [maintainer] Filter by maintainer ID
730
+ * @param {boolean | null} [freezed] Filter by Freezed status
731
+ * @param {boolean | null} [hasReleases] Filter by has releases status
732
+ * @param {number | null} [skip] Skip query results
733
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
734
+ * @param {*} [options] Override http request option.
735
+ * @throws {RequiredError}
736
+ */
737
+ getDevicesListDevicesGet(id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseShortDeviceResponse>>;
738
+ /**
739
+ * Lists all OEM names
740
+ * @summary Get Oems List
741
+ * @param {*} [options] Override http request option.
742
+ * @throws {RequiredError}
743
+ */
744
+ getOemsListOemsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseStr>>;
745
+ };
746
+ /**
747
+ * DeviceApi - factory interface
748
+ * @export
749
+ */
750
+ export declare const DeviceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
751
+ /**
752
+ * Gets device info using device ID.
753
+ * @summary Get Device
754
+ * @param {string} deviceId
755
+ * @param {*} [options] Override http request option.
756
+ * @throws {RequiredError}
757
+ */
758
+ getDeviceDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
759
+ /**
760
+ * 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.
761
+ * @summary Get Device Extended
762
+ * @param { | null} [deviceId]
763
+ * @param { | null} [id] Filter by Device ID (deprecated)
764
+ * @param {string | null} [codename] Not recommended to use when you can
765
+ * @param {*} [options] Override http request option.
766
+ * @throws {RequiredError}
767
+ */
768
+ getDeviceExtendedDevicesGetGet(deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
769
+ /**
770
+ * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
771
+ * @summary Get Devices List
772
+ * @param {Array<any>} [id] Filter by Device IDs
773
+ * @param {Array<any>} [id2] Filter by Device IDs (deprecated)
774
+ * @param {Array<string>} [oemName] Filter by OEM names
775
+ * @param {Array<string>} [codename] Filter by device codenames
776
+ * @param {Array<string>} [modelName] Filter by model names
777
+ * @param {boolean | null} [supported] Supported status
778
+ * @param {Array<string>} [maintainer] Filter by maintainer ID
779
+ * @param {boolean | null} [freezed] Filter by Freezed status
780
+ * @param {boolean | null} [hasReleases] Filter by has releases status
781
+ * @param {number | null} [skip] Skip query results
782
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
783
+ * @param {*} [options] Override http request option.
784
+ * @throws {RequiredError}
785
+ */
786
+ getDevicesListDevicesGet(id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortDeviceResponse>;
787
+ /**
788
+ * Lists all OEM names
789
+ * @summary Get Oems List
790
+ * @param {*} [options] Override http request option.
791
+ * @throws {RequiredError}
792
+ */
793
+ getOemsListOemsGet(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseStr>;
794
+ };
795
+ /**
796
+ * DeviceApi - interface
797
+ * @export
798
+ * @interface DeviceApi
799
+ */
800
+ export interface DeviceApiInterface {
801
+ /**
802
+ * Gets device info using device ID.
803
+ * @summary Get Device
804
+ * @param {string} deviceId
805
+ * @param {*} [options] Override http request option.
806
+ * @throws {RequiredError}
807
+ * @memberof DeviceApiInterface
808
+ */
809
+ getDeviceDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
810
+ /**
811
+ * 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.
812
+ * @summary Get Device Extended
813
+ * @param { | null} [deviceId]
814
+ * @param { | null} [id] Filter by Device ID (deprecated)
815
+ * @param {string | null} [codename] Not recommended to use when you can
816
+ * @param {*} [options] Override http request option.
817
+ * @throws {RequiredError}
818
+ * @memberof DeviceApiInterface
819
+ */
820
+ getDeviceExtendedDevicesGetGet(deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
821
+ /**
822
+ * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
823
+ * @summary Get Devices List
824
+ * @param {Array<any>} [id] Filter by Device IDs
825
+ * @param {Array<any>} [id2] Filter by Device IDs (deprecated)
826
+ * @param {Array<string>} [oemName] Filter by OEM names
827
+ * @param {Array<string>} [codename] Filter by device codenames
828
+ * @param {Array<string>} [modelName] Filter by model names
829
+ * @param {boolean | null} [supported] Supported status
830
+ * @param {Array<string>} [maintainer] Filter by maintainer ID
831
+ * @param {boolean | null} [freezed] Filter by Freezed status
832
+ * @param {boolean | null} [hasReleases] Filter by has releases status
833
+ * @param {number | null} [skip] Skip query results
834
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
835
+ * @param {*} [options] Override http request option.
836
+ * @throws {RequiredError}
837
+ * @memberof DeviceApiInterface
838
+ */
839
+ getDevicesListDevicesGet(id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortDeviceResponse>;
840
+ /**
841
+ * Lists all OEM names
842
+ * @summary Get Oems List
843
+ * @param {*} [options] Override http request option.
844
+ * @throws {RequiredError}
845
+ * @memberof DeviceApiInterface
846
+ */
847
+ getOemsListOemsGet(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseStr>;
848
+ }
849
+ /**
850
+ * DeviceApi - object-oriented interface
851
+ * @export
852
+ * @class DeviceApi
853
+ * @extends {BaseAPI}
854
+ */
855
+ export declare class DeviceApi extends BaseAPI implements DeviceApiInterface {
856
+ /**
857
+ * Gets device info using device ID.
858
+ * @summary Get Device
859
+ * @param {string} deviceId
860
+ * @param {*} [options] Override http request option.
861
+ * @throws {RequiredError}
862
+ * @memberof DeviceApi
863
+ */
864
+ getDeviceDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceResponse, any>>;
865
+ /**
866
+ * 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.
867
+ * @summary Get Device Extended
868
+ * @param { | null} [deviceId]
869
+ * @param { | null} [id] Filter by Device ID (deprecated)
870
+ * @param {string | null} [codename] Not recommended to use when you can
871
+ * @param {*} [options] Override http request option.
872
+ * @throws {RequiredError}
873
+ * @memberof DeviceApi
874
+ */
875
+ getDeviceExtendedDevicesGetGet(deviceId?: null, id?: null, codename?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceResponse, any>>;
876
+ /**
877
+ * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
878
+ * @summary Get Devices List
879
+ * @param {Array<any>} [id] Filter by Device IDs
880
+ * @param {Array<any>} [id2] Filter by Device IDs (deprecated)
881
+ * @param {Array<string>} [oemName] Filter by OEM names
882
+ * @param {Array<string>} [codename] Filter by device codenames
883
+ * @param {Array<string>} [modelName] Filter by model names
884
+ * @param {boolean | null} [supported] Supported status
885
+ * @param {Array<string>} [maintainer] Filter by maintainer ID
886
+ * @param {boolean | null} [freezed] Filter by Freezed status
887
+ * @param {boolean | null} [hasReleases] Filter by has releases status
888
+ * @param {number | null} [skip] Skip query results
889
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
890
+ * @param {*} [options] Override http request option.
891
+ * @throws {RequiredError}
892
+ * @memberof DeviceApi
893
+ */
894
+ getDevicesListDevicesGet(id?: Array<any>, id2?: Array<any>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseShortDeviceResponse, any>>;
895
+ /**
896
+ * Lists all OEM names
897
+ * @summary Get Oems List
898
+ * @param {*} [options] Override http request option.
899
+ * @throws {RequiredError}
900
+ * @memberof DeviceApi
901
+ */
902
+ getOemsListOemsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseStr, any>>;
903
+ }
904
+ /**
905
+ * ReleaseApi - axios parameter creator
906
+ * @export
907
+ */
908
+ export declare const ReleaseApiAxiosParamCreator: (configuration?: Configuration) => {
909
+ /**
910
+ * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
911
+ * @summary Get Release Extended
912
+ * @param { | null} [releaseId] Release ID
913
+ * @param { | null} [id] Release ID (deprecated)
914
+ * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
915
+ * @param {string | null} [filename]
916
+ * @param {*} [options] Override http request option.
917
+ * @throws {RequiredError}
918
+ */
919
+ getReleaseExtendedReleasesGetGet: (releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
920
+ /**
921
+ * Gets release information using the release ID, nothing to discuss really.
922
+ * @summary Get Release
923
+ * @param {any} releaseId
924
+ * @param {*} [options] Override http request option.
925
+ * @throws {RequiredError}
926
+ */
927
+ getReleaseReleasesReleaseIdGet: (releaseId: any, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
928
+ /**
929
+ * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
930
+ * @summary Get Releases
931
+ * @param {Array<any>} [id] Filter by Release IDs
932
+ * @param {Array<any>} [id2] Filter by Release IDs (deprecated)
933
+ * @param {Array<string>} [buildId] Filter by Build IDs
934
+ * @param {Array<any>} [deviceId] Filter by Device IDs
935
+ * @param {Array<any>} [maintainerId] Filter by Maintainer IDs
936
+ * @param {Array<string>} [codename] Filter by device codenames
937
+ * @param {Array<string>} [version] Filter by release version
938
+ * @param {Array<ReleaseType>} [type] Filter by release type
939
+ * @param {boolean | null} [archived] Filter by the archived status
940
+ * @param {boolean | null} [freezed] Filter by the freezed status
941
+ * @param { | null} [afterReleaseId] Show releases after the provided one
942
+ * @param {number | null} [afterDate] Show releases after the provided timestamp
943
+ * @param {ReleasesSort} [sort] Sort mode
944
+ * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
945
+ * @param {number | null} [skip] Skip query results
946
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
947
+ * @param {*} [options] Override http request option.
948
+ * @throws {RequiredError}
949
+ */
950
+ getReleasesReleasesGet: (id?: Array<any>, id2?: Array<any>, buildId?: Array<string>, deviceId?: Array<any>, maintainerId?: Array<any>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
951
+ /**
952
+ * 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!
953
+ * @summary Get Updates
954
+ * @param {any} lastKnownId
955
+ * @param {Array<any>} [deviceId] Filter by device ID
956
+ * @param {Array<ReleaseType>} [type] Filter by release type
957
+ * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
958
+ * @param {number | null} [skip] Skip query results
959
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
960
+ * @param {*} [options] Override http request option.
961
+ * @deprecated
962
+ * @throws {RequiredError}
963
+ */
964
+ getUpdatesUpdatesLastKnownIdGet: (lastKnownId: any, deviceId?: Array<any>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
965
+ };
966
+ /**
967
+ * ReleaseApi - functional programming interface
968
+ * @export
969
+ */
970
+ export declare const ReleaseApiFp: (configuration?: Configuration) => {
971
+ /**
972
+ * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
973
+ * @summary Get Release Extended
974
+ * @param { | null} [releaseId] Release ID
975
+ * @param { | null} [id] Release ID (deprecated)
976
+ * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
977
+ * @param {string | null} [filename]
978
+ * @param {*} [options] Override http request option.
979
+ * @throws {RequiredError}
980
+ */
981
+ getReleaseExtendedReleasesGetGet(releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>>;
982
+ /**
983
+ * Gets release information using the release ID, nothing to discuss really.
984
+ * @summary Get Release
985
+ * @param {any} releaseId
986
+ * @param {*} [options] Override http request option.
987
+ * @throws {RequiredError}
988
+ */
989
+ getReleaseReleasesReleaseIdGet(releaseId: any, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>>;
990
+ /**
991
+ * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
992
+ * @summary Get Releases
993
+ * @param {Array<any>} [id] Filter by Release IDs
994
+ * @param {Array<any>} [id2] Filter by Release IDs (deprecated)
995
+ * @param {Array<string>} [buildId] Filter by Build IDs
996
+ * @param {Array<any>} [deviceId] Filter by Device IDs
997
+ * @param {Array<any>} [maintainerId] Filter by Maintainer IDs
998
+ * @param {Array<string>} [codename] Filter by device codenames
999
+ * @param {Array<string>} [version] Filter by release version
1000
+ * @param {Array<ReleaseType>} [type] Filter by release type
1001
+ * @param {boolean | null} [archived] Filter by the archived status
1002
+ * @param {boolean | null} [freezed] Filter by the freezed status
1003
+ * @param { | null} [afterReleaseId] Show releases after the provided one
1004
+ * @param {number | null} [afterDate] Show releases after the provided timestamp
1005
+ * @param {ReleasesSort} [sort] Sort mode
1006
+ * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
1007
+ * @param {number | null} [skip] Skip query results
1008
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
1009
+ * @param {*} [options] Override http request option.
1010
+ * @throws {RequiredError}
1011
+ */
1012
+ getReleasesReleasesGet(id?: Array<any>, id2?: Array<any>, buildId?: Array<string>, deviceId?: Array<any>, maintainerId?: Array<any>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseGetReleasesReleasesGet>>;
1013
+ /**
1014
+ * 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!
1015
+ * @summary Get Updates
1016
+ * @param {any} lastKnownId
1017
+ * @param {Array<any>} [deviceId] Filter by device ID
1018
+ * @param {Array<ReleaseType>} [type] Filter by release type
1019
+ * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
1020
+ * @param {number | null} [skip] Skip query results
1021
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
1022
+ * @param {*} [options] Override http request option.
1023
+ * @deprecated
1024
+ * @throws {RequiredError}
1025
+ */
1026
+ getUpdatesUpdatesLastKnownIdGet(lastKnownId: any, deviceId?: Array<any>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseShortReleaseResponse>>;
1027
+ };
1028
+ /**
1029
+ * ReleaseApi - factory interface
1030
+ * @export
1031
+ */
1032
+ export declare const ReleaseApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1033
+ /**
1034
+ * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
1035
+ * @summary Get Release Extended
1036
+ * @param { | null} [releaseId] Release ID
1037
+ * @param { | null} [id] Release ID (deprecated)
1038
+ * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
1039
+ * @param {string | null} [filename]
1040
+ * @param {*} [options] Override http request option.
1041
+ * @throws {RequiredError}
1042
+ */
1043
+ getReleaseExtendedReleasesGetGet(releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
1044
+ /**
1045
+ * Gets release information using the release ID, nothing to discuss really.
1046
+ * @summary Get Release
1047
+ * @param {any} releaseId
1048
+ * @param {*} [options] Override http request option.
1049
+ * @throws {RequiredError}
1050
+ */
1051
+ getReleaseReleasesReleaseIdGet(releaseId: any, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
1052
+ /**
1053
+ * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
1054
+ * @summary Get Releases
1055
+ * @param {Array<any>} [id] Filter by Release IDs
1056
+ * @param {Array<any>} [id2] Filter by Release IDs (deprecated)
1057
+ * @param {Array<string>} [buildId] Filter by Build IDs
1058
+ * @param {Array<any>} [deviceId] Filter by Device IDs
1059
+ * @param {Array<any>} [maintainerId] Filter by Maintainer IDs
1060
+ * @param {Array<string>} [codename] Filter by device codenames
1061
+ * @param {Array<string>} [version] Filter by release version
1062
+ * @param {Array<ReleaseType>} [type] Filter by release type
1063
+ * @param {boolean | null} [archived] Filter by the archived status
1064
+ * @param {boolean | null} [freezed] Filter by the freezed status
1065
+ * @param { | null} [afterReleaseId] Show releases after the provided one
1066
+ * @param {number | null} [afterDate] Show releases after the provided timestamp
1067
+ * @param {ReleasesSort} [sort] Sort mode
1068
+ * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
1069
+ * @param {number | null} [skip] Skip query results
1070
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
1071
+ * @param {*} [options] Override http request option.
1072
+ * @throws {RequiredError}
1073
+ */
1074
+ getReleasesReleasesGet(id?: Array<any>, id2?: Array<any>, buildId?: Array<string>, deviceId?: Array<any>, maintainerId?: Array<any>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ResponseGetReleasesReleasesGet>;
1075
+ /**
1076
+ * 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!
1077
+ * @summary Get Updates
1078
+ * @param {any} lastKnownId
1079
+ * @param {Array<any>} [deviceId] Filter by device ID
1080
+ * @param {Array<ReleaseType>} [type] Filter by release type
1081
+ * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
1082
+ * @param {number | null} [skip] Skip query results
1083
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
1084
+ * @param {*} [options] Override http request option.
1085
+ * @deprecated
1086
+ * @throws {RequiredError}
1087
+ */
1088
+ getUpdatesUpdatesLastKnownIdGet(lastKnownId: any, deviceId?: Array<any>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse>;
1089
+ };
1090
+ /**
1091
+ * ReleaseApi - interface
1092
+ * @export
1093
+ * @interface ReleaseApi
1094
+ */
1095
+ export interface ReleaseApiInterface {
1096
+ /**
1097
+ * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
1098
+ * @summary Get Release Extended
1099
+ * @param { | null} [releaseId] Release ID
1100
+ * @param { | null} [id] Release ID (deprecated)
1101
+ * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
1102
+ * @param {string | null} [filename]
1103
+ * @param {*} [options] Override http request option.
1104
+ * @throws {RequiredError}
1105
+ * @memberof ReleaseApiInterface
1106
+ */
1107
+ getReleaseExtendedReleasesGetGet(releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
1108
+ /**
1109
+ * Gets release information using the release ID, nothing to discuss really.
1110
+ * @summary Get Release
1111
+ * @param {any} releaseId
1112
+ * @param {*} [options] Override http request option.
1113
+ * @throws {RequiredError}
1114
+ * @memberof ReleaseApiInterface
1115
+ */
1116
+ getReleaseReleasesReleaseIdGet(releaseId: any, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
1117
+ /**
1118
+ * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
1119
+ * @summary Get Releases
1120
+ * @param {Array<any>} [id] Filter by Release IDs
1121
+ * @param {Array<any>} [id2] Filter by Release IDs (deprecated)
1122
+ * @param {Array<string>} [buildId] Filter by Build IDs
1123
+ * @param {Array<any>} [deviceId] Filter by Device IDs
1124
+ * @param {Array<any>} [maintainerId] Filter by Maintainer IDs
1125
+ * @param {Array<string>} [codename] Filter by device codenames
1126
+ * @param {Array<string>} [version] Filter by release version
1127
+ * @param {Array<ReleaseType>} [type] Filter by release type
1128
+ * @param {boolean | null} [archived] Filter by the archived status
1129
+ * @param {boolean | null} [freezed] Filter by the freezed status
1130
+ * @param { | null} [afterReleaseId] Show releases after the provided one
1131
+ * @param {number | null} [afterDate] Show releases after the provided timestamp
1132
+ * @param {ReleasesSort} [sort] Sort mode
1133
+ * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
1134
+ * @param {number | null} [skip] Skip query results
1135
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
1136
+ * @param {*} [options] Override http request option.
1137
+ * @throws {RequiredError}
1138
+ * @memberof ReleaseApiInterface
1139
+ */
1140
+ getReleasesReleasesGet(id?: Array<any>, id2?: Array<any>, buildId?: Array<string>, deviceId?: Array<any>, maintainerId?: Array<any>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ResponseGetReleasesReleasesGet>;
1141
+ /**
1142
+ * 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!
1143
+ * @summary Get Updates
1144
+ * @param {any} lastKnownId
1145
+ * @param {Array<any>} [deviceId] Filter by device ID
1146
+ * @param {Array<ReleaseType>} [type] Filter by release type
1147
+ * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
1148
+ * @param {number | null} [skip] Skip query results
1149
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
1150
+ * @param {*} [options] Override http request option.
1151
+ * @deprecated
1152
+ * @throws {RequiredError}
1153
+ * @memberof ReleaseApiInterface
1154
+ */
1155
+ getUpdatesUpdatesLastKnownIdGet(lastKnownId: any, deviceId?: Array<any>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse>;
1156
+ }
1157
+ /**
1158
+ * ReleaseApi - object-oriented interface
1159
+ * @export
1160
+ * @class ReleaseApi
1161
+ * @extends {BaseAPI}
1162
+ */
1163
+ export declare class ReleaseApi extends BaseAPI implements ReleaseApiInterface {
1164
+ /**
1165
+ * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
1166
+ * @summary Get Release Extended
1167
+ * @param { | null} [releaseId] Release ID
1168
+ * @param { | null} [id] Release ID (deprecated)
1169
+ * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
1170
+ * @param {string | null} [filename]
1171
+ * @param {*} [options] Override http request option.
1172
+ * @throws {RequiredError}
1173
+ * @memberof ReleaseApi
1174
+ */
1175
+ getReleaseExtendedReleasesGetGet(releaseId?: null, id?: null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleaseResponse, any>>;
1176
+ /**
1177
+ * Gets release information using the release ID, nothing to discuss really.
1178
+ * @summary Get Release
1179
+ * @param {any} releaseId
1180
+ * @param {*} [options] Override http request option.
1181
+ * @throws {RequiredError}
1182
+ * @memberof ReleaseApi
1183
+ */
1184
+ getReleaseReleasesReleaseIdGet(releaseId: any, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleaseResponse, any>>;
1185
+ /**
1186
+ * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
1187
+ * @summary Get Releases
1188
+ * @param {Array<any>} [id] Filter by Release IDs
1189
+ * @param {Array<any>} [id2] Filter by Release IDs (deprecated)
1190
+ * @param {Array<string>} [buildId] Filter by Build IDs
1191
+ * @param {Array<any>} [deviceId] Filter by Device IDs
1192
+ * @param {Array<any>} [maintainerId] Filter by Maintainer IDs
1193
+ * @param {Array<string>} [codename] Filter by device codenames
1194
+ * @param {Array<string>} [version] Filter by release version
1195
+ * @param {Array<ReleaseType>} [type] Filter by release type
1196
+ * @param {boolean | null} [archived] Filter by the archived status
1197
+ * @param {boolean | null} [freezed] Filter by the freezed status
1198
+ * @param { | null} [afterReleaseId] Show releases after the provided one
1199
+ * @param {number | null} [afterDate] Show releases after the provided timestamp
1200
+ * @param {ReleasesSort} [sort] Sort mode
1201
+ * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
1202
+ * @param {number | null} [skip] Skip query results
1203
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
1204
+ * @param {*} [options] Override http request option.
1205
+ * @throws {RequiredError}
1206
+ * @memberof ReleaseApi
1207
+ */
1208
+ getReleasesReleasesGet(id?: Array<any>, id2?: Array<any>, buildId?: Array<string>, deviceId?: Array<any>, maintainerId?: Array<any>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResponseGetReleasesReleasesGet, any>>;
1209
+ /**
1210
+ * 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!
1211
+ * @summary Get Updates
1212
+ * @param {any} lastKnownId
1213
+ * @param {Array<any>} [deviceId] Filter by device ID
1214
+ * @param {Array<ReleaseType>} [type] Filter by release type
1215
+ * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
1216
+ * @param {number | null} [skip] Skip query results
1217
+ * @param {number | null} [limit] Limit query results (0 means unlimited)
1218
+ * @param {*} [options] Override http request option.
1219
+ * @deprecated
1220
+ * @throws {RequiredError}
1221
+ * @memberof ReleaseApi
1222
+ */
1223
+ getUpdatesUpdatesLastKnownIdGet(lastKnownId: any, deviceId?: Array<any>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseShortReleaseResponse, any>>;
1224
+ }
1225
+ /**
1226
+ * StatsApi - axios parameter creator
1227
+ * @export
1228
+ */
1229
+ export declare const StatsApiAxiosParamCreator: (configuration?: Configuration) => {
1230
+ /**
1231
+ * Returns the global OrangeFox downloads statistics. This request causes an increased load to the database, as it needs to aggregate all the release stats data, therefore, it is limited to a small number of requests per minute for public usage.
1232
+ * @summary Public Stats
1233
+ * @param {*} [options] Override http request option.
1234
+ * @throws {RequiredError}
1235
+ */
1236
+ publicStatsStatsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1237
+ };
1238
+ /**
1239
+ * StatsApi - functional programming interface
1240
+ * @export
1241
+ */
1242
+ export declare const StatsApiFp: (configuration?: Configuration) => {
1243
+ /**
1244
+ * Returns the global OrangeFox downloads statistics. This request causes an increased load to the database, as it needs to aggregate all the release stats data, therefore, it is limited to a small number of requests per minute for public usage.
1245
+ * @summary Public Stats
1246
+ * @param {*} [options] Override http request option.
1247
+ * @throws {RequiredError}
1248
+ */
1249
+ publicStatsStatsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalStatsAggregationModel>>;
1250
+ };
1251
+ /**
1252
+ * StatsApi - factory interface
1253
+ * @export
1254
+ */
1255
+ export declare const StatsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1256
+ /**
1257
+ * Returns the global OrangeFox downloads statistics. This request causes an increased load to the database, as it needs to aggregate all the release stats data, therefore, it is limited to a small number of requests per minute for public usage.
1258
+ * @summary Public Stats
1259
+ * @param {*} [options] Override http request option.
1260
+ * @throws {RequiredError}
1261
+ */
1262
+ publicStatsStatsGet(options?: RawAxiosRequestConfig): AxiosPromise<GlobalStatsAggregationModel>;
1263
+ };
1264
+ /**
1265
+ * StatsApi - interface
1266
+ * @export
1267
+ * @interface StatsApi
1268
+ */
1269
+ export interface StatsApiInterface {
1270
+ /**
1271
+ * Returns the global OrangeFox downloads statistics. This request causes an increased load to the database, as it needs to aggregate all the release stats data, therefore, it is limited to a small number of requests per minute for public usage.
1272
+ * @summary Public Stats
1273
+ * @param {*} [options] Override http request option.
1274
+ * @throws {RequiredError}
1275
+ * @memberof StatsApiInterface
1276
+ */
1277
+ publicStatsStatsGet(options?: RawAxiosRequestConfig): AxiosPromise<GlobalStatsAggregationModel>;
1278
+ }
1279
+ /**
1280
+ * StatsApi - object-oriented interface
1281
+ * @export
1282
+ * @class StatsApi
1283
+ * @extends {BaseAPI}
1284
+ */
1285
+ export declare class StatsApi extends BaseAPI implements StatsApiInterface {
1286
+ /**
1287
+ * Returns the global OrangeFox downloads statistics. This request causes an increased load to the database, as it needs to aggregate all the release stats data, therefore, it is limited to a small number of requests per minute for public usage.
1288
+ * @summary Public Stats
1289
+ * @param {*} [options] Override http request option.
1290
+ * @throws {RequiredError}
1291
+ * @memberof StatsApi
1292
+ */
1293
+ publicStatsStatsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GlobalStatsAggregationModel, any>>;
1294
+ }