@orangefox-recovery/foxinternalclient 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 (329) hide show
  1. package/.openapi-generator/FILES +14 -2
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +18 -5
  4. package/dist/apis/DeviceApi.d.ts +66 -9
  5. package/dist/apis/DeviceApi.js +60 -23
  6. package/dist/apis/FoxFactoryApi.d.ts +115 -3
  7. package/dist/apis/FoxFactoryApi.js +141 -53
  8. package/dist/apis/GitlabApi.d.ts +13 -1
  9. package/dist/apis/GitlabApi.js +14 -5
  10. package/dist/apis/InternalApi.d.ts +496 -4
  11. package/dist/apis/InternalApi.js +594 -108
  12. package/dist/apis/PasteApi.d.ts +23 -1
  13. package/dist/apis/PasteApi.js +29 -11
  14. package/dist/apis/ReleaseApi.d.ts +76 -5
  15. package/dist/apis/ReleaseApi.js +60 -22
  16. package/dist/apis/StatsApi.d.ts +11 -1
  17. package/dist/apis/StatsApi.js +15 -6
  18. package/dist/esm/apis/DeviceApi.d.ts +66 -9
  19. package/dist/esm/apis/DeviceApi.js +60 -23
  20. package/dist/esm/apis/FoxFactoryApi.d.ts +115 -3
  21. package/dist/esm/apis/FoxFactoryApi.js +141 -53
  22. package/dist/esm/apis/GitlabApi.d.ts +13 -1
  23. package/dist/esm/apis/GitlabApi.js +14 -5
  24. package/dist/esm/apis/InternalApi.d.ts +496 -4
  25. package/dist/esm/apis/InternalApi.js +595 -109
  26. package/dist/esm/apis/PasteApi.d.ts +23 -1
  27. package/dist/esm/apis/PasteApi.js +29 -11
  28. package/dist/esm/apis/ReleaseApi.d.ts +76 -5
  29. package/dist/esm/apis/ReleaseApi.js +60 -22
  30. package/dist/esm/apis/StatsApi.d.ts +11 -1
  31. package/dist/esm/apis/StatsApi.js +15 -6
  32. package/dist/esm/models/BodyChangePasswordProfileChangePasswordPost.d.ts +1 -1
  33. package/dist/esm/models/BodyChangePasswordProfileChangePasswordPost.js +1 -1
  34. package/dist/esm/models/BuildStatusEnum.d.ts +1 -1
  35. package/dist/esm/models/BuildStatusEnum.js +1 -1
  36. package/dist/esm/models/BuildTaskResponse.d.ts +1 -1
  37. package/dist/esm/models/BuildTaskResponse.js +1 -1
  38. package/dist/esm/models/BuildTaskShortResponse.d.ts +1 -1
  39. package/dist/esm/models/BuildTaskShortResponse.js +1 -1
  40. package/dist/esm/models/DeviceInternalResponse.d.ts +2 -2
  41. package/dist/esm/models/DeviceInternalResponse.js +1 -1
  42. package/dist/esm/models/DeviceResponse.d.ts +2 -2
  43. package/dist/esm/models/DeviceResponse.js +1 -1
  44. package/dist/esm/models/DeviceStatsResponse.d.ts +1 -1
  45. package/dist/esm/models/DeviceStatsResponse.js +1 -1
  46. package/dist/esm/models/DeviceUpdateBody.d.ts +1 -1
  47. package/dist/esm/models/DeviceUpdateBody.js +1 -1
  48. package/dist/esm/models/FFStatusEnum.d.ts +1 -1
  49. package/dist/esm/models/FFStatusEnum.js +1 -1
  50. package/dist/esm/models/FFStatusResponse.d.ts +1 -1
  51. package/dist/esm/models/FFStatusResponse.js +1 -1
  52. package/dist/esm/models/GlobalStatsAggregationModel.d.ts +1 -1
  53. package/dist/esm/models/GlobalStatsAggregationModel.js +1 -1
  54. package/dist/esm/models/HTTPValidationError.d.ts +1 -1
  55. package/dist/esm/models/HTTPValidationError.js +1 -1
  56. package/dist/esm/models/ListResponseBuildTaskShortResponse.d.ts +1 -1
  57. package/dist/esm/models/ListResponseBuildTaskShortResponse.js +1 -1
  58. package/dist/esm/models/ListResponseReleaseResponse.d.ts +1 -1
  59. package/dist/esm/models/ListResponseReleaseResponse.js +1 -1
  60. package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +1 -1
  61. package/dist/esm/models/ListResponseShortDeviceResponse.js +1 -1
  62. package/dist/esm/models/ListResponseShortReleaseResponse.d.ts +1 -1
  63. package/dist/esm/models/ListResponseShortReleaseResponse.js +1 -1
  64. package/dist/esm/models/ListResponseStr.d.ts +1 -1
  65. package/dist/esm/models/ListResponseStr.js +1 -1
  66. package/dist/esm/models/ListResponseUserShortResponse.d.ts +1 -1
  67. package/dist/esm/models/ListResponseUserShortResponse.js +1 -1
  68. package/dist/esm/models/LocationInner.d.ts +26 -0
  69. package/dist/esm/models/{ValidationErrorLocInner.js → LocationInner.js} +9 -9
  70. package/dist/esm/models/LogListResponse.d.ts +1 -1
  71. package/dist/esm/models/LogListResponse.js +1 -1
  72. package/dist/esm/models/LogResponse.d.ts +1 -1
  73. package/dist/esm/models/LogResponse.js +1 -1
  74. package/dist/esm/models/MaintainerShortModel.d.ts +1 -1
  75. package/dist/esm/models/MaintainerShortModel.js +1 -1
  76. package/dist/esm/models/NewBuildTaskBody.d.ts +1 -1
  77. package/dist/esm/models/NewBuildTaskBody.js +1 -1
  78. package/dist/esm/models/NewDeviceBody.d.ts +1 -1
  79. package/dist/esm/models/NewDeviceBody.js +1 -1
  80. package/dist/esm/models/PasskeyCredentialResponse.d.ts +68 -0
  81. package/dist/esm/models/PasskeyCredentialResponse.js +61 -0
  82. package/dist/esm/models/PasskeyOptionsResponse.d.ts +40 -0
  83. package/dist/esm/models/PasskeyOptionsResponse.js +47 -0
  84. package/dist/esm/models/PasskeyRegisterOptionsRequest.d.ts +32 -0
  85. package/dist/esm/models/PasskeyRegisterOptionsRequest.js +43 -0
  86. package/dist/esm/models/PasskeyVerifyRequest.d.ts +46 -0
  87. package/dist/esm/models/PasskeyVerifyRequest.js +49 -0
  88. package/dist/esm/models/PasswordConfirmationBody.d.ts +32 -0
  89. package/dist/esm/models/PasswordConfirmationBody.js +43 -0
  90. package/dist/esm/models/PasteInput.d.ts +1 -1
  91. package/dist/esm/models/PasteInput.js +1 -1
  92. package/dist/esm/models/PasteOutput.d.ts +1 -1
  93. package/dist/esm/models/PasteOutput.js +1 -1
  94. package/dist/esm/models/RecoveryImgResponse.d.ts +1 -1
  95. package/dist/esm/models/RecoveryImgResponse.js +1 -1
  96. package/dist/esm/models/ReleaseGroupsResponse.d.ts +1 -1
  97. package/dist/esm/models/ReleaseGroupsResponse.js +1 -1
  98. package/dist/esm/models/ReleaseInternalResponse.d.ts +1 -1
  99. package/dist/esm/models/ReleaseInternalResponse.js +1 -1
  100. package/dist/esm/models/ReleaseInternalResponsePropValue.d.ts +1 -1
  101. package/dist/esm/models/ReleaseInternalResponsePropValue.js +1 -1
  102. package/dist/esm/models/ReleaseResponse.d.ts +1 -1
  103. package/dist/esm/models/ReleaseResponse.js +1 -1
  104. package/dist/esm/models/ReleaseStatsResponse.d.ts +1 -1
  105. package/dist/esm/models/ReleaseStatsResponse.js +1 -1
  106. package/dist/esm/models/ReleaseType.d.ts +1 -1
  107. package/dist/esm/models/ReleaseType.js +1 -1
  108. package/dist/esm/models/ReleaseUpdateBody.d.ts +1 -1
  109. package/dist/esm/models/ReleaseUpdateBody.js +1 -1
  110. package/dist/esm/models/ReleasesSort.d.ts +1 -1
  111. package/dist/esm/models/ReleasesSort.js +1 -1
  112. package/dist/esm/models/RenamePasskeyBody.d.ts +32 -0
  113. package/dist/esm/models/RenamePasskeyBody.js +41 -0
  114. package/dist/esm/models/ResponseGetReleases.d.ts +1 -1
  115. package/dist/esm/models/ResponseGetReleases.js +1 -1
  116. package/dist/esm/models/ShortDeviceResponse.d.ts +2 -2
  117. package/dist/esm/models/ShortDeviceResponse.js +1 -1
  118. package/dist/esm/models/ShortReleaseResponse.d.ts +1 -1
  119. package/dist/esm/models/ShortReleaseResponse.js +1 -1
  120. package/dist/esm/models/TaskUpdateBody.d.ts +1 -1
  121. package/dist/esm/models/TaskUpdateBody.js +1 -1
  122. package/dist/esm/models/TokenResponse.d.ts +1 -1
  123. package/dist/esm/models/TokenResponse.js +1 -1
  124. package/dist/esm/models/UserGitlab.d.ts +1 -1
  125. package/dist/esm/models/UserGitlab.js +1 -1
  126. package/dist/esm/models/UserInternalResponse.d.ts +1 -1
  127. package/dist/esm/models/UserInternalResponse.js +1 -1
  128. package/dist/esm/models/UserMail.d.ts +1 -1
  129. package/dist/esm/models/UserMail.js +1 -1
  130. package/dist/esm/models/UserShortResponse.d.ts +1 -1
  131. package/dist/esm/models/UserShortResponse.js +1 -1
  132. package/dist/esm/models/UserTelegram.d.ts +1 -1
  133. package/dist/esm/models/UserTelegram.js +1 -1
  134. package/dist/esm/models/UserUpdateBody.d.ts +1 -1
  135. package/dist/esm/models/UserUpdateBody.js +1 -1
  136. package/dist/esm/models/ValidationError.d.ts +16 -4
  137. package/dist/esm/models/ValidationError.js +8 -4
  138. package/dist/esm/models/index.d.ts +7 -1
  139. package/dist/esm/models/index.js +7 -1
  140. package/dist/esm/runtime.d.ts +1 -1
  141. package/dist/esm/runtime.js +16 -1
  142. package/dist/models/BodyChangePasswordProfileChangePasswordPost.d.ts +1 -1
  143. package/dist/models/BodyChangePasswordProfileChangePasswordPost.js +1 -1
  144. package/dist/models/BuildStatusEnum.d.ts +1 -1
  145. package/dist/models/BuildStatusEnum.js +1 -1
  146. package/dist/models/BuildTaskResponse.d.ts +1 -1
  147. package/dist/models/BuildTaskResponse.js +1 -1
  148. package/dist/models/BuildTaskShortResponse.d.ts +1 -1
  149. package/dist/models/BuildTaskShortResponse.js +1 -1
  150. package/dist/models/DeviceInternalResponse.d.ts +2 -2
  151. package/dist/models/DeviceInternalResponse.js +1 -1
  152. package/dist/models/DeviceResponse.d.ts +2 -2
  153. package/dist/models/DeviceResponse.js +1 -1
  154. package/dist/models/DeviceStatsResponse.d.ts +1 -1
  155. package/dist/models/DeviceStatsResponse.js +1 -1
  156. package/dist/models/DeviceUpdateBody.d.ts +1 -1
  157. package/dist/models/DeviceUpdateBody.js +1 -1
  158. package/dist/models/FFStatusEnum.d.ts +1 -1
  159. package/dist/models/FFStatusEnum.js +1 -1
  160. package/dist/models/FFStatusResponse.d.ts +1 -1
  161. package/dist/models/FFStatusResponse.js +1 -1
  162. package/dist/models/GlobalStatsAggregationModel.d.ts +1 -1
  163. package/dist/models/GlobalStatsAggregationModel.js +1 -1
  164. package/dist/models/HTTPValidationError.d.ts +1 -1
  165. package/dist/models/HTTPValidationError.js +1 -1
  166. package/dist/models/ListResponseBuildTaskShortResponse.d.ts +1 -1
  167. package/dist/models/ListResponseBuildTaskShortResponse.js +1 -1
  168. package/dist/models/ListResponseReleaseResponse.d.ts +1 -1
  169. package/dist/models/ListResponseReleaseResponse.js +1 -1
  170. package/dist/models/ListResponseShortDeviceResponse.d.ts +1 -1
  171. package/dist/models/ListResponseShortDeviceResponse.js +1 -1
  172. package/dist/models/ListResponseShortReleaseResponse.d.ts +1 -1
  173. package/dist/models/ListResponseShortReleaseResponse.js +1 -1
  174. package/dist/models/ListResponseStr.d.ts +1 -1
  175. package/dist/models/ListResponseStr.js +1 -1
  176. package/dist/models/ListResponseUserShortResponse.d.ts +1 -1
  177. package/dist/models/ListResponseUserShortResponse.js +1 -1
  178. package/dist/models/LocationInner.d.ts +26 -0
  179. package/dist/models/LocationInner.js +38 -0
  180. package/dist/models/LogListResponse.d.ts +1 -1
  181. package/dist/models/LogListResponse.js +1 -1
  182. package/dist/models/LogResponse.d.ts +1 -1
  183. package/dist/models/LogResponse.js +1 -1
  184. package/dist/models/MaintainerShortModel.d.ts +1 -1
  185. package/dist/models/MaintainerShortModel.js +1 -1
  186. package/dist/models/NewBuildTaskBody.d.ts +1 -1
  187. package/dist/models/NewBuildTaskBody.js +1 -1
  188. package/dist/models/NewDeviceBody.d.ts +1 -1
  189. package/dist/models/NewDeviceBody.js +1 -1
  190. package/dist/models/PasskeyCredentialResponse.d.ts +68 -0
  191. package/dist/models/PasskeyCredentialResponse.js +68 -0
  192. package/dist/models/PasskeyOptionsResponse.d.ts +40 -0
  193. package/dist/models/PasskeyOptionsResponse.js +54 -0
  194. package/dist/models/PasskeyRegisterOptionsRequest.d.ts +32 -0
  195. package/dist/models/PasskeyRegisterOptionsRequest.js +50 -0
  196. package/dist/models/PasskeyVerifyRequest.d.ts +46 -0
  197. package/dist/models/PasskeyVerifyRequest.js +56 -0
  198. package/dist/models/PasswordConfirmationBody.d.ts +32 -0
  199. package/dist/models/PasswordConfirmationBody.js +50 -0
  200. package/dist/models/PasteInput.d.ts +1 -1
  201. package/dist/models/PasteInput.js +1 -1
  202. package/dist/models/PasteOutput.d.ts +1 -1
  203. package/dist/models/PasteOutput.js +1 -1
  204. package/dist/models/RecoveryImgResponse.d.ts +1 -1
  205. package/dist/models/RecoveryImgResponse.js +1 -1
  206. package/dist/models/ReleaseGroupsResponse.d.ts +1 -1
  207. package/dist/models/ReleaseGroupsResponse.js +1 -1
  208. package/dist/models/ReleaseInternalResponse.d.ts +1 -1
  209. package/dist/models/ReleaseInternalResponse.js +1 -1
  210. package/dist/models/ReleaseInternalResponsePropValue.d.ts +1 -1
  211. package/dist/models/ReleaseInternalResponsePropValue.js +1 -1
  212. package/dist/models/ReleaseResponse.d.ts +1 -1
  213. package/dist/models/ReleaseResponse.js +1 -1
  214. package/dist/models/ReleaseStatsResponse.d.ts +1 -1
  215. package/dist/models/ReleaseStatsResponse.js +1 -1
  216. package/dist/models/ReleaseType.d.ts +1 -1
  217. package/dist/models/ReleaseType.js +1 -1
  218. package/dist/models/ReleaseUpdateBody.d.ts +1 -1
  219. package/dist/models/ReleaseUpdateBody.js +1 -1
  220. package/dist/models/ReleasesSort.d.ts +1 -1
  221. package/dist/models/ReleasesSort.js +1 -1
  222. package/dist/models/RenamePasskeyBody.d.ts +32 -0
  223. package/dist/models/RenamePasskeyBody.js +48 -0
  224. package/dist/models/ResponseGetReleases.d.ts +1 -1
  225. package/dist/models/ResponseGetReleases.js +1 -1
  226. package/dist/models/ShortDeviceResponse.d.ts +2 -2
  227. package/dist/models/ShortDeviceResponse.js +1 -1
  228. package/dist/models/ShortReleaseResponse.d.ts +1 -1
  229. package/dist/models/ShortReleaseResponse.js +1 -1
  230. package/dist/models/TaskUpdateBody.d.ts +1 -1
  231. package/dist/models/TaskUpdateBody.js +1 -1
  232. package/dist/models/TokenResponse.d.ts +1 -1
  233. package/dist/models/TokenResponse.js +1 -1
  234. package/dist/models/UserGitlab.d.ts +1 -1
  235. package/dist/models/UserGitlab.js +1 -1
  236. package/dist/models/UserInternalResponse.d.ts +1 -1
  237. package/dist/models/UserInternalResponse.js +1 -1
  238. package/dist/models/UserMail.d.ts +1 -1
  239. package/dist/models/UserMail.js +1 -1
  240. package/dist/models/UserShortResponse.d.ts +1 -1
  241. package/dist/models/UserShortResponse.js +1 -1
  242. package/dist/models/UserTelegram.d.ts +1 -1
  243. package/dist/models/UserTelegram.js +1 -1
  244. package/dist/models/UserUpdateBody.d.ts +1 -1
  245. package/dist/models/UserUpdateBody.js +1 -1
  246. package/dist/models/ValidationError.d.ts +16 -4
  247. package/dist/models/ValidationError.js +8 -4
  248. package/dist/models/index.d.ts +7 -1
  249. package/dist/models/index.js +7 -1
  250. package/dist/runtime.d.ts +1 -1
  251. package/dist/runtime.js +16 -1
  252. package/docs/DeviceApi.md +2 -2
  253. package/docs/FoxFactoryApi.md +3 -3
  254. package/docs/InternalApi.md +474 -11
  255. package/docs/{ValidationErrorLocInner.md → LocationInner.md} +4 -4
  256. package/docs/PasskeyCredentialResponse.md +46 -0
  257. package/docs/PasskeyOptionsResponse.md +36 -0
  258. package/docs/PasskeyRegisterOptionsRequest.md +34 -0
  259. package/docs/PasskeyVerifyRequest.md +38 -0
  260. package/docs/PasswordConfirmationBody.md +34 -0
  261. package/docs/ReleaseApi.md +1 -1
  262. package/docs/RenamePasskeyBody.md +34 -0
  263. package/docs/ValidationError.md +5 -1
  264. package/package.json +1 -2
  265. package/src/apis/DeviceApi.ts +104 -27
  266. package/src/apis/FoxFactoryApi.ts +215 -55
  267. package/src/apis/GitlabApi.ts +22 -5
  268. package/src/apis/InternalApi.ts +1016 -115
  269. package/src/apis/PasteApi.ts +43 -11
  270. package/src/apis/ReleaseApi.ts +115 -24
  271. package/src/apis/StatsApi.ts +21 -6
  272. package/src/models/BodyChangePasswordProfileChangePasswordPost.ts +1 -1
  273. package/src/models/BuildStatusEnum.ts +1 -1
  274. package/src/models/BuildTaskResponse.ts +1 -1
  275. package/src/models/BuildTaskShortResponse.ts +1 -1
  276. package/src/models/DeviceInternalResponse.ts +2 -2
  277. package/src/models/DeviceResponse.ts +2 -2
  278. package/src/models/DeviceStatsResponse.ts +1 -1
  279. package/src/models/DeviceUpdateBody.ts +1 -1
  280. package/src/models/FFStatusEnum.ts +1 -1
  281. package/src/models/FFStatusResponse.ts +1 -1
  282. package/src/models/GlobalStatsAggregationModel.ts +1 -1
  283. package/src/models/HTTPValidationError.ts +1 -1
  284. package/src/models/ListResponseBuildTaskShortResponse.ts +1 -1
  285. package/src/models/ListResponseReleaseResponse.ts +1 -1
  286. package/src/models/ListResponseShortDeviceResponse.ts +1 -1
  287. package/src/models/ListResponseShortReleaseResponse.ts +1 -1
  288. package/src/models/ListResponseStr.ts +1 -1
  289. package/src/models/ListResponseUserShortResponse.ts +1 -1
  290. package/src/models/{ValidationErrorLocInner.ts → LocationInner.ts} +11 -11
  291. package/src/models/LogListResponse.ts +1 -1
  292. package/src/models/LogResponse.ts +1 -1
  293. package/src/models/MaintainerShortModel.ts +1 -1
  294. package/src/models/NewBuildTaskBody.ts +1 -1
  295. package/src/models/NewDeviceBody.ts +1 -1
  296. package/src/models/PasskeyCredentialResponse.ts +117 -0
  297. package/src/models/PasskeyOptionsResponse.ts +75 -0
  298. package/src/models/PasskeyRegisterOptionsRequest.ts +66 -0
  299. package/src/models/PasskeyVerifyRequest.ts +83 -0
  300. package/src/models/PasswordConfirmationBody.ts +66 -0
  301. package/src/models/PasteInput.ts +1 -1
  302. package/src/models/PasteOutput.ts +1 -1
  303. package/src/models/RecoveryImgResponse.ts +1 -1
  304. package/src/models/ReleaseGroupsResponse.ts +1 -1
  305. package/src/models/ReleaseInternalResponse.ts +1 -1
  306. package/src/models/ReleaseInternalResponsePropValue.ts +1 -1
  307. package/src/models/ReleaseResponse.ts +1 -1
  308. package/src/models/ReleaseStatsResponse.ts +1 -1
  309. package/src/models/ReleaseType.ts +1 -1
  310. package/src/models/ReleaseUpdateBody.ts +1 -1
  311. package/src/models/ReleasesSort.ts +1 -1
  312. package/src/models/RenamePasskeyBody.ts +65 -0
  313. package/src/models/ResponseGetReleases.ts +1 -1
  314. package/src/models/ShortDeviceResponse.ts +2 -2
  315. package/src/models/ShortReleaseResponse.ts +1 -1
  316. package/src/models/TaskUpdateBody.ts +1 -1
  317. package/src/models/TokenResponse.ts +1 -1
  318. package/src/models/UserGitlab.ts +1 -1
  319. package/src/models/UserInternalResponse.ts +1 -1
  320. package/src/models/UserMail.ts +1 -1
  321. package/src/models/UserShortResponse.ts +1 -1
  322. package/src/models/UserTelegram.ts +1 -1
  323. package/src/models/UserUpdateBody.ts +1 -1
  324. package/src/models/ValidationError.ts +27 -11
  325. package/src/models/index.ts +7 -1
  326. package/src/runtime.ts +19 -1
  327. package/dist/esm/models/ValidationErrorLocInner.d.ts +0 -26
  328. package/dist/models/ValidationErrorLocInner.d.ts +0 -26
  329. package/dist/models/ValidationErrorLocInner.js +0 -38
@@ -0,0 +1,38 @@
1
+
2
+ # PasskeyVerifyRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `requestId` | string
10
+ `credential` | { [key: string]: any; }
11
+ `nickname` | string
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { PasskeyVerifyRequest } from '@orangefox-recovery/foxinternalclient'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "requestId": null,
21
+ "credential": null,
22
+ "nickname": null,
23
+ } satisfies PasskeyVerifyRequest
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as PasskeyVerifyRequest
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
@@ -0,0 +1,34 @@
1
+
2
+ # PasswordConfirmationBody
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `password` | string
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { PasswordConfirmationBody } from '@orangefox-recovery/foxinternalclient'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "password": null,
19
+ } satisfies PasswordConfirmationBody
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as PasswordConfirmationBody
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -162,7 +162,7 @@ No authorization required
162
162
 
163
163
  Get Releases
164
164
 
165
- 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.
165
+ 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.
166
166
 
167
167
  ### Example
168
168
 
@@ -0,0 +1,34 @@
1
+
2
+ # RenamePasskeyBody
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `nickname` | string
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { RenamePasskeyBody } from '@orangefox-recovery/foxinternalclient'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "nickname": null,
19
+ } satisfies RenamePasskeyBody
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as RenamePasskeyBody
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -6,9 +6,11 @@
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `loc` | [Array<ValidationErrorLocInner>](ValidationErrorLocInner.md)
9
+ `loc` | [Array<LocationInner>](LocationInner.md)
10
10
  `msg` | string
11
11
  `type` | string
12
+ `input` | any
13
+ `ctx` | object
12
14
 
13
15
  ## Example
14
16
 
@@ -20,6 +22,8 @@ const example = {
20
22
  "loc": null,
21
23
  "msg": null,
22
24
  "type": null,
25
+ "input": null,
26
+ "ctx": null,
23
27
  } satisfies ValidationError
24
28
 
25
29
  console.log(example)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orangefox-recovery/foxinternalclient",
3
- "version": "5.3.2",
3
+ "version": "5.4.0",
4
4
  "description": "OpenAPI client for @orangefox-recovery/foxinternalclient",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -29,7 +29,6 @@
29
29
  },
30
30
  "keywords": [],
31
31
  "license": "ISC",
32
- "type": "commonjs",
33
32
  "bugs": {
34
33
  "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"
35
34
  },
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 5.3.2
7
+ * The version of the OpenAPI document: 5.4.0
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -63,7 +63,17 @@ export interface GetDevicesRequest {
63
63
  */
64
64
  export interface DeviceApiInterface {
65
65
  /**
66
- * Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
66
+ * Creates request options for getDevice without sending the request
67
+ * @param {string} [deviceId]
68
+ * @param {string} [id] Filter by Device ID (deprecated)
69
+ * @param {string} [codename] Not recommended to use when you can
70
+ * @throws {RequiredError}
71
+ * @memberof DeviceApiInterface
72
+ */
73
+ getDeviceRequestOpts(requestParameters: GetDeviceRequest): Promise<runtime.RequestOpts>;
74
+
75
+ /**
76
+ * 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.
67
77
  * @summary Get Device
68
78
  * @param {string} [deviceId]
69
79
  * @param {string} [id] Filter by Device ID (deprecated)
@@ -75,11 +85,20 @@ export interface DeviceApiInterface {
75
85
  getDeviceRaw(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>>;
76
86
 
77
87
  /**
78
- * 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.
88
+ * 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.
79
89
  * Get Device
80
90
  */
81
91
  getDevice(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
82
92
 
93
+ /**
94
+ * Creates request options for getDeviceDeprecated without sending the request
95
+ * @param {string} deviceId
96
+ * @deprecated
97
+ * @throws {RequiredError}
98
+ * @memberof DeviceApiInterface
99
+ */
100
+ getDeviceDeprecatedRequestOpts(requestParameters: GetDeviceDeprecatedRequest): Promise<runtime.RequestOpts>;
101
+
83
102
  /**
84
103
  * Gets device info using device ID.
85
104
  * @summary Get Device Short
@@ -99,7 +118,25 @@ export interface DeviceApiInterface {
99
118
  getDeviceDeprecated(requestParameters: GetDeviceDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse>;
100
119
 
101
120
  /**
102
- * 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.
121
+ * Creates request options for getDevices without sending the request
122
+ * @param {Array<string>} [id] Filter by Device IDs
123
+ * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
124
+ * @param {Array<string>} [oemName] Filter by OEM names
125
+ * @param {Array<string>} [codename] Filter by device codenames
126
+ * @param {Array<string>} [modelName] Filter by model names
127
+ * @param {boolean} [supported] Supported status
128
+ * @param {Array<string>} [maintainer] Filter by maintainer ID
129
+ * @param {boolean} [freezed] Filter by Freezed status
130
+ * @param {boolean} [hasReleases] Filter by has releases status
131
+ * @param {number} [skip] Skip query results
132
+ * @param {number} [limit] Limit query results (0 means unlimited)
133
+ * @throws {RequiredError}
134
+ * @memberof DeviceApiInterface
135
+ */
136
+ getDevicesRequestOpts(requestParameters: GetDevicesRequest): Promise<runtime.RequestOpts>;
137
+
138
+ /**
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.
103
140
  * @summary Get Devices
104
141
  * @param {Array<string>} [id] Filter by Device IDs
105
142
  * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
@@ -119,11 +156,18 @@ export interface DeviceApiInterface {
119
156
  getDevicesRaw(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseShortDeviceResponse>>;
120
157
 
121
158
  /**
122
- * 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.
159
+ * 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.
123
160
  * Get Devices
124
161
  */
125
162
  getDevices(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseShortDeviceResponse>;
126
163
 
164
+ /**
165
+ * Creates request options for getOems without sending the request
166
+ * @throws {RequiredError}
167
+ * @memberof DeviceApiInterface
168
+ */
169
+ getOemsRequestOpts(): Promise<runtime.RequestOpts>;
170
+
127
171
  /**
128
172
  * Lists all OEM names
129
173
  * @summary Get Oems
@@ -147,10 +191,9 @@ export interface DeviceApiInterface {
147
191
  export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
148
192
 
149
193
  /**
150
- * 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.
151
- * Get Device
194
+ * Creates request options for getDevice without sending the request
152
195
  */
153
- async getDeviceRaw(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>> {
196
+ async getDeviceRequestOpts(requestParameters: GetDeviceRequest): Promise<runtime.RequestOpts> {
154
197
  const queryParameters: any = {};
155
198
 
156
199
  if (requestParameters['deviceId'] != null) {
@@ -170,18 +213,27 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
170
213
 
171
214
  let urlPath = `/devices/get`;
172
215
 
173
- const response = await this.request({
216
+ return {
174
217
  path: urlPath,
175
218
  method: 'GET',
176
219
  headers: headerParameters,
177
220
  query: queryParameters,
178
- }, initOverrides);
221
+ };
222
+ }
223
+
224
+ /**
225
+ * 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.
226
+ * Get Device
227
+ */
228
+ async getDeviceRaw(requestParameters: GetDeviceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>> {
229
+ const requestOptions = await this.getDeviceRequestOpts(requestParameters);
230
+ const response = await this.request(requestOptions, initOverrides);
179
231
 
180
232
  return new runtime.JSONApiResponse(response, (jsonValue) => DeviceResponseFromJSON(jsonValue));
181
233
  }
182
234
 
183
235
  /**
184
- * 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.
236
+ * 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.
185
237
  * Get Device
186
238
  */
187
239
  async getDevice(requestParameters: GetDeviceRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeviceResponse> {
@@ -190,11 +242,10 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
190
242
  }
191
243
 
192
244
  /**
193
- * Gets device info using device ID.
194
- * Get Device Short
245
+ * Creates request options for getDeviceDeprecated without sending the request
195
246
  * @deprecated
196
247
  */
197
- async getDeviceDeprecatedRaw(requestParameters: GetDeviceDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>> {
248
+ async getDeviceDeprecatedRequestOpts(requestParameters: GetDeviceDeprecatedRequest): Promise<runtime.RequestOpts> {
198
249
  if (requestParameters['deviceId'] == null) {
199
250
  throw new runtime.RequiredError(
200
251
  'deviceId',
@@ -210,12 +261,22 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
210
261
  let urlPath = `/devices/{device_id}`;
211
262
  urlPath = urlPath.replace(`{${"device_id"}}`, encodeURIComponent(String(requestParameters['deviceId'])));
212
263
 
213
- const response = await this.request({
264
+ return {
214
265
  path: urlPath,
215
266
  method: 'GET',
216
267
  headers: headerParameters,
217
268
  query: queryParameters,
218
- }, initOverrides);
269
+ };
270
+ }
271
+
272
+ /**
273
+ * Gets device info using device ID.
274
+ * Get Device Short
275
+ * @deprecated
276
+ */
277
+ async getDeviceDeprecatedRaw(requestParameters: GetDeviceDeprecatedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeviceResponse>> {
278
+ const requestOptions = await this.getDeviceDeprecatedRequestOpts(requestParameters);
279
+ const response = await this.request(requestOptions, initOverrides);
219
280
 
220
281
  return new runtime.JSONApiResponse(response, (jsonValue) => DeviceResponseFromJSON(jsonValue));
221
282
  }
@@ -231,10 +292,9 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
231
292
  }
232
293
 
233
294
  /**
234
- * 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.
235
- * Get Devices
295
+ * Creates request options for getDevices without sending the request
236
296
  */
237
- async getDevicesRaw(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseShortDeviceResponse>> {
297
+ async getDevicesRequestOpts(requestParameters: GetDevicesRequest): Promise<runtime.RequestOpts> {
238
298
  const queryParameters: any = {};
239
299
 
240
300
  if (requestParameters['id'] != null) {
@@ -286,18 +346,27 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
286
346
 
287
347
  let urlPath = `/devices/`;
288
348
 
289
- const response = await this.request({
349
+ return {
290
350
  path: urlPath,
291
351
  method: 'GET',
292
352
  headers: headerParameters,
293
353
  query: queryParameters,
294
- }, initOverrides);
354
+ };
355
+ }
356
+
357
+ /**
358
+ * 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.
359
+ * Get Devices
360
+ */
361
+ async getDevicesRaw(requestParameters: GetDevicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseShortDeviceResponse>> {
362
+ const requestOptions = await this.getDevicesRequestOpts(requestParameters);
363
+ const response = await this.request(requestOptions, initOverrides);
295
364
 
296
365
  return new runtime.JSONApiResponse(response, (jsonValue) => ListResponseShortDeviceResponseFromJSON(jsonValue));
297
366
  }
298
367
 
299
368
  /**
300
- * 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.
369
+ * 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.
301
370
  * Get Devices
302
371
  */
303
372
  async getDevices(requestParameters: GetDevicesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseShortDeviceResponse> {
@@ -306,10 +375,9 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
306
375
  }
307
376
 
308
377
  /**
309
- * Lists all OEM names
310
- * Get Oems
378
+ * Creates request options for getOems without sending the request
311
379
  */
312
- async getOemsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseStr>> {
380
+ async getOemsRequestOpts(): Promise<runtime.RequestOpts> {
313
381
  const queryParameters: any = {};
314
382
 
315
383
  const headerParameters: runtime.HTTPHeaders = {};
@@ -317,12 +385,21 @@ export class DeviceApi extends runtime.BaseAPI implements DeviceApiInterface {
317
385
 
318
386
  let urlPath = `/oems/`;
319
387
 
320
- const response = await this.request({
388
+ return {
321
389
  path: urlPath,
322
390
  method: 'GET',
323
391
  headers: headerParameters,
324
392
  query: queryParameters,
325
- }, initOverrides);
393
+ };
394
+ }
395
+
396
+ /**
397
+ * Lists all OEM names
398
+ * Get Oems
399
+ */
400
+ async getOemsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseStr>> {
401
+ const requestOptions = await this.getOemsRequestOpts();
402
+ const response = await this.request(requestOptions, initOverrides);
326
403
 
327
404
  return new runtime.JSONApiResponse(response, (jsonValue) => ListResponseStrFromJSON(jsonValue));
328
405
  }