@orangefox-recovery/foxclient 5.3.2 → 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.
Files changed (141) hide show
  1. package/.openapi-generator/FILES +2 -2
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +5 -5
  4. package/dist/apis/DeviceApi.d.ts +66 -9
  5. package/dist/apis/DeviceApi.js +60 -23
  6. package/dist/apis/PasteApi.d.ts +23 -1
  7. package/dist/apis/PasteApi.js +29 -11
  8. package/dist/apis/ReleaseApi.d.ts +76 -5
  9. package/dist/apis/ReleaseApi.js +60 -22
  10. package/dist/apis/StatsApi.d.ts +11 -1
  11. package/dist/apis/StatsApi.js +15 -6
  12. package/dist/esm/apis/DeviceApi.d.ts +66 -9
  13. package/dist/esm/apis/DeviceApi.js +60 -23
  14. package/dist/esm/apis/PasteApi.d.ts +23 -1
  15. package/dist/esm/apis/PasteApi.js +29 -11
  16. package/dist/esm/apis/ReleaseApi.d.ts +76 -5
  17. package/dist/esm/apis/ReleaseApi.js +60 -22
  18. package/dist/esm/apis/StatsApi.d.ts +11 -1
  19. package/dist/esm/apis/StatsApi.js +15 -6
  20. package/dist/esm/models/DeviceResponse.d.ts +2 -2
  21. package/dist/esm/models/DeviceResponse.js +1 -1
  22. package/dist/esm/models/GlobalStatsAggregationModel.d.ts +1 -1
  23. package/dist/esm/models/GlobalStatsAggregationModel.js +1 -1
  24. package/dist/esm/models/HTTPValidationError.d.ts +1 -1
  25. package/dist/esm/models/HTTPValidationError.js +1 -1
  26. package/dist/esm/models/ListResponseReleaseResponse.d.ts +1 -1
  27. package/dist/esm/models/ListResponseReleaseResponse.js +1 -1
  28. package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +1 -1
  29. package/dist/esm/models/ListResponseShortDeviceResponse.js +1 -1
  30. package/dist/esm/models/ListResponseShortReleaseResponse.d.ts +1 -1
  31. package/dist/esm/models/ListResponseShortReleaseResponse.js +1 -1
  32. package/dist/esm/models/ListResponseStr.d.ts +1 -1
  33. package/dist/esm/models/ListResponseStr.js +1 -1
  34. package/dist/esm/models/LocationInner.d.ts +26 -0
  35. package/dist/esm/models/{ValidationErrorLocInner.js → LocationInner.js} +9 -9
  36. package/dist/esm/models/MaintainerShortModel.d.ts +1 -1
  37. package/dist/esm/models/MaintainerShortModel.js +1 -1
  38. package/dist/esm/models/PasteInput.d.ts +1 -1
  39. package/dist/esm/models/PasteInput.js +1 -1
  40. package/dist/esm/models/PasteOutput.d.ts +1 -1
  41. package/dist/esm/models/PasteOutput.js +1 -1
  42. package/dist/esm/models/RecoveryImgResponse.d.ts +1 -1
  43. package/dist/esm/models/RecoveryImgResponse.js +1 -1
  44. package/dist/esm/models/ReleaseGroupsResponse.d.ts +1 -1
  45. package/dist/esm/models/ReleaseGroupsResponse.js +1 -1
  46. package/dist/esm/models/ReleaseResponse.d.ts +1 -1
  47. package/dist/esm/models/ReleaseResponse.js +1 -1
  48. package/dist/esm/models/ReleaseType.d.ts +1 -1
  49. package/dist/esm/models/ReleaseType.js +1 -1
  50. package/dist/esm/models/ReleasesSort.d.ts +1 -1
  51. package/dist/esm/models/ReleasesSort.js +1 -1
  52. package/dist/esm/models/ResponseGetReleases.d.ts +1 -1
  53. package/dist/esm/models/ResponseGetReleases.js +1 -1
  54. package/dist/esm/models/ShortDeviceResponse.d.ts +2 -2
  55. package/dist/esm/models/ShortDeviceResponse.js +1 -1
  56. package/dist/esm/models/ShortReleaseResponse.d.ts +1 -1
  57. package/dist/esm/models/ShortReleaseResponse.js +1 -1
  58. package/dist/esm/models/ValidationError.d.ts +16 -4
  59. package/dist/esm/models/ValidationError.js +8 -4
  60. package/dist/esm/models/index.d.ts +1 -1
  61. package/dist/esm/models/index.js +1 -1
  62. package/dist/esm/runtime.d.ts +1 -1
  63. package/dist/esm/runtime.js +16 -1
  64. package/dist/models/DeviceResponse.d.ts +2 -2
  65. package/dist/models/DeviceResponse.js +1 -1
  66. package/dist/models/GlobalStatsAggregationModel.d.ts +1 -1
  67. package/dist/models/GlobalStatsAggregationModel.js +1 -1
  68. package/dist/models/HTTPValidationError.d.ts +1 -1
  69. package/dist/models/HTTPValidationError.js +1 -1
  70. package/dist/models/ListResponseReleaseResponse.d.ts +1 -1
  71. package/dist/models/ListResponseReleaseResponse.js +1 -1
  72. package/dist/models/ListResponseShortDeviceResponse.d.ts +1 -1
  73. package/dist/models/ListResponseShortDeviceResponse.js +1 -1
  74. package/dist/models/ListResponseShortReleaseResponse.d.ts +1 -1
  75. package/dist/models/ListResponseShortReleaseResponse.js +1 -1
  76. package/dist/models/ListResponseStr.d.ts +1 -1
  77. package/dist/models/ListResponseStr.js +1 -1
  78. package/dist/models/LocationInner.d.ts +26 -0
  79. package/dist/models/LocationInner.js +38 -0
  80. package/dist/models/MaintainerShortModel.d.ts +1 -1
  81. package/dist/models/MaintainerShortModel.js +1 -1
  82. package/dist/models/PasteInput.d.ts +1 -1
  83. package/dist/models/PasteInput.js +1 -1
  84. package/dist/models/PasteOutput.d.ts +1 -1
  85. package/dist/models/PasteOutput.js +1 -1
  86. package/dist/models/RecoveryImgResponse.d.ts +1 -1
  87. package/dist/models/RecoveryImgResponse.js +1 -1
  88. package/dist/models/ReleaseGroupsResponse.d.ts +1 -1
  89. package/dist/models/ReleaseGroupsResponse.js +1 -1
  90. package/dist/models/ReleaseResponse.d.ts +1 -1
  91. package/dist/models/ReleaseResponse.js +1 -1
  92. package/dist/models/ReleaseType.d.ts +1 -1
  93. package/dist/models/ReleaseType.js +1 -1
  94. package/dist/models/ReleasesSort.d.ts +1 -1
  95. package/dist/models/ReleasesSort.js +1 -1
  96. package/dist/models/ResponseGetReleases.d.ts +1 -1
  97. package/dist/models/ResponseGetReleases.js +1 -1
  98. package/dist/models/ShortDeviceResponse.d.ts +2 -2
  99. package/dist/models/ShortDeviceResponse.js +1 -1
  100. package/dist/models/ShortReleaseResponse.d.ts +1 -1
  101. package/dist/models/ShortReleaseResponse.js +1 -1
  102. package/dist/models/ValidationError.d.ts +16 -4
  103. package/dist/models/ValidationError.js +8 -4
  104. package/dist/models/index.d.ts +1 -1
  105. package/dist/models/index.js +1 -1
  106. package/dist/runtime.d.ts +1 -1
  107. package/dist/runtime.js +16 -1
  108. package/docs/DeviceApi.md +2 -2
  109. package/docs/{ValidationErrorLocInner.md → LocationInner.md} +4 -4
  110. package/docs/ReleaseApi.md +1 -1
  111. package/docs/ValidationError.md +5 -1
  112. package/package.json +1 -2
  113. package/src/apis/DeviceApi.ts +104 -27
  114. package/src/apis/PasteApi.ts +43 -11
  115. package/src/apis/ReleaseApi.ts +115 -24
  116. package/src/apis/StatsApi.ts +21 -6
  117. package/src/models/DeviceResponse.ts +2 -2
  118. package/src/models/GlobalStatsAggregationModel.ts +1 -1
  119. package/src/models/HTTPValidationError.ts +1 -1
  120. package/src/models/ListResponseReleaseResponse.ts +1 -1
  121. package/src/models/ListResponseShortDeviceResponse.ts +1 -1
  122. package/src/models/ListResponseShortReleaseResponse.ts +1 -1
  123. package/src/models/ListResponseStr.ts +1 -1
  124. package/src/models/{ValidationErrorLocInner.ts → LocationInner.ts} +11 -11
  125. package/src/models/MaintainerShortModel.ts +1 -1
  126. package/src/models/PasteInput.ts +1 -1
  127. package/src/models/PasteOutput.ts +1 -1
  128. package/src/models/RecoveryImgResponse.ts +1 -1
  129. package/src/models/ReleaseGroupsResponse.ts +1 -1
  130. package/src/models/ReleaseResponse.ts +1 -1
  131. package/src/models/ReleaseType.ts +1 -1
  132. package/src/models/ReleasesSort.ts +1 -1
  133. package/src/models/ResponseGetReleases.ts +1 -1
  134. package/src/models/ShortDeviceResponse.ts +2 -2
  135. package/src/models/ShortReleaseResponse.ts +1 -1
  136. package/src/models/ValidationError.ts +27 -11
  137. package/src/models/index.ts +1 -1
  138. package/src/runtime.ts +19 -1
  139. package/dist/esm/models/ValidationErrorLocInner.d.ts +0 -26
  140. package/dist/models/ValidationErrorLocInner.d.ts +0 -26
  141. package/dist/models/ValidationErrorLocInner.js +0 -38
@@ -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.3.2
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
- * 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.
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 (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.
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
- * 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.
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 (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.
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
@@ -5,7 +5,7 @@
5
5
  * Fox API
6
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
7
  *
8
- * The version of the OpenAPI document: 5.3.2
8
+ * The version of the OpenAPI document: 5.4.0
9
9
  * Contact: admin@orangefox.tech
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,10 +30,9 @@ const index_1 = require("../models/index");
30
30
  */
31
31
  class ReleaseApi extends runtime.BaseAPI {
32
32
  /**
33
- * 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!
34
- * Get Release
33
+ * Creates request options for getRelease without sending the request
35
34
  */
36
- getReleaseRaw(requestParameters, initOverrides) {
35
+ getReleaseRequestOpts(requestParameters) {
37
36
  return __awaiter(this, void 0, void 0, function* () {
38
37
  const queryParameters = {};
39
38
  if (requestParameters['releaseId'] != null) {
@@ -50,12 +49,22 @@ class ReleaseApi extends runtime.BaseAPI {
50
49
  }
51
50
  const headerParameters = {};
52
51
  let urlPath = `/releases/get`;
53
- const response = yield this.request({
52
+ return {
54
53
  path: urlPath,
55
54
  method: 'GET',
56
55
  headers: headerParameters,
57
56
  query: queryParameters,
58
- }, initOverrides);
57
+ };
58
+ });
59
+ }
60
+ /**
61
+ * 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!
62
+ * Get Release
63
+ */
64
+ getReleaseRaw(requestParameters, initOverrides) {
65
+ return __awaiter(this, void 0, void 0, function* () {
66
+ const requestOptions = yield this.getReleaseRequestOpts(requestParameters);
67
+ const response = yield this.request(requestOptions, initOverrides);
59
68
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReleaseResponseFromJSON)(jsonValue));
60
69
  });
61
70
  }
@@ -70,11 +79,10 @@ class ReleaseApi extends runtime.BaseAPI {
70
79
  });
71
80
  }
72
81
  /**
73
- * Gets release information using the release ID, nothing to discuss really.
74
- * Get Release Short
82
+ * Creates request options for getReleaseDeprecated without sending the request
75
83
  * @deprecated
76
84
  */
77
- getReleaseDeprecatedRaw(requestParameters, initOverrides) {
85
+ getReleaseDeprecatedRequestOpts(requestParameters) {
78
86
  return __awaiter(this, void 0, void 0, function* () {
79
87
  if (requestParameters['releaseId'] == null) {
80
88
  throw new runtime.RequiredError('releaseId', 'Required parameter "releaseId" was null or undefined when calling getReleaseDeprecated().');
@@ -83,12 +91,23 @@ class ReleaseApi extends runtime.BaseAPI {
83
91
  const headerParameters = {};
84
92
  let urlPath = `/releases/{release_id}`;
85
93
  urlPath = urlPath.replace(`{${"release_id"}}`, encodeURIComponent(String(requestParameters['releaseId'])));
86
- const response = yield this.request({
94
+ return {
87
95
  path: urlPath,
88
96
  method: 'GET',
89
97
  headers: headerParameters,
90
98
  query: queryParameters,
91
- }, initOverrides);
99
+ };
100
+ });
101
+ }
102
+ /**
103
+ * Gets release information using the release ID, nothing to discuss really.
104
+ * Get Release Short
105
+ * @deprecated
106
+ */
107
+ getReleaseDeprecatedRaw(requestParameters, initOverrides) {
108
+ return __awaiter(this, void 0, void 0, function* () {
109
+ const requestOptions = yield this.getReleaseDeprecatedRequestOpts(requestParameters);
110
+ const response = yield this.request(requestOptions, initOverrides);
92
111
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReleaseResponseFromJSON)(jsonValue));
93
112
  });
94
113
  }
@@ -104,10 +123,9 @@ class ReleaseApi extends runtime.BaseAPI {
104
123
  });
105
124
  }
106
125
  /**
107
- * 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.
108
- * Get Releases
126
+ * Creates request options for getReleases without sending the request
109
127
  */
110
- getReleasesRaw(requestParameters, initOverrides) {
128
+ getReleasesRequestOpts(requestParameters) {
111
129
  return __awaiter(this, void 0, void 0, function* () {
112
130
  const queryParameters = {};
113
131
  if (requestParameters['id'] != null) {
@@ -160,17 +178,27 @@ class ReleaseApi extends runtime.BaseAPI {
160
178
  }
161
179
  const headerParameters = {};
162
180
  let urlPath = `/releases/`;
163
- const response = yield this.request({
181
+ return {
164
182
  path: urlPath,
165
183
  method: 'GET',
166
184
  headers: headerParameters,
167
185
  query: queryParameters,
168
- }, initOverrides);
186
+ };
187
+ });
188
+ }
189
+ /**
190
+ * 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.
191
+ * Get Releases
192
+ */
193
+ getReleasesRaw(requestParameters, initOverrides) {
194
+ return __awaiter(this, void 0, void 0, function* () {
195
+ const requestOptions = yield this.getReleasesRequestOpts(requestParameters);
196
+ const response = yield this.request(requestOptions, initOverrides);
169
197
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ResponseGetReleasesFromJSON)(jsonValue));
170
198
  });
171
199
  }
172
200
  /**
173
- * 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.
201
+ * 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.
174
202
  * Get Releases
175
203
  */
176
204
  getReleases() {
@@ -180,11 +208,10 @@ class ReleaseApi extends runtime.BaseAPI {
180
208
  });
181
209
  }
182
210
  /**
183
- * 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!
184
- * Get Updates
211
+ * Creates request options for getUpdatesDeprecated without sending the request
185
212
  * @deprecated
186
213
  */
187
- getUpdatesDeprecatedRaw(requestParameters, initOverrides) {
214
+ getUpdatesDeprecatedRequestOpts(requestParameters) {
188
215
  return __awaiter(this, void 0, void 0, function* () {
189
216
  if (requestParameters['lastKnownId'] == null) {
190
217
  throw new runtime.RequiredError('lastKnownId', 'Required parameter "lastKnownId" was null or undefined when calling getUpdatesDeprecated().');
@@ -208,12 +235,23 @@ class ReleaseApi extends runtime.BaseAPI {
208
235
  const headerParameters = {};
209
236
  let urlPath = `/updates/{last_known_id}`;
210
237
  urlPath = urlPath.replace(`{${"last_known_id"}}`, encodeURIComponent(String(requestParameters['lastKnownId'])));
211
- const response = yield this.request({
238
+ return {
212
239
  path: urlPath,
213
240
  method: 'GET',
214
241
  headers: headerParameters,
215
242
  query: queryParameters,
216
- }, initOverrides);
243
+ };
244
+ });
245
+ }
246
+ /**
247
+ * 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!
248
+ * Get Updates
249
+ * @deprecated
250
+ */
251
+ getUpdatesDeprecatedRaw(requestParameters, initOverrides) {
252
+ return __awaiter(this, void 0, void 0, function* () {
253
+ const requestOptions = yield this.getUpdatesDeprecatedRequestOpts(requestParameters);
254
+ const response = yield this.request(requestOptions, initOverrides);
217
255
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListResponseShortReleaseResponseFromJSON)(jsonValue));
218
256
  });
219
257
  }
@@ -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.3.2
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).
@@ -18,6 +18,12 @@ import type { GlobalStatsAggregationModel } from '../models/index';
18
18
  * @interface StatsApiInterface
19
19
  */
20
20
  export interface StatsApiInterface {
21
+ /**
22
+ * Creates request options for getPublicStats without sending the request
23
+ * @throws {RequiredError}
24
+ * @memberof StatsApiInterface
25
+ */
26
+ getPublicStatsRequestOpts(): Promise<runtime.RequestOpts>;
21
27
  /**
22
28
  * 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.
23
29
  * @summary Public Stats
@@ -36,6 +42,10 @@ export interface StatsApiInterface {
36
42
  *
37
43
  */
38
44
  export declare class StatsApi extends runtime.BaseAPI implements StatsApiInterface {
45
+ /**
46
+ * Creates request options for getPublicStats without sending the request
47
+ */
48
+ getPublicStatsRequestOpts(): Promise<runtime.RequestOpts>;
39
49
  /**
40
50
  * 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.
41
51
  * Public Stats
@@ -5,7 +5,7 @@
5
5
  * Fox API
6
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
7
  *
8
- * The version of the OpenAPI document: 5.3.2
8
+ * The version of the OpenAPI document: 5.4.0
9
9
  * Contact: admin@orangefox.tech
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,20 +30,29 @@ const index_1 = require("../models/index");
30
30
  */
31
31
  class StatsApi extends runtime.BaseAPI {
32
32
  /**
33
- * 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.
34
- * Public Stats
33
+ * Creates request options for getPublicStats without sending the request
35
34
  */
36
- getPublicStatsRaw(initOverrides) {
35
+ getPublicStatsRequestOpts() {
37
36
  return __awaiter(this, void 0, void 0, function* () {
38
37
  const queryParameters = {};
39
38
  const headerParameters = {};
40
39
  let urlPath = `/stats/`;
41
- const response = yield this.request({
40
+ return {
42
41
  path: urlPath,
43
42
  method: 'GET',
44
43
  headers: headerParameters,
45
44
  query: queryParameters,
46
- }, initOverrides);
45
+ };
46
+ });
47
+ }
48
+ /**
49
+ * 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.
50
+ * Public Stats
51
+ */
52
+ getPublicStatsRaw(initOverrides) {
53
+ return __awaiter(this, void 0, void 0, function* () {
54
+ const requestOptions = yield this.getPublicStatsRequestOpts();
55
+ const response = yield this.request(requestOptions, initOverrides);
47
56
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GlobalStatsAggregationModelFromJSON)(jsonValue));
48
57
  });
49
58
  }
@@ -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.3.2
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).
@@ -40,7 +40,16 @@ export interface GetDevicesRequest {
40
40
  */
41
41
  export interface DeviceApiInterface {
42
42
  /**
43
- * 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.
43
+ * Creates request options for getDevice without sending the request
44
+ * @param {string} [deviceId]
45
+ * @param {string} [id] Filter by Device ID (deprecated)
46
+ * @param {string} [codename] Not recommended to use when you can
47
+ * @throws {RequiredError}
48
+ * @memberof DeviceApiInterface
49
+ */
50
+ getDeviceRequestOpts(requestParameters: GetDeviceRequest): Promise<runtime.RequestOpts>;
51
+ /**
52
+ * 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.
44
53
  * @summary Get Device
45
54
  * @param {string} [deviceId]
46
55
  * @param {string} [id] Filter by Device ID (deprecated)
@@ -51,10 +60,18 @@ export interface DeviceApiInterface {
51
60
  */
52
61
  getDeviceRaw(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>>;
53
62
  /**
54
- * 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.
63
+ * 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.
55
64
  * Get Device
56
65
  */
57
66
  getDevice(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
67
+ /**
68
+ * Creates request options for getDeviceDeprecated without sending the request
69
+ * @param {string} deviceId
70
+ * @deprecated
71
+ * @throws {RequiredError}
72
+ * @memberof DeviceApiInterface
73
+ */
74
+ getDeviceDeprecatedRequestOpts(requestParameters: GetDeviceDeprecatedRequest): Promise<runtime.RequestOpts>;
58
75
  /**
59
76
  * Gets device info using device ID.
60
77
  * @summary Get Device Short
@@ -72,7 +89,24 @@ export interface DeviceApiInterface {
72
89
  */
73
90
  getDeviceDeprecated(requestParameters: GetDeviceDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
74
91
  /**
75
- * 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.
92
+ * Creates request options for getDevices without sending the request
93
+ * @param {Array<string>} [id] Filter by Device IDs
94
+ * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
95
+ * @param {Array<string>} [oemName] Filter by OEM names
96
+ * @param {Array<string>} [codename] Filter by device codenames
97
+ * @param {Array<string>} [modelName] Filter by model names
98
+ * @param {boolean} [supported] Supported status
99
+ * @param {Array<string>} [maintainer] Filter by maintainer ID
100
+ * @param {boolean} [freezed] Filter by Freezed status
101
+ * @param {boolean} [hasReleases] Filter by has releases status
102
+ * @param {number} [skip] Skip query results
103
+ * @param {number} [limit] Limit query results (0 means unlimited)
104
+ * @throws {RequiredError}
105
+ * @memberof DeviceApiInterface
106
+ */
107
+ getDevicesRequestOpts(requestParameters: GetDevicesRequest): Promise<runtime.RequestOpts>;
108
+ /**
109
+ * 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.
76
110
  * @summary Get Devices
77
111
  * @param {Array<string>} [id] Filter by Device IDs
78
112
  * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
@@ -91,10 +125,16 @@ export interface DeviceApiInterface {
91
125
  */
92
126
  getDevicesRaw(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseShortDeviceResponse>>;
93
127
  /**
94
- * 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.
128
+ * 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.
95
129
  * Get Devices
96
130
  */
97
131
  getDevices(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseShortDeviceResponse>;
132
+ /**
133
+ * Creates request options for getOems without sending the request
134
+ * @throws {RequiredError}
135
+ * @memberof DeviceApiInterface
136
+ */
137
+ getOemsRequestOpts(): Promise<runtime.RequestOpts>;
98
138
  /**
99
139
  * Lists all OEM names
100
140
  * @summary Get Oems
@@ -114,15 +154,24 @@ export interface DeviceApiInterface {
114
154
  */
115
155
  export declare class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
116
156
  /**
117
- * 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.
157
+ * Creates request options for getDevice without sending the request
158
+ */
159
+ getDeviceRequestOpts(requestParameters: GetDeviceRequest): Promise<runtime.RequestOpts>;
160
+ /**
161
+ * 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.
118
162
  * Get Device
119
163
  */
120
164
  getDeviceRaw(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>>;
121
165
  /**
122
- * 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.
166
+ * 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.
123
167
  * Get Device
124
168
  */
125
169
  getDevice(requestParameters?: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
170
+ /**
171
+ * Creates request options for getDeviceDeprecated without sending the request
172
+ * @deprecated
173
+ */
174
+ getDeviceDeprecatedRequestOpts(requestParameters: GetDeviceDeprecatedRequest): Promise<runtime.RequestOpts>;
126
175
  /**
127
176
  * Gets device info using device ID.
128
177
  * Get Device Short
@@ -136,15 +185,23 @@ export declare class DeviceApi extends runtime.BaseAPI implements DeviceApiInter
136
185
  */
137
186
  getDeviceDeprecated(requestParameters: GetDeviceDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
138
187
  /**
139
- * 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.
188
+ * Creates request options for getDevices without sending the request
189
+ */
190
+ getDevicesRequestOpts(requestParameters: GetDevicesRequest): Promise<runtime.RequestOpts>;
191
+ /**
192
+ * 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.
140
193
  * Get Devices
141
194
  */
142
195
  getDevicesRaw(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseShortDeviceResponse>>;
143
196
  /**
144
- * 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.
197
+ * 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.
145
198
  * Get Devices
146
199
  */
147
200
  getDevices(requestParameters?: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseShortDeviceResponse>;
201
+ /**
202
+ * Creates request options for getOems without sending the request
203
+ */
204
+ getOemsRequestOpts(): Promise<runtime.RequestOpts>;
148
205
  /**
149
206
  * Lists all OEM names
150
207
  * Get Oems