@orangefox-recovery/foxclient 5.3.3 → 5.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -2
- package/.openapi-generator/VERSION +1 -1
- package/README.md +5 -5
- package/dist/apis/DeviceApi.d.ts +66 -9
- package/dist/apis/DeviceApi.js +60 -23
- package/dist/apis/PasteApi.d.ts +23 -1
- package/dist/apis/PasteApi.js +29 -11
- package/dist/apis/ReleaseApi.d.ts +76 -5
- package/dist/apis/ReleaseApi.js +60 -22
- package/dist/apis/StatsApi.d.ts +11 -1
- package/dist/apis/StatsApi.js +15 -6
- package/dist/esm/apis/DeviceApi.d.ts +66 -9
- package/dist/esm/apis/DeviceApi.js +60 -23
- package/dist/esm/apis/PasteApi.d.ts +23 -1
- package/dist/esm/apis/PasteApi.js +29 -11
- package/dist/esm/apis/ReleaseApi.d.ts +76 -5
- package/dist/esm/apis/ReleaseApi.js +60 -22
- package/dist/esm/apis/StatsApi.d.ts +11 -1
- package/dist/esm/apis/StatsApi.js +15 -6
- package/dist/esm/models/DeviceResponse.d.ts +1 -1
- package/dist/esm/models/DeviceResponse.js +1 -1
- package/dist/esm/models/GlobalStatsAggregationModel.d.ts +1 -1
- package/dist/esm/models/GlobalStatsAggregationModel.js +1 -1
- package/dist/esm/models/HTTPValidationError.d.ts +1 -1
- package/dist/esm/models/HTTPValidationError.js +1 -1
- package/dist/esm/models/ListResponseReleaseResponse.d.ts +1 -1
- package/dist/esm/models/ListResponseReleaseResponse.js +1 -1
- package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +1 -1
- package/dist/esm/models/ListResponseShortDeviceResponse.js +1 -1
- package/dist/esm/models/ListResponseShortReleaseResponse.d.ts +1 -1
- package/dist/esm/models/ListResponseShortReleaseResponse.js +1 -1
- package/dist/esm/models/ListResponseStr.d.ts +1 -1
- package/dist/esm/models/ListResponseStr.js +1 -1
- package/dist/esm/models/LocationInner.d.ts +26 -0
- package/dist/esm/models/{ValidationErrorLocInner.js → LocationInner.js} +9 -9
- package/dist/esm/models/MaintainerShortModel.d.ts +1 -1
- package/dist/esm/models/MaintainerShortModel.js +1 -1
- package/dist/esm/models/PasteInput.d.ts +1 -1
- package/dist/esm/models/PasteInput.js +1 -1
- package/dist/esm/models/PasteOutput.d.ts +1 -1
- package/dist/esm/models/PasteOutput.js +1 -1
- package/dist/esm/models/RecoveryImgResponse.d.ts +1 -1
- package/dist/esm/models/RecoveryImgResponse.js +1 -1
- package/dist/esm/models/ReleaseGroupsResponse.d.ts +1 -1
- package/dist/esm/models/ReleaseGroupsResponse.js +1 -1
- package/dist/esm/models/ReleaseResponse.d.ts +1 -1
- package/dist/esm/models/ReleaseResponse.js +1 -1
- package/dist/esm/models/ReleaseType.d.ts +1 -1
- package/dist/esm/models/ReleaseType.js +1 -1
- package/dist/esm/models/ReleasesSort.d.ts +1 -1
- package/dist/esm/models/ReleasesSort.js +1 -1
- package/dist/esm/models/ResponseGetReleases.d.ts +1 -1
- package/dist/esm/models/ResponseGetReleases.js +1 -1
- package/dist/esm/models/ShortDeviceResponse.d.ts +1 -1
- package/dist/esm/models/ShortDeviceResponse.js +1 -1
- package/dist/esm/models/ShortReleaseResponse.d.ts +1 -1
- package/dist/esm/models/ShortReleaseResponse.js +1 -1
- package/dist/esm/models/ValidationError.d.ts +16 -4
- package/dist/esm/models/ValidationError.js +8 -4
- package/dist/esm/models/index.d.ts +1 -1
- package/dist/esm/models/index.js +1 -1
- package/dist/esm/runtime.d.ts +1 -1
- package/dist/esm/runtime.js +16 -1
- package/dist/models/DeviceResponse.d.ts +1 -1
- package/dist/models/DeviceResponse.js +1 -1
- package/dist/models/GlobalStatsAggregationModel.d.ts +1 -1
- package/dist/models/GlobalStatsAggregationModel.js +1 -1
- package/dist/models/HTTPValidationError.d.ts +1 -1
- package/dist/models/HTTPValidationError.js +1 -1
- package/dist/models/ListResponseReleaseResponse.d.ts +1 -1
- package/dist/models/ListResponseReleaseResponse.js +1 -1
- package/dist/models/ListResponseShortDeviceResponse.d.ts +1 -1
- package/dist/models/ListResponseShortDeviceResponse.js +1 -1
- package/dist/models/ListResponseShortReleaseResponse.d.ts +1 -1
- package/dist/models/ListResponseShortReleaseResponse.js +1 -1
- package/dist/models/ListResponseStr.d.ts +1 -1
- package/dist/models/ListResponseStr.js +1 -1
- package/dist/models/LocationInner.d.ts +26 -0
- package/dist/models/LocationInner.js +38 -0
- package/dist/models/MaintainerShortModel.d.ts +1 -1
- package/dist/models/MaintainerShortModel.js +1 -1
- package/dist/models/PasteInput.d.ts +1 -1
- package/dist/models/PasteInput.js +1 -1
- package/dist/models/PasteOutput.d.ts +1 -1
- package/dist/models/PasteOutput.js +1 -1
- package/dist/models/RecoveryImgResponse.d.ts +1 -1
- package/dist/models/RecoveryImgResponse.js +1 -1
- package/dist/models/ReleaseGroupsResponse.d.ts +1 -1
- package/dist/models/ReleaseGroupsResponse.js +1 -1
- package/dist/models/ReleaseResponse.d.ts +1 -1
- package/dist/models/ReleaseResponse.js +1 -1
- package/dist/models/ReleaseType.d.ts +1 -1
- package/dist/models/ReleaseType.js +1 -1
- package/dist/models/ReleasesSort.d.ts +1 -1
- package/dist/models/ReleasesSort.js +1 -1
- package/dist/models/ResponseGetReleases.d.ts +1 -1
- package/dist/models/ResponseGetReleases.js +1 -1
- package/dist/models/ShortDeviceResponse.d.ts +1 -1
- package/dist/models/ShortDeviceResponse.js +1 -1
- package/dist/models/ShortReleaseResponse.d.ts +1 -1
- package/dist/models/ShortReleaseResponse.js +1 -1
- package/dist/models/ValidationError.d.ts +16 -4
- package/dist/models/ValidationError.js +8 -4
- package/dist/models/index.d.ts +1 -1
- package/dist/models/index.js +1 -1
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +16 -1
- package/docs/DeviceApi.md +2 -2
- package/docs/{ValidationErrorLocInner.md → LocationInner.md} +4 -4
- package/docs/ReleaseApi.md +1 -1
- package/docs/ValidationError.md +5 -1
- package/package.json +1 -2
- package/src/apis/DeviceApi.ts +104 -27
- package/src/apis/PasteApi.ts +43 -11
- package/src/apis/ReleaseApi.ts +115 -24
- package/src/apis/StatsApi.ts +21 -6
- package/src/models/DeviceResponse.ts +1 -1
- package/src/models/GlobalStatsAggregationModel.ts +1 -1
- package/src/models/HTTPValidationError.ts +1 -1
- package/src/models/ListResponseReleaseResponse.ts +1 -1
- package/src/models/ListResponseShortDeviceResponse.ts +1 -1
- package/src/models/ListResponseShortReleaseResponse.ts +1 -1
- package/src/models/ListResponseStr.ts +1 -1
- package/src/models/{ValidationErrorLocInner.ts → LocationInner.ts} +11 -11
- package/src/models/MaintainerShortModel.ts +1 -1
- package/src/models/PasteInput.ts +1 -1
- package/src/models/PasteOutput.ts +1 -1
- package/src/models/RecoveryImgResponse.ts +1 -1
- package/src/models/ReleaseGroupsResponse.ts +1 -1
- package/src/models/ReleaseResponse.ts +1 -1
- package/src/models/ReleaseType.ts +1 -1
- package/src/models/ReleasesSort.ts +1 -1
- package/src/models/ResponseGetReleases.ts +1 -1
- package/src/models/ShortDeviceResponse.ts +1 -1
- package/src/models/ShortReleaseResponse.ts +1 -1
- package/src/models/ValidationError.ts +27 -11
- package/src/models/index.ts +1 -1
- package/src/runtime.ts +19 -1
- package/dist/esm/models/ValidationErrorLocInner.d.ts +0 -26
- package/dist/models/ValidationErrorLocInner.d.ts +0 -26
- package/dist/models/ValidationErrorLocInner.js +0 -38
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.
|
|
7
|
+
* The version of the OpenAPI document: 5.4.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -27,10 +27,9 @@ import { DeviceResponseFromJSON, ListResponseShortDeviceResponseFromJSON, ListRe
|
|
|
27
27
|
*/
|
|
28
28
|
export class DeviceApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
* Get Device
|
|
30
|
+
* Creates request options for getDevice without sending the request
|
|
32
31
|
*/
|
|
33
|
-
|
|
32
|
+
getDeviceRequestOpts(requestParameters) {
|
|
34
33
|
return __awaiter(this, void 0, void 0, function* () {
|
|
35
34
|
const queryParameters = {};
|
|
36
35
|
if (requestParameters['deviceId'] != null) {
|
|
@@ -44,17 +43,27 @@ export class DeviceApi extends runtime.BaseAPI {
|
|
|
44
43
|
}
|
|
45
44
|
const headerParameters = {};
|
|
46
45
|
let urlPath = `/devices/get`;
|
|
47
|
-
|
|
46
|
+
return {
|
|
48
47
|
path: urlPath,
|
|
49
48
|
method: 'GET',
|
|
50
49
|
headers: headerParameters,
|
|
51
50
|
query: queryParameters,
|
|
52
|
-
}
|
|
51
|
+
};
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
|
|
56
|
+
* Get Device
|
|
57
|
+
*/
|
|
58
|
+
getDeviceRaw(requestParameters, initOverrides) {
|
|
59
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
60
|
+
const requestOptions = yield this.getDeviceRequestOpts(requestParameters);
|
|
61
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
53
62
|
return new runtime.JSONApiResponse(response, (jsonValue) => DeviceResponseFromJSON(jsonValue));
|
|
54
63
|
});
|
|
55
64
|
}
|
|
56
65
|
/**
|
|
57
|
-
* 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
|
|
66
|
+
* 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.
|
|
58
67
|
* Get Device
|
|
59
68
|
*/
|
|
60
69
|
getDevice() {
|
|
@@ -64,11 +73,10 @@ export class DeviceApi extends runtime.BaseAPI {
|
|
|
64
73
|
});
|
|
65
74
|
}
|
|
66
75
|
/**
|
|
67
|
-
*
|
|
68
|
-
* Get Device Short
|
|
76
|
+
* Creates request options for getDeviceDeprecated without sending the request
|
|
69
77
|
* @deprecated
|
|
70
78
|
*/
|
|
71
|
-
|
|
79
|
+
getDeviceDeprecatedRequestOpts(requestParameters) {
|
|
72
80
|
return __awaiter(this, void 0, void 0, function* () {
|
|
73
81
|
if (requestParameters['deviceId'] == null) {
|
|
74
82
|
throw new runtime.RequiredError('deviceId', 'Required parameter "deviceId" was null or undefined when calling getDeviceDeprecated().');
|
|
@@ -77,12 +85,23 @@ export class DeviceApi extends runtime.BaseAPI {
|
|
|
77
85
|
const headerParameters = {};
|
|
78
86
|
let urlPath = `/devices/{device_id}`;
|
|
79
87
|
urlPath = urlPath.replace(`{${"device_id"}}`, encodeURIComponent(String(requestParameters['deviceId'])));
|
|
80
|
-
|
|
88
|
+
return {
|
|
81
89
|
path: urlPath,
|
|
82
90
|
method: 'GET',
|
|
83
91
|
headers: headerParameters,
|
|
84
92
|
query: queryParameters,
|
|
85
|
-
}
|
|
93
|
+
};
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* Gets device info using device ID.
|
|
98
|
+
* Get Device Short
|
|
99
|
+
* @deprecated
|
|
100
|
+
*/
|
|
101
|
+
getDeviceDeprecatedRaw(requestParameters, initOverrides) {
|
|
102
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
103
|
+
const requestOptions = yield this.getDeviceDeprecatedRequestOpts(requestParameters);
|
|
104
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
86
105
|
return new runtime.JSONApiResponse(response, (jsonValue) => DeviceResponseFromJSON(jsonValue));
|
|
87
106
|
});
|
|
88
107
|
}
|
|
@@ -98,10 +117,9 @@ export class DeviceApi extends runtime.BaseAPI {
|
|
|
98
117
|
});
|
|
99
118
|
}
|
|
100
119
|
/**
|
|
101
|
-
*
|
|
102
|
-
* Get Devices
|
|
120
|
+
* Creates request options for getDevices without sending the request
|
|
103
121
|
*/
|
|
104
|
-
|
|
122
|
+
getDevicesRequestOpts(requestParameters) {
|
|
105
123
|
return __awaiter(this, void 0, void 0, function* () {
|
|
106
124
|
const queryParameters = {};
|
|
107
125
|
if (requestParameters['id'] != null) {
|
|
@@ -139,17 +157,27 @@ export class DeviceApi extends runtime.BaseAPI {
|
|
|
139
157
|
}
|
|
140
158
|
const headerParameters = {};
|
|
141
159
|
let urlPath = `/devices/`;
|
|
142
|
-
|
|
160
|
+
return {
|
|
143
161
|
path: urlPath,
|
|
144
162
|
method: 'GET',
|
|
145
163
|
headers: headerParameters,
|
|
146
164
|
query: queryParameters,
|
|
147
|
-
}
|
|
165
|
+
};
|
|
166
|
+
});
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* 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.
|
|
170
|
+
* Get Devices
|
|
171
|
+
*/
|
|
172
|
+
getDevicesRaw(requestParameters, initOverrides) {
|
|
173
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
174
|
+
const requestOptions = yield this.getDevicesRequestOpts(requestParameters);
|
|
175
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
148
176
|
return new runtime.JSONApiResponse(response, (jsonValue) => ListResponseShortDeviceResponseFromJSON(jsonValue));
|
|
149
177
|
});
|
|
150
178
|
}
|
|
151
179
|
/**
|
|
152
|
-
* 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,
|
|
180
|
+
* 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.
|
|
153
181
|
* Get Devices
|
|
154
182
|
*/
|
|
155
183
|
getDevices() {
|
|
@@ -159,20 +187,29 @@ export class DeviceApi extends runtime.BaseAPI {
|
|
|
159
187
|
});
|
|
160
188
|
}
|
|
161
189
|
/**
|
|
162
|
-
*
|
|
163
|
-
* Get Oems
|
|
190
|
+
* Creates request options for getOems without sending the request
|
|
164
191
|
*/
|
|
165
|
-
|
|
192
|
+
getOemsRequestOpts() {
|
|
166
193
|
return __awaiter(this, void 0, void 0, function* () {
|
|
167
194
|
const queryParameters = {};
|
|
168
195
|
const headerParameters = {};
|
|
169
196
|
let urlPath = `/oems/`;
|
|
170
|
-
|
|
197
|
+
return {
|
|
171
198
|
path: urlPath,
|
|
172
199
|
method: 'GET',
|
|
173
200
|
headers: headerParameters,
|
|
174
201
|
query: queryParameters,
|
|
175
|
-
}
|
|
202
|
+
};
|
|
203
|
+
});
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* Lists all OEM names
|
|
207
|
+
* Get Oems
|
|
208
|
+
*/
|
|
209
|
+
getOemsRaw(initOverrides) {
|
|
210
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
211
|
+
const requestOptions = yield this.getOemsRequestOpts();
|
|
212
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
176
213
|
return new runtime.JSONApiResponse(response, (jsonValue) => ListResponseStrFromJSON(jsonValue));
|
|
177
214
|
});
|
|
178
215
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.
|
|
5
|
+
* The version of the OpenAPI document: 5.4.0
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -24,6 +24,13 @@ export interface GetPastePastePasteIdGetRequest {
|
|
|
24
24
|
* @interface PasteApiInterface
|
|
25
25
|
*/
|
|
26
26
|
export interface PasteApiInterface {
|
|
27
|
+
/**
|
|
28
|
+
* Creates request options for createPastePastePost without sending the request
|
|
29
|
+
* @param {PasteInput} pasteInput
|
|
30
|
+
* @throws {RequiredError}
|
|
31
|
+
* @memberof PasteApiInterface
|
|
32
|
+
*/
|
|
33
|
+
createPastePastePostRequestOpts(requestParameters: CreatePastePastePostRequest): Promise<runtime.RequestOpts>;
|
|
27
34
|
/**
|
|
28
35
|
* Create a new paste.
|
|
29
36
|
* @summary Create Paste
|
|
@@ -38,6 +45,13 @@ export interface PasteApiInterface {
|
|
|
38
45
|
* Create Paste
|
|
39
46
|
*/
|
|
40
47
|
createPastePastePost(requestParameters: CreatePastePastePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteOutput>;
|
|
48
|
+
/**
|
|
49
|
+
* Creates request options for getPastePastePasteIdGet without sending the request
|
|
50
|
+
* @param {string} pasteId
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
* @memberof PasteApiInterface
|
|
53
|
+
*/
|
|
54
|
+
getPastePastePasteIdGetRequestOpts(requestParameters: GetPastePastePasteIdGetRequest): Promise<runtime.RequestOpts>;
|
|
41
55
|
/**
|
|
42
56
|
* Get a paste by ID.
|
|
43
57
|
* @summary Get Paste
|
|
@@ -57,6 +71,10 @@ export interface PasteApiInterface {
|
|
|
57
71
|
*
|
|
58
72
|
*/
|
|
59
73
|
export declare class PasteApi extends runtime.BaseAPI implements PasteApiInterface {
|
|
74
|
+
/**
|
|
75
|
+
* Creates request options for createPastePastePost without sending the request
|
|
76
|
+
*/
|
|
77
|
+
createPastePastePostRequestOpts(requestParameters: CreatePastePastePostRequest): Promise<runtime.RequestOpts>;
|
|
60
78
|
/**
|
|
61
79
|
* Create a new paste.
|
|
62
80
|
* Create Paste
|
|
@@ -67,6 +85,10 @@ export declare class PasteApi extends runtime.BaseAPI implements PasteApiInterfa
|
|
|
67
85
|
* Create Paste
|
|
68
86
|
*/
|
|
69
87
|
createPastePastePost(requestParameters: CreatePastePastePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasteOutput>;
|
|
88
|
+
/**
|
|
89
|
+
* Creates request options for getPastePastePasteIdGet without sending the request
|
|
90
|
+
*/
|
|
91
|
+
getPastePastePasteIdGetRequestOpts(requestParameters: GetPastePastePasteIdGetRequest): Promise<runtime.RequestOpts>;
|
|
70
92
|
/**
|
|
71
93
|
* Get a paste by ID.
|
|
72
94
|
* Get Paste
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Fox API
|
|
5
5
|
* Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.
|
|
7
|
+
* The version of the OpenAPI document: 5.4.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -27,10 +27,9 @@ import { PasteInputToJSON, PasteOutputFromJSON, } from '../models/index';
|
|
|
27
27
|
*/
|
|
28
28
|
export class PasteApi extends runtime.BaseAPI {
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
* Create Paste
|
|
30
|
+
* Creates request options for createPastePastePost without sending the request
|
|
32
31
|
*/
|
|
33
|
-
|
|
32
|
+
createPastePastePostRequestOpts(requestParameters) {
|
|
34
33
|
return __awaiter(this, void 0, void 0, function* () {
|
|
35
34
|
if (requestParameters['pasteInput'] == null) {
|
|
36
35
|
throw new runtime.RequiredError('pasteInput', 'Required parameter "pasteInput" was null or undefined when calling createPastePastePost().');
|
|
@@ -39,13 +38,23 @@ export class PasteApi extends runtime.BaseAPI {
|
|
|
39
38
|
const headerParameters = {};
|
|
40
39
|
headerParameters['Content-Type'] = 'application/json';
|
|
41
40
|
let urlPath = `/paste/`;
|
|
42
|
-
|
|
41
|
+
return {
|
|
43
42
|
path: urlPath,
|
|
44
43
|
method: 'POST',
|
|
45
44
|
headers: headerParameters,
|
|
46
45
|
query: queryParameters,
|
|
47
46
|
body: PasteInputToJSON(requestParameters['pasteInput']),
|
|
48
|
-
}
|
|
47
|
+
};
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Create a new paste.
|
|
52
|
+
* Create Paste
|
|
53
|
+
*/
|
|
54
|
+
createPastePastePostRaw(requestParameters, initOverrides) {
|
|
55
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
56
|
+
const requestOptions = yield this.createPastePastePostRequestOpts(requestParameters);
|
|
57
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
49
58
|
return new runtime.JSONApiResponse(response, (jsonValue) => PasteOutputFromJSON(jsonValue));
|
|
50
59
|
});
|
|
51
60
|
}
|
|
@@ -60,10 +69,9 @@ export class PasteApi extends runtime.BaseAPI {
|
|
|
60
69
|
});
|
|
61
70
|
}
|
|
62
71
|
/**
|
|
63
|
-
*
|
|
64
|
-
* Get Paste
|
|
72
|
+
* Creates request options for getPastePastePasteIdGet without sending the request
|
|
65
73
|
*/
|
|
66
|
-
|
|
74
|
+
getPastePastePasteIdGetRequestOpts(requestParameters) {
|
|
67
75
|
return __awaiter(this, void 0, void 0, function* () {
|
|
68
76
|
if (requestParameters['pasteId'] == null) {
|
|
69
77
|
throw new runtime.RequiredError('pasteId', 'Required parameter "pasteId" was null or undefined when calling getPastePastePasteIdGet().');
|
|
@@ -72,12 +80,22 @@ export class PasteApi extends runtime.BaseAPI {
|
|
|
72
80
|
const headerParameters = {};
|
|
73
81
|
let urlPath = `/paste/{paste_id}`;
|
|
74
82
|
urlPath = urlPath.replace(`{${"paste_id"}}`, encodeURIComponent(String(requestParameters['pasteId'])));
|
|
75
|
-
|
|
83
|
+
return {
|
|
76
84
|
path: urlPath,
|
|
77
85
|
method: 'GET',
|
|
78
86
|
headers: headerParameters,
|
|
79
87
|
query: queryParameters,
|
|
80
|
-
}
|
|
88
|
+
};
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Get a paste by ID.
|
|
93
|
+
* Get Paste
|
|
94
|
+
*/
|
|
95
|
+
getPastePastePasteIdGetRaw(requestParameters, initOverrides) {
|
|
96
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
97
|
+
const requestOptions = yield this.getPastePastePasteIdGetRequestOpts(requestParameters);
|
|
98
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
81
99
|
return new runtime.JSONApiResponse(response, (jsonValue) => PasteOutputFromJSON(jsonValue));
|
|
82
100
|
});
|
|
83
101
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Fox API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.
|
|
5
|
+
* The version of the OpenAPI document: 5.4.0
|
|
6
6
|
* Contact: admin@orangefox.tech
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -53,6 +53,16 @@ export interface GetUpdatesDeprecatedRequest {
|
|
|
53
53
|
* @interface ReleaseApiInterface
|
|
54
54
|
*/
|
|
55
55
|
export interface ReleaseApiInterface {
|
|
56
|
+
/**
|
|
57
|
+
* Creates request options for getRelease without sending the request
|
|
58
|
+
* @param {string} [releaseId] Release ID
|
|
59
|
+
* @param {string} [id] Release ID (deprecated)
|
|
60
|
+
* @param {string} [buildId] Build ID, `ro.build.fox_id` prop
|
|
61
|
+
* @param {string} [filename]
|
|
62
|
+
* @throws {RequiredError}
|
|
63
|
+
* @memberof ReleaseApiInterface
|
|
64
|
+
*/
|
|
65
|
+
getReleaseRequestOpts(requestParameters: GetReleaseRequest): Promise<runtime.RequestOpts>;
|
|
56
66
|
/**
|
|
57
67
|
* 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!
|
|
58
68
|
* @summary Get Release
|
|
@@ -70,6 +80,14 @@ export interface ReleaseApiInterface {
|
|
|
70
80
|
* Get Release
|
|
71
81
|
*/
|
|
72
82
|
getRelease(requestParameters: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseResponse>;
|
|
83
|
+
/**
|
|
84
|
+
* Creates request options for getReleaseDeprecated without sending the request
|
|
85
|
+
* @param {string} releaseId
|
|
86
|
+
* @deprecated
|
|
87
|
+
* @throws {RequiredError}
|
|
88
|
+
* @memberof ReleaseApiInterface
|
|
89
|
+
*/
|
|
90
|
+
getReleaseDeprecatedRequestOpts(requestParameters: GetReleaseDeprecatedRequest): Promise<runtime.RequestOpts>;
|
|
73
91
|
/**
|
|
74
92
|
* Gets release information using the release ID, nothing to discuss really.
|
|
75
93
|
* @summary Get Release Short
|
|
@@ -87,7 +105,29 @@ export interface ReleaseApiInterface {
|
|
|
87
105
|
*/
|
|
88
106
|
getReleaseDeprecated(requestParameters: GetReleaseDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseResponse>;
|
|
89
107
|
/**
|
|
90
|
-
*
|
|
108
|
+
* Creates request options for getReleases without sending the request
|
|
109
|
+
* @param {Array<string>} [id] Filter by Release IDs
|
|
110
|
+
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
111
|
+
* @param {Array<string>} [buildId] Filter by Build IDs
|
|
112
|
+
* @param {Array<string>} [deviceId] Filter by Device IDs
|
|
113
|
+
* @param {Array<string>} [maintainerId] Filter by Maintainer IDs
|
|
114
|
+
* @param {Array<string>} [codename] Filter by device codenames
|
|
115
|
+
* @param {Array<string>} [version] Filter by release version
|
|
116
|
+
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
117
|
+
* @param {boolean} [archived] Filter by the archived status
|
|
118
|
+
* @param {boolean} [freezed] Filter by the freezed status
|
|
119
|
+
* @param {string} [afterReleaseId] Show releases after the provided one
|
|
120
|
+
* @param {number} [afterDate] Show releases after the provided timestamp
|
|
121
|
+
* @param {ReleasesSort} [sort] Sort mode
|
|
122
|
+
* @param {boolean} [group] Group releases by version + variant. This will change the response!
|
|
123
|
+
* @param {number} [skip] Skip query results
|
|
124
|
+
* @param {number} [limit] Limit query results (0 means unlimited)
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
* @memberof ReleaseApiInterface
|
|
127
|
+
*/
|
|
128
|
+
getReleasesRequestOpts(requestParameters: GetReleasesRequest): Promise<runtime.RequestOpts>;
|
|
129
|
+
/**
|
|
130
|
+
* 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.
|
|
91
131
|
* @summary Get Releases
|
|
92
132
|
* @param {Array<string>} [id] Filter by Release IDs
|
|
93
133
|
* @param {Array<string>} [id2] Filter by Release IDs (deprecated)
|
|
@@ -111,10 +151,23 @@ export interface ReleaseApiInterface {
|
|
|
111
151
|
*/
|
|
112
152
|
getReleasesRaw(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseGetReleases>>;
|
|
113
153
|
/**
|
|
114
|
-
* 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
|
|
154
|
+
* 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.
|
|
115
155
|
* Get Releases
|
|
116
156
|
*/
|
|
117
157
|
getReleases(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseGetReleases>;
|
|
158
|
+
/**
|
|
159
|
+
* Creates request options for getUpdatesDeprecated without sending the request
|
|
160
|
+
* @param {string} lastKnownId
|
|
161
|
+
* @param {Array<string>} [deviceId] Filter by device ID
|
|
162
|
+
* @param {Array<ReleaseType>} [type] Filter by release type
|
|
163
|
+
* @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
|
|
164
|
+
* @param {number} [skip] Skip query results
|
|
165
|
+
* @param {number} [limit] Limit query results (0 means unlimited)
|
|
166
|
+
* @deprecated
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
* @memberof ReleaseApiInterface
|
|
169
|
+
*/
|
|
170
|
+
getUpdatesDeprecatedRequestOpts(requestParameters: GetUpdatesDeprecatedRequest): Promise<runtime.RequestOpts>;
|
|
118
171
|
/**
|
|
119
172
|
* 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!
|
|
120
173
|
* @summary Get Updates
|
|
@@ -141,6 +194,10 @@ export interface ReleaseApiInterface {
|
|
|
141
194
|
*
|
|
142
195
|
*/
|
|
143
196
|
export declare class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInterface {
|
|
197
|
+
/**
|
|
198
|
+
* Creates request options for getRelease without sending the request
|
|
199
|
+
*/
|
|
200
|
+
getReleaseRequestOpts(requestParameters: GetReleaseRequest): Promise<runtime.RequestOpts>;
|
|
144
201
|
/**
|
|
145
202
|
* 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!
|
|
146
203
|
* Get Release
|
|
@@ -151,6 +208,11 @@ export declare class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInt
|
|
|
151
208
|
* Get Release
|
|
152
209
|
*/
|
|
153
210
|
getRelease(requestParameters?: GetReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseResponse>;
|
|
211
|
+
/**
|
|
212
|
+
* Creates request options for getReleaseDeprecated without sending the request
|
|
213
|
+
* @deprecated
|
|
214
|
+
*/
|
|
215
|
+
getReleaseDeprecatedRequestOpts(requestParameters: GetReleaseDeprecatedRequest): Promise<runtime.RequestOpts>;
|
|
154
216
|
/**
|
|
155
217
|
* Gets release information using the release ID, nothing to discuss really.
|
|
156
218
|
* Get Release Short
|
|
@@ -164,15 +226,24 @@ export declare class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInt
|
|
|
164
226
|
*/
|
|
165
227
|
getReleaseDeprecated(requestParameters: GetReleaseDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseResponse>;
|
|
166
228
|
/**
|
|
167
|
-
*
|
|
229
|
+
* Creates request options for getReleases without sending the request
|
|
230
|
+
*/
|
|
231
|
+
getReleasesRequestOpts(requestParameters: GetReleasesRequest): Promise<runtime.RequestOpts>;
|
|
232
|
+
/**
|
|
233
|
+
* 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.
|
|
168
234
|
* Get Releases
|
|
169
235
|
*/
|
|
170
236
|
getReleasesRaw(requestParameters: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResponseGetReleases>>;
|
|
171
237
|
/**
|
|
172
|
-
* 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
|
|
238
|
+
* 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.
|
|
173
239
|
* Get Releases
|
|
174
240
|
*/
|
|
175
241
|
getReleases(requestParameters?: GetReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResponseGetReleases>;
|
|
242
|
+
/**
|
|
243
|
+
* Creates request options for getUpdatesDeprecated without sending the request
|
|
244
|
+
* @deprecated
|
|
245
|
+
*/
|
|
246
|
+
getUpdatesDeprecatedRequestOpts(requestParameters: GetUpdatesDeprecatedRequest): Promise<runtime.RequestOpts>;
|
|
176
247
|
/**
|
|
177
248
|
* 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!
|
|
178
249
|
* Get Updates
|