@orangefox-recovery/foxclient 5.2.5 → 5.2.7

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 (186) hide show
  1. package/.openapi-generator/FILES +28 -27
  2. package/README.md +3 -61
  3. package/dist/apis/DeviceApi.d.ts +158 -0
  4. package/dist/apis/DeviceApi.js +188 -0
  5. package/dist/apis/PasteApi.d.ts +80 -0
  6. package/dist/apis/PasteApi.js +95 -0
  7. package/dist/apis/ReleaseApi.d.ts +188 -0
  8. package/dist/apis/ReleaseApi.js +226 -0
  9. package/dist/apis/StatsApi.d.ts +49 -0
  10. package/dist/apis/StatsApi.js +60 -0
  11. package/dist/apis/index.d.ts +4 -0
  12. package/dist/apis/index.js +22 -0
  13. package/dist/esm/apis/DeviceApi.d.ts +158 -0
  14. package/dist/esm/apis/DeviceApi.js +184 -0
  15. package/dist/esm/apis/PasteApi.d.ts +80 -0
  16. package/dist/esm/apis/PasteApi.js +91 -0
  17. package/dist/esm/apis/ReleaseApi.d.ts +188 -0
  18. package/dist/esm/apis/ReleaseApi.js +222 -0
  19. package/dist/esm/apis/StatsApi.d.ts +49 -0
  20. package/dist/esm/apis/StatsApi.js +56 -0
  21. package/dist/esm/apis/index.d.ts +4 -0
  22. package/dist/esm/apis/index.js +6 -0
  23. package/dist/esm/index.d.ts +3 -13
  24. package/dist/esm/index.js +3 -13
  25. package/dist/esm/models/DeviceResponse.d.ts +101 -0
  26. package/dist/esm/models/DeviceResponse.js +82 -0
  27. package/dist/esm/models/GlobalStatsAggregationModel.d.ts +52 -0
  28. package/dist/esm/models/GlobalStatsAggregationModel.js +55 -0
  29. package/dist/esm/models/HTTPValidationError.d.ts +33 -0
  30. package/dist/esm/models/HTTPValidationError.js +42 -0
  31. package/dist/esm/models/ListResponseReleaseResponse.d.ts +39 -0
  32. package/dist/esm/models/ListResponseReleaseResponse.js +47 -0
  33. package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +39 -0
  34. package/dist/esm/models/ListResponseShortDeviceResponse.js +47 -0
  35. package/dist/esm/models/ListResponseShortReleaseResponse.d.ts +39 -0
  36. package/dist/esm/models/ListResponseShortReleaseResponse.js +47 -0
  37. package/dist/esm/models/ListResponseStr.d.ts +38 -0
  38. package/dist/esm/models/ListResponseStr.js +46 -0
  39. package/dist/esm/models/MaintainerShortModel.d.ts +44 -0
  40. package/dist/esm/models/MaintainerShortModel.js +51 -0
  41. package/dist/esm/models/PasteInput.d.ts +50 -0
  42. package/dist/esm/models/PasteInput.js +51 -0
  43. package/dist/esm/models/PasteOutput.d.ts +50 -0
  44. package/dist/esm/models/PasteOutput.js +51 -0
  45. package/dist/esm/models/RecoveryImgResponse.d.ts +38 -0
  46. package/dist/esm/models/RecoveryImgResponse.js +47 -0
  47. package/dist/esm/models/ReleaseGroupsResponse.d.ts +35 -0
  48. package/dist/esm/models/ReleaseGroupsResponse.js +43 -0
  49. package/dist/esm/models/ReleaseResponse.d.ts +139 -0
  50. package/dist/esm/models/ReleaseResponse.js +107 -0
  51. package/dist/esm/models/ReleaseType.d.ts +26 -0
  52. package/dist/esm/models/ReleaseType.js +44 -0
  53. package/dist/esm/models/ReleasesSort.d.ts +25 -0
  54. package/dist/esm/models/ReleasesSort.js +43 -0
  55. package/dist/esm/models/ResponseGetReleases.d.ts +41 -0
  56. package/dist/esm/models/ResponseGetReleases.js +46 -0
  57. package/dist/esm/models/ShortDeviceResponse.d.ts +82 -0
  58. package/dist/esm/models/ShortDeviceResponse.js +73 -0
  59. package/dist/esm/models/ShortReleaseResponse.d.ts +100 -0
  60. package/dist/esm/models/ShortReleaseResponse.js +84 -0
  61. package/dist/esm/models/ValidationError.d.ts +45 -0
  62. package/dist/esm/models/ValidationError.js +52 -0
  63. package/dist/esm/models/ValidationErrorLocInner.d.ts +26 -0
  64. package/{index.ts → dist/esm/models/ValidationErrorLocInner.js} +20 -7
  65. package/dist/esm/models/index.d.ts +20 -0
  66. package/dist/esm/models/index.js +22 -0
  67. package/dist/esm/runtime.d.ts +184 -0
  68. package/dist/esm/runtime.js +334 -0
  69. package/dist/index.d.ts +3 -13
  70. package/dist/index.js +5 -15
  71. package/dist/models/DeviceResponse.d.ts +101 -0
  72. package/dist/models/DeviceResponse.js +89 -0
  73. package/dist/models/GlobalStatsAggregationModel.d.ts +52 -0
  74. package/dist/models/GlobalStatsAggregationModel.js +62 -0
  75. package/dist/models/HTTPValidationError.d.ts +33 -0
  76. package/dist/models/HTTPValidationError.js +49 -0
  77. package/dist/models/ListResponseReleaseResponse.d.ts +39 -0
  78. package/dist/models/ListResponseReleaseResponse.js +54 -0
  79. package/dist/models/ListResponseShortDeviceResponse.d.ts +39 -0
  80. package/dist/models/ListResponseShortDeviceResponse.js +54 -0
  81. package/dist/models/ListResponseShortReleaseResponse.d.ts +39 -0
  82. package/dist/models/ListResponseShortReleaseResponse.js +54 -0
  83. package/dist/models/ListResponseStr.d.ts +38 -0
  84. package/dist/models/ListResponseStr.js +53 -0
  85. package/dist/models/MaintainerShortModel.d.ts +44 -0
  86. package/dist/models/MaintainerShortModel.js +58 -0
  87. package/dist/models/PasteInput.d.ts +50 -0
  88. package/dist/models/PasteInput.js +58 -0
  89. package/dist/models/PasteOutput.d.ts +50 -0
  90. package/dist/models/PasteOutput.js +58 -0
  91. package/dist/models/RecoveryImgResponse.d.ts +38 -0
  92. package/dist/models/RecoveryImgResponse.js +54 -0
  93. package/dist/models/ReleaseGroupsResponse.d.ts +35 -0
  94. package/dist/models/ReleaseGroupsResponse.js +50 -0
  95. package/dist/models/ReleaseResponse.d.ts +139 -0
  96. package/dist/models/ReleaseResponse.js +114 -0
  97. package/dist/models/ReleaseType.d.ts +26 -0
  98. package/dist/models/ReleaseType.js +52 -0
  99. package/dist/models/ReleasesSort.d.ts +25 -0
  100. package/dist/models/ReleasesSort.js +51 -0
  101. package/dist/models/ResponseGetReleases.d.ts +41 -0
  102. package/dist/models/ResponseGetReleases.js +53 -0
  103. package/dist/models/ShortDeviceResponse.d.ts +82 -0
  104. package/dist/models/ShortDeviceResponse.js +80 -0
  105. package/dist/models/ShortReleaseResponse.d.ts +100 -0
  106. package/dist/models/ShortReleaseResponse.js +91 -0
  107. package/dist/models/ValidationError.d.ts +45 -0
  108. package/dist/models/ValidationError.js +59 -0
  109. package/dist/models/ValidationErrorLocInner.d.ts +26 -0
  110. package/dist/models/ValidationErrorLocInner.js +38 -0
  111. package/dist/models/index.d.ts +20 -0
  112. package/dist/models/index.js +38 -0
  113. package/dist/runtime.d.ts +184 -0
  114. package/dist/runtime.js +350 -0
  115. package/package.json +4 -17
  116. package/src/apis/DeviceApi.ts +326 -0
  117. package/src/apis/PasteApi.ts +158 -0
  118. package/src/apis/ReleaseApi.ts +414 -0
  119. package/src/apis/StatsApi.ts +82 -0
  120. package/src/apis/index.ts +6 -0
  121. package/src/index.ts +5 -0
  122. package/src/models/DeviceResponse.ts +171 -0
  123. package/src/models/GlobalStatsAggregationModel.ts +93 -0
  124. package/src/models/HTTPValidationError.ts +73 -0
  125. package/src/models/ListResponseReleaseResponse.ts +82 -0
  126. package/src/models/ListResponseShortDeviceResponse.ts +82 -0
  127. package/src/models/ListResponseShortReleaseResponse.ts +82 -0
  128. package/src/models/ListResponseStr.ts +74 -0
  129. package/src/models/MaintainerShortModel.ts +84 -0
  130. package/src/models/PasteInput.ts +91 -0
  131. package/src/models/PasteOutput.ts +91 -0
  132. package/src/models/RecoveryImgResponse.ts +75 -0
  133. package/src/models/ReleaseGroupsResponse.ts +74 -0
  134. package/src/models/ReleaseResponse.ts +233 -0
  135. package/src/models/ReleaseType.ts +54 -0
  136. package/src/models/ReleasesSort.ts +53 -0
  137. package/src/models/ResponseGetReleases.ts +96 -0
  138. package/src/models/ShortDeviceResponse.ts +138 -0
  139. package/src/models/ShortReleaseResponse.ts +174 -0
  140. package/src/models/ValidationError.ts +92 -0
  141. package/src/models/ValidationErrorLocInner.ts +46 -0
  142. package/src/models/index.ts +22 -0
  143. package/src/runtime.ts +432 -0
  144. package/tsconfig.json +2 -4
  145. package/api.ts +0 -1832
  146. package/base.ts +0 -86
  147. package/common.ts +0 -150
  148. package/configuration.ts +0 -115
  149. package/dist/api.d.ts +0 -1304
  150. package/dist/api.js +0 -1001
  151. package/dist/base.d.ts +0 -66
  152. package/dist/base.js +0 -65
  153. package/dist/common.d.ts +0 -65
  154. package/dist/common.js +0 -161
  155. package/dist/configuration.d.ts +0 -91
  156. package/dist/configuration.js +0 -44
  157. package/dist/esm/api.d.ts +0 -1304
  158. package/dist/esm/api.js +0 -986
  159. package/dist/esm/base.d.ts +0 -66
  160. package/dist/esm/base.js +0 -60
  161. package/dist/esm/common.d.ts +0 -65
  162. package/dist/esm/common.js +0 -149
  163. package/dist/esm/configuration.d.ts +0 -91
  164. package/dist/esm/configuration.js +0 -40
  165. package/docs/DeviceApi.md +0 -251
  166. package/docs/DeviceResponse.md +0 -44
  167. package/docs/GlobalStatsAggregationModel.md +0 -26
  168. package/docs/HTTPValidationError.md +0 -20
  169. package/docs/ListResponseReleaseResponse.md +0 -22
  170. package/docs/ListResponseShortDeviceResponse.md +0 -22
  171. package/docs/ListResponseShortReleaseResponse.md +0 -22
  172. package/docs/ListResponseStr.md +0 -22
  173. package/docs/MaintainerShortModel.md +0 -26
  174. package/docs/RecoveryImgResponse.md +0 -22
  175. package/docs/ReleaseApi.md +0 -289
  176. package/docs/ReleaseGroupsResponse.md +0 -20
  177. package/docs/ReleaseResponse.md +0 -56
  178. package/docs/ReleaseType.md +0 -12
  179. package/docs/ReleasesSort.md +0 -10
  180. package/docs/ResponseGetReleases.md +0 -22
  181. package/docs/ShortDeviceResponse.md +0 -38
  182. package/docs/ShortReleaseResponse.md +0 -44
  183. package/docs/StatsApi.md +0 -53
  184. package/docs/ValidationError.md +0 -24
  185. package/docs/ValidationErrorLocInner.md +0 -18
  186. package/git_push.sh +0 -57
package/api.ts DELETED
@@ -1,1832 +0,0 @@
1
- /* tslint:disable */
2
- /* eslint-disable */
3
- /**
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 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
- *
7
- * The version of the OpenAPI document: 5.2.5
8
- * Contact: admin@orangefox.tech
9
- *
10
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
- * https://openapi-generator.tech
12
- * Do not edit the class manually.
13
- */
14
-
15
-
16
- import type { Configuration } from './configuration';
17
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
- import globalAxios from 'axios';
19
- // Some imports not used depending on template conditions
20
- // @ts-ignore
21
- import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
22
- import type { RequestArgs } from './base';
23
- // @ts-ignore
24
- import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
-
26
- /**
27
- *
28
- * @export
29
- * @interface DeviceResponse
30
- */
31
- export interface DeviceResponse {
32
- /**
33
- *
34
- * @type {string}
35
- * @memberof DeviceResponse
36
- * @deprecated
37
- */
38
- '_id': string;
39
- /**
40
- * Device codename, legacy
41
- * @type {string}
42
- * @memberof DeviceResponse
43
- * @deprecated
44
- */
45
- 'codename': string;
46
- /**
47
- * Model name of device, does not include the OEM part, legacy
48
- * @type {string}
49
- * @memberof DeviceResponse
50
- * @deprecated
51
- */
52
- 'model_name': string;
53
- /**
54
- *
55
- * @type {string}
56
- * @memberof DeviceResponse
57
- */
58
- 'oem_name': string;
59
- /**
60
- *
61
- * @type {string}
62
- * @memberof DeviceResponse
63
- */
64
- 'id': string;
65
- /**
66
- *
67
- * @type {Array<string>}
68
- * @memberof DeviceResponse
69
- */
70
- 'codenames': Array<string>;
71
- /**
72
- *
73
- * @type {Array<string>}
74
- * @memberof DeviceResponse
75
- */
76
- 'model_names': Array<string>;
77
- /**
78
- *
79
- * @type {boolean}
80
- * @memberof DeviceResponse
81
- */
82
- 'supported': boolean;
83
- /**
84
- *
85
- * @type {MaintainerShortModel}
86
- * @memberof DeviceResponse
87
- */
88
- 'maintainer': MaintainerShortModel;
89
- /**
90
- *
91
- * @type {string}
92
- * @memberof DeviceResponse
93
- */
94
- 'notes'?: string | null;
95
- /**
96
- *
97
- * @type {string}
98
- * @memberof DeviceResponse
99
- */
100
- 'device_tree'?: string | null;
101
- /**
102
- * Full name of device / devices, legacy
103
- * @type {string}
104
- * @memberof DeviceResponse
105
- */
106
- 'full_name': string;
107
- /**
108
- * URL of the device on the official website
109
- * @type {string}
110
- * @memberof DeviceResponse
111
- */
112
- 'url': string;
113
- }
114
- /**
115
- *
116
- * @export
117
- * @interface GlobalStatsAggregationModel
118
- */
119
- export interface GlobalStatsAggregationModel {
120
- /**
121
- *
122
- * @type {number}
123
- * @memberof GlobalStatsAggregationModel
124
- */
125
- 'count': number;
126
- /**
127
- *
128
- * @type {number}
129
- * @memberof GlobalStatsAggregationModel
130
- */
131
- 'deviceCount': number;
132
- /**
133
- *
134
- * @type {number}
135
- * @memberof GlobalStatsAggregationModel
136
- */
137
- 'releaseCount': number;
138
- /**
139
- *
140
- * @type {{ [key: string]: number; }}
141
- * @memberof GlobalStatsAggregationModel
142
- */
143
- 'days': { [key: string]: number; };
144
- }
145
- /**
146
- *
147
- * @export
148
- * @interface HTTPValidationError
149
- */
150
- export interface HTTPValidationError {
151
- /**
152
- *
153
- * @type {Array<ValidationError>}
154
- * @memberof HTTPValidationError
155
- */
156
- 'detail'?: Array<ValidationError>;
157
- }
158
- /**
159
- *
160
- * @export
161
- * @interface ListResponseReleaseResponse
162
- */
163
- export interface ListResponseReleaseResponse {
164
- /**
165
- *
166
- * @type {Array<ReleaseResponse>}
167
- * @memberof ListResponseReleaseResponse
168
- */
169
- 'data': Array<ReleaseResponse>;
170
- /**
171
- *
172
- * @type {number}
173
- * @memberof ListResponseReleaseResponse
174
- */
175
- 'count': number;
176
- }
177
- /**
178
- *
179
- * @export
180
- * @interface ListResponseShortDeviceResponse
181
- */
182
- export interface ListResponseShortDeviceResponse {
183
- /**
184
- *
185
- * @type {Array<ShortDeviceResponse>}
186
- * @memberof ListResponseShortDeviceResponse
187
- */
188
- 'data': Array<ShortDeviceResponse>;
189
- /**
190
- *
191
- * @type {number}
192
- * @memberof ListResponseShortDeviceResponse
193
- */
194
- 'count': number;
195
- }
196
- /**
197
- *
198
- * @export
199
- * @interface ListResponseShortReleaseResponse
200
- */
201
- export interface ListResponseShortReleaseResponse {
202
- /**
203
- *
204
- * @type {Array<ShortReleaseResponse>}
205
- * @memberof ListResponseShortReleaseResponse
206
- */
207
- 'data': Array<ShortReleaseResponse>;
208
- /**
209
- *
210
- * @type {number}
211
- * @memberof ListResponseShortReleaseResponse
212
- */
213
- 'count': number;
214
- }
215
- /**
216
- *
217
- * @export
218
- * @interface ListResponseStr
219
- */
220
- export interface ListResponseStr {
221
- /**
222
- *
223
- * @type {Array<string>}
224
- * @memberof ListResponseStr
225
- */
226
- 'data': Array<string>;
227
- /**
228
- *
229
- * @type {number}
230
- * @memberof ListResponseStr
231
- */
232
- 'count': number;
233
- }
234
- /**
235
- *
236
- * @export
237
- * @interface MaintainerShortModel
238
- */
239
- export interface MaintainerShortModel {
240
- /**
241
- *
242
- * @type {string}
243
- * @memberof MaintainerShortModel
244
- * @deprecated
245
- */
246
- '_id': string;
247
- /**
248
- *
249
- * @type {string}
250
- * @memberof MaintainerShortModel
251
- */
252
- 'id': string;
253
- /**
254
- *
255
- * @type {string}
256
- * @memberof MaintainerShortModel
257
- */
258
- 'name': string;
259
- /**
260
- *
261
- * @type {string}
262
- * @memberof MaintainerShortModel
263
- */
264
- 'username': string;
265
- }
266
- /**
267
- *
268
- * @export
269
- * @interface RecoveryImgResponse
270
- */
271
- export interface RecoveryImgResponse {
272
- /**
273
- *
274
- * @type {number}
275
- * @memberof RecoveryImgResponse
276
- */
277
- 'size': number;
278
- /**
279
- *
280
- * @type {string}
281
- * @memberof RecoveryImgResponse
282
- */
283
- 'md5': string;
284
- }
285
- /**
286
- *
287
- * @export
288
- * @interface ReleaseGroupsResponse
289
- */
290
- export interface ReleaseGroupsResponse {
291
- /**
292
- *
293
- * @type {{ [key: string]: Array<ReleaseResponse>; }}
294
- * @memberof ReleaseGroupsResponse
295
- */
296
- 'data': { [key: string]: Array<ReleaseResponse>; };
297
- }
298
- /**
299
- *
300
- * @export
301
- * @interface ReleaseResponse
302
- */
303
- export interface ReleaseResponse {
304
- /**
305
- *
306
- * @type {string}
307
- * @memberof ReleaseResponse
308
- * @deprecated
309
- */
310
- '_id': string;
311
- /**
312
- *
313
- * @type {number}
314
- * @memberof ReleaseResponse
315
- * @deprecated
316
- */
317
- 'size': number;
318
- /**
319
- * Release ID, that\'s how we indentify the release in the infrastructure
320
- * @type {string}
321
- * @memberof ReleaseResponse
322
- */
323
- 'id': string;
324
- /**
325
- *
326
- * @type {string}
327
- * @memberof ReleaseResponse
328
- */
329
- 'build_id'?: string | null;
330
- /**
331
- *
332
- * @type {string}
333
- * @memberof ReleaseResponse
334
- */
335
- 'filename': string;
336
- /**
337
- *
338
- * @type {string}
339
- * @memberof ReleaseResponse
340
- */
341
- 'variant': string;
342
- /**
343
- *
344
- * @type {string}
345
- * @memberof ReleaseResponse
346
- */
347
- 'device_id': string;
348
- /**
349
- *
350
- * @type {number}
351
- * @memberof ReleaseResponse
352
- */
353
- 'date': number;
354
- /**
355
- *
356
- * @type {string}
357
- * @memberof ReleaseResponse
358
- */
359
- 'md5': string;
360
- /**
361
- *
362
- * @type {string}
363
- * @memberof ReleaseResponse
364
- */
365
- 'version': string;
366
- /**
367
- *
368
- * @type {ReleaseType}
369
- * @memberof ReleaseResponse
370
- */
371
- 'type': ReleaseType;
372
- /**
373
- *
374
- * @type {string}
375
- * @memberof ReleaseResponse
376
- */
377
- 'maintainer_id'?: string | null;
378
- /**
379
- *
380
- * @type {boolean}
381
- * @memberof ReleaseResponse
382
- */
383
- 'archived': boolean;
384
- /**
385
- *
386
- * @type {RecoveryImgResponse}
387
- * @memberof ReleaseResponse
388
- */
389
- 'recovery_img': RecoveryImgResponse;
390
- /**
391
- *
392
- * @type {Array<string>}
393
- * @memberof ReleaseResponse
394
- */
395
- 'changelog': Array<string>;
396
- /**
397
- *
398
- * @type {Array<string>}
399
- * @memberof ReleaseResponse
400
- */
401
- 'bugs': Array<string> | null;
402
- /**
403
- *
404
- * @type {string}
405
- * @memberof ReleaseResponse
406
- */
407
- 'notes': string | null;
408
- /**
409
- * URL of the release on the official website
410
- * @type {string}
411
- * @memberof ReleaseResponse
412
- */
413
- 'url': string;
414
- /**
415
- * Mirrors list (deprecated)
416
- * @type {{ [key: string]: string; }}
417
- * @memberof ReleaseResponse
418
- */
419
- 'mirrors': { [key: string]: string; };
420
- }
421
-
422
-
423
- /**
424
- *
425
- * @export
426
- * @enum {string}
427
- */
428
-
429
- export const ReleaseType = {
430
- Stable: 'stable',
431
- Beta: 'beta',
432
- Alpha: 'alpha'
433
- } as const;
434
-
435
- export type ReleaseType = typeof ReleaseType[keyof typeof ReleaseType];
436
-
437
-
438
- /**
439
- *
440
- * @export
441
- * @enum {string}
442
- */
443
-
444
- export const ReleasesSort = {
445
- DateAsc: 'date_asc',
446
- DateDesc: 'date_desc'
447
- } as const;
448
-
449
- export type ReleasesSort = typeof ReleasesSort[keyof typeof ReleasesSort];
450
-
451
-
452
- /**
453
- *
454
- * @export
455
- * @interface ResponseGetReleases
456
- */
457
- export interface ResponseGetReleases {
458
- /**
459
- *
460
- * @type {{ [key: string]: Array<ReleaseResponse>; }}
461
- * @memberof ResponseGetReleases
462
- */
463
- 'data': { [key: string]: Array<ReleaseResponse>; };
464
- /**
465
- *
466
- * @type {number}
467
- * @memberof ResponseGetReleases
468
- */
469
- 'count': number;
470
- }
471
- /**
472
- *
473
- * @export
474
- * @interface ShortDeviceResponse
475
- */
476
- export interface ShortDeviceResponse {
477
- /**
478
- *
479
- * @type {string}
480
- * @memberof ShortDeviceResponse
481
- * @deprecated
482
- */
483
- '_id': string;
484
- /**
485
- * Device codename, legacy
486
- * @type {string}
487
- * @memberof ShortDeviceResponse
488
- * @deprecated
489
- */
490
- 'codename': string;
491
- /**
492
- * Model name of device, does not include the OEM part, legacy
493
- * @type {string}
494
- * @memberof ShortDeviceResponse
495
- * @deprecated
496
- */
497
- 'model_name': string;
498
- /**
499
- *
500
- * @type {string}
501
- * @memberof ShortDeviceResponse
502
- */
503
- 'oem_name': string;
504
- /**
505
- *
506
- * @type {string}
507
- * @memberof ShortDeviceResponse
508
- */
509
- 'id': string;
510
- /**
511
- *
512
- * @type {Array<string>}
513
- * @memberof ShortDeviceResponse
514
- */
515
- 'codenames': Array<string>;
516
- /**
517
- *
518
- * @type {Array<string>}
519
- * @memberof ShortDeviceResponse
520
- */
521
- 'model_names': Array<string>;
522
- /**
523
- *
524
- * @type {boolean}
525
- * @memberof ShortDeviceResponse
526
- */
527
- 'supported': boolean;
528
- /**
529
- * Full name of device / devices, legacy
530
- * @type {string}
531
- * @memberof ShortDeviceResponse
532
- */
533
- 'full_name': string;
534
- /**
535
- * URL of the device on the official website
536
- * @type {string}
537
- * @memberof ShortDeviceResponse
538
- */
539
- 'url': string;
540
- }
541
- /**
542
- *
543
- * @export
544
- * @interface ShortReleaseResponse
545
- */
546
- export interface ShortReleaseResponse {
547
- /**
548
- *
549
- * @type {string}
550
- * @memberof ShortReleaseResponse
551
- * @deprecated
552
- */
553
- '_id': string;
554
- /**
555
- *
556
- * @type {number}
557
- * @memberof ShortReleaseResponse
558
- * @deprecated
559
- */
560
- 'size': number;
561
- /**
562
- * Release ID, that\'s how we indentify the release in the infrastructure
563
- * @type {string}
564
- * @memberof ShortReleaseResponse
565
- */
566
- 'id': string;
567
- /**
568
- *
569
- * @type {string}
570
- * @memberof ShortReleaseResponse
571
- */
572
- 'build_id'?: string | null;
573
- /**
574
- *
575
- * @type {string}
576
- * @memberof ShortReleaseResponse
577
- */
578
- 'filename': string;
579
- /**
580
- *
581
- * @type {string}
582
- * @memberof ShortReleaseResponse
583
- */
584
- 'variant': string;
585
- /**
586
- *
587
- * @type {string}
588
- * @memberof ShortReleaseResponse
589
- */
590
- 'device_id': string;
591
- /**
592
- *
593
- * @type {number}
594
- * @memberof ShortReleaseResponse
595
- */
596
- 'date': number;
597
- /**
598
- *
599
- * @type {string}
600
- * @memberof ShortReleaseResponse
601
- */
602
- 'md5': string;
603
- /**
604
- *
605
- * @type {string}
606
- * @memberof ShortReleaseResponse
607
- */
608
- 'version': string;
609
- /**
610
- *
611
- * @type {ReleaseType}
612
- * @memberof ShortReleaseResponse
613
- */
614
- 'type': ReleaseType;
615
- /**
616
- *
617
- * @type {string}
618
- * @memberof ShortReleaseResponse
619
- */
620
- 'maintainer_id'?: string | null;
621
- /**
622
- *
623
- * @type {boolean}
624
- * @memberof ShortReleaseResponse
625
- */
626
- 'archived': boolean;
627
- }
628
-
629
-
630
- /**
631
- *
632
- * @export
633
- * @interface ValidationError
634
- */
635
- export interface ValidationError {
636
- /**
637
- *
638
- * @type {Array<ValidationErrorLocInner>}
639
- * @memberof ValidationError
640
- */
641
- 'loc': Array<ValidationErrorLocInner>;
642
- /**
643
- *
644
- * @type {string}
645
- * @memberof ValidationError
646
- */
647
- 'msg': string;
648
- /**
649
- *
650
- * @type {string}
651
- * @memberof ValidationError
652
- */
653
- 'type': string;
654
- }
655
- /**
656
- *
657
- * @export
658
- * @interface ValidationErrorLocInner
659
- */
660
- export interface ValidationErrorLocInner {
661
- }
662
-
663
- /**
664
- * DeviceApi - axios parameter creator
665
- * @export
666
- */
667
- export const DeviceApiAxiosParamCreator = function (configuration?: Configuration) {
668
- return {
669
- /**
670
- * Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
671
- * @summary Get Device
672
- * @param {string | null} [deviceId]
673
- * @param {string | null} [id] Filter by Device ID (deprecated)
674
- * @param {string | null} [codename] Not recommended to use when you can
675
- * @param {*} [options] Override http request option.
676
- * @throws {RequiredError}
677
- */
678
- getDevice: async (deviceId?: string | null, id?: string | null, codename?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
679
- const localVarPath = `/devices/get`;
680
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
681
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
682
- let baseOptions;
683
- if (configuration) {
684
- baseOptions = configuration.baseOptions;
685
- }
686
-
687
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
688
- const localVarHeaderParameter = {} as any;
689
- const localVarQueryParameter = {} as any;
690
-
691
- if (deviceId !== undefined) {
692
- localVarQueryParameter['device_id'] = deviceId;
693
- }
694
-
695
- if (id !== undefined) {
696
- localVarQueryParameter['_id'] = id;
697
- }
698
-
699
- if (codename !== undefined) {
700
- localVarQueryParameter['codename'] = codename;
701
- }
702
-
703
-
704
-
705
- setSearchParams(localVarUrlObj, localVarQueryParameter);
706
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
707
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
708
-
709
- return {
710
- url: toPathString(localVarUrlObj),
711
- options: localVarRequestOptions,
712
- };
713
- },
714
- /**
715
- * Gets device info using device ID.
716
- * @summary Get Device Short
717
- * @param {string} deviceId
718
- * @param {*} [options] Override http request option.
719
- * @deprecated
720
- * @throws {RequiredError}
721
- */
722
- getDeviceDeprecated: async (deviceId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
723
- // verify required parameter 'deviceId' is not null or undefined
724
- assertParamExists('getDeviceDeprecated', 'deviceId', deviceId)
725
- const localVarPath = `/devices/{device_id}`
726
- .replace(`{${"device_id"}}`, encodeURIComponent(String(deviceId)));
727
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
728
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
729
- let baseOptions;
730
- if (configuration) {
731
- baseOptions = configuration.baseOptions;
732
- }
733
-
734
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
735
- const localVarHeaderParameter = {} as any;
736
- const localVarQueryParameter = {} as any;
737
-
738
-
739
-
740
- setSearchParams(localVarUrlObj, localVarQueryParameter);
741
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
742
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
743
-
744
- return {
745
- url: toPathString(localVarUrlObj),
746
- options: localVarRequestOptions,
747
- };
748
- },
749
- /**
750
- * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
751
- * @summary Get Devices
752
- * @param {Array<string>} [id] Filter by Device IDs
753
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
754
- * @param {Array<string>} [oemName] Filter by OEM names
755
- * @param {Array<string>} [codename] Filter by device codenames
756
- * @param {Array<string>} [modelName] Filter by model names
757
- * @param {boolean | null} [supported] Supported status
758
- * @param {Array<string>} [maintainer] Filter by maintainer ID
759
- * @param {boolean | null} [freezed] Filter by Freezed status
760
- * @param {boolean | null} [hasReleases] Filter by has releases status
761
- * @param {number | null} [skip] Skip query results
762
- * @param {number | null} [limit] Limit query results (0 means unlimited)
763
- * @param {*} [options] Override http request option.
764
- * @throws {RequiredError}
765
- */
766
- getDevices: async (id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
767
- const localVarPath = `/devices/`;
768
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
769
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
770
- let baseOptions;
771
- if (configuration) {
772
- baseOptions = configuration.baseOptions;
773
- }
774
-
775
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
776
- const localVarHeaderParameter = {} as any;
777
- const localVarQueryParameter = {} as any;
778
-
779
- if (id) {
780
- localVarQueryParameter['id'] = id;
781
- }
782
-
783
- if (id2) {
784
- localVarQueryParameter['_id'] = id2;
785
- }
786
-
787
- if (oemName) {
788
- localVarQueryParameter['oem_name'] = oemName;
789
- }
790
-
791
- if (codename) {
792
- localVarQueryParameter['codename'] = codename;
793
- }
794
-
795
- if (modelName) {
796
- localVarQueryParameter['model_name'] = modelName;
797
- }
798
-
799
- if (supported !== undefined) {
800
- localVarQueryParameter['supported'] = supported;
801
- }
802
-
803
- if (maintainer) {
804
- localVarQueryParameter['maintainer'] = maintainer;
805
- }
806
-
807
- if (freezed !== undefined) {
808
- localVarQueryParameter['freezed'] = freezed;
809
- }
810
-
811
- if (hasReleases !== undefined) {
812
- localVarQueryParameter['has_releases'] = hasReleases;
813
- }
814
-
815
- if (skip !== undefined) {
816
- localVarQueryParameter['skip'] = skip;
817
- }
818
-
819
- if (limit !== undefined) {
820
- localVarQueryParameter['limit'] = limit;
821
- }
822
-
823
-
824
-
825
- setSearchParams(localVarUrlObj, localVarQueryParameter);
826
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
827
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
828
-
829
- return {
830
- url: toPathString(localVarUrlObj),
831
- options: localVarRequestOptions,
832
- };
833
- },
834
- /**
835
- * Lists all OEM names
836
- * @summary Get Oems
837
- * @param {*} [options] Override http request option.
838
- * @throws {RequiredError}
839
- */
840
- getOems: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
841
- const localVarPath = `/oems/`;
842
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
843
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
844
- let baseOptions;
845
- if (configuration) {
846
- baseOptions = configuration.baseOptions;
847
- }
848
-
849
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
850
- const localVarHeaderParameter = {} as any;
851
- const localVarQueryParameter = {} as any;
852
-
853
-
854
-
855
- setSearchParams(localVarUrlObj, localVarQueryParameter);
856
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
857
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
858
-
859
- return {
860
- url: toPathString(localVarUrlObj),
861
- options: localVarRequestOptions,
862
- };
863
- },
864
- }
865
- };
866
-
867
- /**
868
- * DeviceApi - functional programming interface
869
- * @export
870
- */
871
- export const DeviceApiFp = function(configuration?: Configuration) {
872
- const localVarAxiosParamCreator = DeviceApiAxiosParamCreator(configuration)
873
- return {
874
- /**
875
- * Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
876
- * @summary Get Device
877
- * @param {string | null} [deviceId]
878
- * @param {string | null} [id] Filter by Device ID (deprecated)
879
- * @param {string | null} [codename] Not recommended to use when you can
880
- * @param {*} [options] Override http request option.
881
- * @throws {RequiredError}
882
- */
883
- async getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>> {
884
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDevice(deviceId, id, codename, options);
885
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
886
- const localVarOperationServerBasePath = operationServerMap['DeviceApi.getDevice']?.[localVarOperationServerIndex]?.url;
887
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
888
- },
889
- /**
890
- * Gets device info using device ID.
891
- * @summary Get Device Short
892
- * @param {string} deviceId
893
- * @param {*} [options] Override http request option.
894
- * @deprecated
895
- * @throws {RequiredError}
896
- */
897
- async getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>> {
898
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDeviceDeprecated(deviceId, options);
899
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
900
- const localVarOperationServerBasePath = operationServerMap['DeviceApi.getDeviceDeprecated']?.[localVarOperationServerIndex]?.url;
901
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
902
- },
903
- /**
904
- * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
905
- * @summary Get Devices
906
- * @param {Array<string>} [id] Filter by Device IDs
907
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
908
- * @param {Array<string>} [oemName] Filter by OEM names
909
- * @param {Array<string>} [codename] Filter by device codenames
910
- * @param {Array<string>} [modelName] Filter by model names
911
- * @param {boolean | null} [supported] Supported status
912
- * @param {Array<string>} [maintainer] Filter by maintainer ID
913
- * @param {boolean | null} [freezed] Filter by Freezed status
914
- * @param {boolean | null} [hasReleases] Filter by has releases status
915
- * @param {number | null} [skip] Skip query results
916
- * @param {number | null} [limit] Limit query results (0 means unlimited)
917
- * @param {*} [options] Override http request option.
918
- * @throws {RequiredError}
919
- */
920
- async getDevices(id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseShortDeviceResponse>> {
921
- const localVarAxiosArgs = await localVarAxiosParamCreator.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options);
922
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
923
- const localVarOperationServerBasePath = operationServerMap['DeviceApi.getDevices']?.[localVarOperationServerIndex]?.url;
924
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
925
- },
926
- /**
927
- * Lists all OEM names
928
- * @summary Get Oems
929
- * @param {*} [options] Override http request option.
930
- * @throws {RequiredError}
931
- */
932
- async getOems(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseStr>> {
933
- const localVarAxiosArgs = await localVarAxiosParamCreator.getOems(options);
934
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
935
- const localVarOperationServerBasePath = operationServerMap['DeviceApi.getOems']?.[localVarOperationServerIndex]?.url;
936
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
937
- },
938
- }
939
- };
940
-
941
- /**
942
- * DeviceApi - factory interface
943
- * @export
944
- */
945
- export const DeviceApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
946
- const localVarFp = DeviceApiFp(configuration)
947
- return {
948
- /**
949
- * Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
950
- * @summary Get Device
951
- * @param {string | null} [deviceId]
952
- * @param {string | null} [id] Filter by Device ID (deprecated)
953
- * @param {string | null} [codename] Not recommended to use when you can
954
- * @param {*} [options] Override http request option.
955
- * @throws {RequiredError}
956
- */
957
- getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse> {
958
- return localVarFp.getDevice(deviceId, id, codename, options).then((request) => request(axios, basePath));
959
- },
960
- /**
961
- * Gets device info using device ID.
962
- * @summary Get Device Short
963
- * @param {string} deviceId
964
- * @param {*} [options] Override http request option.
965
- * @deprecated
966
- * @throws {RequiredError}
967
- */
968
- getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse> {
969
- return localVarFp.getDeviceDeprecated(deviceId, options).then((request) => request(axios, basePath));
970
- },
971
- /**
972
- * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
973
- * @summary Get Devices
974
- * @param {Array<string>} [id] Filter by Device IDs
975
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
976
- * @param {Array<string>} [oemName] Filter by OEM names
977
- * @param {Array<string>} [codename] Filter by device codenames
978
- * @param {Array<string>} [modelName] Filter by model names
979
- * @param {boolean | null} [supported] Supported status
980
- * @param {Array<string>} [maintainer] Filter by maintainer ID
981
- * @param {boolean | null} [freezed] Filter by Freezed status
982
- * @param {boolean | null} [hasReleases] Filter by has releases status
983
- * @param {number | null} [skip] Skip query results
984
- * @param {number | null} [limit] Limit query results (0 means unlimited)
985
- * @param {*} [options] Override http request option.
986
- * @throws {RequiredError}
987
- */
988
- getDevices(id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortDeviceResponse> {
989
- return localVarFp.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(axios, basePath));
990
- },
991
- /**
992
- * Lists all OEM names
993
- * @summary Get Oems
994
- * @param {*} [options] Override http request option.
995
- * @throws {RequiredError}
996
- */
997
- getOems(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseStr> {
998
- return localVarFp.getOems(options).then((request) => request(axios, basePath));
999
- },
1000
- };
1001
- };
1002
-
1003
- /**
1004
- * DeviceApi - interface
1005
- * @export
1006
- * @interface DeviceApi
1007
- */
1008
- export interface DeviceApiInterface {
1009
- /**
1010
- * Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
1011
- * @summary Get Device
1012
- * @param {string | null} [deviceId]
1013
- * @param {string | null} [id] Filter by Device ID (deprecated)
1014
- * @param {string | null} [codename] Not recommended to use when you can
1015
- * @param {*} [options] Override http request option.
1016
- * @throws {RequiredError}
1017
- * @memberof DeviceApiInterface
1018
- */
1019
- getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
1020
-
1021
- /**
1022
- * Gets device info using device ID.
1023
- * @summary Get Device Short
1024
- * @param {string} deviceId
1025
- * @param {*} [options] Override http request option.
1026
- * @deprecated
1027
- * @throws {RequiredError}
1028
- * @memberof DeviceApiInterface
1029
- */
1030
- getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
1031
-
1032
- /**
1033
- * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
1034
- * @summary Get Devices
1035
- * @param {Array<string>} [id] Filter by Device IDs
1036
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
1037
- * @param {Array<string>} [oemName] Filter by OEM names
1038
- * @param {Array<string>} [codename] Filter by device codenames
1039
- * @param {Array<string>} [modelName] Filter by model names
1040
- * @param {boolean | null} [supported] Supported status
1041
- * @param {Array<string>} [maintainer] Filter by maintainer ID
1042
- * @param {boolean | null} [freezed] Filter by Freezed status
1043
- * @param {boolean | null} [hasReleases] Filter by has releases status
1044
- * @param {number | null} [skip] Skip query results
1045
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1046
- * @param {*} [options] Override http request option.
1047
- * @throws {RequiredError}
1048
- * @memberof DeviceApiInterface
1049
- */
1050
- getDevices(id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortDeviceResponse>;
1051
-
1052
- /**
1053
- * Lists all OEM names
1054
- * @summary Get Oems
1055
- * @param {*} [options] Override http request option.
1056
- * @throws {RequiredError}
1057
- * @memberof DeviceApiInterface
1058
- */
1059
- getOems(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseStr>;
1060
-
1061
- }
1062
-
1063
- /**
1064
- * DeviceApi - object-oriented interface
1065
- * @export
1066
- * @class DeviceApi
1067
- * @extends {BaseAPI}
1068
- */
1069
- export class DeviceApi extends BaseAPI implements DeviceApiInterface {
1070
- /**
1071
- * Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
1072
- * @summary Get Device
1073
- * @param {string | null} [deviceId]
1074
- * @param {string | null} [id] Filter by Device ID (deprecated)
1075
- * @param {string | null} [codename] Not recommended to use when you can
1076
- * @param {*} [options] Override http request option.
1077
- * @throws {RequiredError}
1078
- * @memberof DeviceApi
1079
- */
1080
- public getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig) {
1081
- return DeviceApiFp(this.configuration).getDevice(deviceId, id, codename, options).then((request) => request(this.axios, this.basePath));
1082
- }
1083
-
1084
- /**
1085
- * Gets device info using device ID.
1086
- * @summary Get Device Short
1087
- * @param {string} deviceId
1088
- * @param {*} [options] Override http request option.
1089
- * @deprecated
1090
- * @throws {RequiredError}
1091
- * @memberof DeviceApi
1092
- */
1093
- public getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig) {
1094
- return DeviceApiFp(this.configuration).getDeviceDeprecated(deviceId, options).then((request) => request(this.axios, this.basePath));
1095
- }
1096
-
1097
- /**
1098
- * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
1099
- * @summary Get Devices
1100
- * @param {Array<string>} [id] Filter by Device IDs
1101
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
1102
- * @param {Array<string>} [oemName] Filter by OEM names
1103
- * @param {Array<string>} [codename] Filter by device codenames
1104
- * @param {Array<string>} [modelName] Filter by model names
1105
- * @param {boolean | null} [supported] Supported status
1106
- * @param {Array<string>} [maintainer] Filter by maintainer ID
1107
- * @param {boolean | null} [freezed] Filter by Freezed status
1108
- * @param {boolean | null} [hasReleases] Filter by has releases status
1109
- * @param {number | null} [skip] Skip query results
1110
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1111
- * @param {*} [options] Override http request option.
1112
- * @throws {RequiredError}
1113
- * @memberof DeviceApi
1114
- */
1115
- public getDevices(id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) {
1116
- return DeviceApiFp(this.configuration).getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(this.axios, this.basePath));
1117
- }
1118
-
1119
- /**
1120
- * Lists all OEM names
1121
- * @summary Get Oems
1122
- * @param {*} [options] Override http request option.
1123
- * @throws {RequiredError}
1124
- * @memberof DeviceApi
1125
- */
1126
- public getOems(options?: RawAxiosRequestConfig) {
1127
- return DeviceApiFp(this.configuration).getOems(options).then((request) => request(this.axios, this.basePath));
1128
- }
1129
- }
1130
-
1131
-
1132
-
1133
- /**
1134
- * ReleaseApi - axios parameter creator
1135
- * @export
1136
- */
1137
- export const ReleaseApiAxiosParamCreator = function (configuration?: Configuration) {
1138
- return {
1139
- /**
1140
- * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
1141
- * @summary Get Release
1142
- * @param {string | null} [releaseId] Release ID
1143
- * @param {string | null} [id] Release ID (deprecated)
1144
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
1145
- * @param {string | null} [filename]
1146
- * @param {*} [options] Override http request option.
1147
- * @throws {RequiredError}
1148
- */
1149
- getRelease: async (releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1150
- const localVarPath = `/releases/get`;
1151
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1152
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1153
- let baseOptions;
1154
- if (configuration) {
1155
- baseOptions = configuration.baseOptions;
1156
- }
1157
-
1158
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1159
- const localVarHeaderParameter = {} as any;
1160
- const localVarQueryParameter = {} as any;
1161
-
1162
- if (releaseId !== undefined) {
1163
- localVarQueryParameter['release_id'] = releaseId;
1164
- }
1165
-
1166
- if (id !== undefined) {
1167
- localVarQueryParameter['_id'] = id;
1168
- }
1169
-
1170
- if (buildId !== undefined) {
1171
- localVarQueryParameter['build_id'] = buildId;
1172
- }
1173
-
1174
- if (filename !== undefined) {
1175
- localVarQueryParameter['filename'] = filename;
1176
- }
1177
-
1178
-
1179
-
1180
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1181
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1182
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1183
-
1184
- return {
1185
- url: toPathString(localVarUrlObj),
1186
- options: localVarRequestOptions,
1187
- };
1188
- },
1189
- /**
1190
- * Gets release information using the release ID, nothing to discuss really.
1191
- * @summary Get Release Short
1192
- * @param {string} releaseId
1193
- * @param {*} [options] Override http request option.
1194
- * @deprecated
1195
- * @throws {RequiredError}
1196
- */
1197
- getReleaseDeprecated: async (releaseId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1198
- // verify required parameter 'releaseId' is not null or undefined
1199
- assertParamExists('getReleaseDeprecated', 'releaseId', releaseId)
1200
- const localVarPath = `/releases/{release_id}`
1201
- .replace(`{${"release_id"}}`, encodeURIComponent(String(releaseId)));
1202
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1203
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1204
- let baseOptions;
1205
- if (configuration) {
1206
- baseOptions = configuration.baseOptions;
1207
- }
1208
-
1209
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1210
- const localVarHeaderParameter = {} as any;
1211
- const localVarQueryParameter = {} as any;
1212
-
1213
-
1214
-
1215
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1216
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1217
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1218
-
1219
- return {
1220
- url: toPathString(localVarUrlObj),
1221
- options: localVarRequestOptions,
1222
- };
1223
- },
1224
- /**
1225
- * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
1226
- * @summary Get Releases
1227
- * @param {Array<string>} [id] Filter by Release IDs
1228
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
1229
- * @param {Array<string>} [buildId] Filter by Build IDs
1230
- * @param {Array<string>} [deviceId] Filter by Device IDs
1231
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
1232
- * @param {Array<string>} [codename] Filter by device codenames
1233
- * @param {Array<string>} [version] Filter by release version
1234
- * @param {Array<ReleaseType>} [type] Filter by release type
1235
- * @param {boolean | null} [archived] Filter by the archived status
1236
- * @param {boolean | null} [freezed] Filter by the freezed status
1237
- * @param {string | null} [afterReleaseId] Show releases after the provided one
1238
- * @param {number | null} [afterDate] Show releases after the provided timestamp
1239
- * @param {ReleasesSort} [sort] Sort mode
1240
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
1241
- * @param {number | null} [skip] Skip query results
1242
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1243
- * @param {*} [options] Override http request option.
1244
- * @throws {RequiredError}
1245
- */
1246
- getReleases: async (id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1247
- const localVarPath = `/releases/`;
1248
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1249
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1250
- let baseOptions;
1251
- if (configuration) {
1252
- baseOptions = configuration.baseOptions;
1253
- }
1254
-
1255
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1256
- const localVarHeaderParameter = {} as any;
1257
- const localVarQueryParameter = {} as any;
1258
-
1259
- if (id) {
1260
- localVarQueryParameter['id'] = id;
1261
- }
1262
-
1263
- if (id2) {
1264
- localVarQueryParameter['_id'] = id2;
1265
- }
1266
-
1267
- if (buildId) {
1268
- localVarQueryParameter['build_id'] = buildId;
1269
- }
1270
-
1271
- if (deviceId) {
1272
- localVarQueryParameter['device_id'] = deviceId;
1273
- }
1274
-
1275
- if (maintainerId) {
1276
- localVarQueryParameter['maintainer_id'] = maintainerId;
1277
- }
1278
-
1279
- if (codename) {
1280
- localVarQueryParameter['codename'] = codename;
1281
- }
1282
-
1283
- if (version) {
1284
- localVarQueryParameter['version'] = version;
1285
- }
1286
-
1287
- if (type) {
1288
- localVarQueryParameter['type'] = type;
1289
- }
1290
-
1291
- if (archived !== undefined) {
1292
- localVarQueryParameter['archived'] = archived;
1293
- }
1294
-
1295
- if (freezed !== undefined) {
1296
- localVarQueryParameter['freezed'] = freezed;
1297
- }
1298
-
1299
- if (afterReleaseId !== undefined) {
1300
- localVarQueryParameter['after_release_id'] = afterReleaseId;
1301
- }
1302
-
1303
- if (afterDate !== undefined) {
1304
- localVarQueryParameter['after_date'] = afterDate;
1305
- }
1306
-
1307
- if (sort !== undefined) {
1308
- localVarQueryParameter['sort'] = sort;
1309
- }
1310
-
1311
- if (group !== undefined) {
1312
- localVarQueryParameter['group'] = group;
1313
- }
1314
-
1315
- if (skip !== undefined) {
1316
- localVarQueryParameter['skip'] = skip;
1317
- }
1318
-
1319
- if (limit !== undefined) {
1320
- localVarQueryParameter['limit'] = limit;
1321
- }
1322
-
1323
-
1324
-
1325
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1326
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1327
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1328
-
1329
- return {
1330
- url: toPathString(localVarUrlObj),
1331
- options: localVarRequestOptions,
1332
- };
1333
- },
1334
- /**
1335
- * Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
1336
- * @summary Get Updates
1337
- * @param {string} lastKnownId
1338
- * @param {Array<string>} [deviceId] Filter by device ID
1339
- * @param {Array<ReleaseType>} [type] Filter by release type
1340
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
1341
- * @param {number | null} [skip] Skip query results
1342
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1343
- * @param {*} [options] Override http request option.
1344
- * @deprecated
1345
- * @throws {RequiredError}
1346
- */
1347
- getUpdatesDeprecated: async (lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1348
- // verify required parameter 'lastKnownId' is not null or undefined
1349
- assertParamExists('getUpdatesDeprecated', 'lastKnownId', lastKnownId)
1350
- const localVarPath = `/updates/{last_known_id}`
1351
- .replace(`{${"last_known_id"}}`, encodeURIComponent(String(lastKnownId)));
1352
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1353
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1354
- let baseOptions;
1355
- if (configuration) {
1356
- baseOptions = configuration.baseOptions;
1357
- }
1358
-
1359
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1360
- const localVarHeaderParameter = {} as any;
1361
- const localVarQueryParameter = {} as any;
1362
-
1363
- if (deviceId) {
1364
- localVarQueryParameter['device_id'] = deviceId;
1365
- }
1366
-
1367
- if (type) {
1368
- localVarQueryParameter['type'] = type;
1369
- }
1370
-
1371
- if (releaseType) {
1372
- localVarQueryParameter['release_type'] = releaseType;
1373
- }
1374
-
1375
- if (skip !== undefined) {
1376
- localVarQueryParameter['skip'] = skip;
1377
- }
1378
-
1379
- if (limit !== undefined) {
1380
- localVarQueryParameter['limit'] = limit;
1381
- }
1382
-
1383
-
1384
-
1385
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1386
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1387
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1388
-
1389
- return {
1390
- url: toPathString(localVarUrlObj),
1391
- options: localVarRequestOptions,
1392
- };
1393
- },
1394
- }
1395
- };
1396
-
1397
- /**
1398
- * ReleaseApi - functional programming interface
1399
- * @export
1400
- */
1401
- export const ReleaseApiFp = function(configuration?: Configuration) {
1402
- const localVarAxiosParamCreator = ReleaseApiAxiosParamCreator(configuration)
1403
- return {
1404
- /**
1405
- * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
1406
- * @summary Get Release
1407
- * @param {string | null} [releaseId] Release ID
1408
- * @param {string | null} [id] Release ID (deprecated)
1409
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
1410
- * @param {string | null} [filename]
1411
- * @param {*} [options] Override http request option.
1412
- * @throws {RequiredError}
1413
- */
1414
- async getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>> {
1415
- const localVarAxiosArgs = await localVarAxiosParamCreator.getRelease(releaseId, id, buildId, filename, options);
1416
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1417
- const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getRelease']?.[localVarOperationServerIndex]?.url;
1418
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1419
- },
1420
- /**
1421
- * Gets release information using the release ID, nothing to discuss really.
1422
- * @summary Get Release Short
1423
- * @param {string} releaseId
1424
- * @param {*} [options] Override http request option.
1425
- * @deprecated
1426
- * @throws {RequiredError}
1427
- */
1428
- async getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>> {
1429
- const localVarAxiosArgs = await localVarAxiosParamCreator.getReleaseDeprecated(releaseId, options);
1430
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1431
- const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getReleaseDeprecated']?.[localVarOperationServerIndex]?.url;
1432
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1433
- },
1434
- /**
1435
- * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
1436
- * @summary Get Releases
1437
- * @param {Array<string>} [id] Filter by Release IDs
1438
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
1439
- * @param {Array<string>} [buildId] Filter by Build IDs
1440
- * @param {Array<string>} [deviceId] Filter by Device IDs
1441
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
1442
- * @param {Array<string>} [codename] Filter by device codenames
1443
- * @param {Array<string>} [version] Filter by release version
1444
- * @param {Array<ReleaseType>} [type] Filter by release type
1445
- * @param {boolean | null} [archived] Filter by the archived status
1446
- * @param {boolean | null} [freezed] Filter by the freezed status
1447
- * @param {string | null} [afterReleaseId] Show releases after the provided one
1448
- * @param {number | null} [afterDate] Show releases after the provided timestamp
1449
- * @param {ReleasesSort} [sort] Sort mode
1450
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
1451
- * @param {number | null} [skip] Skip query results
1452
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1453
- * @param {*} [options] Override http request option.
1454
- * @throws {RequiredError}
1455
- */
1456
- async getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseGetReleases>> {
1457
- const localVarAxiosArgs = await localVarAxiosParamCreator.getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options);
1458
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1459
- const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getReleases']?.[localVarOperationServerIndex]?.url;
1460
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1461
- },
1462
- /**
1463
- * Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
1464
- * @summary Get Updates
1465
- * @param {string} lastKnownId
1466
- * @param {Array<string>} [deviceId] Filter by device ID
1467
- * @param {Array<ReleaseType>} [type] Filter by release type
1468
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
1469
- * @param {number | null} [skip] Skip query results
1470
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1471
- * @param {*} [options] Override http request option.
1472
- * @deprecated
1473
- * @throws {RequiredError}
1474
- */
1475
- async getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseShortReleaseResponse>> {
1476
- const localVarAxiosArgs = await localVarAxiosParamCreator.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options);
1477
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1478
- const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getUpdatesDeprecated']?.[localVarOperationServerIndex]?.url;
1479
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1480
- },
1481
- }
1482
- };
1483
-
1484
- /**
1485
- * ReleaseApi - factory interface
1486
- * @export
1487
- */
1488
- export const ReleaseApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1489
- const localVarFp = ReleaseApiFp(configuration)
1490
- return {
1491
- /**
1492
- * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
1493
- * @summary Get Release
1494
- * @param {string | null} [releaseId] Release ID
1495
- * @param {string | null} [id] Release ID (deprecated)
1496
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
1497
- * @param {string | null} [filename]
1498
- * @param {*} [options] Override http request option.
1499
- * @throws {RequiredError}
1500
- */
1501
- getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse> {
1502
- return localVarFp.getRelease(releaseId, id, buildId, filename, options).then((request) => request(axios, basePath));
1503
- },
1504
- /**
1505
- * Gets release information using the release ID, nothing to discuss really.
1506
- * @summary Get Release Short
1507
- * @param {string} releaseId
1508
- * @param {*} [options] Override http request option.
1509
- * @deprecated
1510
- * @throws {RequiredError}
1511
- */
1512
- getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse> {
1513
- return localVarFp.getReleaseDeprecated(releaseId, options).then((request) => request(axios, basePath));
1514
- },
1515
- /**
1516
- * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
1517
- * @summary Get Releases
1518
- * @param {Array<string>} [id] Filter by Release IDs
1519
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
1520
- * @param {Array<string>} [buildId] Filter by Build IDs
1521
- * @param {Array<string>} [deviceId] Filter by Device IDs
1522
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
1523
- * @param {Array<string>} [codename] Filter by device codenames
1524
- * @param {Array<string>} [version] Filter by release version
1525
- * @param {Array<ReleaseType>} [type] Filter by release type
1526
- * @param {boolean | null} [archived] Filter by the archived status
1527
- * @param {boolean | null} [freezed] Filter by the freezed status
1528
- * @param {string | null} [afterReleaseId] Show releases after the provided one
1529
- * @param {number | null} [afterDate] Show releases after the provided timestamp
1530
- * @param {ReleasesSort} [sort] Sort mode
1531
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
1532
- * @param {number | null} [skip] Skip query results
1533
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1534
- * @param {*} [options] Override http request option.
1535
- * @throws {RequiredError}
1536
- */
1537
- getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ResponseGetReleases> {
1538
- return localVarFp.getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options).then((request) => request(axios, basePath));
1539
- },
1540
- /**
1541
- * Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
1542
- * @summary Get Updates
1543
- * @param {string} lastKnownId
1544
- * @param {Array<string>} [deviceId] Filter by device ID
1545
- * @param {Array<ReleaseType>} [type] Filter by release type
1546
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
1547
- * @param {number | null} [skip] Skip query results
1548
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1549
- * @param {*} [options] Override http request option.
1550
- * @deprecated
1551
- * @throws {RequiredError}
1552
- */
1553
- getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse> {
1554
- return localVarFp.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(axios, basePath));
1555
- },
1556
- };
1557
- };
1558
-
1559
- /**
1560
- * ReleaseApi - interface
1561
- * @export
1562
- * @interface ReleaseApi
1563
- */
1564
- export interface ReleaseApiInterface {
1565
- /**
1566
- * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
1567
- * @summary Get Release
1568
- * @param {string | null} [releaseId] Release ID
1569
- * @param {string | null} [id] Release ID (deprecated)
1570
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
1571
- * @param {string | null} [filename]
1572
- * @param {*} [options] Override http request option.
1573
- * @throws {RequiredError}
1574
- * @memberof ReleaseApiInterface
1575
- */
1576
- getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
1577
-
1578
- /**
1579
- * Gets release information using the release ID, nothing to discuss really.
1580
- * @summary Get Release Short
1581
- * @param {string} releaseId
1582
- * @param {*} [options] Override http request option.
1583
- * @deprecated
1584
- * @throws {RequiredError}
1585
- * @memberof ReleaseApiInterface
1586
- */
1587
- getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
1588
-
1589
- /**
1590
- * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
1591
- * @summary Get Releases
1592
- * @param {Array<string>} [id] Filter by Release IDs
1593
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
1594
- * @param {Array<string>} [buildId] Filter by Build IDs
1595
- * @param {Array<string>} [deviceId] Filter by Device IDs
1596
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
1597
- * @param {Array<string>} [codename] Filter by device codenames
1598
- * @param {Array<string>} [version] Filter by release version
1599
- * @param {Array<ReleaseType>} [type] Filter by release type
1600
- * @param {boolean | null} [archived] Filter by the archived status
1601
- * @param {boolean | null} [freezed] Filter by the freezed status
1602
- * @param {string | null} [afterReleaseId] Show releases after the provided one
1603
- * @param {number | null} [afterDate] Show releases after the provided timestamp
1604
- * @param {ReleasesSort} [sort] Sort mode
1605
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
1606
- * @param {number | null} [skip] Skip query results
1607
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1608
- * @param {*} [options] Override http request option.
1609
- * @throws {RequiredError}
1610
- * @memberof ReleaseApiInterface
1611
- */
1612
- getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ResponseGetReleases>;
1613
-
1614
- /**
1615
- * Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
1616
- * @summary Get Updates
1617
- * @param {string} lastKnownId
1618
- * @param {Array<string>} [deviceId] Filter by device ID
1619
- * @param {Array<ReleaseType>} [type] Filter by release type
1620
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
1621
- * @param {number | null} [skip] Skip query results
1622
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1623
- * @param {*} [options] Override http request option.
1624
- * @deprecated
1625
- * @throws {RequiredError}
1626
- * @memberof ReleaseApiInterface
1627
- */
1628
- getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse>;
1629
-
1630
- }
1631
-
1632
- /**
1633
- * ReleaseApi - object-oriented interface
1634
- * @export
1635
- * @class ReleaseApi
1636
- * @extends {BaseAPI}
1637
- */
1638
- export class ReleaseApi extends BaseAPI implements ReleaseApiInterface {
1639
- /**
1640
- * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
1641
- * @summary Get Release
1642
- * @param {string | null} [releaseId] Release ID
1643
- * @param {string | null} [id] Release ID (deprecated)
1644
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
1645
- * @param {string | null} [filename]
1646
- * @param {*} [options] Override http request option.
1647
- * @throws {RequiredError}
1648
- * @memberof ReleaseApi
1649
- */
1650
- public getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig) {
1651
- return ReleaseApiFp(this.configuration).getRelease(releaseId, id, buildId, filename, options).then((request) => request(this.axios, this.basePath));
1652
- }
1653
-
1654
- /**
1655
- * Gets release information using the release ID, nothing to discuss really.
1656
- * @summary Get Release Short
1657
- * @param {string} releaseId
1658
- * @param {*} [options] Override http request option.
1659
- * @deprecated
1660
- * @throws {RequiredError}
1661
- * @memberof ReleaseApi
1662
- */
1663
- public getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig) {
1664
- return ReleaseApiFp(this.configuration).getReleaseDeprecated(releaseId, options).then((request) => request(this.axios, this.basePath));
1665
- }
1666
-
1667
- /**
1668
- * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
1669
- * @summary Get Releases
1670
- * @param {Array<string>} [id] Filter by Release IDs
1671
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
1672
- * @param {Array<string>} [buildId] Filter by Build IDs
1673
- * @param {Array<string>} [deviceId] Filter by Device IDs
1674
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
1675
- * @param {Array<string>} [codename] Filter by device codenames
1676
- * @param {Array<string>} [version] Filter by release version
1677
- * @param {Array<ReleaseType>} [type] Filter by release type
1678
- * @param {boolean | null} [archived] Filter by the archived status
1679
- * @param {boolean | null} [freezed] Filter by the freezed status
1680
- * @param {string | null} [afterReleaseId] Show releases after the provided one
1681
- * @param {number | null} [afterDate] Show releases after the provided timestamp
1682
- * @param {ReleasesSort} [sort] Sort mode
1683
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
1684
- * @param {number | null} [skip] Skip query results
1685
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1686
- * @param {*} [options] Override http request option.
1687
- * @throws {RequiredError}
1688
- * @memberof ReleaseApi
1689
- */
1690
- public getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) {
1691
- return ReleaseApiFp(this.configuration).getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options).then((request) => request(this.axios, this.basePath));
1692
- }
1693
-
1694
- /**
1695
- * Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
1696
- * @summary Get Updates
1697
- * @param {string} lastKnownId
1698
- * @param {Array<string>} [deviceId] Filter by device ID
1699
- * @param {Array<ReleaseType>} [type] Filter by release type
1700
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
1701
- * @param {number | null} [skip] Skip query results
1702
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1703
- * @param {*} [options] Override http request option.
1704
- * @deprecated
1705
- * @throws {RequiredError}
1706
- * @memberof ReleaseApi
1707
- */
1708
- public getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) {
1709
- return ReleaseApiFp(this.configuration).getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(this.axios, this.basePath));
1710
- }
1711
- }
1712
-
1713
-
1714
-
1715
- /**
1716
- * StatsApi - axios parameter creator
1717
- * @export
1718
- */
1719
- export const StatsApiAxiosParamCreator = function (configuration?: Configuration) {
1720
- return {
1721
- /**
1722
- * 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.
1723
- * @summary Public Stats
1724
- * @param {*} [options] Override http request option.
1725
- * @throws {RequiredError}
1726
- */
1727
- getPublicStats: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1728
- const localVarPath = `/stats/`;
1729
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1730
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1731
- let baseOptions;
1732
- if (configuration) {
1733
- baseOptions = configuration.baseOptions;
1734
- }
1735
-
1736
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1737
- const localVarHeaderParameter = {} as any;
1738
- const localVarQueryParameter = {} as any;
1739
-
1740
-
1741
-
1742
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1743
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1744
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1745
-
1746
- return {
1747
- url: toPathString(localVarUrlObj),
1748
- options: localVarRequestOptions,
1749
- };
1750
- },
1751
- }
1752
- };
1753
-
1754
- /**
1755
- * StatsApi - functional programming interface
1756
- * @export
1757
- */
1758
- export const StatsApiFp = function(configuration?: Configuration) {
1759
- const localVarAxiosParamCreator = StatsApiAxiosParamCreator(configuration)
1760
- return {
1761
- /**
1762
- * 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.
1763
- * @summary Public Stats
1764
- * @param {*} [options] Override http request option.
1765
- * @throws {RequiredError}
1766
- */
1767
- async getPublicStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalStatsAggregationModel>> {
1768
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicStats(options);
1769
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1770
- const localVarOperationServerBasePath = operationServerMap['StatsApi.getPublicStats']?.[localVarOperationServerIndex]?.url;
1771
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1772
- },
1773
- }
1774
- };
1775
-
1776
- /**
1777
- * StatsApi - factory interface
1778
- * @export
1779
- */
1780
- export const StatsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1781
- const localVarFp = StatsApiFp(configuration)
1782
- return {
1783
- /**
1784
- * 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.
1785
- * @summary Public Stats
1786
- * @param {*} [options] Override http request option.
1787
- * @throws {RequiredError}
1788
- */
1789
- getPublicStats(options?: RawAxiosRequestConfig): AxiosPromise<GlobalStatsAggregationModel> {
1790
- return localVarFp.getPublicStats(options).then((request) => request(axios, basePath));
1791
- },
1792
- };
1793
- };
1794
-
1795
- /**
1796
- * StatsApi - interface
1797
- * @export
1798
- * @interface StatsApi
1799
- */
1800
- export interface StatsApiInterface {
1801
- /**
1802
- * 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.
1803
- * @summary Public Stats
1804
- * @param {*} [options] Override http request option.
1805
- * @throws {RequiredError}
1806
- * @memberof StatsApiInterface
1807
- */
1808
- getPublicStats(options?: RawAxiosRequestConfig): AxiosPromise<GlobalStatsAggregationModel>;
1809
-
1810
- }
1811
-
1812
- /**
1813
- * StatsApi - object-oriented interface
1814
- * @export
1815
- * @class StatsApi
1816
- * @extends {BaseAPI}
1817
- */
1818
- export class StatsApi extends BaseAPI implements StatsApiInterface {
1819
- /**
1820
- * 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.
1821
- * @summary Public Stats
1822
- * @param {*} [options] Override http request option.
1823
- * @throws {RequiredError}
1824
- * @memberof StatsApi
1825
- */
1826
- public getPublicStats(options?: RawAxiosRequestConfig) {
1827
- return StatsApiFp(this.configuration).getPublicStats(options).then((request) => request(this.axios, this.basePath));
1828
- }
1829
- }
1830
-
1831
-
1832
-