@orangefox-recovery/foxclient 5.2.6 → 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.
- package/.openapi-generator/FILES +28 -30
- package/README.md +3 -65
- package/dist/apis/DeviceApi.d.ts +158 -0
- package/dist/apis/DeviceApi.js +188 -0
- package/dist/apis/PasteApi.d.ts +80 -0
- package/dist/apis/PasteApi.js +95 -0
- package/dist/apis/ReleaseApi.d.ts +188 -0
- package/dist/apis/ReleaseApi.js +226 -0
- package/dist/apis/StatsApi.d.ts +49 -0
- package/dist/apis/StatsApi.js +60 -0
- package/dist/apis/index.d.ts +4 -0
- package/dist/apis/index.js +22 -0
- package/dist/esm/apis/DeviceApi.d.ts +158 -0
- package/dist/esm/apis/DeviceApi.js +184 -0
- package/dist/esm/apis/PasteApi.d.ts +80 -0
- package/dist/esm/apis/PasteApi.js +91 -0
- package/dist/esm/apis/ReleaseApi.d.ts +188 -0
- package/dist/esm/apis/ReleaseApi.js +222 -0
- package/dist/esm/apis/StatsApi.d.ts +49 -0
- package/dist/esm/apis/StatsApi.js +56 -0
- package/dist/esm/apis/index.d.ts +4 -0
- package/dist/esm/apis/index.js +6 -0
- package/dist/esm/index.d.ts +3 -13
- package/dist/esm/index.js +3 -13
- package/dist/esm/models/DeviceResponse.d.ts +101 -0
- package/dist/esm/models/DeviceResponse.js +82 -0
- package/dist/esm/models/GlobalStatsAggregationModel.d.ts +52 -0
- package/dist/esm/models/GlobalStatsAggregationModel.js +55 -0
- package/dist/esm/models/HTTPValidationError.d.ts +33 -0
- package/dist/esm/models/HTTPValidationError.js +42 -0
- package/dist/esm/models/ListResponseReleaseResponse.d.ts +39 -0
- package/dist/esm/models/ListResponseReleaseResponse.js +47 -0
- package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +39 -0
- package/dist/esm/models/ListResponseShortDeviceResponse.js +47 -0
- package/dist/esm/models/ListResponseShortReleaseResponse.d.ts +39 -0
- package/dist/esm/models/ListResponseShortReleaseResponse.js +47 -0
- package/dist/esm/models/ListResponseStr.d.ts +38 -0
- package/dist/esm/models/ListResponseStr.js +46 -0
- package/dist/esm/models/MaintainerShortModel.d.ts +44 -0
- package/dist/esm/models/MaintainerShortModel.js +51 -0
- package/dist/esm/models/PasteInput.d.ts +50 -0
- package/dist/esm/models/PasteInput.js +51 -0
- package/dist/esm/models/PasteOutput.d.ts +50 -0
- package/dist/esm/models/PasteOutput.js +51 -0
- package/dist/esm/models/RecoveryImgResponse.d.ts +38 -0
- package/dist/esm/models/RecoveryImgResponse.js +47 -0
- package/dist/esm/models/ReleaseGroupsResponse.d.ts +35 -0
- package/dist/esm/models/ReleaseGroupsResponse.js +43 -0
- package/dist/esm/models/ReleaseResponse.d.ts +139 -0
- package/dist/esm/models/ReleaseResponse.js +107 -0
- package/dist/esm/models/ReleaseType.d.ts +26 -0
- package/dist/esm/models/ReleaseType.js +44 -0
- package/dist/esm/models/ReleasesSort.d.ts +25 -0
- package/dist/esm/models/ReleasesSort.js +43 -0
- package/dist/esm/models/ResponseGetReleases.d.ts +41 -0
- package/dist/esm/models/ResponseGetReleases.js +46 -0
- package/dist/esm/models/ShortDeviceResponse.d.ts +82 -0
- package/dist/esm/models/ShortDeviceResponse.js +73 -0
- package/dist/esm/models/ShortReleaseResponse.d.ts +100 -0
- package/dist/esm/models/ShortReleaseResponse.js +84 -0
- package/dist/esm/models/ValidationError.d.ts +45 -0
- package/dist/esm/models/ValidationError.js +52 -0
- package/dist/esm/models/ValidationErrorLocInner.d.ts +26 -0
- package/{index.ts → dist/esm/models/ValidationErrorLocInner.js} +20 -7
- package/dist/esm/models/index.d.ts +20 -0
- package/dist/esm/models/index.js +22 -0
- package/dist/esm/runtime.d.ts +184 -0
- package/dist/esm/runtime.js +334 -0
- package/dist/index.d.ts +3 -13
- package/dist/index.js +5 -15
- package/dist/models/DeviceResponse.d.ts +101 -0
- package/dist/models/DeviceResponse.js +89 -0
- package/dist/models/GlobalStatsAggregationModel.d.ts +52 -0
- package/dist/models/GlobalStatsAggregationModel.js +62 -0
- package/dist/models/HTTPValidationError.d.ts +33 -0
- package/dist/models/HTTPValidationError.js +49 -0
- package/dist/models/ListResponseReleaseResponse.d.ts +39 -0
- package/dist/models/ListResponseReleaseResponse.js +54 -0
- package/dist/models/ListResponseShortDeviceResponse.d.ts +39 -0
- package/dist/models/ListResponseShortDeviceResponse.js +54 -0
- package/dist/models/ListResponseShortReleaseResponse.d.ts +39 -0
- package/dist/models/ListResponseShortReleaseResponse.js +54 -0
- package/dist/models/ListResponseStr.d.ts +38 -0
- package/dist/models/ListResponseStr.js +53 -0
- package/dist/models/MaintainerShortModel.d.ts +44 -0
- package/dist/models/MaintainerShortModel.js +58 -0
- package/dist/models/PasteInput.d.ts +50 -0
- package/dist/models/PasteInput.js +58 -0
- package/dist/models/PasteOutput.d.ts +50 -0
- package/dist/models/PasteOutput.js +58 -0
- package/dist/models/RecoveryImgResponse.d.ts +38 -0
- package/dist/models/RecoveryImgResponse.js +54 -0
- package/dist/models/ReleaseGroupsResponse.d.ts +35 -0
- package/dist/models/ReleaseGroupsResponse.js +50 -0
- package/dist/models/ReleaseResponse.d.ts +139 -0
- package/dist/models/ReleaseResponse.js +114 -0
- package/dist/models/ReleaseType.d.ts +26 -0
- package/dist/models/ReleaseType.js +52 -0
- package/dist/models/ReleasesSort.d.ts +25 -0
- package/dist/models/ReleasesSort.js +51 -0
- package/dist/models/ResponseGetReleases.d.ts +41 -0
- package/dist/models/ResponseGetReleases.js +53 -0
- package/dist/models/ShortDeviceResponse.d.ts +82 -0
- package/dist/models/ShortDeviceResponse.js +80 -0
- package/dist/models/ShortReleaseResponse.d.ts +100 -0
- package/dist/models/ShortReleaseResponse.js +91 -0
- package/dist/models/ValidationError.d.ts +45 -0
- package/dist/models/ValidationError.js +59 -0
- package/dist/models/ValidationErrorLocInner.d.ts +26 -0
- package/dist/models/ValidationErrorLocInner.js +38 -0
- package/dist/models/index.d.ts +20 -0
- package/dist/models/index.js +38 -0
- package/dist/runtime.d.ts +184 -0
- package/dist/runtime.js +350 -0
- package/package.json +4 -17
- package/src/apis/DeviceApi.ts +326 -0
- package/src/apis/PasteApi.ts +158 -0
- package/src/apis/ReleaseApi.ts +414 -0
- package/src/apis/StatsApi.ts +82 -0
- package/src/apis/index.ts +6 -0
- package/src/index.ts +5 -0
- package/src/models/DeviceResponse.ts +171 -0
- package/src/models/GlobalStatsAggregationModel.ts +93 -0
- package/src/models/HTTPValidationError.ts +73 -0
- package/src/models/ListResponseReleaseResponse.ts +82 -0
- package/src/models/ListResponseShortDeviceResponse.ts +82 -0
- package/src/models/ListResponseShortReleaseResponse.ts +82 -0
- package/src/models/ListResponseStr.ts +74 -0
- package/src/models/MaintainerShortModel.ts +84 -0
- package/src/models/PasteInput.ts +91 -0
- package/src/models/PasteOutput.ts +91 -0
- package/src/models/RecoveryImgResponse.ts +75 -0
- package/src/models/ReleaseGroupsResponse.ts +74 -0
- package/src/models/ReleaseResponse.ts +233 -0
- package/src/models/ReleaseType.ts +54 -0
- package/src/models/ReleasesSort.ts +53 -0
- package/src/models/ResponseGetReleases.ts +96 -0
- package/src/models/ShortDeviceResponse.ts +138 -0
- package/src/models/ShortReleaseResponse.ts +174 -0
- package/src/models/ValidationError.ts +92 -0
- package/src/models/ValidationErrorLocInner.ts +46 -0
- package/src/models/index.ts +22 -0
- package/src/runtime.ts +432 -0
- package/tsconfig.json +2 -4
- package/api.ts +0 -2101
- package/base.ts +0 -86
- package/common.ts +0 -150
- package/configuration.ts +0 -115
- package/dist/api.d.ts +0 -1483
- package/dist/api.js +0 -1172
- package/dist/base.d.ts +0 -66
- package/dist/base.js +0 -65
- package/dist/common.d.ts +0 -65
- package/dist/common.js +0 -161
- package/dist/configuration.d.ts +0 -91
- package/dist/configuration.js +0 -44
- package/dist/esm/api.d.ts +0 -1483
- package/dist/esm/api.js +0 -1153
- package/dist/esm/base.d.ts +0 -66
- package/dist/esm/base.js +0 -60
- package/dist/esm/common.d.ts +0 -65
- package/dist/esm/common.js +0 -149
- package/dist/esm/configuration.d.ts +0 -91
- package/dist/esm/configuration.js +0 -40
- package/docs/DeviceApi.md +0 -251
- package/docs/DeviceResponse.md +0 -44
- package/docs/GlobalStatsAggregationModel.md +0 -26
- package/docs/HTTPValidationError.md +0 -20
- package/docs/ListResponseReleaseResponse.md +0 -22
- package/docs/ListResponseShortDeviceResponse.md +0 -22
- package/docs/ListResponseShortReleaseResponse.md +0 -22
- package/docs/ListResponseStr.md +0 -22
- package/docs/MaintainerShortModel.md +0 -26
- package/docs/PasteApi.md +0 -117
- package/docs/PasteInput.md +0 -26
- package/docs/PasteOutput.md +0 -26
- package/docs/RecoveryImgResponse.md +0 -22
- package/docs/ReleaseApi.md +0 -289
- package/docs/ReleaseGroupsResponse.md +0 -20
- package/docs/ReleaseResponse.md +0 -56
- package/docs/ReleaseType.md +0 -12
- package/docs/ReleasesSort.md +0 -10
- package/docs/ResponseGetReleases.md +0 -22
- package/docs/ShortDeviceResponse.md +0 -38
- package/docs/ShortReleaseResponse.md +0 -44
- package/docs/StatsApi.md +0 -53
- package/docs/ValidationError.md +0 -24
- package/docs/ValidationErrorLocInner.md +0 -18
- package/git_push.sh +0 -57
package/api.ts
DELETED
|
@@ -1,2101 +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.6
|
|
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 PasteInput
|
|
270
|
-
*/
|
|
271
|
-
export interface PasteInput {
|
|
272
|
-
/**
|
|
273
|
-
*
|
|
274
|
-
* @type {string}
|
|
275
|
-
* @memberof PasteInput
|
|
276
|
-
*/
|
|
277
|
-
'_id'?: string | null;
|
|
278
|
-
/**
|
|
279
|
-
*
|
|
280
|
-
* @type {string}
|
|
281
|
-
* @memberof PasteInput
|
|
282
|
-
*/
|
|
283
|
-
'content': string;
|
|
284
|
-
/**
|
|
285
|
-
*
|
|
286
|
-
* @type {string}
|
|
287
|
-
* @memberof PasteInput
|
|
288
|
-
*/
|
|
289
|
-
'ip_address': string;
|
|
290
|
-
/**
|
|
291
|
-
*
|
|
292
|
-
* @type {string}
|
|
293
|
-
* @memberof PasteInput
|
|
294
|
-
*/
|
|
295
|
-
'created_at'?: string;
|
|
296
|
-
}
|
|
297
|
-
/**
|
|
298
|
-
*
|
|
299
|
-
* @export
|
|
300
|
-
* @interface PasteOutput
|
|
301
|
-
*/
|
|
302
|
-
export interface PasteOutput {
|
|
303
|
-
/**
|
|
304
|
-
*
|
|
305
|
-
* @type {string}
|
|
306
|
-
* @memberof PasteOutput
|
|
307
|
-
*/
|
|
308
|
-
'_id'?: string | null;
|
|
309
|
-
/**
|
|
310
|
-
*
|
|
311
|
-
* @type {string}
|
|
312
|
-
* @memberof PasteOutput
|
|
313
|
-
*/
|
|
314
|
-
'content': string;
|
|
315
|
-
/**
|
|
316
|
-
*
|
|
317
|
-
* @type {string}
|
|
318
|
-
* @memberof PasteOutput
|
|
319
|
-
*/
|
|
320
|
-
'ip_address': string;
|
|
321
|
-
/**
|
|
322
|
-
*
|
|
323
|
-
* @type {string}
|
|
324
|
-
* @memberof PasteOutput
|
|
325
|
-
*/
|
|
326
|
-
'created_at'?: string;
|
|
327
|
-
}
|
|
328
|
-
/**
|
|
329
|
-
*
|
|
330
|
-
* @export
|
|
331
|
-
* @interface RecoveryImgResponse
|
|
332
|
-
*/
|
|
333
|
-
export interface RecoveryImgResponse {
|
|
334
|
-
/**
|
|
335
|
-
*
|
|
336
|
-
* @type {number}
|
|
337
|
-
* @memberof RecoveryImgResponse
|
|
338
|
-
*/
|
|
339
|
-
'size': number;
|
|
340
|
-
/**
|
|
341
|
-
*
|
|
342
|
-
* @type {string}
|
|
343
|
-
* @memberof RecoveryImgResponse
|
|
344
|
-
*/
|
|
345
|
-
'md5': string;
|
|
346
|
-
}
|
|
347
|
-
/**
|
|
348
|
-
*
|
|
349
|
-
* @export
|
|
350
|
-
* @interface ReleaseGroupsResponse
|
|
351
|
-
*/
|
|
352
|
-
export interface ReleaseGroupsResponse {
|
|
353
|
-
/**
|
|
354
|
-
*
|
|
355
|
-
* @type {{ [key: string]: Array<ReleaseResponse>; }}
|
|
356
|
-
* @memberof ReleaseGroupsResponse
|
|
357
|
-
*/
|
|
358
|
-
'data': { [key: string]: Array<ReleaseResponse>; };
|
|
359
|
-
}
|
|
360
|
-
/**
|
|
361
|
-
*
|
|
362
|
-
* @export
|
|
363
|
-
* @interface ReleaseResponse
|
|
364
|
-
*/
|
|
365
|
-
export interface ReleaseResponse {
|
|
366
|
-
/**
|
|
367
|
-
*
|
|
368
|
-
* @type {string}
|
|
369
|
-
* @memberof ReleaseResponse
|
|
370
|
-
* @deprecated
|
|
371
|
-
*/
|
|
372
|
-
'_id': string;
|
|
373
|
-
/**
|
|
374
|
-
*
|
|
375
|
-
* @type {number}
|
|
376
|
-
* @memberof ReleaseResponse
|
|
377
|
-
* @deprecated
|
|
378
|
-
*/
|
|
379
|
-
'size': number;
|
|
380
|
-
/**
|
|
381
|
-
* Release ID, that\'s how we indentify the release in the infrastructure
|
|
382
|
-
* @type {string}
|
|
383
|
-
* @memberof ReleaseResponse
|
|
384
|
-
*/
|
|
385
|
-
'id': string;
|
|
386
|
-
/**
|
|
387
|
-
*
|
|
388
|
-
* @type {string}
|
|
389
|
-
* @memberof ReleaseResponse
|
|
390
|
-
*/
|
|
391
|
-
'build_id'?: string | null;
|
|
392
|
-
/**
|
|
393
|
-
*
|
|
394
|
-
* @type {string}
|
|
395
|
-
* @memberof ReleaseResponse
|
|
396
|
-
*/
|
|
397
|
-
'filename': string;
|
|
398
|
-
/**
|
|
399
|
-
*
|
|
400
|
-
* @type {string}
|
|
401
|
-
* @memberof ReleaseResponse
|
|
402
|
-
*/
|
|
403
|
-
'variant': string;
|
|
404
|
-
/**
|
|
405
|
-
*
|
|
406
|
-
* @type {string}
|
|
407
|
-
* @memberof ReleaseResponse
|
|
408
|
-
*/
|
|
409
|
-
'device_id': string;
|
|
410
|
-
/**
|
|
411
|
-
*
|
|
412
|
-
* @type {number}
|
|
413
|
-
* @memberof ReleaseResponse
|
|
414
|
-
*/
|
|
415
|
-
'date': number;
|
|
416
|
-
/**
|
|
417
|
-
*
|
|
418
|
-
* @type {string}
|
|
419
|
-
* @memberof ReleaseResponse
|
|
420
|
-
*/
|
|
421
|
-
'md5': string;
|
|
422
|
-
/**
|
|
423
|
-
*
|
|
424
|
-
* @type {string}
|
|
425
|
-
* @memberof ReleaseResponse
|
|
426
|
-
*/
|
|
427
|
-
'version': string;
|
|
428
|
-
/**
|
|
429
|
-
*
|
|
430
|
-
* @type {ReleaseType}
|
|
431
|
-
* @memberof ReleaseResponse
|
|
432
|
-
*/
|
|
433
|
-
'type': ReleaseType;
|
|
434
|
-
/**
|
|
435
|
-
*
|
|
436
|
-
* @type {string}
|
|
437
|
-
* @memberof ReleaseResponse
|
|
438
|
-
*/
|
|
439
|
-
'maintainer_id'?: string | null;
|
|
440
|
-
/**
|
|
441
|
-
*
|
|
442
|
-
* @type {boolean}
|
|
443
|
-
* @memberof ReleaseResponse
|
|
444
|
-
*/
|
|
445
|
-
'archived': boolean;
|
|
446
|
-
/**
|
|
447
|
-
*
|
|
448
|
-
* @type {RecoveryImgResponse}
|
|
449
|
-
* @memberof ReleaseResponse
|
|
450
|
-
*/
|
|
451
|
-
'recovery_img': RecoveryImgResponse;
|
|
452
|
-
/**
|
|
453
|
-
*
|
|
454
|
-
* @type {Array<string>}
|
|
455
|
-
* @memberof ReleaseResponse
|
|
456
|
-
*/
|
|
457
|
-
'changelog': Array<string>;
|
|
458
|
-
/**
|
|
459
|
-
*
|
|
460
|
-
* @type {Array<string>}
|
|
461
|
-
* @memberof ReleaseResponse
|
|
462
|
-
*/
|
|
463
|
-
'bugs': Array<string> | null;
|
|
464
|
-
/**
|
|
465
|
-
*
|
|
466
|
-
* @type {string}
|
|
467
|
-
* @memberof ReleaseResponse
|
|
468
|
-
*/
|
|
469
|
-
'notes': string | null;
|
|
470
|
-
/**
|
|
471
|
-
* URL of the release on the official website
|
|
472
|
-
* @type {string}
|
|
473
|
-
* @memberof ReleaseResponse
|
|
474
|
-
*/
|
|
475
|
-
'url': string;
|
|
476
|
-
/**
|
|
477
|
-
* Mirrors list (deprecated)
|
|
478
|
-
* @type {{ [key: string]: string; }}
|
|
479
|
-
* @memberof ReleaseResponse
|
|
480
|
-
*/
|
|
481
|
-
'mirrors': { [key: string]: string; };
|
|
482
|
-
}
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
/**
|
|
486
|
-
*
|
|
487
|
-
* @export
|
|
488
|
-
* @enum {string}
|
|
489
|
-
*/
|
|
490
|
-
|
|
491
|
-
export const ReleaseType = {
|
|
492
|
-
Stable: 'stable',
|
|
493
|
-
Beta: 'beta',
|
|
494
|
-
Alpha: 'alpha'
|
|
495
|
-
} as const;
|
|
496
|
-
|
|
497
|
-
export type ReleaseType = typeof ReleaseType[keyof typeof ReleaseType];
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
/**
|
|
501
|
-
*
|
|
502
|
-
* @export
|
|
503
|
-
* @enum {string}
|
|
504
|
-
*/
|
|
505
|
-
|
|
506
|
-
export const ReleasesSort = {
|
|
507
|
-
DateAsc: 'date_asc',
|
|
508
|
-
DateDesc: 'date_desc'
|
|
509
|
-
} as const;
|
|
510
|
-
|
|
511
|
-
export type ReleasesSort = typeof ReleasesSort[keyof typeof ReleasesSort];
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
/**
|
|
515
|
-
*
|
|
516
|
-
* @export
|
|
517
|
-
* @interface ResponseGetReleases
|
|
518
|
-
*/
|
|
519
|
-
export interface ResponseGetReleases {
|
|
520
|
-
/**
|
|
521
|
-
*
|
|
522
|
-
* @type {{ [key: string]: Array<ReleaseResponse>; }}
|
|
523
|
-
* @memberof ResponseGetReleases
|
|
524
|
-
*/
|
|
525
|
-
'data': { [key: string]: Array<ReleaseResponse>; };
|
|
526
|
-
/**
|
|
527
|
-
*
|
|
528
|
-
* @type {number}
|
|
529
|
-
* @memberof ResponseGetReleases
|
|
530
|
-
*/
|
|
531
|
-
'count': number;
|
|
532
|
-
}
|
|
533
|
-
/**
|
|
534
|
-
*
|
|
535
|
-
* @export
|
|
536
|
-
* @interface ShortDeviceResponse
|
|
537
|
-
*/
|
|
538
|
-
export interface ShortDeviceResponse {
|
|
539
|
-
/**
|
|
540
|
-
*
|
|
541
|
-
* @type {string}
|
|
542
|
-
* @memberof ShortDeviceResponse
|
|
543
|
-
* @deprecated
|
|
544
|
-
*/
|
|
545
|
-
'_id': string;
|
|
546
|
-
/**
|
|
547
|
-
* Device codename, legacy
|
|
548
|
-
* @type {string}
|
|
549
|
-
* @memberof ShortDeviceResponse
|
|
550
|
-
* @deprecated
|
|
551
|
-
*/
|
|
552
|
-
'codename': string;
|
|
553
|
-
/**
|
|
554
|
-
* Model name of device, does not include the OEM part, legacy
|
|
555
|
-
* @type {string}
|
|
556
|
-
* @memberof ShortDeviceResponse
|
|
557
|
-
* @deprecated
|
|
558
|
-
*/
|
|
559
|
-
'model_name': string;
|
|
560
|
-
/**
|
|
561
|
-
*
|
|
562
|
-
* @type {string}
|
|
563
|
-
* @memberof ShortDeviceResponse
|
|
564
|
-
*/
|
|
565
|
-
'oem_name': string;
|
|
566
|
-
/**
|
|
567
|
-
*
|
|
568
|
-
* @type {string}
|
|
569
|
-
* @memberof ShortDeviceResponse
|
|
570
|
-
*/
|
|
571
|
-
'id': string;
|
|
572
|
-
/**
|
|
573
|
-
*
|
|
574
|
-
* @type {Array<string>}
|
|
575
|
-
* @memberof ShortDeviceResponse
|
|
576
|
-
*/
|
|
577
|
-
'codenames': Array<string>;
|
|
578
|
-
/**
|
|
579
|
-
*
|
|
580
|
-
* @type {Array<string>}
|
|
581
|
-
* @memberof ShortDeviceResponse
|
|
582
|
-
*/
|
|
583
|
-
'model_names': Array<string>;
|
|
584
|
-
/**
|
|
585
|
-
*
|
|
586
|
-
* @type {boolean}
|
|
587
|
-
* @memberof ShortDeviceResponse
|
|
588
|
-
*/
|
|
589
|
-
'supported': boolean;
|
|
590
|
-
/**
|
|
591
|
-
* Full name of device / devices, legacy
|
|
592
|
-
* @type {string}
|
|
593
|
-
* @memberof ShortDeviceResponse
|
|
594
|
-
*/
|
|
595
|
-
'full_name': string;
|
|
596
|
-
/**
|
|
597
|
-
* URL of the device on the official website
|
|
598
|
-
* @type {string}
|
|
599
|
-
* @memberof ShortDeviceResponse
|
|
600
|
-
*/
|
|
601
|
-
'url': string;
|
|
602
|
-
}
|
|
603
|
-
/**
|
|
604
|
-
*
|
|
605
|
-
* @export
|
|
606
|
-
* @interface ShortReleaseResponse
|
|
607
|
-
*/
|
|
608
|
-
export interface ShortReleaseResponse {
|
|
609
|
-
/**
|
|
610
|
-
*
|
|
611
|
-
* @type {string}
|
|
612
|
-
* @memberof ShortReleaseResponse
|
|
613
|
-
* @deprecated
|
|
614
|
-
*/
|
|
615
|
-
'_id': string;
|
|
616
|
-
/**
|
|
617
|
-
*
|
|
618
|
-
* @type {number}
|
|
619
|
-
* @memberof ShortReleaseResponse
|
|
620
|
-
* @deprecated
|
|
621
|
-
*/
|
|
622
|
-
'size': number;
|
|
623
|
-
/**
|
|
624
|
-
* Release ID, that\'s how we indentify the release in the infrastructure
|
|
625
|
-
* @type {string}
|
|
626
|
-
* @memberof ShortReleaseResponse
|
|
627
|
-
*/
|
|
628
|
-
'id': string;
|
|
629
|
-
/**
|
|
630
|
-
*
|
|
631
|
-
* @type {string}
|
|
632
|
-
* @memberof ShortReleaseResponse
|
|
633
|
-
*/
|
|
634
|
-
'build_id'?: string | null;
|
|
635
|
-
/**
|
|
636
|
-
*
|
|
637
|
-
* @type {string}
|
|
638
|
-
* @memberof ShortReleaseResponse
|
|
639
|
-
*/
|
|
640
|
-
'filename': string;
|
|
641
|
-
/**
|
|
642
|
-
*
|
|
643
|
-
* @type {string}
|
|
644
|
-
* @memberof ShortReleaseResponse
|
|
645
|
-
*/
|
|
646
|
-
'variant': string;
|
|
647
|
-
/**
|
|
648
|
-
*
|
|
649
|
-
* @type {string}
|
|
650
|
-
* @memberof ShortReleaseResponse
|
|
651
|
-
*/
|
|
652
|
-
'device_id': string;
|
|
653
|
-
/**
|
|
654
|
-
*
|
|
655
|
-
* @type {number}
|
|
656
|
-
* @memberof ShortReleaseResponse
|
|
657
|
-
*/
|
|
658
|
-
'date': number;
|
|
659
|
-
/**
|
|
660
|
-
*
|
|
661
|
-
* @type {string}
|
|
662
|
-
* @memberof ShortReleaseResponse
|
|
663
|
-
*/
|
|
664
|
-
'md5': string;
|
|
665
|
-
/**
|
|
666
|
-
*
|
|
667
|
-
* @type {string}
|
|
668
|
-
* @memberof ShortReleaseResponse
|
|
669
|
-
*/
|
|
670
|
-
'version': string;
|
|
671
|
-
/**
|
|
672
|
-
*
|
|
673
|
-
* @type {ReleaseType}
|
|
674
|
-
* @memberof ShortReleaseResponse
|
|
675
|
-
*/
|
|
676
|
-
'type': ReleaseType;
|
|
677
|
-
/**
|
|
678
|
-
*
|
|
679
|
-
* @type {string}
|
|
680
|
-
* @memberof ShortReleaseResponse
|
|
681
|
-
*/
|
|
682
|
-
'maintainer_id'?: string | null;
|
|
683
|
-
/**
|
|
684
|
-
*
|
|
685
|
-
* @type {boolean}
|
|
686
|
-
* @memberof ShortReleaseResponse
|
|
687
|
-
*/
|
|
688
|
-
'archived': boolean;
|
|
689
|
-
}
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
/**
|
|
693
|
-
*
|
|
694
|
-
* @export
|
|
695
|
-
* @interface ValidationError
|
|
696
|
-
*/
|
|
697
|
-
export interface ValidationError {
|
|
698
|
-
/**
|
|
699
|
-
*
|
|
700
|
-
* @type {Array<ValidationErrorLocInner>}
|
|
701
|
-
* @memberof ValidationError
|
|
702
|
-
*/
|
|
703
|
-
'loc': Array<ValidationErrorLocInner>;
|
|
704
|
-
/**
|
|
705
|
-
*
|
|
706
|
-
* @type {string}
|
|
707
|
-
* @memberof ValidationError
|
|
708
|
-
*/
|
|
709
|
-
'msg': string;
|
|
710
|
-
/**
|
|
711
|
-
*
|
|
712
|
-
* @type {string}
|
|
713
|
-
* @memberof ValidationError
|
|
714
|
-
*/
|
|
715
|
-
'type': string;
|
|
716
|
-
}
|
|
717
|
-
/**
|
|
718
|
-
*
|
|
719
|
-
* @export
|
|
720
|
-
* @interface ValidationErrorLocInner
|
|
721
|
-
*/
|
|
722
|
-
export interface ValidationErrorLocInner {
|
|
723
|
-
}
|
|
724
|
-
|
|
725
|
-
/**
|
|
726
|
-
* DeviceApi - axios parameter creator
|
|
727
|
-
* @export
|
|
728
|
-
*/
|
|
729
|
-
export const DeviceApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
730
|
-
return {
|
|
731
|
-
/**
|
|
732
|
-
* 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.
|
|
733
|
-
* @summary Get Device
|
|
734
|
-
* @param {string | null} [deviceId]
|
|
735
|
-
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
736
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
737
|
-
* @param {*} [options] Override http request option.
|
|
738
|
-
* @throws {RequiredError}
|
|
739
|
-
*/
|
|
740
|
-
getDevice: async (deviceId?: string | null, id?: string | null, codename?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
741
|
-
const localVarPath = `/devices/get`;
|
|
742
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
743
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
744
|
-
let baseOptions;
|
|
745
|
-
if (configuration) {
|
|
746
|
-
baseOptions = configuration.baseOptions;
|
|
747
|
-
}
|
|
748
|
-
|
|
749
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
750
|
-
const localVarHeaderParameter = {} as any;
|
|
751
|
-
const localVarQueryParameter = {} as any;
|
|
752
|
-
|
|
753
|
-
if (deviceId !== undefined) {
|
|
754
|
-
localVarQueryParameter['device_id'] = deviceId;
|
|
755
|
-
}
|
|
756
|
-
|
|
757
|
-
if (id !== undefined) {
|
|
758
|
-
localVarQueryParameter['_id'] = id;
|
|
759
|
-
}
|
|
760
|
-
|
|
761
|
-
if (codename !== undefined) {
|
|
762
|
-
localVarQueryParameter['codename'] = codename;
|
|
763
|
-
}
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
768
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
769
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
770
|
-
|
|
771
|
-
return {
|
|
772
|
-
url: toPathString(localVarUrlObj),
|
|
773
|
-
options: localVarRequestOptions,
|
|
774
|
-
};
|
|
775
|
-
},
|
|
776
|
-
/**
|
|
777
|
-
* Gets device info using device ID.
|
|
778
|
-
* @summary Get Device Short
|
|
779
|
-
* @param {string} deviceId
|
|
780
|
-
* @param {*} [options] Override http request option.
|
|
781
|
-
* @deprecated
|
|
782
|
-
* @throws {RequiredError}
|
|
783
|
-
*/
|
|
784
|
-
getDeviceDeprecated: async (deviceId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
785
|
-
// verify required parameter 'deviceId' is not null or undefined
|
|
786
|
-
assertParamExists('getDeviceDeprecated', 'deviceId', deviceId)
|
|
787
|
-
const localVarPath = `/devices/{device_id}`
|
|
788
|
-
.replace(`{${"device_id"}}`, encodeURIComponent(String(deviceId)));
|
|
789
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
790
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
791
|
-
let baseOptions;
|
|
792
|
-
if (configuration) {
|
|
793
|
-
baseOptions = configuration.baseOptions;
|
|
794
|
-
}
|
|
795
|
-
|
|
796
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
797
|
-
const localVarHeaderParameter = {} as any;
|
|
798
|
-
const localVarQueryParameter = {} as any;
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
803
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
804
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
805
|
-
|
|
806
|
-
return {
|
|
807
|
-
url: toPathString(localVarUrlObj),
|
|
808
|
-
options: localVarRequestOptions,
|
|
809
|
-
};
|
|
810
|
-
},
|
|
811
|
-
/**
|
|
812
|
-
* 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.
|
|
813
|
-
* @summary Get Devices
|
|
814
|
-
* @param {Array<string>} [id] Filter by Device IDs
|
|
815
|
-
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
816
|
-
* @param {Array<string>} [oemName] Filter by OEM names
|
|
817
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
818
|
-
* @param {Array<string>} [modelName] Filter by model names
|
|
819
|
-
* @param {boolean | null} [supported] Supported status
|
|
820
|
-
* @param {Array<string>} [maintainer] Filter by maintainer ID
|
|
821
|
-
* @param {boolean | null} [freezed] Filter by Freezed status
|
|
822
|
-
* @param {boolean | null} [hasReleases] Filter by has releases status
|
|
823
|
-
* @param {number | null} [skip] Skip query results
|
|
824
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
825
|
-
* @param {*} [options] Override http request option.
|
|
826
|
-
* @throws {RequiredError}
|
|
827
|
-
*/
|
|
828
|
-
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> => {
|
|
829
|
-
const localVarPath = `/devices/`;
|
|
830
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
831
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
832
|
-
let baseOptions;
|
|
833
|
-
if (configuration) {
|
|
834
|
-
baseOptions = configuration.baseOptions;
|
|
835
|
-
}
|
|
836
|
-
|
|
837
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
838
|
-
const localVarHeaderParameter = {} as any;
|
|
839
|
-
const localVarQueryParameter = {} as any;
|
|
840
|
-
|
|
841
|
-
if (id) {
|
|
842
|
-
localVarQueryParameter['id'] = id;
|
|
843
|
-
}
|
|
844
|
-
|
|
845
|
-
if (id2) {
|
|
846
|
-
localVarQueryParameter['_id'] = id2;
|
|
847
|
-
}
|
|
848
|
-
|
|
849
|
-
if (oemName) {
|
|
850
|
-
localVarQueryParameter['oem_name'] = oemName;
|
|
851
|
-
}
|
|
852
|
-
|
|
853
|
-
if (codename) {
|
|
854
|
-
localVarQueryParameter['codename'] = codename;
|
|
855
|
-
}
|
|
856
|
-
|
|
857
|
-
if (modelName) {
|
|
858
|
-
localVarQueryParameter['model_name'] = modelName;
|
|
859
|
-
}
|
|
860
|
-
|
|
861
|
-
if (supported !== undefined) {
|
|
862
|
-
localVarQueryParameter['supported'] = supported;
|
|
863
|
-
}
|
|
864
|
-
|
|
865
|
-
if (maintainer) {
|
|
866
|
-
localVarQueryParameter['maintainer'] = maintainer;
|
|
867
|
-
}
|
|
868
|
-
|
|
869
|
-
if (freezed !== undefined) {
|
|
870
|
-
localVarQueryParameter['freezed'] = freezed;
|
|
871
|
-
}
|
|
872
|
-
|
|
873
|
-
if (hasReleases !== undefined) {
|
|
874
|
-
localVarQueryParameter['has_releases'] = hasReleases;
|
|
875
|
-
}
|
|
876
|
-
|
|
877
|
-
if (skip !== undefined) {
|
|
878
|
-
localVarQueryParameter['skip'] = skip;
|
|
879
|
-
}
|
|
880
|
-
|
|
881
|
-
if (limit !== undefined) {
|
|
882
|
-
localVarQueryParameter['limit'] = limit;
|
|
883
|
-
}
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
888
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
889
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
890
|
-
|
|
891
|
-
return {
|
|
892
|
-
url: toPathString(localVarUrlObj),
|
|
893
|
-
options: localVarRequestOptions,
|
|
894
|
-
};
|
|
895
|
-
},
|
|
896
|
-
/**
|
|
897
|
-
* Lists all OEM names
|
|
898
|
-
* @summary Get Oems
|
|
899
|
-
* @param {*} [options] Override http request option.
|
|
900
|
-
* @throws {RequiredError}
|
|
901
|
-
*/
|
|
902
|
-
getOems: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
903
|
-
const localVarPath = `/oems/`;
|
|
904
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
905
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
906
|
-
let baseOptions;
|
|
907
|
-
if (configuration) {
|
|
908
|
-
baseOptions = configuration.baseOptions;
|
|
909
|
-
}
|
|
910
|
-
|
|
911
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
912
|
-
const localVarHeaderParameter = {} as any;
|
|
913
|
-
const localVarQueryParameter = {} as any;
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
918
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
919
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
920
|
-
|
|
921
|
-
return {
|
|
922
|
-
url: toPathString(localVarUrlObj),
|
|
923
|
-
options: localVarRequestOptions,
|
|
924
|
-
};
|
|
925
|
-
},
|
|
926
|
-
}
|
|
927
|
-
};
|
|
928
|
-
|
|
929
|
-
/**
|
|
930
|
-
* DeviceApi - functional programming interface
|
|
931
|
-
* @export
|
|
932
|
-
*/
|
|
933
|
-
export const DeviceApiFp = function(configuration?: Configuration) {
|
|
934
|
-
const localVarAxiosParamCreator = DeviceApiAxiosParamCreator(configuration)
|
|
935
|
-
return {
|
|
936
|
-
/**
|
|
937
|
-
* 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.
|
|
938
|
-
* @summary Get Device
|
|
939
|
-
* @param {string | null} [deviceId]
|
|
940
|
-
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
941
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
942
|
-
* @param {*} [options] Override http request option.
|
|
943
|
-
* @throws {RequiredError}
|
|
944
|
-
*/
|
|
945
|
-
async getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>> {
|
|
946
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDevice(deviceId, id, codename, options);
|
|
947
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
948
|
-
const localVarOperationServerBasePath = operationServerMap['DeviceApi.getDevice']?.[localVarOperationServerIndex]?.url;
|
|
949
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
950
|
-
},
|
|
951
|
-
/**
|
|
952
|
-
* Gets device info using device ID.
|
|
953
|
-
* @summary Get Device Short
|
|
954
|
-
* @param {string} deviceId
|
|
955
|
-
* @param {*} [options] Override http request option.
|
|
956
|
-
* @deprecated
|
|
957
|
-
* @throws {RequiredError}
|
|
958
|
-
*/
|
|
959
|
-
async getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>> {
|
|
960
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDeviceDeprecated(deviceId, options);
|
|
961
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
962
|
-
const localVarOperationServerBasePath = operationServerMap['DeviceApi.getDeviceDeprecated']?.[localVarOperationServerIndex]?.url;
|
|
963
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
964
|
-
},
|
|
965
|
-
/**
|
|
966
|
-
* 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.
|
|
967
|
-
* @summary Get Devices
|
|
968
|
-
* @param {Array<string>} [id] Filter by Device IDs
|
|
969
|
-
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
970
|
-
* @param {Array<string>} [oemName] Filter by OEM names
|
|
971
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
972
|
-
* @param {Array<string>} [modelName] Filter by model names
|
|
973
|
-
* @param {boolean | null} [supported] Supported status
|
|
974
|
-
* @param {Array<string>} [maintainer] Filter by maintainer ID
|
|
975
|
-
* @param {boolean | null} [freezed] Filter by Freezed status
|
|
976
|
-
* @param {boolean | null} [hasReleases] Filter by has releases status
|
|
977
|
-
* @param {number | null} [skip] Skip query results
|
|
978
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
979
|
-
* @param {*} [options] Override http request option.
|
|
980
|
-
* @throws {RequiredError}
|
|
981
|
-
*/
|
|
982
|
-
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>> {
|
|
983
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options);
|
|
984
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
985
|
-
const localVarOperationServerBasePath = operationServerMap['DeviceApi.getDevices']?.[localVarOperationServerIndex]?.url;
|
|
986
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
987
|
-
},
|
|
988
|
-
/**
|
|
989
|
-
* Lists all OEM names
|
|
990
|
-
* @summary Get Oems
|
|
991
|
-
* @param {*} [options] Override http request option.
|
|
992
|
-
* @throws {RequiredError}
|
|
993
|
-
*/
|
|
994
|
-
async getOems(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseStr>> {
|
|
995
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getOems(options);
|
|
996
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
997
|
-
const localVarOperationServerBasePath = operationServerMap['DeviceApi.getOems']?.[localVarOperationServerIndex]?.url;
|
|
998
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
999
|
-
},
|
|
1000
|
-
}
|
|
1001
|
-
};
|
|
1002
|
-
|
|
1003
|
-
/**
|
|
1004
|
-
* DeviceApi - factory interface
|
|
1005
|
-
* @export
|
|
1006
|
-
*/
|
|
1007
|
-
export const DeviceApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1008
|
-
const localVarFp = DeviceApiFp(configuration)
|
|
1009
|
-
return {
|
|
1010
|
-
/**
|
|
1011
|
-
* 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.
|
|
1012
|
-
* @summary Get Device
|
|
1013
|
-
* @param {string | null} [deviceId]
|
|
1014
|
-
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
1015
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
1016
|
-
* @param {*} [options] Override http request option.
|
|
1017
|
-
* @throws {RequiredError}
|
|
1018
|
-
*/
|
|
1019
|
-
getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse> {
|
|
1020
|
-
return localVarFp.getDevice(deviceId, id, codename, options).then((request) => request(axios, basePath));
|
|
1021
|
-
},
|
|
1022
|
-
/**
|
|
1023
|
-
* Gets device info using device ID.
|
|
1024
|
-
* @summary Get Device Short
|
|
1025
|
-
* @param {string} deviceId
|
|
1026
|
-
* @param {*} [options] Override http request option.
|
|
1027
|
-
* @deprecated
|
|
1028
|
-
* @throws {RequiredError}
|
|
1029
|
-
*/
|
|
1030
|
-
getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse> {
|
|
1031
|
-
return localVarFp.getDeviceDeprecated(deviceId, options).then((request) => request(axios, basePath));
|
|
1032
|
-
},
|
|
1033
|
-
/**
|
|
1034
|
-
* 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.
|
|
1035
|
-
* @summary Get Devices
|
|
1036
|
-
* @param {Array<string>} [id] Filter by Device IDs
|
|
1037
|
-
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
1038
|
-
* @param {Array<string>} [oemName] Filter by OEM names
|
|
1039
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
1040
|
-
* @param {Array<string>} [modelName] Filter by model names
|
|
1041
|
-
* @param {boolean | null} [supported] Supported status
|
|
1042
|
-
* @param {Array<string>} [maintainer] Filter by maintainer ID
|
|
1043
|
-
* @param {boolean | null} [freezed] Filter by Freezed status
|
|
1044
|
-
* @param {boolean | null} [hasReleases] Filter by has releases status
|
|
1045
|
-
* @param {number | null} [skip] Skip query results
|
|
1046
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1047
|
-
* @param {*} [options] Override http request option.
|
|
1048
|
-
* @throws {RequiredError}
|
|
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
|
-
return localVarFp.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(axios, basePath));
|
|
1052
|
-
},
|
|
1053
|
-
/**
|
|
1054
|
-
* Lists all OEM names
|
|
1055
|
-
* @summary Get Oems
|
|
1056
|
-
* @param {*} [options] Override http request option.
|
|
1057
|
-
* @throws {RequiredError}
|
|
1058
|
-
*/
|
|
1059
|
-
getOems(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseStr> {
|
|
1060
|
-
return localVarFp.getOems(options).then((request) => request(axios, basePath));
|
|
1061
|
-
},
|
|
1062
|
-
};
|
|
1063
|
-
};
|
|
1064
|
-
|
|
1065
|
-
/**
|
|
1066
|
-
* DeviceApi - interface
|
|
1067
|
-
* @export
|
|
1068
|
-
* @interface DeviceApi
|
|
1069
|
-
*/
|
|
1070
|
-
export interface DeviceApiInterface {
|
|
1071
|
-
/**
|
|
1072
|
-
* 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.
|
|
1073
|
-
* @summary Get Device
|
|
1074
|
-
* @param {string | null} [deviceId]
|
|
1075
|
-
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
1076
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
1077
|
-
* @param {*} [options] Override http request option.
|
|
1078
|
-
* @throws {RequiredError}
|
|
1079
|
-
* @memberof DeviceApiInterface
|
|
1080
|
-
*/
|
|
1081
|
-
getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
|
|
1082
|
-
|
|
1083
|
-
/**
|
|
1084
|
-
* Gets device info using device ID.
|
|
1085
|
-
* @summary Get Device Short
|
|
1086
|
-
* @param {string} deviceId
|
|
1087
|
-
* @param {*} [options] Override http request option.
|
|
1088
|
-
* @deprecated
|
|
1089
|
-
* @throws {RequiredError}
|
|
1090
|
-
* @memberof DeviceApiInterface
|
|
1091
|
-
*/
|
|
1092
|
-
getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
|
|
1093
|
-
|
|
1094
|
-
/**
|
|
1095
|
-
* 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.
|
|
1096
|
-
* @summary Get Devices
|
|
1097
|
-
* @param {Array<string>} [id] Filter by Device IDs
|
|
1098
|
-
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
1099
|
-
* @param {Array<string>} [oemName] Filter by OEM names
|
|
1100
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
1101
|
-
* @param {Array<string>} [modelName] Filter by model names
|
|
1102
|
-
* @param {boolean | null} [supported] Supported status
|
|
1103
|
-
* @param {Array<string>} [maintainer] Filter by maintainer ID
|
|
1104
|
-
* @param {boolean | null} [freezed] Filter by Freezed status
|
|
1105
|
-
* @param {boolean | null} [hasReleases] Filter by has releases status
|
|
1106
|
-
* @param {number | null} [skip] Skip query results
|
|
1107
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1108
|
-
* @param {*} [options] Override http request option.
|
|
1109
|
-
* @throws {RequiredError}
|
|
1110
|
-
* @memberof DeviceApiInterface
|
|
1111
|
-
*/
|
|
1112
|
-
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>;
|
|
1113
|
-
|
|
1114
|
-
/**
|
|
1115
|
-
* Lists all OEM names
|
|
1116
|
-
* @summary Get Oems
|
|
1117
|
-
* @param {*} [options] Override http request option.
|
|
1118
|
-
* @throws {RequiredError}
|
|
1119
|
-
* @memberof DeviceApiInterface
|
|
1120
|
-
*/
|
|
1121
|
-
getOems(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseStr>;
|
|
1122
|
-
|
|
1123
|
-
}
|
|
1124
|
-
|
|
1125
|
-
/**
|
|
1126
|
-
* DeviceApi - object-oriented interface
|
|
1127
|
-
* @export
|
|
1128
|
-
* @class DeviceApi
|
|
1129
|
-
* @extends {BaseAPI}
|
|
1130
|
-
*/
|
|
1131
|
-
export class DeviceApi extends BaseAPI implements DeviceApiInterface {
|
|
1132
|
-
/**
|
|
1133
|
-
* 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.
|
|
1134
|
-
* @summary Get Device
|
|
1135
|
-
* @param {string | null} [deviceId]
|
|
1136
|
-
* @param {string | null} [id] Filter by Device ID (deprecated)
|
|
1137
|
-
* @param {string | null} [codename] Not recommended to use when you can
|
|
1138
|
-
* @param {*} [options] Override http request option.
|
|
1139
|
-
* @throws {RequiredError}
|
|
1140
|
-
* @memberof DeviceApi
|
|
1141
|
-
*/
|
|
1142
|
-
public getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig) {
|
|
1143
|
-
return DeviceApiFp(this.configuration).getDevice(deviceId, id, codename, options).then((request) => request(this.axios, this.basePath));
|
|
1144
|
-
}
|
|
1145
|
-
|
|
1146
|
-
/**
|
|
1147
|
-
* Gets device info using device ID.
|
|
1148
|
-
* @summary Get Device Short
|
|
1149
|
-
* @param {string} deviceId
|
|
1150
|
-
* @param {*} [options] Override http request option.
|
|
1151
|
-
* @deprecated
|
|
1152
|
-
* @throws {RequiredError}
|
|
1153
|
-
* @memberof DeviceApi
|
|
1154
|
-
*/
|
|
1155
|
-
public getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig) {
|
|
1156
|
-
return DeviceApiFp(this.configuration).getDeviceDeprecated(deviceId, options).then((request) => request(this.axios, this.basePath));
|
|
1157
|
-
}
|
|
1158
|
-
|
|
1159
|
-
/**
|
|
1160
|
-
* 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.
|
|
1161
|
-
* @summary Get Devices
|
|
1162
|
-
* @param {Array<string>} [id] Filter by Device IDs
|
|
1163
|
-
* @param {Array<string>} [id2] Filter by Device IDs (deprecated)
|
|
1164
|
-
* @param {Array<string>} [oemName] Filter by OEM names
|
|
1165
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
1166
|
-
* @param {Array<string>} [modelName] Filter by model names
|
|
1167
|
-
* @param {boolean | null} [supported] Supported status
|
|
1168
|
-
* @param {Array<string>} [maintainer] Filter by maintainer ID
|
|
1169
|
-
* @param {boolean | null} [freezed] Filter by Freezed status
|
|
1170
|
-
* @param {boolean | null} [hasReleases] Filter by has releases status
|
|
1171
|
-
* @param {number | null} [skip] Skip query results
|
|
1172
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1173
|
-
* @param {*} [options] Override http request option.
|
|
1174
|
-
* @throws {RequiredError}
|
|
1175
|
-
* @memberof DeviceApi
|
|
1176
|
-
*/
|
|
1177
|
-
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) {
|
|
1178
|
-
return DeviceApiFp(this.configuration).getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1179
|
-
}
|
|
1180
|
-
|
|
1181
|
-
/**
|
|
1182
|
-
* Lists all OEM names
|
|
1183
|
-
* @summary Get Oems
|
|
1184
|
-
* @param {*} [options] Override http request option.
|
|
1185
|
-
* @throws {RequiredError}
|
|
1186
|
-
* @memberof DeviceApi
|
|
1187
|
-
*/
|
|
1188
|
-
public getOems(options?: RawAxiosRequestConfig) {
|
|
1189
|
-
return DeviceApiFp(this.configuration).getOems(options).then((request) => request(this.axios, this.basePath));
|
|
1190
|
-
}
|
|
1191
|
-
}
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
/**
|
|
1196
|
-
* PasteApi - axios parameter creator
|
|
1197
|
-
* @export
|
|
1198
|
-
*/
|
|
1199
|
-
export const PasteApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1200
|
-
return {
|
|
1201
|
-
/**
|
|
1202
|
-
* Create a new paste.
|
|
1203
|
-
* @summary Create Paste
|
|
1204
|
-
* @param {PasteInput} pasteInput
|
|
1205
|
-
* @param {*} [options] Override http request option.
|
|
1206
|
-
* @throws {RequiredError}
|
|
1207
|
-
*/
|
|
1208
|
-
createPastePastePost: async (pasteInput: PasteInput, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1209
|
-
// verify required parameter 'pasteInput' is not null or undefined
|
|
1210
|
-
assertParamExists('createPastePastePost', 'pasteInput', pasteInput)
|
|
1211
|
-
const localVarPath = `/paste/`;
|
|
1212
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1213
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1214
|
-
let baseOptions;
|
|
1215
|
-
if (configuration) {
|
|
1216
|
-
baseOptions = configuration.baseOptions;
|
|
1217
|
-
}
|
|
1218
|
-
|
|
1219
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1220
|
-
const localVarHeaderParameter = {} as any;
|
|
1221
|
-
const localVarQueryParameter = {} as any;
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1226
|
-
|
|
1227
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1228
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1229
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1230
|
-
localVarRequestOptions.data = serializeDataIfNeeded(pasteInput, localVarRequestOptions, configuration)
|
|
1231
|
-
|
|
1232
|
-
return {
|
|
1233
|
-
url: toPathString(localVarUrlObj),
|
|
1234
|
-
options: localVarRequestOptions,
|
|
1235
|
-
};
|
|
1236
|
-
},
|
|
1237
|
-
/**
|
|
1238
|
-
* Get a paste by ID.
|
|
1239
|
-
* @summary Get Paste
|
|
1240
|
-
* @param {string} pasteId
|
|
1241
|
-
* @param {*} [options] Override http request option.
|
|
1242
|
-
* @throws {RequiredError}
|
|
1243
|
-
*/
|
|
1244
|
-
getPastePastePasteIdGet: async (pasteId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1245
|
-
// verify required parameter 'pasteId' is not null or undefined
|
|
1246
|
-
assertParamExists('getPastePastePasteIdGet', 'pasteId', pasteId)
|
|
1247
|
-
const localVarPath = `/paste/{paste_id}`
|
|
1248
|
-
.replace(`{${"paste_id"}}`, encodeURIComponent(String(pasteId)));
|
|
1249
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1250
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1251
|
-
let baseOptions;
|
|
1252
|
-
if (configuration) {
|
|
1253
|
-
baseOptions = configuration.baseOptions;
|
|
1254
|
-
}
|
|
1255
|
-
|
|
1256
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1257
|
-
const localVarHeaderParameter = {} as any;
|
|
1258
|
-
const localVarQueryParameter = {} as any;
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1263
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1264
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1265
|
-
|
|
1266
|
-
return {
|
|
1267
|
-
url: toPathString(localVarUrlObj),
|
|
1268
|
-
options: localVarRequestOptions,
|
|
1269
|
-
};
|
|
1270
|
-
},
|
|
1271
|
-
}
|
|
1272
|
-
};
|
|
1273
|
-
|
|
1274
|
-
/**
|
|
1275
|
-
* PasteApi - functional programming interface
|
|
1276
|
-
* @export
|
|
1277
|
-
*/
|
|
1278
|
-
export const PasteApiFp = function(configuration?: Configuration) {
|
|
1279
|
-
const localVarAxiosParamCreator = PasteApiAxiosParamCreator(configuration)
|
|
1280
|
-
return {
|
|
1281
|
-
/**
|
|
1282
|
-
* Create a new paste.
|
|
1283
|
-
* @summary Create Paste
|
|
1284
|
-
* @param {PasteInput} pasteInput
|
|
1285
|
-
* @param {*} [options] Override http request option.
|
|
1286
|
-
* @throws {RequiredError}
|
|
1287
|
-
*/
|
|
1288
|
-
async createPastePastePost(pasteInput: PasteInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasteOutput>> {
|
|
1289
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createPastePastePost(pasteInput, options);
|
|
1290
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1291
|
-
const localVarOperationServerBasePath = operationServerMap['PasteApi.createPastePastePost']?.[localVarOperationServerIndex]?.url;
|
|
1292
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1293
|
-
},
|
|
1294
|
-
/**
|
|
1295
|
-
* Get a paste by ID.
|
|
1296
|
-
* @summary Get Paste
|
|
1297
|
-
* @param {string} pasteId
|
|
1298
|
-
* @param {*} [options] Override http request option.
|
|
1299
|
-
* @throws {RequiredError}
|
|
1300
|
-
*/
|
|
1301
|
-
async getPastePastePasteIdGet(pasteId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasteOutput>> {
|
|
1302
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPastePastePasteIdGet(pasteId, options);
|
|
1303
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1304
|
-
const localVarOperationServerBasePath = operationServerMap['PasteApi.getPastePastePasteIdGet']?.[localVarOperationServerIndex]?.url;
|
|
1305
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1306
|
-
},
|
|
1307
|
-
}
|
|
1308
|
-
};
|
|
1309
|
-
|
|
1310
|
-
/**
|
|
1311
|
-
* PasteApi - factory interface
|
|
1312
|
-
* @export
|
|
1313
|
-
*/
|
|
1314
|
-
export const PasteApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1315
|
-
const localVarFp = PasteApiFp(configuration)
|
|
1316
|
-
return {
|
|
1317
|
-
/**
|
|
1318
|
-
* Create a new paste.
|
|
1319
|
-
* @summary Create Paste
|
|
1320
|
-
* @param {PasteInput} pasteInput
|
|
1321
|
-
* @param {*} [options] Override http request option.
|
|
1322
|
-
* @throws {RequiredError}
|
|
1323
|
-
*/
|
|
1324
|
-
createPastePastePost(pasteInput: PasteInput, options?: RawAxiosRequestConfig): AxiosPromise<PasteOutput> {
|
|
1325
|
-
return localVarFp.createPastePastePost(pasteInput, options).then((request) => request(axios, basePath));
|
|
1326
|
-
},
|
|
1327
|
-
/**
|
|
1328
|
-
* Get a paste by ID.
|
|
1329
|
-
* @summary Get Paste
|
|
1330
|
-
* @param {string} pasteId
|
|
1331
|
-
* @param {*} [options] Override http request option.
|
|
1332
|
-
* @throws {RequiredError}
|
|
1333
|
-
*/
|
|
1334
|
-
getPastePastePasteIdGet(pasteId: string, options?: RawAxiosRequestConfig): AxiosPromise<PasteOutput> {
|
|
1335
|
-
return localVarFp.getPastePastePasteIdGet(pasteId, options).then((request) => request(axios, basePath));
|
|
1336
|
-
},
|
|
1337
|
-
};
|
|
1338
|
-
};
|
|
1339
|
-
|
|
1340
|
-
/**
|
|
1341
|
-
* PasteApi - interface
|
|
1342
|
-
* @export
|
|
1343
|
-
* @interface PasteApi
|
|
1344
|
-
*/
|
|
1345
|
-
export interface PasteApiInterface {
|
|
1346
|
-
/**
|
|
1347
|
-
* Create a new paste.
|
|
1348
|
-
* @summary Create Paste
|
|
1349
|
-
* @param {PasteInput} pasteInput
|
|
1350
|
-
* @param {*} [options] Override http request option.
|
|
1351
|
-
* @throws {RequiredError}
|
|
1352
|
-
* @memberof PasteApiInterface
|
|
1353
|
-
*/
|
|
1354
|
-
createPastePastePost(pasteInput: PasteInput, options?: RawAxiosRequestConfig): AxiosPromise<PasteOutput>;
|
|
1355
|
-
|
|
1356
|
-
/**
|
|
1357
|
-
* Get a paste by ID.
|
|
1358
|
-
* @summary Get Paste
|
|
1359
|
-
* @param {string} pasteId
|
|
1360
|
-
* @param {*} [options] Override http request option.
|
|
1361
|
-
* @throws {RequiredError}
|
|
1362
|
-
* @memberof PasteApiInterface
|
|
1363
|
-
*/
|
|
1364
|
-
getPastePastePasteIdGet(pasteId: string, options?: RawAxiosRequestConfig): AxiosPromise<PasteOutput>;
|
|
1365
|
-
|
|
1366
|
-
}
|
|
1367
|
-
|
|
1368
|
-
/**
|
|
1369
|
-
* PasteApi - object-oriented interface
|
|
1370
|
-
* @export
|
|
1371
|
-
* @class PasteApi
|
|
1372
|
-
* @extends {BaseAPI}
|
|
1373
|
-
*/
|
|
1374
|
-
export class PasteApi extends BaseAPI implements PasteApiInterface {
|
|
1375
|
-
/**
|
|
1376
|
-
* Create a new paste.
|
|
1377
|
-
* @summary Create Paste
|
|
1378
|
-
* @param {PasteInput} pasteInput
|
|
1379
|
-
* @param {*} [options] Override http request option.
|
|
1380
|
-
* @throws {RequiredError}
|
|
1381
|
-
* @memberof PasteApi
|
|
1382
|
-
*/
|
|
1383
|
-
public createPastePastePost(pasteInput: PasteInput, options?: RawAxiosRequestConfig) {
|
|
1384
|
-
return PasteApiFp(this.configuration).createPastePastePost(pasteInput, options).then((request) => request(this.axios, this.basePath));
|
|
1385
|
-
}
|
|
1386
|
-
|
|
1387
|
-
/**
|
|
1388
|
-
* Get a paste by ID.
|
|
1389
|
-
* @summary Get Paste
|
|
1390
|
-
* @param {string} pasteId
|
|
1391
|
-
* @param {*} [options] Override http request option.
|
|
1392
|
-
* @throws {RequiredError}
|
|
1393
|
-
* @memberof PasteApi
|
|
1394
|
-
*/
|
|
1395
|
-
public getPastePastePasteIdGet(pasteId: string, options?: RawAxiosRequestConfig) {
|
|
1396
|
-
return PasteApiFp(this.configuration).getPastePastePasteIdGet(pasteId, options).then((request) => request(this.axios, this.basePath));
|
|
1397
|
-
}
|
|
1398
|
-
}
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
/**
|
|
1403
|
-
* ReleaseApi - axios parameter creator
|
|
1404
|
-
* @export
|
|
1405
|
-
*/
|
|
1406
|
-
export const ReleaseApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1407
|
-
return {
|
|
1408
|
-
/**
|
|
1409
|
-
* 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!
|
|
1410
|
-
* @summary Get Release
|
|
1411
|
-
* @param {string | null} [releaseId] Release ID
|
|
1412
|
-
* @param {string | null} [id] Release ID (deprecated)
|
|
1413
|
-
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1414
|
-
* @param {string | null} [filename]
|
|
1415
|
-
* @param {*} [options] Override http request option.
|
|
1416
|
-
* @throws {RequiredError}
|
|
1417
|
-
*/
|
|
1418
|
-
getRelease: async (releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1419
|
-
const localVarPath = `/releases/get`;
|
|
1420
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1421
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1422
|
-
let baseOptions;
|
|
1423
|
-
if (configuration) {
|
|
1424
|
-
baseOptions = configuration.baseOptions;
|
|
1425
|
-
}
|
|
1426
|
-
|
|
1427
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1428
|
-
const localVarHeaderParameter = {} as any;
|
|
1429
|
-
const localVarQueryParameter = {} as any;
|
|
1430
|
-
|
|
1431
|
-
if (releaseId !== undefined) {
|
|
1432
|
-
localVarQueryParameter['release_id'] = releaseId;
|
|
1433
|
-
}
|
|
1434
|
-
|
|
1435
|
-
if (id !== undefined) {
|
|
1436
|
-
localVarQueryParameter['_id'] = id;
|
|
1437
|
-
}
|
|
1438
|
-
|
|
1439
|
-
if (buildId !== undefined) {
|
|
1440
|
-
localVarQueryParameter['build_id'] = buildId;
|
|
1441
|
-
}
|
|
1442
|
-
|
|
1443
|
-
if (filename !== undefined) {
|
|
1444
|
-
localVarQueryParameter['filename'] = filename;
|
|
1445
|
-
}
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1450
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1451
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1452
|
-
|
|
1453
|
-
return {
|
|
1454
|
-
url: toPathString(localVarUrlObj),
|
|
1455
|
-
options: localVarRequestOptions,
|
|
1456
|
-
};
|
|
1457
|
-
},
|
|
1458
|
-
/**
|
|
1459
|
-
* Gets release information using the release ID, nothing to discuss really.
|
|
1460
|
-
* @summary Get Release Short
|
|
1461
|
-
* @param {string} releaseId
|
|
1462
|
-
* @param {*} [options] Override http request option.
|
|
1463
|
-
* @deprecated
|
|
1464
|
-
* @throws {RequiredError}
|
|
1465
|
-
*/
|
|
1466
|
-
getReleaseDeprecated: async (releaseId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1467
|
-
// verify required parameter 'releaseId' is not null or undefined
|
|
1468
|
-
assertParamExists('getReleaseDeprecated', 'releaseId', releaseId)
|
|
1469
|
-
const localVarPath = `/releases/{release_id}`
|
|
1470
|
-
.replace(`{${"release_id"}}`, encodeURIComponent(String(releaseId)));
|
|
1471
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1472
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1473
|
-
let baseOptions;
|
|
1474
|
-
if (configuration) {
|
|
1475
|
-
baseOptions = configuration.baseOptions;
|
|
1476
|
-
}
|
|
1477
|
-
|
|
1478
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1479
|
-
const localVarHeaderParameter = {} as any;
|
|
1480
|
-
const localVarQueryParameter = {} as any;
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1485
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1486
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1487
|
-
|
|
1488
|
-
return {
|
|
1489
|
-
url: toPathString(localVarUrlObj),
|
|
1490
|
-
options: localVarRequestOptions,
|
|
1491
|
-
};
|
|
1492
|
-
},
|
|
1493
|
-
/**
|
|
1494
|
-
* 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.
|
|
1495
|
-
* @summary Get Releases
|
|
1496
|
-
* @param {Array<string>} [id] Filter by Release IDs
|
|
1497
|
-
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1498
|
-
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1499
|
-
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1500
|
-
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1501
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
1502
|
-
* @param {Array<string>} [version] Filter by release version
|
|
1503
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1504
|
-
* @param {boolean | null} [archived] Filter by the archived status
|
|
1505
|
-
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1506
|
-
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1507
|
-
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1508
|
-
* @param {ReleasesSort} [sort] Sort mode
|
|
1509
|
-
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
1510
|
-
* @param {number | null} [skip] Skip query results
|
|
1511
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1512
|
-
* @param {*} [options] Override http request option.
|
|
1513
|
-
* @throws {RequiredError}
|
|
1514
|
-
*/
|
|
1515
|
-
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> => {
|
|
1516
|
-
const localVarPath = `/releases/`;
|
|
1517
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1518
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1519
|
-
let baseOptions;
|
|
1520
|
-
if (configuration) {
|
|
1521
|
-
baseOptions = configuration.baseOptions;
|
|
1522
|
-
}
|
|
1523
|
-
|
|
1524
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1525
|
-
const localVarHeaderParameter = {} as any;
|
|
1526
|
-
const localVarQueryParameter = {} as any;
|
|
1527
|
-
|
|
1528
|
-
if (id) {
|
|
1529
|
-
localVarQueryParameter['id'] = id;
|
|
1530
|
-
}
|
|
1531
|
-
|
|
1532
|
-
if (id2) {
|
|
1533
|
-
localVarQueryParameter['_id'] = id2;
|
|
1534
|
-
}
|
|
1535
|
-
|
|
1536
|
-
if (buildId) {
|
|
1537
|
-
localVarQueryParameter['build_id'] = buildId;
|
|
1538
|
-
}
|
|
1539
|
-
|
|
1540
|
-
if (deviceId) {
|
|
1541
|
-
localVarQueryParameter['device_id'] = deviceId;
|
|
1542
|
-
}
|
|
1543
|
-
|
|
1544
|
-
if (maintainerId) {
|
|
1545
|
-
localVarQueryParameter['maintainer_id'] = maintainerId;
|
|
1546
|
-
}
|
|
1547
|
-
|
|
1548
|
-
if (codename) {
|
|
1549
|
-
localVarQueryParameter['codename'] = codename;
|
|
1550
|
-
}
|
|
1551
|
-
|
|
1552
|
-
if (version) {
|
|
1553
|
-
localVarQueryParameter['version'] = version;
|
|
1554
|
-
}
|
|
1555
|
-
|
|
1556
|
-
if (type) {
|
|
1557
|
-
localVarQueryParameter['type'] = type;
|
|
1558
|
-
}
|
|
1559
|
-
|
|
1560
|
-
if (archived !== undefined) {
|
|
1561
|
-
localVarQueryParameter['archived'] = archived;
|
|
1562
|
-
}
|
|
1563
|
-
|
|
1564
|
-
if (freezed !== undefined) {
|
|
1565
|
-
localVarQueryParameter['freezed'] = freezed;
|
|
1566
|
-
}
|
|
1567
|
-
|
|
1568
|
-
if (afterReleaseId !== undefined) {
|
|
1569
|
-
localVarQueryParameter['after_release_id'] = afterReleaseId;
|
|
1570
|
-
}
|
|
1571
|
-
|
|
1572
|
-
if (afterDate !== undefined) {
|
|
1573
|
-
localVarQueryParameter['after_date'] = afterDate;
|
|
1574
|
-
}
|
|
1575
|
-
|
|
1576
|
-
if (sort !== undefined) {
|
|
1577
|
-
localVarQueryParameter['sort'] = sort;
|
|
1578
|
-
}
|
|
1579
|
-
|
|
1580
|
-
if (group !== undefined) {
|
|
1581
|
-
localVarQueryParameter['group'] = group;
|
|
1582
|
-
}
|
|
1583
|
-
|
|
1584
|
-
if (skip !== undefined) {
|
|
1585
|
-
localVarQueryParameter['skip'] = skip;
|
|
1586
|
-
}
|
|
1587
|
-
|
|
1588
|
-
if (limit !== undefined) {
|
|
1589
|
-
localVarQueryParameter['limit'] = limit;
|
|
1590
|
-
}
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1595
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1596
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1597
|
-
|
|
1598
|
-
return {
|
|
1599
|
-
url: toPathString(localVarUrlObj),
|
|
1600
|
-
options: localVarRequestOptions,
|
|
1601
|
-
};
|
|
1602
|
-
},
|
|
1603
|
-
/**
|
|
1604
|
-
* 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!
|
|
1605
|
-
* @summary Get Updates
|
|
1606
|
-
* @param {string} lastKnownId
|
|
1607
|
-
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1608
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1609
|
-
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1610
|
-
* @param {number | null} [skip] Skip query results
|
|
1611
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1612
|
-
* @param {*} [options] Override http request option.
|
|
1613
|
-
* @deprecated
|
|
1614
|
-
* @throws {RequiredError}
|
|
1615
|
-
*/
|
|
1616
|
-
getUpdatesDeprecated: async (lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1617
|
-
// verify required parameter 'lastKnownId' is not null or undefined
|
|
1618
|
-
assertParamExists('getUpdatesDeprecated', 'lastKnownId', lastKnownId)
|
|
1619
|
-
const localVarPath = `/updates/{last_known_id}`
|
|
1620
|
-
.replace(`{${"last_known_id"}}`, encodeURIComponent(String(lastKnownId)));
|
|
1621
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1622
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1623
|
-
let baseOptions;
|
|
1624
|
-
if (configuration) {
|
|
1625
|
-
baseOptions = configuration.baseOptions;
|
|
1626
|
-
}
|
|
1627
|
-
|
|
1628
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1629
|
-
const localVarHeaderParameter = {} as any;
|
|
1630
|
-
const localVarQueryParameter = {} as any;
|
|
1631
|
-
|
|
1632
|
-
if (deviceId) {
|
|
1633
|
-
localVarQueryParameter['device_id'] = deviceId;
|
|
1634
|
-
}
|
|
1635
|
-
|
|
1636
|
-
if (type) {
|
|
1637
|
-
localVarQueryParameter['type'] = type;
|
|
1638
|
-
}
|
|
1639
|
-
|
|
1640
|
-
if (releaseType) {
|
|
1641
|
-
localVarQueryParameter['release_type'] = releaseType;
|
|
1642
|
-
}
|
|
1643
|
-
|
|
1644
|
-
if (skip !== undefined) {
|
|
1645
|
-
localVarQueryParameter['skip'] = skip;
|
|
1646
|
-
}
|
|
1647
|
-
|
|
1648
|
-
if (limit !== undefined) {
|
|
1649
|
-
localVarQueryParameter['limit'] = limit;
|
|
1650
|
-
}
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1655
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1656
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1657
|
-
|
|
1658
|
-
return {
|
|
1659
|
-
url: toPathString(localVarUrlObj),
|
|
1660
|
-
options: localVarRequestOptions,
|
|
1661
|
-
};
|
|
1662
|
-
},
|
|
1663
|
-
}
|
|
1664
|
-
};
|
|
1665
|
-
|
|
1666
|
-
/**
|
|
1667
|
-
* ReleaseApi - functional programming interface
|
|
1668
|
-
* @export
|
|
1669
|
-
*/
|
|
1670
|
-
export const ReleaseApiFp = function(configuration?: Configuration) {
|
|
1671
|
-
const localVarAxiosParamCreator = ReleaseApiAxiosParamCreator(configuration)
|
|
1672
|
-
return {
|
|
1673
|
-
/**
|
|
1674
|
-
* 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!
|
|
1675
|
-
* @summary Get Release
|
|
1676
|
-
* @param {string | null} [releaseId] Release ID
|
|
1677
|
-
* @param {string | null} [id] Release ID (deprecated)
|
|
1678
|
-
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1679
|
-
* @param {string | null} [filename]
|
|
1680
|
-
* @param {*} [options] Override http request option.
|
|
1681
|
-
* @throws {RequiredError}
|
|
1682
|
-
*/
|
|
1683
|
-
async getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>> {
|
|
1684
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getRelease(releaseId, id, buildId, filename, options);
|
|
1685
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1686
|
-
const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getRelease']?.[localVarOperationServerIndex]?.url;
|
|
1687
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1688
|
-
},
|
|
1689
|
-
/**
|
|
1690
|
-
* Gets release information using the release ID, nothing to discuss really.
|
|
1691
|
-
* @summary Get Release Short
|
|
1692
|
-
* @param {string} releaseId
|
|
1693
|
-
* @param {*} [options] Override http request option.
|
|
1694
|
-
* @deprecated
|
|
1695
|
-
* @throws {RequiredError}
|
|
1696
|
-
*/
|
|
1697
|
-
async getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>> {
|
|
1698
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getReleaseDeprecated(releaseId, options);
|
|
1699
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1700
|
-
const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getReleaseDeprecated']?.[localVarOperationServerIndex]?.url;
|
|
1701
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1702
|
-
},
|
|
1703
|
-
/**
|
|
1704
|
-
* 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.
|
|
1705
|
-
* @summary Get Releases
|
|
1706
|
-
* @param {Array<string>} [id] Filter by Release IDs
|
|
1707
|
-
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1708
|
-
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1709
|
-
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1710
|
-
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1711
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
1712
|
-
* @param {Array<string>} [version] Filter by release version
|
|
1713
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1714
|
-
* @param {boolean | null} [archived] Filter by the archived status
|
|
1715
|
-
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1716
|
-
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1717
|
-
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1718
|
-
* @param {ReleasesSort} [sort] Sort mode
|
|
1719
|
-
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
1720
|
-
* @param {number | null} [skip] Skip query results
|
|
1721
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1722
|
-
* @param {*} [options] Override http request option.
|
|
1723
|
-
* @throws {RequiredError}
|
|
1724
|
-
*/
|
|
1725
|
-
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>> {
|
|
1726
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options);
|
|
1727
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1728
|
-
const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getReleases']?.[localVarOperationServerIndex]?.url;
|
|
1729
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1730
|
-
},
|
|
1731
|
-
/**
|
|
1732
|
-
* 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!
|
|
1733
|
-
* @summary Get Updates
|
|
1734
|
-
* @param {string} lastKnownId
|
|
1735
|
-
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1736
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1737
|
-
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1738
|
-
* @param {number | null} [skip] Skip query results
|
|
1739
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1740
|
-
* @param {*} [options] Override http request option.
|
|
1741
|
-
* @deprecated
|
|
1742
|
-
* @throws {RequiredError}
|
|
1743
|
-
*/
|
|
1744
|
-
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>> {
|
|
1745
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options);
|
|
1746
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1747
|
-
const localVarOperationServerBasePath = operationServerMap['ReleaseApi.getUpdatesDeprecated']?.[localVarOperationServerIndex]?.url;
|
|
1748
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1749
|
-
},
|
|
1750
|
-
}
|
|
1751
|
-
};
|
|
1752
|
-
|
|
1753
|
-
/**
|
|
1754
|
-
* ReleaseApi - factory interface
|
|
1755
|
-
* @export
|
|
1756
|
-
*/
|
|
1757
|
-
export const ReleaseApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1758
|
-
const localVarFp = ReleaseApiFp(configuration)
|
|
1759
|
-
return {
|
|
1760
|
-
/**
|
|
1761
|
-
* 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!
|
|
1762
|
-
* @summary Get Release
|
|
1763
|
-
* @param {string | null} [releaseId] Release ID
|
|
1764
|
-
* @param {string | null} [id] Release ID (deprecated)
|
|
1765
|
-
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1766
|
-
* @param {string | null} [filename]
|
|
1767
|
-
* @param {*} [options] Override http request option.
|
|
1768
|
-
* @throws {RequiredError}
|
|
1769
|
-
*/
|
|
1770
|
-
getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse> {
|
|
1771
|
-
return localVarFp.getRelease(releaseId, id, buildId, filename, options).then((request) => request(axios, basePath));
|
|
1772
|
-
},
|
|
1773
|
-
/**
|
|
1774
|
-
* Gets release information using the release ID, nothing to discuss really.
|
|
1775
|
-
* @summary Get Release Short
|
|
1776
|
-
* @param {string} releaseId
|
|
1777
|
-
* @param {*} [options] Override http request option.
|
|
1778
|
-
* @deprecated
|
|
1779
|
-
* @throws {RequiredError}
|
|
1780
|
-
*/
|
|
1781
|
-
getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse> {
|
|
1782
|
-
return localVarFp.getReleaseDeprecated(releaseId, options).then((request) => request(axios, basePath));
|
|
1783
|
-
},
|
|
1784
|
-
/**
|
|
1785
|
-
* 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.
|
|
1786
|
-
* @summary Get Releases
|
|
1787
|
-
* @param {Array<string>} [id] Filter by Release IDs
|
|
1788
|
-
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1789
|
-
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1790
|
-
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1791
|
-
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1792
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
1793
|
-
* @param {Array<string>} [version] Filter by release version
|
|
1794
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1795
|
-
* @param {boolean | null} [archived] Filter by the archived status
|
|
1796
|
-
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1797
|
-
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1798
|
-
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1799
|
-
* @param {ReleasesSort} [sort] Sort mode
|
|
1800
|
-
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
1801
|
-
* @param {number | null} [skip] Skip query results
|
|
1802
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1803
|
-
* @param {*} [options] Override http request option.
|
|
1804
|
-
* @throws {RequiredError}
|
|
1805
|
-
*/
|
|
1806
|
-
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> {
|
|
1807
|
-
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));
|
|
1808
|
-
},
|
|
1809
|
-
/**
|
|
1810
|
-
* 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!
|
|
1811
|
-
* @summary Get Updates
|
|
1812
|
-
* @param {string} lastKnownId
|
|
1813
|
-
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1814
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1815
|
-
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1816
|
-
* @param {number | null} [skip] Skip query results
|
|
1817
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1818
|
-
* @param {*} [options] Override http request option.
|
|
1819
|
-
* @deprecated
|
|
1820
|
-
* @throws {RequiredError}
|
|
1821
|
-
*/
|
|
1822
|
-
getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse> {
|
|
1823
|
-
return localVarFp.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(axios, basePath));
|
|
1824
|
-
},
|
|
1825
|
-
};
|
|
1826
|
-
};
|
|
1827
|
-
|
|
1828
|
-
/**
|
|
1829
|
-
* ReleaseApi - interface
|
|
1830
|
-
* @export
|
|
1831
|
-
* @interface ReleaseApi
|
|
1832
|
-
*/
|
|
1833
|
-
export interface ReleaseApiInterface {
|
|
1834
|
-
/**
|
|
1835
|
-
* 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!
|
|
1836
|
-
* @summary Get Release
|
|
1837
|
-
* @param {string | null} [releaseId] Release ID
|
|
1838
|
-
* @param {string | null} [id] Release ID (deprecated)
|
|
1839
|
-
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1840
|
-
* @param {string | null} [filename]
|
|
1841
|
-
* @param {*} [options] Override http request option.
|
|
1842
|
-
* @throws {RequiredError}
|
|
1843
|
-
* @memberof ReleaseApiInterface
|
|
1844
|
-
*/
|
|
1845
|
-
getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
|
|
1846
|
-
|
|
1847
|
-
/**
|
|
1848
|
-
* Gets release information using the release ID, nothing to discuss really.
|
|
1849
|
-
* @summary Get Release Short
|
|
1850
|
-
* @param {string} releaseId
|
|
1851
|
-
* @param {*} [options] Override http request option.
|
|
1852
|
-
* @deprecated
|
|
1853
|
-
* @throws {RequiredError}
|
|
1854
|
-
* @memberof ReleaseApiInterface
|
|
1855
|
-
*/
|
|
1856
|
-
getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
|
|
1857
|
-
|
|
1858
|
-
/**
|
|
1859
|
-
* 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.
|
|
1860
|
-
* @summary Get Releases
|
|
1861
|
-
* @param {Array<string>} [id] Filter by Release IDs
|
|
1862
|
-
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1863
|
-
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1864
|
-
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1865
|
-
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1866
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
1867
|
-
* @param {Array<string>} [version] Filter by release version
|
|
1868
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1869
|
-
* @param {boolean | null} [archived] Filter by the archived status
|
|
1870
|
-
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1871
|
-
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1872
|
-
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1873
|
-
* @param {ReleasesSort} [sort] Sort mode
|
|
1874
|
-
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
1875
|
-
* @param {number | null} [skip] Skip query results
|
|
1876
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1877
|
-
* @param {*} [options] Override http request option.
|
|
1878
|
-
* @throws {RequiredError}
|
|
1879
|
-
* @memberof ReleaseApiInterface
|
|
1880
|
-
*/
|
|
1881
|
-
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>;
|
|
1882
|
-
|
|
1883
|
-
/**
|
|
1884
|
-
* 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!
|
|
1885
|
-
* @summary Get Updates
|
|
1886
|
-
* @param {string} lastKnownId
|
|
1887
|
-
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1888
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1889
|
-
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1890
|
-
* @param {number | null} [skip] Skip query results
|
|
1891
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1892
|
-
* @param {*} [options] Override http request option.
|
|
1893
|
-
* @deprecated
|
|
1894
|
-
* @throws {RequiredError}
|
|
1895
|
-
* @memberof ReleaseApiInterface
|
|
1896
|
-
*/
|
|
1897
|
-
getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse>;
|
|
1898
|
-
|
|
1899
|
-
}
|
|
1900
|
-
|
|
1901
|
-
/**
|
|
1902
|
-
* ReleaseApi - object-oriented interface
|
|
1903
|
-
* @export
|
|
1904
|
-
* @class ReleaseApi
|
|
1905
|
-
* @extends {BaseAPI}
|
|
1906
|
-
*/
|
|
1907
|
-
export class ReleaseApi extends BaseAPI implements ReleaseApiInterface {
|
|
1908
|
-
/**
|
|
1909
|
-
* 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!
|
|
1910
|
-
* @summary Get Release
|
|
1911
|
-
* @param {string | null} [releaseId] Release ID
|
|
1912
|
-
* @param {string | null} [id] Release ID (deprecated)
|
|
1913
|
-
* @param {string | null} [buildId] Build ID, `ro.build.fox_id` prop
|
|
1914
|
-
* @param {string | null} [filename]
|
|
1915
|
-
* @param {*} [options] Override http request option.
|
|
1916
|
-
* @throws {RequiredError}
|
|
1917
|
-
* @memberof ReleaseApi
|
|
1918
|
-
*/
|
|
1919
|
-
public getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig) {
|
|
1920
|
-
return ReleaseApiFp(this.configuration).getRelease(releaseId, id, buildId, filename, options).then((request) => request(this.axios, this.basePath));
|
|
1921
|
-
}
|
|
1922
|
-
|
|
1923
|
-
/**
|
|
1924
|
-
* Gets release information using the release ID, nothing to discuss really.
|
|
1925
|
-
* @summary Get Release Short
|
|
1926
|
-
* @param {string} releaseId
|
|
1927
|
-
* @param {*} [options] Override http request option.
|
|
1928
|
-
* @deprecated
|
|
1929
|
-
* @throws {RequiredError}
|
|
1930
|
-
* @memberof ReleaseApi
|
|
1931
|
-
*/
|
|
1932
|
-
public getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig) {
|
|
1933
|
-
return ReleaseApiFp(this.configuration).getReleaseDeprecated(releaseId, options).then((request) => request(this.axios, this.basePath));
|
|
1934
|
-
}
|
|
1935
|
-
|
|
1936
|
-
/**
|
|
1937
|
-
* 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.
|
|
1938
|
-
* @summary Get Releases
|
|
1939
|
-
* @param {Array<string>} [id] Filter by Release IDs
|
|
1940
|
-
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
1941
|
-
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
1942
|
-
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
1943
|
-
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
1944
|
-
* @param {Array<string>} [codename] Filter by device codenames
|
|
1945
|
-
* @param {Array<string>} [version] Filter by release version
|
|
1946
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1947
|
-
* @param {boolean | null} [archived] Filter by the archived status
|
|
1948
|
-
* @param {boolean | null} [freezed] Filter by the freezed status
|
|
1949
|
-
* @param {string | null} [afterReleaseId] Show releases after the provided one
|
|
1950
|
-
* @param {number | null} [afterDate] Show releases after the provided timestamp
|
|
1951
|
-
* @param {ReleasesSort} [sort] Sort mode
|
|
1952
|
-
* @param {boolean | null} [group] Group releases by version + variant. This will change the response!
|
|
1953
|
-
* @param {number | null} [skip] Skip query results
|
|
1954
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1955
|
-
* @param {*} [options] Override http request option.
|
|
1956
|
-
* @throws {RequiredError}
|
|
1957
|
-
* @memberof ReleaseApi
|
|
1958
|
-
*/
|
|
1959
|
-
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) {
|
|
1960
|
-
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));
|
|
1961
|
-
}
|
|
1962
|
-
|
|
1963
|
-
/**
|
|
1964
|
-
* 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!
|
|
1965
|
-
* @summary Get Updates
|
|
1966
|
-
* @param {string} lastKnownId
|
|
1967
|
-
* @param {Array<string>} [deviceId] Filter by device ID
|
|
1968
|
-
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
1969
|
-
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
1970
|
-
* @param {number | null} [skip] Skip query results
|
|
1971
|
-
* @param {number | null} [limit] Limit query results (0 means unlimited)
|
|
1972
|
-
* @param {*} [options] Override http request option.
|
|
1973
|
-
* @deprecated
|
|
1974
|
-
* @throws {RequiredError}
|
|
1975
|
-
* @memberof ReleaseApi
|
|
1976
|
-
*/
|
|
1977
|
-
public getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) {
|
|
1978
|
-
return ReleaseApiFp(this.configuration).getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(this.axios, this.basePath));
|
|
1979
|
-
}
|
|
1980
|
-
}
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
|
|
1984
|
-
/**
|
|
1985
|
-
* StatsApi - axios parameter creator
|
|
1986
|
-
* @export
|
|
1987
|
-
*/
|
|
1988
|
-
export const StatsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1989
|
-
return {
|
|
1990
|
-
/**
|
|
1991
|
-
* 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.
|
|
1992
|
-
* @summary Public Stats
|
|
1993
|
-
* @param {*} [options] Override http request option.
|
|
1994
|
-
* @throws {RequiredError}
|
|
1995
|
-
*/
|
|
1996
|
-
getPublicStats: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1997
|
-
const localVarPath = `/stats/`;
|
|
1998
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1999
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2000
|
-
let baseOptions;
|
|
2001
|
-
if (configuration) {
|
|
2002
|
-
baseOptions = configuration.baseOptions;
|
|
2003
|
-
}
|
|
2004
|
-
|
|
2005
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2006
|
-
const localVarHeaderParameter = {} as any;
|
|
2007
|
-
const localVarQueryParameter = {} as any;
|
|
2008
|
-
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2012
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2013
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2014
|
-
|
|
2015
|
-
return {
|
|
2016
|
-
url: toPathString(localVarUrlObj),
|
|
2017
|
-
options: localVarRequestOptions,
|
|
2018
|
-
};
|
|
2019
|
-
},
|
|
2020
|
-
}
|
|
2021
|
-
};
|
|
2022
|
-
|
|
2023
|
-
/**
|
|
2024
|
-
* StatsApi - functional programming interface
|
|
2025
|
-
* @export
|
|
2026
|
-
*/
|
|
2027
|
-
export const StatsApiFp = function(configuration?: Configuration) {
|
|
2028
|
-
const localVarAxiosParamCreator = StatsApiAxiosParamCreator(configuration)
|
|
2029
|
-
return {
|
|
2030
|
-
/**
|
|
2031
|
-
* 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.
|
|
2032
|
-
* @summary Public Stats
|
|
2033
|
-
* @param {*} [options] Override http request option.
|
|
2034
|
-
* @throws {RequiredError}
|
|
2035
|
-
*/
|
|
2036
|
-
async getPublicStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalStatsAggregationModel>> {
|
|
2037
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPublicStats(options);
|
|
2038
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2039
|
-
const localVarOperationServerBasePath = operationServerMap['StatsApi.getPublicStats']?.[localVarOperationServerIndex]?.url;
|
|
2040
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2041
|
-
},
|
|
2042
|
-
}
|
|
2043
|
-
};
|
|
2044
|
-
|
|
2045
|
-
/**
|
|
2046
|
-
* StatsApi - factory interface
|
|
2047
|
-
* @export
|
|
2048
|
-
*/
|
|
2049
|
-
export const StatsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
2050
|
-
const localVarFp = StatsApiFp(configuration)
|
|
2051
|
-
return {
|
|
2052
|
-
/**
|
|
2053
|
-
* 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.
|
|
2054
|
-
* @summary Public Stats
|
|
2055
|
-
* @param {*} [options] Override http request option.
|
|
2056
|
-
* @throws {RequiredError}
|
|
2057
|
-
*/
|
|
2058
|
-
getPublicStats(options?: RawAxiosRequestConfig): AxiosPromise<GlobalStatsAggregationModel> {
|
|
2059
|
-
return localVarFp.getPublicStats(options).then((request) => request(axios, basePath));
|
|
2060
|
-
},
|
|
2061
|
-
};
|
|
2062
|
-
};
|
|
2063
|
-
|
|
2064
|
-
/**
|
|
2065
|
-
* StatsApi - interface
|
|
2066
|
-
* @export
|
|
2067
|
-
* @interface StatsApi
|
|
2068
|
-
*/
|
|
2069
|
-
export interface StatsApiInterface {
|
|
2070
|
-
/**
|
|
2071
|
-
* 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.
|
|
2072
|
-
* @summary Public Stats
|
|
2073
|
-
* @param {*} [options] Override http request option.
|
|
2074
|
-
* @throws {RequiredError}
|
|
2075
|
-
* @memberof StatsApiInterface
|
|
2076
|
-
*/
|
|
2077
|
-
getPublicStats(options?: RawAxiosRequestConfig): AxiosPromise<GlobalStatsAggregationModel>;
|
|
2078
|
-
|
|
2079
|
-
}
|
|
2080
|
-
|
|
2081
|
-
/**
|
|
2082
|
-
* StatsApi - object-oriented interface
|
|
2083
|
-
* @export
|
|
2084
|
-
* @class StatsApi
|
|
2085
|
-
* @extends {BaseAPI}
|
|
2086
|
-
*/
|
|
2087
|
-
export class StatsApi extends BaseAPI implements StatsApiInterface {
|
|
2088
|
-
/**
|
|
2089
|
-
* 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.
|
|
2090
|
-
* @summary Public Stats
|
|
2091
|
-
* @param {*} [options] Override http request option.
|
|
2092
|
-
* @throws {RequiredError}
|
|
2093
|
-
* @memberof StatsApi
|
|
2094
|
-
*/
|
|
2095
|
-
public getPublicStats(options?: RawAxiosRequestConfig) {
|
|
2096
|
-
return StatsApiFp(this.configuration).getPublicStats(options).then((request) => request(this.axios, this.basePath));
|
|
2097
|
-
}
|
|
2098
|
-
}
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|