@orangefox-recovery/foxclient 5.2.5 → 5.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (186) hide show
  1. package/.openapi-generator/FILES +28 -27
  2. package/README.md +3 -61
  3. package/dist/apis/DeviceApi.d.ts +158 -0
  4. package/dist/apis/DeviceApi.js +188 -0
  5. package/dist/apis/PasteApi.d.ts +80 -0
  6. package/dist/apis/PasteApi.js +95 -0
  7. package/dist/apis/ReleaseApi.d.ts +188 -0
  8. package/dist/apis/ReleaseApi.js +226 -0
  9. package/dist/apis/StatsApi.d.ts +49 -0
  10. package/dist/apis/StatsApi.js +60 -0
  11. package/dist/apis/index.d.ts +4 -0
  12. package/dist/apis/index.js +22 -0
  13. package/dist/esm/apis/DeviceApi.d.ts +158 -0
  14. package/dist/esm/apis/DeviceApi.js +184 -0
  15. package/dist/esm/apis/PasteApi.d.ts +80 -0
  16. package/dist/esm/apis/PasteApi.js +91 -0
  17. package/dist/esm/apis/ReleaseApi.d.ts +188 -0
  18. package/dist/esm/apis/ReleaseApi.js +222 -0
  19. package/dist/esm/apis/StatsApi.d.ts +49 -0
  20. package/dist/esm/apis/StatsApi.js +56 -0
  21. package/dist/esm/apis/index.d.ts +4 -0
  22. package/dist/esm/apis/index.js +6 -0
  23. package/dist/esm/index.d.ts +3 -13
  24. package/dist/esm/index.js +3 -13
  25. package/dist/esm/models/DeviceResponse.d.ts +101 -0
  26. package/dist/esm/models/DeviceResponse.js +82 -0
  27. package/dist/esm/models/GlobalStatsAggregationModel.d.ts +52 -0
  28. package/dist/esm/models/GlobalStatsAggregationModel.js +55 -0
  29. package/dist/esm/models/HTTPValidationError.d.ts +33 -0
  30. package/dist/esm/models/HTTPValidationError.js +42 -0
  31. package/dist/esm/models/ListResponseReleaseResponse.d.ts +39 -0
  32. package/dist/esm/models/ListResponseReleaseResponse.js +47 -0
  33. package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +39 -0
  34. package/dist/esm/models/ListResponseShortDeviceResponse.js +47 -0
  35. package/dist/esm/models/ListResponseShortReleaseResponse.d.ts +39 -0
  36. package/dist/esm/models/ListResponseShortReleaseResponse.js +47 -0
  37. package/dist/esm/models/ListResponseStr.d.ts +38 -0
  38. package/dist/esm/models/ListResponseStr.js +46 -0
  39. package/dist/esm/models/MaintainerShortModel.d.ts +44 -0
  40. package/dist/esm/models/MaintainerShortModel.js +51 -0
  41. package/dist/esm/models/PasteInput.d.ts +50 -0
  42. package/dist/esm/models/PasteInput.js +51 -0
  43. package/dist/esm/models/PasteOutput.d.ts +50 -0
  44. package/dist/esm/models/PasteOutput.js +51 -0
  45. package/dist/esm/models/RecoveryImgResponse.d.ts +38 -0
  46. package/dist/esm/models/RecoveryImgResponse.js +47 -0
  47. package/dist/esm/models/ReleaseGroupsResponse.d.ts +35 -0
  48. package/dist/esm/models/ReleaseGroupsResponse.js +43 -0
  49. package/dist/esm/models/ReleaseResponse.d.ts +139 -0
  50. package/dist/esm/models/ReleaseResponse.js +107 -0
  51. package/dist/esm/models/ReleaseType.d.ts +26 -0
  52. package/dist/esm/models/ReleaseType.js +44 -0
  53. package/dist/esm/models/ReleasesSort.d.ts +25 -0
  54. package/dist/esm/models/ReleasesSort.js +43 -0
  55. package/dist/esm/models/ResponseGetReleases.d.ts +41 -0
  56. package/dist/esm/models/ResponseGetReleases.js +46 -0
  57. package/dist/esm/models/ShortDeviceResponse.d.ts +82 -0
  58. package/dist/esm/models/ShortDeviceResponse.js +73 -0
  59. package/dist/esm/models/ShortReleaseResponse.d.ts +100 -0
  60. package/dist/esm/models/ShortReleaseResponse.js +84 -0
  61. package/dist/esm/models/ValidationError.d.ts +45 -0
  62. package/dist/esm/models/ValidationError.js +52 -0
  63. package/dist/esm/models/ValidationErrorLocInner.d.ts +26 -0
  64. package/{index.ts → dist/esm/models/ValidationErrorLocInner.js} +20 -7
  65. package/dist/esm/models/index.d.ts +20 -0
  66. package/dist/esm/models/index.js +22 -0
  67. package/dist/esm/runtime.d.ts +184 -0
  68. package/dist/esm/runtime.js +334 -0
  69. package/dist/index.d.ts +3 -13
  70. package/dist/index.js +5 -15
  71. package/dist/models/DeviceResponse.d.ts +101 -0
  72. package/dist/models/DeviceResponse.js +89 -0
  73. package/dist/models/GlobalStatsAggregationModel.d.ts +52 -0
  74. package/dist/models/GlobalStatsAggregationModel.js +62 -0
  75. package/dist/models/HTTPValidationError.d.ts +33 -0
  76. package/dist/models/HTTPValidationError.js +49 -0
  77. package/dist/models/ListResponseReleaseResponse.d.ts +39 -0
  78. package/dist/models/ListResponseReleaseResponse.js +54 -0
  79. package/dist/models/ListResponseShortDeviceResponse.d.ts +39 -0
  80. package/dist/models/ListResponseShortDeviceResponse.js +54 -0
  81. package/dist/models/ListResponseShortReleaseResponse.d.ts +39 -0
  82. package/dist/models/ListResponseShortReleaseResponse.js +54 -0
  83. package/dist/models/ListResponseStr.d.ts +38 -0
  84. package/dist/models/ListResponseStr.js +53 -0
  85. package/dist/models/MaintainerShortModel.d.ts +44 -0
  86. package/dist/models/MaintainerShortModel.js +58 -0
  87. package/dist/models/PasteInput.d.ts +50 -0
  88. package/dist/models/PasteInput.js +58 -0
  89. package/dist/models/PasteOutput.d.ts +50 -0
  90. package/dist/models/PasteOutput.js +58 -0
  91. package/dist/models/RecoveryImgResponse.d.ts +38 -0
  92. package/dist/models/RecoveryImgResponse.js +54 -0
  93. package/dist/models/ReleaseGroupsResponse.d.ts +35 -0
  94. package/dist/models/ReleaseGroupsResponse.js +50 -0
  95. package/dist/models/ReleaseResponse.d.ts +139 -0
  96. package/dist/models/ReleaseResponse.js +114 -0
  97. package/dist/models/ReleaseType.d.ts +26 -0
  98. package/dist/models/ReleaseType.js +52 -0
  99. package/dist/models/ReleasesSort.d.ts +25 -0
  100. package/dist/models/ReleasesSort.js +51 -0
  101. package/dist/models/ResponseGetReleases.d.ts +41 -0
  102. package/dist/models/ResponseGetReleases.js +53 -0
  103. package/dist/models/ShortDeviceResponse.d.ts +82 -0
  104. package/dist/models/ShortDeviceResponse.js +80 -0
  105. package/dist/models/ShortReleaseResponse.d.ts +100 -0
  106. package/dist/models/ShortReleaseResponse.js +91 -0
  107. package/dist/models/ValidationError.d.ts +45 -0
  108. package/dist/models/ValidationError.js +59 -0
  109. package/dist/models/ValidationErrorLocInner.d.ts +26 -0
  110. package/dist/models/ValidationErrorLocInner.js +38 -0
  111. package/dist/models/index.d.ts +20 -0
  112. package/dist/models/index.js +38 -0
  113. package/dist/runtime.d.ts +184 -0
  114. package/dist/runtime.js +350 -0
  115. package/package.json +4 -17
  116. package/src/apis/DeviceApi.ts +326 -0
  117. package/src/apis/PasteApi.ts +158 -0
  118. package/src/apis/ReleaseApi.ts +414 -0
  119. package/src/apis/StatsApi.ts +82 -0
  120. package/src/apis/index.ts +6 -0
  121. package/src/index.ts +5 -0
  122. package/src/models/DeviceResponse.ts +171 -0
  123. package/src/models/GlobalStatsAggregationModel.ts +93 -0
  124. package/src/models/HTTPValidationError.ts +73 -0
  125. package/src/models/ListResponseReleaseResponse.ts +82 -0
  126. package/src/models/ListResponseShortDeviceResponse.ts +82 -0
  127. package/src/models/ListResponseShortReleaseResponse.ts +82 -0
  128. package/src/models/ListResponseStr.ts +74 -0
  129. package/src/models/MaintainerShortModel.ts +84 -0
  130. package/src/models/PasteInput.ts +91 -0
  131. package/src/models/PasteOutput.ts +91 -0
  132. package/src/models/RecoveryImgResponse.ts +75 -0
  133. package/src/models/ReleaseGroupsResponse.ts +74 -0
  134. package/src/models/ReleaseResponse.ts +233 -0
  135. package/src/models/ReleaseType.ts +54 -0
  136. package/src/models/ReleasesSort.ts +53 -0
  137. package/src/models/ResponseGetReleases.ts +96 -0
  138. package/src/models/ShortDeviceResponse.ts +138 -0
  139. package/src/models/ShortReleaseResponse.ts +174 -0
  140. package/src/models/ValidationError.ts +92 -0
  141. package/src/models/ValidationErrorLocInner.ts +46 -0
  142. package/src/models/index.ts +22 -0
  143. package/src/runtime.ts +432 -0
  144. package/tsconfig.json +2 -4
  145. package/api.ts +0 -1832
  146. package/base.ts +0 -86
  147. package/common.ts +0 -150
  148. package/configuration.ts +0 -115
  149. package/dist/api.d.ts +0 -1304
  150. package/dist/api.js +0 -1001
  151. package/dist/base.d.ts +0 -66
  152. package/dist/base.js +0 -65
  153. package/dist/common.d.ts +0 -65
  154. package/dist/common.js +0 -161
  155. package/dist/configuration.d.ts +0 -91
  156. package/dist/configuration.js +0 -44
  157. package/dist/esm/api.d.ts +0 -1304
  158. package/dist/esm/api.js +0 -986
  159. package/dist/esm/base.d.ts +0 -66
  160. package/dist/esm/base.js +0 -60
  161. package/dist/esm/common.d.ts +0 -65
  162. package/dist/esm/common.js +0 -149
  163. package/dist/esm/configuration.d.ts +0 -91
  164. package/dist/esm/configuration.js +0 -40
  165. package/docs/DeviceApi.md +0 -251
  166. package/docs/DeviceResponse.md +0 -44
  167. package/docs/GlobalStatsAggregationModel.md +0 -26
  168. package/docs/HTTPValidationError.md +0 -20
  169. package/docs/ListResponseReleaseResponse.md +0 -22
  170. package/docs/ListResponseShortDeviceResponse.md +0 -22
  171. package/docs/ListResponseShortReleaseResponse.md +0 -22
  172. package/docs/ListResponseStr.md +0 -22
  173. package/docs/MaintainerShortModel.md +0 -26
  174. package/docs/RecoveryImgResponse.md +0 -22
  175. package/docs/ReleaseApi.md +0 -289
  176. package/docs/ReleaseGroupsResponse.md +0 -20
  177. package/docs/ReleaseResponse.md +0 -56
  178. package/docs/ReleaseType.md +0 -12
  179. package/docs/ReleasesSort.md +0 -10
  180. package/docs/ResponseGetReleases.md +0 -22
  181. package/docs/ShortDeviceResponse.md +0 -38
  182. package/docs/ShortReleaseResponse.md +0 -44
  183. package/docs/StatsApi.md +0 -53
  184. package/docs/ValidationError.md +0 -24
  185. package/docs/ValidationErrorLocInner.md +0 -18
  186. package/git_push.sh +0 -57
package/dist/api.js DELETED
@@ -1,1001 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Fox API
6
- * 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.
7
- *
8
- * The version of the OpenAPI document: 5.2.5
9
- * Contact: admin@orangefox.tech
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
- return new (P || (P = Promise))(function (resolve, reject) {
18
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
- step((generator = generator.apply(thisArg, _arguments || [])).next());
22
- });
23
- };
24
- Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.StatsApi = exports.StatsApiFactory = exports.StatsApiFp = exports.StatsApiAxiosParamCreator = exports.ReleaseApi = exports.ReleaseApiFactory = exports.ReleaseApiFp = exports.ReleaseApiAxiosParamCreator = exports.DeviceApi = exports.DeviceApiFactory = exports.DeviceApiFp = exports.DeviceApiAxiosParamCreator = exports.ReleasesSort = exports.ReleaseType = void 0;
26
- const axios_1 = require("axios");
27
- // Some imports not used depending on template conditions
28
- // @ts-ignore
29
- const common_1 = require("./common");
30
- // @ts-ignore
31
- const base_1 = require("./base");
32
- /**
33
- *
34
- * @export
35
- * @enum {string}
36
- */
37
- exports.ReleaseType = {
38
- Stable: 'stable',
39
- Beta: 'beta',
40
- Alpha: 'alpha'
41
- };
42
- /**
43
- *
44
- * @export
45
- * @enum {string}
46
- */
47
- exports.ReleasesSort = {
48
- DateAsc: 'date_asc',
49
- DateDesc: 'date_desc'
50
- };
51
- /**
52
- * DeviceApi - axios parameter creator
53
- * @export
54
- */
55
- const DeviceApiAxiosParamCreator = function (configuration) {
56
- return {
57
- /**
58
- * 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.
59
- * @summary Get Device
60
- * @param {string | null} [deviceId]
61
- * @param {string | null} [id] Filter by Device ID (deprecated)
62
- * @param {string | null} [codename] Not recommended to use when you can
63
- * @param {*} [options] Override http request option.
64
- * @throws {RequiredError}
65
- */
66
- getDevice: (deviceId_1, id_1, codename_1, ...args_1) => __awaiter(this, [deviceId_1, id_1, codename_1, ...args_1], void 0, function* (deviceId, id, codename, options = {}) {
67
- const localVarPath = `/devices/get`;
68
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
69
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
70
- let baseOptions;
71
- if (configuration) {
72
- baseOptions = configuration.baseOptions;
73
- }
74
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
75
- const localVarHeaderParameter = {};
76
- const localVarQueryParameter = {};
77
- if (deviceId !== undefined) {
78
- localVarQueryParameter['device_id'] = deviceId;
79
- }
80
- if (id !== undefined) {
81
- localVarQueryParameter['_id'] = id;
82
- }
83
- if (codename !== undefined) {
84
- localVarQueryParameter['codename'] = codename;
85
- }
86
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
87
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
88
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
89
- return {
90
- url: (0, common_1.toPathString)(localVarUrlObj),
91
- options: localVarRequestOptions,
92
- };
93
- }),
94
- /**
95
- * Gets device info using device ID.
96
- * @summary Get Device Short
97
- * @param {string} deviceId
98
- * @param {*} [options] Override http request option.
99
- * @deprecated
100
- * @throws {RequiredError}
101
- */
102
- getDeviceDeprecated: (deviceId_1, ...args_1) => __awaiter(this, [deviceId_1, ...args_1], void 0, function* (deviceId, options = {}) {
103
- // verify required parameter 'deviceId' is not null or undefined
104
- (0, common_1.assertParamExists)('getDeviceDeprecated', 'deviceId', deviceId);
105
- const localVarPath = `/devices/{device_id}`
106
- .replace(`{${"device_id"}}`, encodeURIComponent(String(deviceId)));
107
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
108
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
109
- let baseOptions;
110
- if (configuration) {
111
- baseOptions = configuration.baseOptions;
112
- }
113
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
114
- const localVarHeaderParameter = {};
115
- const localVarQueryParameter = {};
116
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
117
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
118
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
119
- return {
120
- url: (0, common_1.toPathString)(localVarUrlObj),
121
- options: localVarRequestOptions,
122
- };
123
- }),
124
- /**
125
- * 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.
126
- * @summary Get Devices
127
- * @param {Array<string>} [id] Filter by Device IDs
128
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
129
- * @param {Array<string>} [oemName] Filter by OEM names
130
- * @param {Array<string>} [codename] Filter by device codenames
131
- * @param {Array<string>} [modelName] Filter by model names
132
- * @param {boolean | null} [supported] Supported status
133
- * @param {Array<string>} [maintainer] Filter by maintainer ID
134
- * @param {boolean | null} [freezed] Filter by Freezed status
135
- * @param {boolean | null} [hasReleases] Filter by has releases status
136
- * @param {number | null} [skip] Skip query results
137
- * @param {number | null} [limit] Limit query results (0 means unlimited)
138
- * @param {*} [options] Override http request option.
139
- * @throws {RequiredError}
140
- */
141
- getDevices: (id_1, id2_1, oemName_1, codename_1, modelName_1, supported_1, maintainer_1, freezed_1, hasReleases_1, skip_1, limit_1, ...args_1) => __awaiter(this, [id_1, id2_1, oemName_1, codename_1, modelName_1, supported_1, maintainer_1, freezed_1, hasReleases_1, skip_1, limit_1, ...args_1], void 0, function* (id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options = {}) {
142
- const localVarPath = `/devices/`;
143
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
144
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
145
- let baseOptions;
146
- if (configuration) {
147
- baseOptions = configuration.baseOptions;
148
- }
149
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
150
- const localVarHeaderParameter = {};
151
- const localVarQueryParameter = {};
152
- if (id) {
153
- localVarQueryParameter['id'] = id;
154
- }
155
- if (id2) {
156
- localVarQueryParameter['_id'] = id2;
157
- }
158
- if (oemName) {
159
- localVarQueryParameter['oem_name'] = oemName;
160
- }
161
- if (codename) {
162
- localVarQueryParameter['codename'] = codename;
163
- }
164
- if (modelName) {
165
- localVarQueryParameter['model_name'] = modelName;
166
- }
167
- if (supported !== undefined) {
168
- localVarQueryParameter['supported'] = supported;
169
- }
170
- if (maintainer) {
171
- localVarQueryParameter['maintainer'] = maintainer;
172
- }
173
- if (freezed !== undefined) {
174
- localVarQueryParameter['freezed'] = freezed;
175
- }
176
- if (hasReleases !== undefined) {
177
- localVarQueryParameter['has_releases'] = hasReleases;
178
- }
179
- if (skip !== undefined) {
180
- localVarQueryParameter['skip'] = skip;
181
- }
182
- if (limit !== undefined) {
183
- localVarQueryParameter['limit'] = limit;
184
- }
185
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
186
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
187
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
188
- return {
189
- url: (0, common_1.toPathString)(localVarUrlObj),
190
- options: localVarRequestOptions,
191
- };
192
- }),
193
- /**
194
- * Lists all OEM names
195
- * @summary Get Oems
196
- * @param {*} [options] Override http request option.
197
- * @throws {RequiredError}
198
- */
199
- getOems: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
200
- const localVarPath = `/oems/`;
201
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
202
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
203
- let baseOptions;
204
- if (configuration) {
205
- baseOptions = configuration.baseOptions;
206
- }
207
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
208
- const localVarHeaderParameter = {};
209
- const localVarQueryParameter = {};
210
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
211
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
212
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
213
- return {
214
- url: (0, common_1.toPathString)(localVarUrlObj),
215
- options: localVarRequestOptions,
216
- };
217
- }),
218
- };
219
- };
220
- exports.DeviceApiAxiosParamCreator = DeviceApiAxiosParamCreator;
221
- /**
222
- * DeviceApi - functional programming interface
223
- * @export
224
- */
225
- const DeviceApiFp = function (configuration) {
226
- const localVarAxiosParamCreator = (0, exports.DeviceApiAxiosParamCreator)(configuration);
227
- return {
228
- /**
229
- * Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
230
- * @summary Get Device
231
- * @param {string | null} [deviceId]
232
- * @param {string | null} [id] Filter by Device ID (deprecated)
233
- * @param {string | null} [codename] Not recommended to use when you can
234
- * @param {*} [options] Override http request option.
235
- * @throws {RequiredError}
236
- */
237
- getDevice(deviceId, id, codename, options) {
238
- return __awaiter(this, void 0, void 0, function* () {
239
- var _a, _b, _c;
240
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getDevice(deviceId, id, codename, options);
241
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
242
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getDevice']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
243
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
244
- });
245
- },
246
- /**
247
- * Gets device info using device ID.
248
- * @summary Get Device Short
249
- * @param {string} deviceId
250
- * @param {*} [options] Override http request option.
251
- * @deprecated
252
- * @throws {RequiredError}
253
- */
254
- getDeviceDeprecated(deviceId, options) {
255
- return __awaiter(this, void 0, void 0, function* () {
256
- var _a, _b, _c;
257
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeviceDeprecated(deviceId, options);
258
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
259
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getDeviceDeprecated']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
260
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
261
- });
262
- },
263
- /**
264
- * Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it\'s possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it\'s very inconsistent around some OEMs that play with the names around. As of the current moment, the API won\'t support unified model names at all! In short, do not use model_name as device\'s identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn\'t support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
265
- * @summary Get Devices
266
- * @param {Array<string>} [id] Filter by Device IDs
267
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
268
- * @param {Array<string>} [oemName] Filter by OEM names
269
- * @param {Array<string>} [codename] Filter by device codenames
270
- * @param {Array<string>} [modelName] Filter by model names
271
- * @param {boolean | null} [supported] Supported status
272
- * @param {Array<string>} [maintainer] Filter by maintainer ID
273
- * @param {boolean | null} [freezed] Filter by Freezed status
274
- * @param {boolean | null} [hasReleases] Filter by has releases status
275
- * @param {number | null} [skip] Skip query results
276
- * @param {number | null} [limit] Limit query results (0 means unlimited)
277
- * @param {*} [options] Override http request option.
278
- * @throws {RequiredError}
279
- */
280
- getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
281
- return __awaiter(this, void 0, void 0, function* () {
282
- var _a, _b, _c;
283
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options);
284
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
285
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getDevices']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
286
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
287
- });
288
- },
289
- /**
290
- * Lists all OEM names
291
- * @summary Get Oems
292
- * @param {*} [options] Override http request option.
293
- * @throws {RequiredError}
294
- */
295
- getOems(options) {
296
- return __awaiter(this, void 0, void 0, function* () {
297
- var _a, _b, _c;
298
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getOems(options);
299
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
300
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DeviceApi.getOems']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
301
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
302
- });
303
- },
304
- };
305
- };
306
- exports.DeviceApiFp = DeviceApiFp;
307
- /**
308
- * DeviceApi - factory interface
309
- * @export
310
- */
311
- const DeviceApiFactory = function (configuration, basePath, axios) {
312
- const localVarFp = (0, exports.DeviceApiFp)(configuration);
313
- return {
314
- /**
315
- * 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.
316
- * @summary Get Device
317
- * @param {string | null} [deviceId]
318
- * @param {string | null} [id] Filter by Device ID (deprecated)
319
- * @param {string | null} [codename] Not recommended to use when you can
320
- * @param {*} [options] Override http request option.
321
- * @throws {RequiredError}
322
- */
323
- getDevice(deviceId, id, codename, options) {
324
- return localVarFp.getDevice(deviceId, id, codename, options).then((request) => request(axios, basePath));
325
- },
326
- /**
327
- * Gets device info using device ID.
328
- * @summary Get Device Short
329
- * @param {string} deviceId
330
- * @param {*} [options] Override http request option.
331
- * @deprecated
332
- * @throws {RequiredError}
333
- */
334
- getDeviceDeprecated(deviceId, options) {
335
- return localVarFp.getDeviceDeprecated(deviceId, options).then((request) => request(axios, basePath));
336
- },
337
- /**
338
- * 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.
339
- * @summary Get Devices
340
- * @param {Array<string>} [id] Filter by Device IDs
341
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
342
- * @param {Array<string>} [oemName] Filter by OEM names
343
- * @param {Array<string>} [codename] Filter by device codenames
344
- * @param {Array<string>} [modelName] Filter by model names
345
- * @param {boolean | null} [supported] Supported status
346
- * @param {Array<string>} [maintainer] Filter by maintainer ID
347
- * @param {boolean | null} [freezed] Filter by Freezed status
348
- * @param {boolean | null} [hasReleases] Filter by has releases status
349
- * @param {number | null} [skip] Skip query results
350
- * @param {number | null} [limit] Limit query results (0 means unlimited)
351
- * @param {*} [options] Override http request option.
352
- * @throws {RequiredError}
353
- */
354
- getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
355
- return localVarFp.getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(axios, basePath));
356
- },
357
- /**
358
- * Lists all OEM names
359
- * @summary Get Oems
360
- * @param {*} [options] Override http request option.
361
- * @throws {RequiredError}
362
- */
363
- getOems(options) {
364
- return localVarFp.getOems(options).then((request) => request(axios, basePath));
365
- },
366
- };
367
- };
368
- exports.DeviceApiFactory = DeviceApiFactory;
369
- /**
370
- * DeviceApi - object-oriented interface
371
- * @export
372
- * @class DeviceApi
373
- * @extends {BaseAPI}
374
- */
375
- class DeviceApi extends base_1.BaseAPI {
376
- /**
377
- * 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.
378
- * @summary Get Device
379
- * @param {string | null} [deviceId]
380
- * @param {string | null} [id] Filter by Device ID (deprecated)
381
- * @param {string | null} [codename] Not recommended to use when you can
382
- * @param {*} [options] Override http request option.
383
- * @throws {RequiredError}
384
- * @memberof DeviceApi
385
- */
386
- getDevice(deviceId, id, codename, options) {
387
- return (0, exports.DeviceApiFp)(this.configuration).getDevice(deviceId, id, codename, options).then((request) => request(this.axios, this.basePath));
388
- }
389
- /**
390
- * Gets device info using device ID.
391
- * @summary Get Device Short
392
- * @param {string} deviceId
393
- * @param {*} [options] Override http request option.
394
- * @deprecated
395
- * @throws {RequiredError}
396
- * @memberof DeviceApi
397
- */
398
- getDeviceDeprecated(deviceId, options) {
399
- return (0, exports.DeviceApiFp)(this.configuration).getDeviceDeprecated(deviceId, options).then((request) => request(this.axios, this.basePath));
400
- }
401
- /**
402
- * 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.
403
- * @summary Get Devices
404
- * @param {Array<string>} [id] Filter by Device IDs
405
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
406
- * @param {Array<string>} [oemName] Filter by OEM names
407
- * @param {Array<string>} [codename] Filter by device codenames
408
- * @param {Array<string>} [modelName] Filter by model names
409
- * @param {boolean | null} [supported] Supported status
410
- * @param {Array<string>} [maintainer] Filter by maintainer ID
411
- * @param {boolean | null} [freezed] Filter by Freezed status
412
- * @param {boolean | null} [hasReleases] Filter by has releases status
413
- * @param {number | null} [skip] Skip query results
414
- * @param {number | null} [limit] Limit query results (0 means unlimited)
415
- * @param {*} [options] Override http request option.
416
- * @throws {RequiredError}
417
- * @memberof DeviceApi
418
- */
419
- getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options) {
420
- return (0, exports.DeviceApiFp)(this.configuration).getDevices(id, id2, oemName, codename, modelName, supported, maintainer, freezed, hasReleases, skip, limit, options).then((request) => request(this.axios, this.basePath));
421
- }
422
- /**
423
- * Lists all OEM names
424
- * @summary Get Oems
425
- * @param {*} [options] Override http request option.
426
- * @throws {RequiredError}
427
- * @memberof DeviceApi
428
- */
429
- getOems(options) {
430
- return (0, exports.DeviceApiFp)(this.configuration).getOems(options).then((request) => request(this.axios, this.basePath));
431
- }
432
- }
433
- exports.DeviceApi = DeviceApi;
434
- /**
435
- * ReleaseApi - axios parameter creator
436
- * @export
437
- */
438
- const ReleaseApiAxiosParamCreator = function (configuration) {
439
- return {
440
- /**
441
- * 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!
442
- * @summary Get Release
443
- * @param {string | null} [releaseId] Release ID
444
- * @param {string | null} [id] Release ID (deprecated)
445
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
446
- * @param {string | null} [filename]
447
- * @param {*} [options] Override http request option.
448
- * @throws {RequiredError}
449
- */
450
- getRelease: (releaseId_1, id_1, buildId_1, filename_1, ...args_1) => __awaiter(this, [releaseId_1, id_1, buildId_1, filename_1, ...args_1], void 0, function* (releaseId, id, buildId, filename, options = {}) {
451
- const localVarPath = `/releases/get`;
452
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
453
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
454
- let baseOptions;
455
- if (configuration) {
456
- baseOptions = configuration.baseOptions;
457
- }
458
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
459
- const localVarHeaderParameter = {};
460
- const localVarQueryParameter = {};
461
- if (releaseId !== undefined) {
462
- localVarQueryParameter['release_id'] = releaseId;
463
- }
464
- if (id !== undefined) {
465
- localVarQueryParameter['_id'] = id;
466
- }
467
- if (buildId !== undefined) {
468
- localVarQueryParameter['build_id'] = buildId;
469
- }
470
- if (filename !== undefined) {
471
- localVarQueryParameter['filename'] = filename;
472
- }
473
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
474
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
475
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
476
- return {
477
- url: (0, common_1.toPathString)(localVarUrlObj),
478
- options: localVarRequestOptions,
479
- };
480
- }),
481
- /**
482
- * Gets release information using the release ID, nothing to discuss really.
483
- * @summary Get Release Short
484
- * @param {string} releaseId
485
- * @param {*} [options] Override http request option.
486
- * @deprecated
487
- * @throws {RequiredError}
488
- */
489
- getReleaseDeprecated: (releaseId_1, ...args_1) => __awaiter(this, [releaseId_1, ...args_1], void 0, function* (releaseId, options = {}) {
490
- // verify required parameter 'releaseId' is not null or undefined
491
- (0, common_1.assertParamExists)('getReleaseDeprecated', 'releaseId', releaseId);
492
- const localVarPath = `/releases/{release_id}`
493
- .replace(`{${"release_id"}}`, encodeURIComponent(String(releaseId)));
494
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
495
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
496
- let baseOptions;
497
- if (configuration) {
498
- baseOptions = configuration.baseOptions;
499
- }
500
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
501
- const localVarHeaderParameter = {};
502
- const localVarQueryParameter = {};
503
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
504
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
505
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
506
- return {
507
- url: (0, common_1.toPathString)(localVarUrlObj),
508
- options: localVarRequestOptions,
509
- };
510
- }),
511
- /**
512
- * 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.
513
- * @summary Get Releases
514
- * @param {Array<string>} [id] Filter by Release IDs
515
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
516
- * @param {Array<string>} [buildId] Filter by Build IDs
517
- * @param {Array<string>} [deviceId] Filter by Device IDs
518
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
519
- * @param {Array<string>} [codename] Filter by device codenames
520
- * @param {Array<string>} [version] Filter by release version
521
- * @param {Array<ReleaseType>} [type] Filter by release type
522
- * @param {boolean | null} [archived] Filter by the archived status
523
- * @param {boolean | null} [freezed] Filter by the freezed status
524
- * @param {string | null} [afterReleaseId] Show releases after the provided one
525
- * @param {number | null} [afterDate] Show releases after the provided timestamp
526
- * @param {ReleasesSort} [sort] Sort mode
527
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
528
- * @param {number | null} [skip] Skip query results
529
- * @param {number | null} [limit] Limit query results (0 means unlimited)
530
- * @param {*} [options] Override http request option.
531
- * @throws {RequiredError}
532
- */
533
- getReleases: (id_1, id2_1, buildId_1, deviceId_1, maintainerId_1, codename_1, version_1, type_1, archived_1, freezed_1, afterReleaseId_1, afterDate_1, sort_1, group_1, skip_1, limit_1, ...args_1) => __awaiter(this, [id_1, id2_1, buildId_1, deviceId_1, maintainerId_1, codename_1, version_1, type_1, archived_1, freezed_1, afterReleaseId_1, afterDate_1, sort_1, group_1, skip_1, limit_1, ...args_1], void 0, function* (id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options = {}) {
534
- const localVarPath = `/releases/`;
535
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
536
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
537
- let baseOptions;
538
- if (configuration) {
539
- baseOptions = configuration.baseOptions;
540
- }
541
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
542
- const localVarHeaderParameter = {};
543
- const localVarQueryParameter = {};
544
- if (id) {
545
- localVarQueryParameter['id'] = id;
546
- }
547
- if (id2) {
548
- localVarQueryParameter['_id'] = id2;
549
- }
550
- if (buildId) {
551
- localVarQueryParameter['build_id'] = buildId;
552
- }
553
- if (deviceId) {
554
- localVarQueryParameter['device_id'] = deviceId;
555
- }
556
- if (maintainerId) {
557
- localVarQueryParameter['maintainer_id'] = maintainerId;
558
- }
559
- if (codename) {
560
- localVarQueryParameter['codename'] = codename;
561
- }
562
- if (version) {
563
- localVarQueryParameter['version'] = version;
564
- }
565
- if (type) {
566
- localVarQueryParameter['type'] = type;
567
- }
568
- if (archived !== undefined) {
569
- localVarQueryParameter['archived'] = archived;
570
- }
571
- if (freezed !== undefined) {
572
- localVarQueryParameter['freezed'] = freezed;
573
- }
574
- if (afterReleaseId !== undefined) {
575
- localVarQueryParameter['after_release_id'] = afterReleaseId;
576
- }
577
- if (afterDate !== undefined) {
578
- localVarQueryParameter['after_date'] = afterDate;
579
- }
580
- if (sort !== undefined) {
581
- localVarQueryParameter['sort'] = sort;
582
- }
583
- if (group !== undefined) {
584
- localVarQueryParameter['group'] = group;
585
- }
586
- if (skip !== undefined) {
587
- localVarQueryParameter['skip'] = skip;
588
- }
589
- if (limit !== undefined) {
590
- localVarQueryParameter['limit'] = limit;
591
- }
592
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
593
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
594
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
595
- return {
596
- url: (0, common_1.toPathString)(localVarUrlObj),
597
- options: localVarRequestOptions,
598
- };
599
- }),
600
- /**
601
- * 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!
602
- * @summary Get Updates
603
- * @param {string} lastKnownId
604
- * @param {Array<string>} [deviceId] Filter by device ID
605
- * @param {Array<ReleaseType>} [type] Filter by release type
606
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
607
- * @param {number | null} [skip] Skip query results
608
- * @param {number | null} [limit] Limit query results (0 means unlimited)
609
- * @param {*} [options] Override http request option.
610
- * @deprecated
611
- * @throws {RequiredError}
612
- */
613
- getUpdatesDeprecated: (lastKnownId_1, deviceId_1, type_1, releaseType_1, skip_1, limit_1, ...args_1) => __awaiter(this, [lastKnownId_1, deviceId_1, type_1, releaseType_1, skip_1, limit_1, ...args_1], void 0, function* (lastKnownId, deviceId, type, releaseType, skip, limit, options = {}) {
614
- // verify required parameter 'lastKnownId' is not null or undefined
615
- (0, common_1.assertParamExists)('getUpdatesDeprecated', 'lastKnownId', lastKnownId);
616
- const localVarPath = `/updates/{last_known_id}`
617
- .replace(`{${"last_known_id"}}`, encodeURIComponent(String(lastKnownId)));
618
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
619
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
620
- let baseOptions;
621
- if (configuration) {
622
- baseOptions = configuration.baseOptions;
623
- }
624
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
625
- const localVarHeaderParameter = {};
626
- const localVarQueryParameter = {};
627
- if (deviceId) {
628
- localVarQueryParameter['device_id'] = deviceId;
629
- }
630
- if (type) {
631
- localVarQueryParameter['type'] = type;
632
- }
633
- if (releaseType) {
634
- localVarQueryParameter['release_type'] = releaseType;
635
- }
636
- if (skip !== undefined) {
637
- localVarQueryParameter['skip'] = skip;
638
- }
639
- if (limit !== undefined) {
640
- localVarQueryParameter['limit'] = limit;
641
- }
642
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
643
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
644
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
645
- return {
646
- url: (0, common_1.toPathString)(localVarUrlObj),
647
- options: localVarRequestOptions,
648
- };
649
- }),
650
- };
651
- };
652
- exports.ReleaseApiAxiosParamCreator = ReleaseApiAxiosParamCreator;
653
- /**
654
- * ReleaseApi - functional programming interface
655
- * @export
656
- */
657
- const ReleaseApiFp = function (configuration) {
658
- const localVarAxiosParamCreator = (0, exports.ReleaseApiAxiosParamCreator)(configuration);
659
- return {
660
- /**
661
- * 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!
662
- * @summary Get Release
663
- * @param {string | null} [releaseId] Release ID
664
- * @param {string | null} [id] Release ID (deprecated)
665
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
666
- * @param {string | null} [filename]
667
- * @param {*} [options] Override http request option.
668
- * @throws {RequiredError}
669
- */
670
- getRelease(releaseId, id, buildId, filename, options) {
671
- return __awaiter(this, void 0, void 0, function* () {
672
- var _a, _b, _c;
673
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getRelease(releaseId, id, buildId, filename, options);
674
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
675
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReleaseApi.getRelease']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
676
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
677
- });
678
- },
679
- /**
680
- * Gets release information using the release ID, nothing to discuss really.
681
- * @summary Get Release Short
682
- * @param {string} releaseId
683
- * @param {*} [options] Override http request option.
684
- * @deprecated
685
- * @throws {RequiredError}
686
- */
687
- getReleaseDeprecated(releaseId, options) {
688
- return __awaiter(this, void 0, void 0, function* () {
689
- var _a, _b, _c;
690
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getReleaseDeprecated(releaseId, options);
691
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
692
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReleaseApi.getReleaseDeprecated']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
693
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
694
- });
695
- },
696
- /**
697
- * 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.
698
- * @summary Get Releases
699
- * @param {Array<string>} [id] Filter by Release IDs
700
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
701
- * @param {Array<string>} [buildId] Filter by Build IDs
702
- * @param {Array<string>} [deviceId] Filter by Device IDs
703
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
704
- * @param {Array<string>} [codename] Filter by device codenames
705
- * @param {Array<string>} [version] Filter by release version
706
- * @param {Array<ReleaseType>} [type] Filter by release type
707
- * @param {boolean | null} [archived] Filter by the archived status
708
- * @param {boolean | null} [freezed] Filter by the freezed status
709
- * @param {string | null} [afterReleaseId] Show releases after the provided one
710
- * @param {number | null} [afterDate] Show releases after the provided timestamp
711
- * @param {ReleasesSort} [sort] Sort mode
712
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
713
- * @param {number | null} [skip] Skip query results
714
- * @param {number | null} [limit] Limit query results (0 means unlimited)
715
- * @param {*} [options] Override http request option.
716
- * @throws {RequiredError}
717
- */
718
- getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options) {
719
- return __awaiter(this, void 0, void 0, function* () {
720
- var _a, _b, _c;
721
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options);
722
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
723
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReleaseApi.getReleases']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
724
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
725
- });
726
- },
727
- /**
728
- * 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!
729
- * @summary Get Updates
730
- * @param {string} lastKnownId
731
- * @param {Array<string>} [deviceId] Filter by device ID
732
- * @param {Array<ReleaseType>} [type] Filter by release type
733
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
734
- * @param {number | null} [skip] Skip query results
735
- * @param {number | null} [limit] Limit query results (0 means unlimited)
736
- * @param {*} [options] Override http request option.
737
- * @deprecated
738
- * @throws {RequiredError}
739
- */
740
- getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options) {
741
- return __awaiter(this, void 0, void 0, function* () {
742
- var _a, _b, _c;
743
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options);
744
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
745
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ReleaseApi.getUpdatesDeprecated']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
746
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
747
- });
748
- },
749
- };
750
- };
751
- exports.ReleaseApiFp = ReleaseApiFp;
752
- /**
753
- * ReleaseApi - factory interface
754
- * @export
755
- */
756
- const ReleaseApiFactory = function (configuration, basePath, axios) {
757
- const localVarFp = (0, exports.ReleaseApiFp)(configuration);
758
- return {
759
- /**
760
- * 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!
761
- * @summary Get Release
762
- * @param {string | null} [releaseId] Release ID
763
- * @param {string | null} [id] Release ID (deprecated)
764
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
765
- * @param {string | null} [filename]
766
- * @param {*} [options] Override http request option.
767
- * @throws {RequiredError}
768
- */
769
- getRelease(releaseId, id, buildId, filename, options) {
770
- return localVarFp.getRelease(releaseId, id, buildId, filename, options).then((request) => request(axios, basePath));
771
- },
772
- /**
773
- * Gets release information using the release ID, nothing to discuss really.
774
- * @summary Get Release Short
775
- * @param {string} releaseId
776
- * @param {*} [options] Override http request option.
777
- * @deprecated
778
- * @throws {RequiredError}
779
- */
780
- getReleaseDeprecated(releaseId, options) {
781
- return localVarFp.getReleaseDeprecated(releaseId, options).then((request) => request(axios, basePath));
782
- },
783
- /**
784
- * 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.
785
- * @summary Get Releases
786
- * @param {Array<string>} [id] Filter by Release IDs
787
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
788
- * @param {Array<string>} [buildId] Filter by Build IDs
789
- * @param {Array<string>} [deviceId] Filter by Device IDs
790
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
791
- * @param {Array<string>} [codename] Filter by device codenames
792
- * @param {Array<string>} [version] Filter by release version
793
- * @param {Array<ReleaseType>} [type] Filter by release type
794
- * @param {boolean | null} [archived] Filter by the archived status
795
- * @param {boolean | null} [freezed] Filter by the freezed status
796
- * @param {string | null} [afterReleaseId] Show releases after the provided one
797
- * @param {number | null} [afterDate] Show releases after the provided timestamp
798
- * @param {ReleasesSort} [sort] Sort mode
799
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
800
- * @param {number | null} [skip] Skip query results
801
- * @param {number | null} [limit] Limit query results (0 means unlimited)
802
- * @param {*} [options] Override http request option.
803
- * @throws {RequiredError}
804
- */
805
- getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options) {
806
- 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));
807
- },
808
- /**
809
- * 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!
810
- * @summary Get Updates
811
- * @param {string} lastKnownId
812
- * @param {Array<string>} [deviceId] Filter by device ID
813
- * @param {Array<ReleaseType>} [type] Filter by release type
814
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
815
- * @param {number | null} [skip] Skip query results
816
- * @param {number | null} [limit] Limit query results (0 means unlimited)
817
- * @param {*} [options] Override http request option.
818
- * @deprecated
819
- * @throws {RequiredError}
820
- */
821
- getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options) {
822
- return localVarFp.getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(axios, basePath));
823
- },
824
- };
825
- };
826
- exports.ReleaseApiFactory = ReleaseApiFactory;
827
- /**
828
- * ReleaseApi - object-oriented interface
829
- * @export
830
- * @class ReleaseApi
831
- * @extends {BaseAPI}
832
- */
833
- class ReleaseApi extends base_1.BaseAPI {
834
- /**
835
- * Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
836
- * @summary Get Release
837
- * @param {string | null} [releaseId] Release ID
838
- * @param {string | null} [id] Release ID (deprecated)
839
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
840
- * @param {string | null} [filename]
841
- * @param {*} [options] Override http request option.
842
- * @throws {RequiredError}
843
- * @memberof ReleaseApi
844
- */
845
- getRelease(releaseId, id, buildId, filename, options) {
846
- return (0, exports.ReleaseApiFp)(this.configuration).getRelease(releaseId, id, buildId, filename, options).then((request) => request(this.axios, this.basePath));
847
- }
848
- /**
849
- * Gets release information using the release ID, nothing to discuss really.
850
- * @summary Get Release Short
851
- * @param {string} releaseId
852
- * @param {*} [options] Override http request option.
853
- * @deprecated
854
- * @throws {RequiredError}
855
- * @memberof ReleaseApi
856
- */
857
- getReleaseDeprecated(releaseId, options) {
858
- return (0, exports.ReleaseApiFp)(this.configuration).getReleaseDeprecated(releaseId, options).then((request) => request(this.axios, this.basePath));
859
- }
860
- /**
861
- * Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it\'s not really consistent, as it might contain patch and mod versions and very different by each maintainer.
862
- * @summary Get Releases
863
- * @param {Array<string>} [id] Filter by Release IDs
864
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
865
- * @param {Array<string>} [buildId] Filter by Build IDs
866
- * @param {Array<string>} [deviceId] Filter by Device IDs
867
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
868
- * @param {Array<string>} [codename] Filter by device codenames
869
- * @param {Array<string>} [version] Filter by release version
870
- * @param {Array<ReleaseType>} [type] Filter by release type
871
- * @param {boolean | null} [archived] Filter by the archived status
872
- * @param {boolean | null} [freezed] Filter by the freezed status
873
- * @param {string | null} [afterReleaseId] Show releases after the provided one
874
- * @param {number | null} [afterDate] Show releases after the provided timestamp
875
- * @param {ReleasesSort} [sort] Sort mode
876
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
877
- * @param {number | null} [skip] Skip query results
878
- * @param {number | null} [limit] Limit query results (0 means unlimited)
879
- * @param {*} [options] Override http request option.
880
- * @throws {RequiredError}
881
- * @memberof ReleaseApi
882
- */
883
- getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options) {
884
- return (0, exports.ReleaseApiFp)(this.configuration).getReleases(id, id2, buildId, deviceId, maintainerId, codename, version, type, archived, freezed, afterReleaseId, afterDate, sort, group, skip, limit, options).then((request) => request(this.axios, this.basePath));
885
- }
886
- /**
887
- * Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
888
- * @summary Get Updates
889
- * @param {string} lastKnownId
890
- * @param {Array<string>} [deviceId] Filter by device ID
891
- * @param {Array<ReleaseType>} [type] Filter by release type
892
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
893
- * @param {number | null} [skip] Skip query results
894
- * @param {number | null} [limit] Limit query results (0 means unlimited)
895
- * @param {*} [options] Override http request option.
896
- * @deprecated
897
- * @throws {RequiredError}
898
- * @memberof ReleaseApi
899
- */
900
- getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options) {
901
- return (0, exports.ReleaseApiFp)(this.configuration).getUpdatesDeprecated(lastKnownId, deviceId, type, releaseType, skip, limit, options).then((request) => request(this.axios, this.basePath));
902
- }
903
- }
904
- exports.ReleaseApi = ReleaseApi;
905
- /**
906
- * StatsApi - axios parameter creator
907
- * @export
908
- */
909
- const StatsApiAxiosParamCreator = function (configuration) {
910
- return {
911
- /**
912
- * 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.
913
- * @summary Public Stats
914
- * @param {*} [options] Override http request option.
915
- * @throws {RequiredError}
916
- */
917
- getPublicStats: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
918
- const localVarPath = `/stats/`;
919
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
920
- const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
921
- let baseOptions;
922
- if (configuration) {
923
- baseOptions = configuration.baseOptions;
924
- }
925
- const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
926
- const localVarHeaderParameter = {};
927
- const localVarQueryParameter = {};
928
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
929
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
930
- localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
931
- return {
932
- url: (0, common_1.toPathString)(localVarUrlObj),
933
- options: localVarRequestOptions,
934
- };
935
- }),
936
- };
937
- };
938
- exports.StatsApiAxiosParamCreator = StatsApiAxiosParamCreator;
939
- /**
940
- * StatsApi - functional programming interface
941
- * @export
942
- */
943
- const StatsApiFp = function (configuration) {
944
- const localVarAxiosParamCreator = (0, exports.StatsApiAxiosParamCreator)(configuration);
945
- return {
946
- /**
947
- * 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.
948
- * @summary Public Stats
949
- * @param {*} [options] Override http request option.
950
- * @throws {RequiredError}
951
- */
952
- getPublicStats(options) {
953
- return __awaiter(this, void 0, void 0, function* () {
954
- var _a, _b, _c;
955
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getPublicStats(options);
956
- const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
957
- const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['StatsApi.getPublicStats']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
958
- return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
959
- });
960
- },
961
- };
962
- };
963
- exports.StatsApiFp = StatsApiFp;
964
- /**
965
- * StatsApi - factory interface
966
- * @export
967
- */
968
- const StatsApiFactory = function (configuration, basePath, axios) {
969
- const localVarFp = (0, exports.StatsApiFp)(configuration);
970
- return {
971
- /**
972
- * 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.
973
- * @summary Public Stats
974
- * @param {*} [options] Override http request option.
975
- * @throws {RequiredError}
976
- */
977
- getPublicStats(options) {
978
- return localVarFp.getPublicStats(options).then((request) => request(axios, basePath));
979
- },
980
- };
981
- };
982
- exports.StatsApiFactory = StatsApiFactory;
983
- /**
984
- * StatsApi - object-oriented interface
985
- * @export
986
- * @class StatsApi
987
- * @extends {BaseAPI}
988
- */
989
- class StatsApi extends base_1.BaseAPI {
990
- /**
991
- * 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.
992
- * @summary Public Stats
993
- * @param {*} [options] Override http request option.
994
- * @throws {RequiredError}
995
- * @memberof StatsApi
996
- */
997
- getPublicStats(options) {
998
- return (0, exports.StatsApiFp)(this.configuration).getPublicStats(options).then((request) => request(this.axios, this.basePath));
999
- }
1000
- }
1001
- exports.StatsApi = StatsApi;