@orangefox-recovery/foxinternalclient 5.2.5 → 5.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (366) hide show
  1. package/.openapi-generator/FILES +58 -57
  2. package/README.md +3 -116
  3. package/dist/apis/DeviceApi.d.ts +158 -0
  4. package/dist/apis/DeviceApi.js +188 -0
  5. package/dist/apis/FoxFactoryApi.d.ts +298 -0
  6. package/dist/apis/FoxFactoryApi.js +507 -0
  7. package/dist/apis/GitlabApi.d.ts +51 -0
  8. package/dist/apis/GitlabApi.js +71 -0
  9. package/dist/apis/InternalApi.d.ts +549 -0
  10. package/dist/apis/InternalApi.js +957 -0
  11. package/dist/apis/PasteApi.d.ts +80 -0
  12. package/dist/apis/PasteApi.js +95 -0
  13. package/dist/apis/ReleaseApi.d.ts +188 -0
  14. package/dist/apis/ReleaseApi.js +226 -0
  15. package/dist/apis/StatsApi.d.ts +49 -0
  16. package/dist/apis/StatsApi.js +60 -0
  17. package/dist/apis/index.d.ts +7 -0
  18. package/dist/apis/index.js +25 -0
  19. package/dist/esm/apis/DeviceApi.d.ts +158 -0
  20. package/dist/esm/apis/DeviceApi.js +184 -0
  21. package/dist/esm/apis/FoxFactoryApi.d.ts +298 -0
  22. package/dist/esm/apis/FoxFactoryApi.js +503 -0
  23. package/dist/esm/apis/GitlabApi.d.ts +51 -0
  24. package/dist/esm/apis/GitlabApi.js +67 -0
  25. package/dist/esm/apis/InternalApi.d.ts +549 -0
  26. package/dist/esm/apis/InternalApi.js +953 -0
  27. package/dist/esm/apis/PasteApi.d.ts +80 -0
  28. package/dist/esm/apis/PasteApi.js +91 -0
  29. package/dist/esm/apis/ReleaseApi.d.ts +188 -0
  30. package/dist/esm/apis/ReleaseApi.js +222 -0
  31. package/dist/esm/apis/StatsApi.d.ts +49 -0
  32. package/dist/esm/apis/StatsApi.js +56 -0
  33. package/dist/esm/apis/index.d.ts +7 -0
  34. package/dist/esm/apis/index.js +9 -0
  35. package/dist/esm/index.d.ts +3 -13
  36. package/dist/esm/index.js +3 -13
  37. package/dist/esm/models/BodyChangePasswordProfileChangePasswordPost.d.ts +38 -0
  38. package/dist/esm/models/BodyChangePasswordProfileChangePasswordPost.js +47 -0
  39. package/dist/esm/models/BuildStatusEnum.d.ts +30 -0
  40. package/dist/esm/models/BuildStatusEnum.js +48 -0
  41. package/dist/esm/models/BuildTaskResponse.d.ts +103 -0
  42. package/dist/esm/models/BuildTaskResponse.js +78 -0
  43. package/dist/esm/models/BuildTaskShortResponse.d.ts +89 -0
  44. package/dist/esm/models/BuildTaskShortResponse.js +74 -0
  45. package/dist/esm/models/DeviceInternalResponse.d.ts +114 -0
  46. package/dist/esm/models/DeviceInternalResponse.js +91 -0
  47. package/dist/esm/models/DeviceResponse.d.ts +101 -0
  48. package/dist/esm/models/DeviceResponse.js +82 -0
  49. package/dist/esm/models/DeviceStatsResponse.d.ts +48 -0
  50. package/dist/esm/models/DeviceStatsResponse.js +51 -0
  51. package/dist/esm/models/DeviceUpdateBody.d.ts +62 -0
  52. package/dist/esm/models/DeviceUpdateBody.js +51 -0
  53. package/dist/esm/models/FFStatusEnum.d.ts +26 -0
  54. package/dist/esm/models/FFStatusEnum.js +44 -0
  55. package/dist/esm/models/FFStatusResponse.d.ts +33 -0
  56. package/dist/esm/models/FFStatusResponse.js +44 -0
  57. package/dist/esm/models/GlobalStatsAggregationModel.d.ts +52 -0
  58. package/dist/esm/models/GlobalStatsAggregationModel.js +55 -0
  59. package/dist/esm/models/HTTPValidationError.d.ts +33 -0
  60. package/dist/esm/models/HTTPValidationError.js +42 -0
  61. package/dist/esm/models/ListResponseBuildTaskShortResponse.d.ts +39 -0
  62. package/dist/esm/models/ListResponseBuildTaskShortResponse.js +47 -0
  63. package/dist/esm/models/ListResponseReleaseResponse.d.ts +39 -0
  64. package/dist/esm/models/ListResponseReleaseResponse.js +47 -0
  65. package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +39 -0
  66. package/dist/esm/models/ListResponseShortDeviceResponse.js +47 -0
  67. package/dist/esm/models/ListResponseShortReleaseResponse.d.ts +39 -0
  68. package/dist/esm/models/ListResponseShortReleaseResponse.js +47 -0
  69. package/dist/esm/models/ListResponseStr.d.ts +38 -0
  70. package/dist/esm/models/ListResponseStr.js +46 -0
  71. package/dist/esm/models/ListResponseUserShortResponse.d.ts +39 -0
  72. package/dist/esm/models/ListResponseUserShortResponse.js +47 -0
  73. package/dist/esm/models/LogListResponse.d.ts +51 -0
  74. package/dist/esm/models/LogListResponse.js +56 -0
  75. package/dist/esm/models/LogResponse.d.ts +83 -0
  76. package/dist/esm/models/LogResponse.js +66 -0
  77. package/dist/esm/models/MaintainerShortModel.d.ts +44 -0
  78. package/dist/esm/models/MaintainerShortModel.js +51 -0
  79. package/dist/esm/models/NewBuildTaskBody.d.ts +57 -0
  80. package/dist/esm/models/NewBuildTaskBody.js +52 -0
  81. package/dist/esm/models/NewDeviceBody.d.ts +50 -0
  82. package/dist/esm/models/NewDeviceBody.js +55 -0
  83. package/dist/esm/models/PasteInput.d.ts +50 -0
  84. package/dist/esm/models/PasteInput.js +51 -0
  85. package/dist/esm/models/PasteOutput.d.ts +50 -0
  86. package/dist/esm/models/PasteOutput.js +51 -0
  87. package/dist/esm/models/RecoveryImgResponse.d.ts +38 -0
  88. package/dist/esm/models/RecoveryImgResponse.js +47 -0
  89. package/dist/esm/models/ReleaseGroupsResponse.d.ts +35 -0
  90. package/dist/esm/models/ReleaseGroupsResponse.js +43 -0
  91. package/dist/esm/models/ReleaseInternalResponse.d.ts +162 -0
  92. package/dist/esm/models/ReleaseInternalResponse.js +119 -0
  93. package/dist/esm/models/ReleaseInternalResponsePropValue.d.ts +26 -0
  94. package/dist/esm/models/ReleaseInternalResponsePropValue.js +31 -0
  95. package/dist/esm/models/ReleaseResponse.d.ts +139 -0
  96. package/dist/esm/models/ReleaseResponse.js +107 -0
  97. package/dist/esm/models/ReleaseStatsResponse.d.ts +48 -0
  98. package/dist/esm/models/ReleaseStatsResponse.js +51 -0
  99. package/dist/esm/models/ReleaseType.d.ts +26 -0
  100. package/dist/esm/models/ReleaseType.js +44 -0
  101. package/dist/esm/models/ReleaseUpdateBody.d.ts +50 -0
  102. package/dist/esm/models/ReleaseUpdateBody.js +47 -0
  103. package/dist/esm/models/ReleasesSort.d.ts +25 -0
  104. package/dist/esm/models/ReleasesSort.js +43 -0
  105. package/dist/esm/models/ResponseGetReleases.d.ts +41 -0
  106. package/dist/esm/models/ResponseGetReleases.js +46 -0
  107. package/dist/esm/models/ShortDeviceResponse.d.ts +82 -0
  108. package/dist/esm/models/ShortDeviceResponse.js +73 -0
  109. package/dist/esm/models/ShortReleaseResponse.d.ts +100 -0
  110. package/dist/esm/models/ShortReleaseResponse.js +84 -0
  111. package/dist/esm/models/TaskUpdateBody.d.ts +39 -0
  112. package/dist/esm/models/TaskUpdateBody.js +44 -0
  113. package/dist/esm/models/TokenResponse.d.ts +38 -0
  114. package/dist/esm/models/TokenResponse.js +45 -0
  115. package/dist/esm/models/UserGitlab.d.ts +32 -0
  116. package/dist/esm/models/UserGitlab.js +43 -0
  117. package/dist/esm/models/UserInternalResponse.d.ts +90 -0
  118. package/dist/esm/models/UserInternalResponse.js +75 -0
  119. package/dist/esm/models/UserMail.d.ts +32 -0
  120. package/dist/esm/models/UserMail.js +43 -0
  121. package/dist/esm/models/UserShortResponse.d.ts +50 -0
  122. package/dist/esm/models/UserShortResponse.js +55 -0
  123. package/dist/esm/models/UserTelegram.d.ts +32 -0
  124. package/dist/esm/models/UserTelegram.js +43 -0
  125. package/dist/esm/models/UserUpdateBody.d.ts +56 -0
  126. package/dist/esm/models/UserUpdateBody.js +49 -0
  127. package/dist/esm/models/ValidationError.d.ts +45 -0
  128. package/dist/esm/models/ValidationError.js +52 -0
  129. package/dist/esm/models/ValidationErrorLocInner.d.ts +26 -0
  130. package/{index.ts → dist/esm/models/ValidationErrorLocInner.js} +20 -7
  131. package/dist/esm/models/index.d.ts +47 -0
  132. package/dist/esm/models/index.js +49 -0
  133. package/dist/esm/runtime.d.ts +184 -0
  134. package/dist/esm/runtime.js +334 -0
  135. package/dist/index.d.ts +3 -13
  136. package/dist/index.js +5 -15
  137. package/dist/models/BodyChangePasswordProfileChangePasswordPost.d.ts +38 -0
  138. package/dist/models/BodyChangePasswordProfileChangePasswordPost.js +54 -0
  139. package/dist/models/BuildStatusEnum.d.ts +30 -0
  140. package/dist/models/BuildStatusEnum.js +56 -0
  141. package/dist/models/BuildTaskResponse.d.ts +103 -0
  142. package/dist/models/BuildTaskResponse.js +85 -0
  143. package/dist/models/BuildTaskShortResponse.d.ts +89 -0
  144. package/dist/models/BuildTaskShortResponse.js +81 -0
  145. package/dist/models/DeviceInternalResponse.d.ts +114 -0
  146. package/dist/models/DeviceInternalResponse.js +98 -0
  147. package/dist/models/DeviceResponse.d.ts +101 -0
  148. package/dist/models/DeviceResponse.js +89 -0
  149. package/dist/models/DeviceStatsResponse.d.ts +48 -0
  150. package/dist/models/DeviceStatsResponse.js +58 -0
  151. package/dist/models/DeviceUpdateBody.d.ts +62 -0
  152. package/dist/models/DeviceUpdateBody.js +58 -0
  153. package/dist/models/FFStatusEnum.d.ts +26 -0
  154. package/dist/models/FFStatusEnum.js +52 -0
  155. package/dist/models/FFStatusResponse.d.ts +33 -0
  156. package/dist/models/FFStatusResponse.js +51 -0
  157. package/dist/models/GlobalStatsAggregationModel.d.ts +52 -0
  158. package/dist/models/GlobalStatsAggregationModel.js +62 -0
  159. package/dist/models/HTTPValidationError.d.ts +33 -0
  160. package/dist/models/HTTPValidationError.js +49 -0
  161. package/dist/models/ListResponseBuildTaskShortResponse.d.ts +39 -0
  162. package/dist/models/ListResponseBuildTaskShortResponse.js +54 -0
  163. package/dist/models/ListResponseReleaseResponse.d.ts +39 -0
  164. package/dist/models/ListResponseReleaseResponse.js +54 -0
  165. package/dist/models/ListResponseShortDeviceResponse.d.ts +39 -0
  166. package/dist/models/ListResponseShortDeviceResponse.js +54 -0
  167. package/dist/models/ListResponseShortReleaseResponse.d.ts +39 -0
  168. package/dist/models/ListResponseShortReleaseResponse.js +54 -0
  169. package/dist/models/ListResponseStr.d.ts +38 -0
  170. package/dist/models/ListResponseStr.js +53 -0
  171. package/dist/models/ListResponseUserShortResponse.d.ts +39 -0
  172. package/dist/models/ListResponseUserShortResponse.js +54 -0
  173. package/dist/models/LogListResponse.d.ts +51 -0
  174. package/dist/models/LogListResponse.js +63 -0
  175. package/dist/models/LogResponse.d.ts +83 -0
  176. package/dist/models/LogResponse.js +73 -0
  177. package/dist/models/MaintainerShortModel.d.ts +44 -0
  178. package/dist/models/MaintainerShortModel.js +58 -0
  179. package/dist/models/NewBuildTaskBody.d.ts +57 -0
  180. package/dist/models/NewBuildTaskBody.js +59 -0
  181. package/dist/models/NewDeviceBody.d.ts +50 -0
  182. package/dist/models/NewDeviceBody.js +62 -0
  183. package/dist/models/PasteInput.d.ts +50 -0
  184. package/dist/models/PasteInput.js +58 -0
  185. package/dist/models/PasteOutput.d.ts +50 -0
  186. package/dist/models/PasteOutput.js +58 -0
  187. package/dist/models/RecoveryImgResponse.d.ts +38 -0
  188. package/dist/models/RecoveryImgResponse.js +54 -0
  189. package/dist/models/ReleaseGroupsResponse.d.ts +35 -0
  190. package/dist/models/ReleaseGroupsResponse.js +50 -0
  191. package/dist/models/ReleaseInternalResponse.d.ts +162 -0
  192. package/dist/models/ReleaseInternalResponse.js +126 -0
  193. package/dist/models/ReleaseInternalResponsePropValue.d.ts +26 -0
  194. package/dist/models/ReleaseInternalResponsePropValue.js +38 -0
  195. package/dist/models/ReleaseResponse.d.ts +139 -0
  196. package/dist/models/ReleaseResponse.js +114 -0
  197. package/dist/models/ReleaseStatsResponse.d.ts +48 -0
  198. package/dist/models/ReleaseStatsResponse.js +58 -0
  199. package/dist/models/ReleaseType.d.ts +26 -0
  200. package/dist/models/ReleaseType.js +52 -0
  201. package/dist/models/ReleaseUpdateBody.d.ts +50 -0
  202. package/dist/models/ReleaseUpdateBody.js +54 -0
  203. package/dist/models/ReleasesSort.d.ts +25 -0
  204. package/dist/models/ReleasesSort.js +51 -0
  205. package/dist/models/ResponseGetReleases.d.ts +41 -0
  206. package/dist/models/ResponseGetReleases.js +53 -0
  207. package/dist/models/ShortDeviceResponse.d.ts +82 -0
  208. package/dist/models/ShortDeviceResponse.js +80 -0
  209. package/dist/models/ShortReleaseResponse.d.ts +100 -0
  210. package/dist/models/ShortReleaseResponse.js +91 -0
  211. package/dist/models/TaskUpdateBody.d.ts +39 -0
  212. package/dist/models/TaskUpdateBody.js +51 -0
  213. package/dist/models/TokenResponse.d.ts +38 -0
  214. package/dist/models/TokenResponse.js +52 -0
  215. package/dist/models/UserGitlab.d.ts +32 -0
  216. package/dist/models/UserGitlab.js +50 -0
  217. package/dist/models/UserInternalResponse.d.ts +90 -0
  218. package/dist/models/UserInternalResponse.js +82 -0
  219. package/dist/models/UserMail.d.ts +32 -0
  220. package/dist/models/UserMail.js +50 -0
  221. package/dist/models/UserShortResponse.d.ts +50 -0
  222. package/dist/models/UserShortResponse.js +62 -0
  223. package/dist/models/UserTelegram.d.ts +32 -0
  224. package/dist/models/UserTelegram.js +50 -0
  225. package/dist/models/UserUpdateBody.d.ts +56 -0
  226. package/dist/models/UserUpdateBody.js +56 -0
  227. package/dist/models/ValidationError.d.ts +45 -0
  228. package/dist/models/ValidationError.js +59 -0
  229. package/dist/models/ValidationErrorLocInner.d.ts +26 -0
  230. package/dist/models/ValidationErrorLocInner.js +38 -0
  231. package/dist/models/index.d.ts +47 -0
  232. package/dist/models/index.js +65 -0
  233. package/dist/runtime.d.ts +184 -0
  234. package/dist/runtime.js +350 -0
  235. package/package.json +4 -17
  236. package/src/apis/DeviceApi.ts +326 -0
  237. package/src/apis/FoxFactoryApi.ts +807 -0
  238. package/src/apis/GitlabApi.ts +108 -0
  239. package/src/apis/InternalApi.ts +1590 -0
  240. package/src/apis/PasteApi.ts +158 -0
  241. package/src/apis/ReleaseApi.ts +414 -0
  242. package/src/apis/StatsApi.ts +82 -0
  243. package/src/apis/index.ts +9 -0
  244. package/src/index.ts +5 -0
  245. package/src/models/BodyChangePasswordProfileChangePasswordPost.ts +75 -0
  246. package/src/models/BuildStatusEnum.ts +58 -0
  247. package/src/models/BuildTaskResponse.ts +183 -0
  248. package/src/models/BuildTaskShortResponse.ts +167 -0
  249. package/src/models/DeviceInternalResponse.ts +196 -0
  250. package/src/models/DeviceResponse.ts +171 -0
  251. package/src/models/DeviceStatsResponse.ts +84 -0
  252. package/src/models/DeviceUpdateBody.ts +105 -0
  253. package/src/models/FFStatusEnum.ts +54 -0
  254. package/src/models/FFStatusResponse.ts +76 -0
  255. package/src/models/GlobalStatsAggregationModel.ts +93 -0
  256. package/src/models/HTTPValidationError.ts +73 -0
  257. package/src/models/ListResponseBuildTaskShortResponse.ts +82 -0
  258. package/src/models/ListResponseReleaseResponse.ts +82 -0
  259. package/src/models/ListResponseShortDeviceResponse.ts +82 -0
  260. package/src/models/ListResponseShortReleaseResponse.ts +82 -0
  261. package/src/models/ListResponseStr.ts +74 -0
  262. package/src/models/ListResponseUserShortResponse.ts +82 -0
  263. package/src/models/LogListResponse.ts +101 -0
  264. package/src/models/LogResponse.ts +141 -0
  265. package/src/models/MaintainerShortModel.ts +84 -0
  266. package/src/models/NewBuildTaskBody.ts +108 -0
  267. package/src/models/NewDeviceBody.ts +93 -0
  268. package/src/models/PasteInput.ts +91 -0
  269. package/src/models/PasteOutput.ts +91 -0
  270. package/src/models/RecoveryImgResponse.ts +75 -0
  271. package/src/models/ReleaseGroupsResponse.ts +74 -0
  272. package/src/models/ReleaseInternalResponse.ts +279 -0
  273. package/src/models/ReleaseInternalResponsePropValue.ts +46 -0
  274. package/src/models/ReleaseResponse.ts +233 -0
  275. package/src/models/ReleaseStatsResponse.ts +84 -0
  276. package/src/models/ReleaseType.ts +54 -0
  277. package/src/models/ReleaseUpdateBody.ts +89 -0
  278. package/src/models/ReleasesSort.ts +53 -0
  279. package/src/models/ResponseGetReleases.ts +96 -0
  280. package/src/models/ShortDeviceResponse.ts +138 -0
  281. package/src/models/ShortReleaseResponse.ts +174 -0
  282. package/src/models/TaskUpdateBody.ts +83 -0
  283. package/src/models/TokenResponse.ts +74 -0
  284. package/src/models/UserGitlab.ts +66 -0
  285. package/src/models/UserInternalResponse.ts +172 -0
  286. package/src/models/UserMail.ts +66 -0
  287. package/src/models/UserShortResponse.ts +93 -0
  288. package/src/models/UserTelegram.ts +66 -0
  289. package/src/models/UserUpdateBody.ts +97 -0
  290. package/src/models/ValidationError.ts +92 -0
  291. package/src/models/ValidationErrorLocInner.ts +46 -0
  292. package/src/models/index.ts +49 -0
  293. package/src/runtime.ts +432 -0
  294. package/tsconfig.json +2 -4
  295. package/api.ts +0 -5578
  296. package/base.ts +0 -86
  297. package/common.ts +0 -150
  298. package/configuration.ts +0 -115
  299. package/dist/api.d.ts +0 -3696
  300. package/dist/api.js +0 -3281
  301. package/dist/base.d.ts +0 -66
  302. package/dist/base.js +0 -65
  303. package/dist/common.d.ts +0 -65
  304. package/dist/common.js +0 -161
  305. package/dist/configuration.d.ts +0 -91
  306. package/dist/configuration.js +0 -44
  307. package/dist/esm/api.d.ts +0 -3696
  308. package/dist/esm/api.js +0 -3254
  309. package/dist/esm/base.d.ts +0 -66
  310. package/dist/esm/base.js +0 -60
  311. package/dist/esm/common.d.ts +0 -65
  312. package/dist/esm/common.js +0 -149
  313. package/dist/esm/configuration.d.ts +0 -91
  314. package/dist/esm/configuration.js +0 -40
  315. package/docs/BodyChangePasswordProfileChangePasswordPost.md +0 -22
  316. package/docs/BuildStatusEnum.md +0 -20
  317. package/docs/BuildTaskResponse.md +0 -42
  318. package/docs/BuildTaskShortResponse.md +0 -38
  319. package/docs/DeviceApi.md +0 -251
  320. package/docs/DeviceInternalResponse.md +0 -48
  321. package/docs/DeviceResponse.md +0 -44
  322. package/docs/DeviceStatsResponse.md +0 -24
  323. package/docs/DeviceUpdateBody.md +0 -30
  324. package/docs/FFStatusEnum.md +0 -12
  325. package/docs/FFStatusResponse.md +0 -20
  326. package/docs/FoxFactoryApi.md +0 -540
  327. package/docs/GitlabApi.md +0 -62
  328. package/docs/GlobalStatsAggregationModel.md +0 -26
  329. package/docs/HTTPValidationError.md +0 -20
  330. package/docs/InternalApi.md +0 -958
  331. package/docs/ListResponseBuildTaskShortResponse.md +0 -22
  332. package/docs/ListResponseReleaseResponse.md +0 -22
  333. package/docs/ListResponseShortDeviceResponse.md +0 -22
  334. package/docs/ListResponseShortReleaseResponse.md +0 -22
  335. package/docs/ListResponseStr.md +0 -22
  336. package/docs/ListResponseUserShortResponse.md +0 -22
  337. package/docs/LogListResponse.md +0 -26
  338. package/docs/LogResponse.md +0 -36
  339. package/docs/MaintainerShortModel.md +0 -26
  340. package/docs/NewBuildTaskBody.md +0 -28
  341. package/docs/NewDeviceBody.md +0 -26
  342. package/docs/RecoveryImgResponse.md +0 -22
  343. package/docs/ReleaseApi.md +0 -289
  344. package/docs/ReleaseGroupsResponse.md +0 -20
  345. package/docs/ReleaseInternalResponse.md +0 -62
  346. package/docs/ReleaseInternalResponsePropValue.md +0 -18
  347. package/docs/ReleaseResponse.md +0 -56
  348. package/docs/ReleaseStatsResponse.md +0 -24
  349. package/docs/ReleaseType.md +0 -12
  350. package/docs/ReleaseUpdateBody.md +0 -26
  351. package/docs/ReleasesSort.md +0 -10
  352. package/docs/ResponseGetReleases.md +0 -22
  353. package/docs/ShortDeviceResponse.md +0 -38
  354. package/docs/ShortReleaseResponse.md +0 -44
  355. package/docs/StatsApi.md +0 -53
  356. package/docs/TaskUpdateBody.md +0 -22
  357. package/docs/TokenResponse.md +0 -22
  358. package/docs/UserGitlab.md +0 -20
  359. package/docs/UserInternalResponse.md +0 -38
  360. package/docs/UserMail.md +0 -20
  361. package/docs/UserShortResponse.md +0 -26
  362. package/docs/UserTelegram.md +0 -20
  363. package/docs/UserUpdateBody.md +0 -28
  364. package/docs/ValidationError.md +0 -24
  365. package/docs/ValidationErrorLocInner.md +0 -18
  366. package/git_push.sh +0 -57
package/dist/esm/api.d.ts DELETED
@@ -1,3696 +0,0 @@
1
- /**
2
- * Fox API
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
- *
5
- * The version of the OpenAPI document: 5.2.5
6
- * Contact: admin@orangefox.tech
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from './configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import type { RequestArgs } from './base';
15
- import { BaseAPI } from './base';
16
- /**
17
- *
18
- * @export
19
- * @interface BodyChangePasswordProfileChangePasswordPost
20
- */
21
- export interface BodyChangePasswordProfileChangePasswordPost {
22
- /**
23
- *
24
- * @type {string}
25
- * @memberof BodyChangePasswordProfileChangePasswordPost
26
- */
27
- 'old_password': string;
28
- /**
29
- *
30
- * @type {string}
31
- * @memberof BodyChangePasswordProfileChangePasswordPost
32
- */
33
- 'new_password': string;
34
- }
35
- /**
36
- *
37
- * @export
38
- * @enum {string}
39
- */
40
- export declare const BuildStatusEnum: {
41
- readonly Pending: "pending";
42
- readonly Running: "running";
43
- readonly Cancelling: "cancelling";
44
- readonly Uploading: "uploading";
45
- readonly Success: "success";
46
- readonly Cancelled: "cancelled";
47
- readonly Failed: "failed";
48
- };
49
- export type BuildStatusEnum = typeof BuildStatusEnum[keyof typeof BuildStatusEnum];
50
- /**
51
- *
52
- * @export
53
- * @interface BuildTaskResponse
54
- */
55
- export interface BuildTaskResponse {
56
- /**
57
- *
58
- * @type {string}
59
- * @memberof BuildTaskResponse
60
- */
61
- 'id': string;
62
- /**
63
- *
64
- * @type {string}
65
- * @memberof BuildTaskResponse
66
- */
67
- 'started_by_id': string;
68
- /**
69
- *
70
- * @type {ShortDeviceResponse}
71
- * @memberof BuildTaskResponse
72
- */
73
- 'device': ShortDeviceResponse;
74
- /**
75
- *
76
- * @type {BuildStatusEnum}
77
- * @memberof BuildTaskResponse
78
- */
79
- 'status': BuildStatusEnum;
80
- /**
81
- *
82
- * @type {string}
83
- * @memberof BuildTaskResponse
84
- */
85
- 'version'?: string;
86
- /**
87
- *
88
- * @type {ReleaseType}
89
- * @memberof BuildTaskResponse
90
- */
91
- 'type'?: ReleaseType;
92
- /**
93
- *
94
- * @type {string}
95
- * @memberof BuildTaskResponse
96
- */
97
- 'variant'?: string;
98
- /**
99
- *
100
- * @type {string}
101
- * @memberof BuildTaskResponse
102
- */
103
- 'started_at': string;
104
- /**
105
- *
106
- * @type {string}
107
- * @memberof BuildTaskResponse
108
- */
109
- 'finished_at'?: string | null;
110
- /**
111
- *
112
- * @type {boolean}
113
- * @memberof BuildTaskResponse
114
- */
115
- 'has_artifact': boolean;
116
- /**
117
- *
118
- * @type {{ [key: string]: any; }}
119
- * @memberof BuildTaskResponse
120
- */
121
- 'environment'?: {
122
- [key: string]: any;
123
- } | null;
124
- /**
125
- *
126
- * @type {Array<string>}
127
- * @memberof BuildTaskResponse
128
- */
129
- 'logs'?: Array<string>;
130
- }
131
- /**
132
- *
133
- * @export
134
- * @interface BuildTaskShortResponse
135
- */
136
- export interface BuildTaskShortResponse {
137
- /**
138
- *
139
- * @type {string}
140
- * @memberof BuildTaskShortResponse
141
- */
142
- 'id': string;
143
- /**
144
- *
145
- * @type {string}
146
- * @memberof BuildTaskShortResponse
147
- */
148
- 'started_by_id': string;
149
- /**
150
- *
151
- * @type {ShortDeviceResponse}
152
- * @memberof BuildTaskShortResponse
153
- */
154
- 'device': ShortDeviceResponse;
155
- /**
156
- *
157
- * @type {BuildStatusEnum}
158
- * @memberof BuildTaskShortResponse
159
- */
160
- 'status': BuildStatusEnum;
161
- /**
162
- *
163
- * @type {string}
164
- * @memberof BuildTaskShortResponse
165
- */
166
- 'version'?: string;
167
- /**
168
- *
169
- * @type {ReleaseType}
170
- * @memberof BuildTaskShortResponse
171
- */
172
- 'type'?: ReleaseType;
173
- /**
174
- *
175
- * @type {string}
176
- * @memberof BuildTaskShortResponse
177
- */
178
- 'variant'?: string;
179
- /**
180
- *
181
- * @type {string}
182
- * @memberof BuildTaskShortResponse
183
- */
184
- 'started_at': string;
185
- /**
186
- *
187
- * @type {string}
188
- * @memberof BuildTaskShortResponse
189
- */
190
- 'finished_at'?: string | null;
191
- /**
192
- *
193
- * @type {boolean}
194
- * @memberof BuildTaskShortResponse
195
- */
196
- 'has_artifact': boolean;
197
- }
198
- /**
199
- *
200
- * @export
201
- * @interface DeviceInternalResponse
202
- */
203
- export interface DeviceInternalResponse {
204
- /**
205
- *
206
- * @type {string}
207
- * @memberof DeviceInternalResponse
208
- * @deprecated
209
- */
210
- '_id': string;
211
- /**
212
- * Device codename, legacy
213
- * @type {string}
214
- * @memberof DeviceInternalResponse
215
- * @deprecated
216
- */
217
- 'codename': string;
218
- /**
219
- * Model name of device, does not include the OEM part, legacy
220
- * @type {string}
221
- * @memberof DeviceInternalResponse
222
- * @deprecated
223
- */
224
- 'model_name': string;
225
- /**
226
- *
227
- * @type {string}
228
- * @memberof DeviceInternalResponse
229
- */
230
- 'oem_name': string;
231
- /**
232
- *
233
- * @type {string}
234
- * @memberof DeviceInternalResponse
235
- */
236
- 'id': string;
237
- /**
238
- *
239
- * @type {Array<string>}
240
- * @memberof DeviceInternalResponse
241
- */
242
- 'codenames': Array<string>;
243
- /**
244
- *
245
- * @type {Array<string>}
246
- * @memberof DeviceInternalResponse
247
- */
248
- 'model_names': Array<string>;
249
- /**
250
- *
251
- * @type {boolean}
252
- * @memberof DeviceInternalResponse
253
- */
254
- 'supported': boolean;
255
- /**
256
- *
257
- * @type {MaintainerShortModel}
258
- * @memberof DeviceInternalResponse
259
- */
260
- 'maintainer': MaintainerShortModel;
261
- /**
262
- *
263
- * @type {string}
264
- * @memberof DeviceInternalResponse
265
- */
266
- 'notes'?: string | null;
267
- /**
268
- *
269
- * @type {string}
270
- * @memberof DeviceInternalResponse
271
- */
272
- 'device_tree'?: string | null;
273
- /**
274
- *
275
- * @type {DeviceStatsResponse}
276
- * @memberof DeviceInternalResponse
277
- */
278
- 'stats': DeviceStatsResponse | null;
279
- /**
280
- *
281
- * @type {boolean}
282
- * @memberof DeviceInternalResponse
283
- */
284
- 'freezed': boolean;
285
- /**
286
- * Full name of device / devices, legacy
287
- * @type {string}
288
- * @memberof DeviceInternalResponse
289
- */
290
- 'full_name': string;
291
- /**
292
- * URL of the device on the official website
293
- * @type {string}
294
- * @memberof DeviceInternalResponse
295
- */
296
- 'url': string;
297
- }
298
- /**
299
- *
300
- * @export
301
- * @interface DeviceResponse
302
- */
303
- export interface DeviceResponse {
304
- /**
305
- *
306
- * @type {string}
307
- * @memberof DeviceResponse
308
- * @deprecated
309
- */
310
- '_id': string;
311
- /**
312
- * Device codename, legacy
313
- * @type {string}
314
- * @memberof DeviceResponse
315
- * @deprecated
316
- */
317
- 'codename': string;
318
- /**
319
- * Model name of device, does not include the OEM part, legacy
320
- * @type {string}
321
- * @memberof DeviceResponse
322
- * @deprecated
323
- */
324
- 'model_name': string;
325
- /**
326
- *
327
- * @type {string}
328
- * @memberof DeviceResponse
329
- */
330
- 'oem_name': string;
331
- /**
332
- *
333
- * @type {string}
334
- * @memberof DeviceResponse
335
- */
336
- 'id': string;
337
- /**
338
- *
339
- * @type {Array<string>}
340
- * @memberof DeviceResponse
341
- */
342
- 'codenames': Array<string>;
343
- /**
344
- *
345
- * @type {Array<string>}
346
- * @memberof DeviceResponse
347
- */
348
- 'model_names': Array<string>;
349
- /**
350
- *
351
- * @type {boolean}
352
- * @memberof DeviceResponse
353
- */
354
- 'supported': boolean;
355
- /**
356
- *
357
- * @type {MaintainerShortModel}
358
- * @memberof DeviceResponse
359
- */
360
- 'maintainer': MaintainerShortModel;
361
- /**
362
- *
363
- * @type {string}
364
- * @memberof DeviceResponse
365
- */
366
- 'notes'?: string | null;
367
- /**
368
- *
369
- * @type {string}
370
- * @memberof DeviceResponse
371
- */
372
- 'device_tree'?: string | null;
373
- /**
374
- * Full name of device / devices, legacy
375
- * @type {string}
376
- * @memberof DeviceResponse
377
- */
378
- 'full_name': string;
379
- /**
380
- * URL of the device on the official website
381
- * @type {string}
382
- * @memberof DeviceResponse
383
- */
384
- 'url': string;
385
- }
386
- /**
387
- *
388
- * @export
389
- * @interface DeviceStatsResponse
390
- */
391
- export interface DeviceStatsResponse {
392
- /**
393
- *
394
- * @type {number}
395
- * @memberof DeviceStatsResponse
396
- */
397
- 'count': number;
398
- /**
399
- *
400
- * @type {{ [key: string]: number; }}
401
- * @memberof DeviceStatsResponse
402
- */
403
- 'days': {
404
- [key: string]: number;
405
- };
406
- /**
407
- *
408
- * @type {{ [key: string]: number; }}
409
- * @memberof DeviceStatsResponse
410
- */
411
- 'mirrors': {
412
- [key: string]: number;
413
- };
414
- }
415
- /**
416
- *
417
- * @export
418
- * @interface DeviceUpdateBody
419
- */
420
- export interface DeviceUpdateBody {
421
- /**
422
- *
423
- * @type {string}
424
- * @memberof DeviceUpdateBody
425
- */
426
- 'oem_name'?: string | null;
427
- /**
428
- *
429
- * @type {Array<string>}
430
- * @memberof DeviceUpdateBody
431
- */
432
- 'codenames'?: Array<string> | null;
433
- /**
434
- *
435
- * @type {Array<string>}
436
- * @memberof DeviceUpdateBody
437
- */
438
- 'model_names'?: Array<string> | null;
439
- /**
440
- *
441
- * @type {boolean}
442
- * @memberof DeviceUpdateBody
443
- */
444
- 'supported'?: boolean | null;
445
- /**
446
- *
447
- * @type {boolean}
448
- * @memberof DeviceUpdateBody
449
- */
450
- 'freezed'?: boolean | null;
451
- /**
452
- *
453
- * @type {string}
454
- * @memberof DeviceUpdateBody
455
- */
456
- 'notes'?: string | null;
457
- }
458
- /**
459
- *
460
- * @export
461
- * @enum {string}
462
- */
463
- export declare const FFStatusEnum: {
464
- readonly Free: "free";
465
- readonly Busy: "busy";
466
- readonly Offline: "offline";
467
- };
468
- export type FFStatusEnum = typeof FFStatusEnum[keyof typeof FFStatusEnum];
469
- /**
470
- *
471
- * @export
472
- * @interface FFStatusResponse
473
- */
474
- export interface FFStatusResponse {
475
- /**
476
- *
477
- * @type {FFStatusEnum}
478
- * @memberof FFStatusResponse
479
- */
480
- 'status': FFStatusEnum;
481
- }
482
- /**
483
- *
484
- * @export
485
- * @interface GlobalStatsAggregationModel
486
- */
487
- export interface GlobalStatsAggregationModel {
488
- /**
489
- *
490
- * @type {number}
491
- * @memberof GlobalStatsAggregationModel
492
- */
493
- 'count': number;
494
- /**
495
- *
496
- * @type {number}
497
- * @memberof GlobalStatsAggregationModel
498
- */
499
- 'deviceCount': number;
500
- /**
501
- *
502
- * @type {number}
503
- * @memberof GlobalStatsAggregationModel
504
- */
505
- 'releaseCount': number;
506
- /**
507
- *
508
- * @type {{ [key: string]: number; }}
509
- * @memberof GlobalStatsAggregationModel
510
- */
511
- 'days': {
512
- [key: string]: number;
513
- };
514
- }
515
- /**
516
- *
517
- * @export
518
- * @interface HTTPValidationError
519
- */
520
- export interface HTTPValidationError {
521
- /**
522
- *
523
- * @type {Array<ValidationError>}
524
- * @memberof HTTPValidationError
525
- */
526
- 'detail'?: Array<ValidationError>;
527
- }
528
- /**
529
- *
530
- * @export
531
- * @interface ListResponseBuildTaskShortResponse
532
- */
533
- export interface ListResponseBuildTaskShortResponse {
534
- /**
535
- *
536
- * @type {Array<BuildTaskShortResponse>}
537
- * @memberof ListResponseBuildTaskShortResponse
538
- */
539
- 'data': Array<BuildTaskShortResponse>;
540
- /**
541
- *
542
- * @type {number}
543
- * @memberof ListResponseBuildTaskShortResponse
544
- */
545
- 'count': number;
546
- }
547
- /**
548
- *
549
- * @export
550
- * @interface ListResponseReleaseResponse
551
- */
552
- export interface ListResponseReleaseResponse {
553
- /**
554
- *
555
- * @type {Array<ReleaseResponse>}
556
- * @memberof ListResponseReleaseResponse
557
- */
558
- 'data': Array<ReleaseResponse>;
559
- /**
560
- *
561
- * @type {number}
562
- * @memberof ListResponseReleaseResponse
563
- */
564
- 'count': number;
565
- }
566
- /**
567
- *
568
- * @export
569
- * @interface ListResponseShortDeviceResponse
570
- */
571
- export interface ListResponseShortDeviceResponse {
572
- /**
573
- *
574
- * @type {Array<ShortDeviceResponse>}
575
- * @memberof ListResponseShortDeviceResponse
576
- */
577
- 'data': Array<ShortDeviceResponse>;
578
- /**
579
- *
580
- * @type {number}
581
- * @memberof ListResponseShortDeviceResponse
582
- */
583
- 'count': number;
584
- }
585
- /**
586
- *
587
- * @export
588
- * @interface ListResponseShortReleaseResponse
589
- */
590
- export interface ListResponseShortReleaseResponse {
591
- /**
592
- *
593
- * @type {Array<ShortReleaseResponse>}
594
- * @memberof ListResponseShortReleaseResponse
595
- */
596
- 'data': Array<ShortReleaseResponse>;
597
- /**
598
- *
599
- * @type {number}
600
- * @memberof ListResponseShortReleaseResponse
601
- */
602
- 'count': number;
603
- }
604
- /**
605
- *
606
- * @export
607
- * @interface ListResponseStr
608
- */
609
- export interface ListResponseStr {
610
- /**
611
- *
612
- * @type {Array<string>}
613
- * @memberof ListResponseStr
614
- */
615
- 'data': Array<string>;
616
- /**
617
- *
618
- * @type {number}
619
- * @memberof ListResponseStr
620
- */
621
- 'count': number;
622
- }
623
- /**
624
- *
625
- * @export
626
- * @interface ListResponseUserShortResponse
627
- */
628
- export interface ListResponseUserShortResponse {
629
- /**
630
- *
631
- * @type {Array<UserShortResponse>}
632
- * @memberof ListResponseUserShortResponse
633
- */
634
- 'data': Array<UserShortResponse>;
635
- /**
636
- *
637
- * @type {number}
638
- * @memberof ListResponseUserShortResponse
639
- */
640
- 'count': number;
641
- }
642
- /**
643
- *
644
- * @export
645
- * @interface LogListResponse
646
- */
647
- export interface LogListResponse {
648
- /**
649
- *
650
- * @type {Array<LogResponse>}
651
- * @memberof LogListResponse
652
- */
653
- 'logs': Array<LogResponse>;
654
- /**
655
- *
656
- * @type {number}
657
- * @memberof LogListResponse
658
- */
659
- 'total': number;
660
- /**
661
- *
662
- * @type {number}
663
- * @memberof LogListResponse
664
- */
665
- 'page': number;
666
- /**
667
- *
668
- * @type {number}
669
- * @memberof LogListResponse
670
- */
671
- 'per_page': number;
672
- }
673
- /**
674
- *
675
- * @export
676
- * @interface LogResponse
677
- */
678
- export interface LogResponse {
679
- /**
680
- *
681
- * @type {string}
682
- * @memberof LogResponse
683
- */
684
- 'id': string;
685
- /**
686
- *
687
- * @type {MaintainerShortModel}
688
- * @memberof LogResponse
689
- */
690
- 'user': MaintainerShortModel;
691
- /**
692
- *
693
- * @type {string}
694
- * @memberof LogResponse
695
- */
696
- 'timestamp': string;
697
- /**
698
- *
699
- * @type {string}
700
- * @memberof LogResponse
701
- */
702
- 'action': string;
703
- /**
704
- *
705
- * @type {string}
706
- * @memberof LogResponse
707
- */
708
- 'ip'?: string | null;
709
- /**
710
- *
711
- * @type {string}
712
- * @memberof LogResponse
713
- */
714
- 'device_id'?: string | null;
715
- /**
716
- *
717
- * @type {string}
718
- * @memberof LogResponse
719
- */
720
- 'release_id'?: string | null;
721
- /**
722
- *
723
- * @type {string}
724
- * @memberof LogResponse
725
- */
726
- 'user_id'?: string | null;
727
- /**
728
- *
729
- * @type {{ [key: string]: any; }}
730
- * @memberof LogResponse
731
- */
732
- 'data'?: {
733
- [key: string]: any;
734
- } | null;
735
- }
736
- /**
737
- *
738
- * @export
739
- * @interface MaintainerShortModel
740
- */
741
- export interface MaintainerShortModel {
742
- /**
743
- *
744
- * @type {string}
745
- * @memberof MaintainerShortModel
746
- * @deprecated
747
- */
748
- '_id': string;
749
- /**
750
- *
751
- * @type {string}
752
- * @memberof MaintainerShortModel
753
- */
754
- 'id': string;
755
- /**
756
- *
757
- * @type {string}
758
- * @memberof MaintainerShortModel
759
- */
760
- 'name': string;
761
- /**
762
- *
763
- * @type {string}
764
- * @memberof MaintainerShortModel
765
- */
766
- 'username': string;
767
- }
768
- /**
769
- *
770
- * @export
771
- * @interface NewBuildTaskBody
772
- */
773
- export interface NewBuildTaskBody {
774
- /**
775
- *
776
- * @type {string}
777
- * @memberof NewBuildTaskBody
778
- */
779
- 'device_id': string;
780
- /**
781
- *
782
- * @type {string}
783
- * @memberof NewBuildTaskBody
784
- */
785
- 'tree_branch'?: string | null;
786
- /**
787
- *
788
- * @type {ReleaseType}
789
- * @memberof NewBuildTaskBody
790
- */
791
- 'type'?: ReleaseType;
792
- /**
793
- *
794
- * @type {string}
795
- * @memberof NewBuildTaskBody
796
- */
797
- 'variant'?: string;
798
- /**
799
- *
800
- * @type {Array<string>}
801
- * @memberof NewBuildTaskBody
802
- */
803
- 'additional_env'?: Array<string> | null;
804
- }
805
- /**
806
- *
807
- * @export
808
- * @interface NewDeviceBody
809
- */
810
- export interface NewDeviceBody {
811
- /**
812
- *
813
- * @type {string}
814
- * @memberof NewDeviceBody
815
- */
816
- 'oem_name': string;
817
- /**
818
- *
819
- * @type {Array<string>}
820
- * @memberof NewDeviceBody
821
- */
822
- 'codenames': Array<string>;
823
- /**
824
- *
825
- * @type {Array<string>}
826
- * @memberof NewDeviceBody
827
- */
828
- 'model_names': Array<string>;
829
- /**
830
- *
831
- * @type {string}
832
- * @memberof NewDeviceBody
833
- */
834
- 'maintainer': string;
835
- }
836
- /**
837
- *
838
- * @export
839
- * @interface RecoveryImgResponse
840
- */
841
- export interface RecoveryImgResponse {
842
- /**
843
- *
844
- * @type {number}
845
- * @memberof RecoveryImgResponse
846
- */
847
- 'size': number;
848
- /**
849
- *
850
- * @type {string}
851
- * @memberof RecoveryImgResponse
852
- */
853
- 'md5': string;
854
- }
855
- /**
856
- *
857
- * @export
858
- * @interface ReleaseGroupsResponse
859
- */
860
- export interface ReleaseGroupsResponse {
861
- /**
862
- *
863
- * @type {{ [key: string]: Array<ReleaseResponse>; }}
864
- * @memberof ReleaseGroupsResponse
865
- */
866
- 'data': {
867
- [key: string]: Array<ReleaseResponse>;
868
- };
869
- }
870
- /**
871
- *
872
- * @export
873
- * @interface ReleaseInternalResponse
874
- */
875
- export interface ReleaseInternalResponse {
876
- /**
877
- *
878
- * @type {string}
879
- * @memberof ReleaseInternalResponse
880
- * @deprecated
881
- */
882
- '_id': string;
883
- /**
884
- *
885
- * @type {number}
886
- * @memberof ReleaseInternalResponse
887
- * @deprecated
888
- */
889
- 'size': number;
890
- /**
891
- * Release ID, that\'s how we indentify the release in the infrastructure
892
- * @type {string}
893
- * @memberof ReleaseInternalResponse
894
- */
895
- 'id': string;
896
- /**
897
- *
898
- * @type {string}
899
- * @memberof ReleaseInternalResponse
900
- */
901
- 'build_id'?: string | null;
902
- /**
903
- *
904
- * @type {string}
905
- * @memberof ReleaseInternalResponse
906
- */
907
- 'filename': string;
908
- /**
909
- *
910
- * @type {string}
911
- * @memberof ReleaseInternalResponse
912
- */
913
- 'variant': string;
914
- /**
915
- *
916
- * @type {string}
917
- * @memberof ReleaseInternalResponse
918
- */
919
- 'device_id': string;
920
- /**
921
- *
922
- * @type {number}
923
- * @memberof ReleaseInternalResponse
924
- */
925
- 'date': number;
926
- /**
927
- *
928
- * @type {string}
929
- * @memberof ReleaseInternalResponse
930
- */
931
- 'md5': string;
932
- /**
933
- *
934
- * @type {string}
935
- * @memberof ReleaseInternalResponse
936
- */
937
- 'version': string;
938
- /**
939
- *
940
- * @type {ReleaseType}
941
- * @memberof ReleaseInternalResponse
942
- */
943
- 'type': ReleaseType;
944
- /**
945
- *
946
- * @type {string}
947
- * @memberof ReleaseInternalResponse
948
- */
949
- 'maintainer_id'?: string | null;
950
- /**
951
- *
952
- * @type {boolean}
953
- * @memberof ReleaseInternalResponse
954
- */
955
- 'archived': boolean;
956
- /**
957
- *
958
- * @type {RecoveryImgResponse}
959
- * @memberof ReleaseInternalResponse
960
- */
961
- 'recovery_img': RecoveryImgResponse;
962
- /**
963
- *
964
- * @type {Array<string>}
965
- * @memberof ReleaseInternalResponse
966
- */
967
- 'changelog': Array<string>;
968
- /**
969
- *
970
- * @type {Array<string>}
971
- * @memberof ReleaseInternalResponse
972
- */
973
- 'bugs': Array<string> | null;
974
- /**
975
- *
976
- * @type {string}
977
- * @memberof ReleaseInternalResponse
978
- */
979
- 'notes': string | null;
980
- /**
981
- *
982
- * @type {{ [key: string]: ReleaseInternalResponsePropValue; }}
983
- * @memberof ReleaseInternalResponse
984
- */
985
- 'prop'?: {
986
- [key: string]: ReleaseInternalResponsePropValue;
987
- } | null;
988
- /**
989
- *
990
- * @type {ReleaseStatsResponse}
991
- * @memberof ReleaseInternalResponse
992
- */
993
- 'stats'?: ReleaseStatsResponse | null;
994
- /**
995
- *
996
- * @type {MaintainerShortModel}
997
- * @memberof ReleaseInternalResponse
998
- */
999
- 'maintainer': MaintainerShortModel;
1000
- /**
1001
- * URL of the release on the official website
1002
- * @type {string}
1003
- * @memberof ReleaseInternalResponse
1004
- */
1005
- 'url': string;
1006
- /**
1007
- * Mirrors list (deprecated)
1008
- * @type {{ [key: string]: string; }}
1009
- * @memberof ReleaseInternalResponse
1010
- */
1011
- 'mirrors': {
1012
- [key: string]: string;
1013
- };
1014
- }
1015
- /**
1016
- *
1017
- * @export
1018
- * @interface ReleaseInternalResponsePropValue
1019
- */
1020
- export interface ReleaseInternalResponsePropValue {
1021
- }
1022
- /**
1023
- *
1024
- * @export
1025
- * @interface ReleaseResponse
1026
- */
1027
- export interface ReleaseResponse {
1028
- /**
1029
- *
1030
- * @type {string}
1031
- * @memberof ReleaseResponse
1032
- * @deprecated
1033
- */
1034
- '_id': string;
1035
- /**
1036
- *
1037
- * @type {number}
1038
- * @memberof ReleaseResponse
1039
- * @deprecated
1040
- */
1041
- 'size': number;
1042
- /**
1043
- * Release ID, that\'s how we indentify the release in the infrastructure
1044
- * @type {string}
1045
- * @memberof ReleaseResponse
1046
- */
1047
- 'id': string;
1048
- /**
1049
- *
1050
- * @type {string}
1051
- * @memberof ReleaseResponse
1052
- */
1053
- 'build_id'?: string | null;
1054
- /**
1055
- *
1056
- * @type {string}
1057
- * @memberof ReleaseResponse
1058
- */
1059
- 'filename': string;
1060
- /**
1061
- *
1062
- * @type {string}
1063
- * @memberof ReleaseResponse
1064
- */
1065
- 'variant': string;
1066
- /**
1067
- *
1068
- * @type {string}
1069
- * @memberof ReleaseResponse
1070
- */
1071
- 'device_id': string;
1072
- /**
1073
- *
1074
- * @type {number}
1075
- * @memberof ReleaseResponse
1076
- */
1077
- 'date': number;
1078
- /**
1079
- *
1080
- * @type {string}
1081
- * @memberof ReleaseResponse
1082
- */
1083
- 'md5': string;
1084
- /**
1085
- *
1086
- * @type {string}
1087
- * @memberof ReleaseResponse
1088
- */
1089
- 'version': string;
1090
- /**
1091
- *
1092
- * @type {ReleaseType}
1093
- * @memberof ReleaseResponse
1094
- */
1095
- 'type': ReleaseType;
1096
- /**
1097
- *
1098
- * @type {string}
1099
- * @memberof ReleaseResponse
1100
- */
1101
- 'maintainer_id'?: string | null;
1102
- /**
1103
- *
1104
- * @type {boolean}
1105
- * @memberof ReleaseResponse
1106
- */
1107
- 'archived': boolean;
1108
- /**
1109
- *
1110
- * @type {RecoveryImgResponse}
1111
- * @memberof ReleaseResponse
1112
- */
1113
- 'recovery_img': RecoveryImgResponse;
1114
- /**
1115
- *
1116
- * @type {Array<string>}
1117
- * @memberof ReleaseResponse
1118
- */
1119
- 'changelog': Array<string>;
1120
- /**
1121
- *
1122
- * @type {Array<string>}
1123
- * @memberof ReleaseResponse
1124
- */
1125
- 'bugs': Array<string> | null;
1126
- /**
1127
- *
1128
- * @type {string}
1129
- * @memberof ReleaseResponse
1130
- */
1131
- 'notes': string | null;
1132
- /**
1133
- * URL of the release on the official website
1134
- * @type {string}
1135
- * @memberof ReleaseResponse
1136
- */
1137
- 'url': string;
1138
- /**
1139
- * Mirrors list (deprecated)
1140
- * @type {{ [key: string]: string; }}
1141
- * @memberof ReleaseResponse
1142
- */
1143
- 'mirrors': {
1144
- [key: string]: string;
1145
- };
1146
- }
1147
- /**
1148
- *
1149
- * @export
1150
- * @interface ReleaseStatsResponse
1151
- */
1152
- export interface ReleaseStatsResponse {
1153
- /**
1154
- *
1155
- * @type {number}
1156
- * @memberof ReleaseStatsResponse
1157
- */
1158
- 'count': number;
1159
- /**
1160
- *
1161
- * @type {{ [key: string]: number; }}
1162
- * @memberof ReleaseStatsResponse
1163
- */
1164
- 'days': {
1165
- [key: string]: number;
1166
- };
1167
- /**
1168
- *
1169
- * @type {{ [key: string]: number; }}
1170
- * @memberof ReleaseStatsResponse
1171
- */
1172
- 'mirrors': {
1173
- [key: string]: number;
1174
- };
1175
- }
1176
- /**
1177
- *
1178
- * @export
1179
- * @enum {string}
1180
- */
1181
- export declare const ReleaseType: {
1182
- readonly Stable: "stable";
1183
- readonly Beta: "beta";
1184
- readonly Alpha: "alpha";
1185
- };
1186
- export type ReleaseType = typeof ReleaseType[keyof typeof ReleaseType];
1187
- /**
1188
- *
1189
- * @export
1190
- * @interface ReleaseUpdateBody
1191
- */
1192
- export interface ReleaseUpdateBody {
1193
- /**
1194
- *
1195
- * @type {Array<string>}
1196
- * @memberof ReleaseUpdateBody
1197
- */
1198
- 'changelog'?: Array<string> | null;
1199
- /**
1200
- *
1201
- * @type {Array<string>}
1202
- * @memberof ReleaseUpdateBody
1203
- */
1204
- 'bugs'?: Array<string> | null;
1205
- /**
1206
- *
1207
- * @type {string}
1208
- * @memberof ReleaseUpdateBody
1209
- */
1210
- 'notes'?: string | null;
1211
- /**
1212
- *
1213
- * @type {boolean}
1214
- * @memberof ReleaseUpdateBody
1215
- */
1216
- 'freezed'?: boolean | null;
1217
- }
1218
- /**
1219
- *
1220
- * @export
1221
- * @enum {string}
1222
- */
1223
- export declare const ReleasesSort: {
1224
- readonly DateAsc: "date_asc";
1225
- readonly DateDesc: "date_desc";
1226
- };
1227
- export type ReleasesSort = typeof ReleasesSort[keyof typeof ReleasesSort];
1228
- /**
1229
- *
1230
- * @export
1231
- * @interface ResponseGetReleases
1232
- */
1233
- export interface ResponseGetReleases {
1234
- /**
1235
- *
1236
- * @type {{ [key: string]: Array<ReleaseResponse>; }}
1237
- * @memberof ResponseGetReleases
1238
- */
1239
- 'data': {
1240
- [key: string]: Array<ReleaseResponse>;
1241
- };
1242
- /**
1243
- *
1244
- * @type {number}
1245
- * @memberof ResponseGetReleases
1246
- */
1247
- 'count': number;
1248
- }
1249
- /**
1250
- *
1251
- * @export
1252
- * @interface ShortDeviceResponse
1253
- */
1254
- export interface ShortDeviceResponse {
1255
- /**
1256
- *
1257
- * @type {string}
1258
- * @memberof ShortDeviceResponse
1259
- * @deprecated
1260
- */
1261
- '_id': string;
1262
- /**
1263
- * Device codename, legacy
1264
- * @type {string}
1265
- * @memberof ShortDeviceResponse
1266
- * @deprecated
1267
- */
1268
- 'codename': string;
1269
- /**
1270
- * Model name of device, does not include the OEM part, legacy
1271
- * @type {string}
1272
- * @memberof ShortDeviceResponse
1273
- * @deprecated
1274
- */
1275
- 'model_name': string;
1276
- /**
1277
- *
1278
- * @type {string}
1279
- * @memberof ShortDeviceResponse
1280
- */
1281
- 'oem_name': string;
1282
- /**
1283
- *
1284
- * @type {string}
1285
- * @memberof ShortDeviceResponse
1286
- */
1287
- 'id': string;
1288
- /**
1289
- *
1290
- * @type {Array<string>}
1291
- * @memberof ShortDeviceResponse
1292
- */
1293
- 'codenames': Array<string>;
1294
- /**
1295
- *
1296
- * @type {Array<string>}
1297
- * @memberof ShortDeviceResponse
1298
- */
1299
- 'model_names': Array<string>;
1300
- /**
1301
- *
1302
- * @type {boolean}
1303
- * @memberof ShortDeviceResponse
1304
- */
1305
- 'supported': boolean;
1306
- /**
1307
- * Full name of device / devices, legacy
1308
- * @type {string}
1309
- * @memberof ShortDeviceResponse
1310
- */
1311
- 'full_name': string;
1312
- /**
1313
- * URL of the device on the official website
1314
- * @type {string}
1315
- * @memberof ShortDeviceResponse
1316
- */
1317
- 'url': string;
1318
- }
1319
- /**
1320
- *
1321
- * @export
1322
- * @interface ShortReleaseResponse
1323
- */
1324
- export interface ShortReleaseResponse {
1325
- /**
1326
- *
1327
- * @type {string}
1328
- * @memberof ShortReleaseResponse
1329
- * @deprecated
1330
- */
1331
- '_id': string;
1332
- /**
1333
- *
1334
- * @type {number}
1335
- * @memberof ShortReleaseResponse
1336
- * @deprecated
1337
- */
1338
- 'size': number;
1339
- /**
1340
- * Release ID, that\'s how we indentify the release in the infrastructure
1341
- * @type {string}
1342
- * @memberof ShortReleaseResponse
1343
- */
1344
- 'id': string;
1345
- /**
1346
- *
1347
- * @type {string}
1348
- * @memberof ShortReleaseResponse
1349
- */
1350
- 'build_id'?: string | null;
1351
- /**
1352
- *
1353
- * @type {string}
1354
- * @memberof ShortReleaseResponse
1355
- */
1356
- 'filename': string;
1357
- /**
1358
- *
1359
- * @type {string}
1360
- * @memberof ShortReleaseResponse
1361
- */
1362
- 'variant': string;
1363
- /**
1364
- *
1365
- * @type {string}
1366
- * @memberof ShortReleaseResponse
1367
- */
1368
- 'device_id': string;
1369
- /**
1370
- *
1371
- * @type {number}
1372
- * @memberof ShortReleaseResponse
1373
- */
1374
- 'date': number;
1375
- /**
1376
- *
1377
- * @type {string}
1378
- * @memberof ShortReleaseResponse
1379
- */
1380
- 'md5': string;
1381
- /**
1382
- *
1383
- * @type {string}
1384
- * @memberof ShortReleaseResponse
1385
- */
1386
- 'version': string;
1387
- /**
1388
- *
1389
- * @type {ReleaseType}
1390
- * @memberof ShortReleaseResponse
1391
- */
1392
- 'type': ReleaseType;
1393
- /**
1394
- *
1395
- * @type {string}
1396
- * @memberof ShortReleaseResponse
1397
- */
1398
- 'maintainer_id'?: string | null;
1399
- /**
1400
- *
1401
- * @type {boolean}
1402
- * @memberof ShortReleaseResponse
1403
- */
1404
- 'archived': boolean;
1405
- }
1406
- /**
1407
- *
1408
- * @export
1409
- * @interface TaskUpdateBody
1410
- */
1411
- export interface TaskUpdateBody {
1412
- /**
1413
- *
1414
- * @type {BuildStatusEnum}
1415
- * @memberof TaskUpdateBody
1416
- */
1417
- 'status'?: BuildStatusEnum | null;
1418
- /**
1419
- *
1420
- * @type {Array<string>}
1421
- * @memberof TaskUpdateBody
1422
- */
1423
- 'logs'?: Array<string> | null;
1424
- }
1425
- /**
1426
- *
1427
- * @export
1428
- * @interface TokenResponse
1429
- */
1430
- export interface TokenResponse {
1431
- /**
1432
- *
1433
- * @type {string}
1434
- * @memberof TokenResponse
1435
- */
1436
- 'access_token': string;
1437
- /**
1438
- *
1439
- * @type {string}
1440
- * @memberof TokenResponse
1441
- */
1442
- 'token_type'?: string;
1443
- }
1444
- /**
1445
- *
1446
- * @export
1447
- * @interface UserGitlab
1448
- */
1449
- export interface UserGitlab {
1450
- /**
1451
- *
1452
- * @type {number}
1453
- * @memberof UserGitlab
1454
- */
1455
- 'id': number;
1456
- }
1457
- /**
1458
- *
1459
- * @export
1460
- * @interface UserInternalResponse
1461
- */
1462
- export interface UserInternalResponse {
1463
- /**
1464
- *
1465
- * @type {string}
1466
- * @memberof UserInternalResponse
1467
- */
1468
- 'id': string;
1469
- /**
1470
- *
1471
- * @type {string}
1472
- * @memberof UserInternalResponse
1473
- */
1474
- 'username': string;
1475
- /**
1476
- *
1477
- * @type {string}
1478
- * @memberof UserInternalResponse
1479
- */
1480
- 'name': string;
1481
- /**
1482
- *
1483
- * @type {boolean}
1484
- * @memberof UserInternalResponse
1485
- */
1486
- 'freezed': boolean;
1487
- /**
1488
- *
1489
- * @type {Array<string>}
1490
- * @memberof UserInternalResponse
1491
- */
1492
- 'roles': Array<string>;
1493
- /**
1494
- *
1495
- * @type {UserTelegram}
1496
- * @memberof UserInternalResponse
1497
- */
1498
- 'telegram'?: UserTelegram | null;
1499
- /**
1500
- *
1501
- * @type {UserGitlab}
1502
- * @memberof UserInternalResponse
1503
- */
1504
- 'gitlab'?: UserGitlab | null;
1505
- /**
1506
- *
1507
- * @type {UserMail}
1508
- * @memberof UserInternalResponse
1509
- */
1510
- 'mail'?: UserMail | null;
1511
- /**
1512
- *
1513
- * @type {string}
1514
- * @memberof UserInternalResponse
1515
- */
1516
- 'admin_notes'?: string | null;
1517
- /**
1518
- *
1519
- * @type {Array<ShortDeviceResponse>}
1520
- * @memberof UserInternalResponse
1521
- */
1522
- 'maintained_devices': Array<ShortDeviceResponse>;
1523
- }
1524
- /**
1525
- *
1526
- * @export
1527
- * @interface UserMail
1528
- */
1529
- export interface UserMail {
1530
- /**
1531
- *
1532
- * @type {string}
1533
- * @memberof UserMail
1534
- */
1535
- 'username': string;
1536
- }
1537
- /**
1538
- *
1539
- * @export
1540
- * @interface UserShortResponse
1541
- */
1542
- export interface UserShortResponse {
1543
- /**
1544
- *
1545
- * @type {string}
1546
- * @memberof UserShortResponse
1547
- */
1548
- 'id': string;
1549
- /**
1550
- *
1551
- * @type {string}
1552
- * @memberof UserShortResponse
1553
- */
1554
- 'username': string;
1555
- /**
1556
- *
1557
- * @type {string}
1558
- * @memberof UserShortResponse
1559
- */
1560
- 'name': string;
1561
- /**
1562
- *
1563
- * @type {boolean}
1564
- * @memberof UserShortResponse
1565
- */
1566
- 'freezed': boolean;
1567
- }
1568
- /**
1569
- *
1570
- * @export
1571
- * @interface UserTelegram
1572
- */
1573
- export interface UserTelegram {
1574
- /**
1575
- *
1576
- * @type {number}
1577
- * @memberof UserTelegram
1578
- */
1579
- 'id': number;
1580
- }
1581
- /**
1582
- *
1583
- * @export
1584
- * @interface UserUpdateBody
1585
- */
1586
- export interface UserUpdateBody {
1587
- /**
1588
- *
1589
- * @type {string}
1590
- * @memberof UserUpdateBody
1591
- */
1592
- 'username'?: string | null;
1593
- /**
1594
- *
1595
- * @type {string}
1596
- * @memberof UserUpdateBody
1597
- */
1598
- 'name'?: string | null;
1599
- /**
1600
- *
1601
- * @type {boolean}
1602
- * @memberof UserUpdateBody
1603
- */
1604
- 'freezed'?: boolean | null;
1605
- /**
1606
- *
1607
- * @type {Array<string>}
1608
- * @memberof UserUpdateBody
1609
- */
1610
- 'roles'?: Array<string> | null;
1611
- /**
1612
- *
1613
- * @type {string}
1614
- * @memberof UserUpdateBody
1615
- */
1616
- 'admin_notes'?: string | null;
1617
- }
1618
- /**
1619
- *
1620
- * @export
1621
- * @interface ValidationError
1622
- */
1623
- export interface ValidationError {
1624
- /**
1625
- *
1626
- * @type {Array<ValidationErrorLocInner>}
1627
- * @memberof ValidationError
1628
- */
1629
- 'loc': Array<ValidationErrorLocInner>;
1630
- /**
1631
- *
1632
- * @type {string}
1633
- * @memberof ValidationError
1634
- */
1635
- 'msg': string;
1636
- /**
1637
- *
1638
- * @type {string}
1639
- * @memberof ValidationError
1640
- */
1641
- 'type': string;
1642
- }
1643
- /**
1644
- *
1645
- * @export
1646
- * @interface ValidationErrorLocInner
1647
- */
1648
- export interface ValidationErrorLocInner {
1649
- }
1650
- /**
1651
- * DeviceApi - axios parameter creator
1652
- * @export
1653
- */
1654
- export declare const DeviceApiAxiosParamCreator: (configuration?: Configuration) => {
1655
- /**
1656
- * 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.
1657
- * @summary Get Device
1658
- * @param {string | null} [deviceId]
1659
- * @param {string | null} [id] Filter by Device ID (deprecated)
1660
- * @param {string | null} [codename] Not recommended to use when you can
1661
- * @param {*} [options] Override http request option.
1662
- * @throws {RequiredError}
1663
- */
1664
- getDevice: (deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1665
- /**
1666
- * Gets device info using device ID.
1667
- * @summary Get Device Short
1668
- * @param {string} deviceId
1669
- * @param {*} [options] Override http request option.
1670
- * @deprecated
1671
- * @throws {RequiredError}
1672
- */
1673
- getDeviceDeprecated: (deviceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1674
- /**
1675
- * 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.
1676
- * @summary Get Devices
1677
- * @param {Array<string>} [id] Filter by Device IDs
1678
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
1679
- * @param {Array<string>} [oemName] Filter by OEM names
1680
- * @param {Array<string>} [codename] Filter by device codenames
1681
- * @param {Array<string>} [modelName] Filter by model names
1682
- * @param {boolean | null} [supported] Supported status
1683
- * @param {Array<string>} [maintainer] Filter by maintainer ID
1684
- * @param {boolean | null} [freezed] Filter by Freezed status
1685
- * @param {boolean | null} [hasReleases] Filter by has releases status
1686
- * @param {number | null} [skip] Skip query results
1687
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1688
- * @param {*} [options] Override http request option.
1689
- * @throws {RequiredError}
1690
- */
1691
- getDevices: (id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1692
- /**
1693
- * Lists all OEM names
1694
- * @summary Get Oems
1695
- * @param {*} [options] Override http request option.
1696
- * @throws {RequiredError}
1697
- */
1698
- getOems: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1699
- };
1700
- /**
1701
- * DeviceApi - functional programming interface
1702
- * @export
1703
- */
1704
- export declare const DeviceApiFp: (configuration?: Configuration) => {
1705
- /**
1706
- * 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.
1707
- * @summary Get Device
1708
- * @param {string | null} [deviceId]
1709
- * @param {string | null} [id] Filter by Device ID (deprecated)
1710
- * @param {string | null} [codename] Not recommended to use when you can
1711
- * @param {*} [options] Override http request option.
1712
- * @throws {RequiredError}
1713
- */
1714
- getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>>;
1715
- /**
1716
- * Gets device info using device ID.
1717
- * @summary Get Device Short
1718
- * @param {string} deviceId
1719
- * @param {*} [options] Override http request option.
1720
- * @deprecated
1721
- * @throws {RequiredError}
1722
- */
1723
- getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceResponse>>;
1724
- /**
1725
- * 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.
1726
- * @summary Get Devices
1727
- * @param {Array<string>} [id] Filter by Device IDs
1728
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
1729
- * @param {Array<string>} [oemName] Filter by OEM names
1730
- * @param {Array<string>} [codename] Filter by device codenames
1731
- * @param {Array<string>} [modelName] Filter by model names
1732
- * @param {boolean | null} [supported] Supported status
1733
- * @param {Array<string>} [maintainer] Filter by maintainer ID
1734
- * @param {boolean | null} [freezed] Filter by Freezed status
1735
- * @param {boolean | null} [hasReleases] Filter by has releases status
1736
- * @param {number | null} [skip] Skip query results
1737
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1738
- * @param {*} [options] Override http request option.
1739
- * @throws {RequiredError}
1740
- */
1741
- getDevices(id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseShortDeviceResponse>>;
1742
- /**
1743
- * Lists all OEM names
1744
- * @summary Get Oems
1745
- * @param {*} [options] Override http request option.
1746
- * @throws {RequiredError}
1747
- */
1748
- getOems(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseStr>>;
1749
- };
1750
- /**
1751
- * DeviceApi - factory interface
1752
- * @export
1753
- */
1754
- export declare const DeviceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1755
- /**
1756
- * 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.
1757
- * @summary Get Device
1758
- * @param {string | null} [deviceId]
1759
- * @param {string | null} [id] Filter by Device ID (deprecated)
1760
- * @param {string | null} [codename] Not recommended to use when you can
1761
- * @param {*} [options] Override http request option.
1762
- * @throws {RequiredError}
1763
- */
1764
- getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
1765
- /**
1766
- * Gets device info using device ID.
1767
- * @summary Get Device Short
1768
- * @param {string} deviceId
1769
- * @param {*} [options] Override http request option.
1770
- * @deprecated
1771
- * @throws {RequiredError}
1772
- */
1773
- getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
1774
- /**
1775
- * 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.
1776
- * @summary Get Devices
1777
- * @param {Array<string>} [id] Filter by Device IDs
1778
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
1779
- * @param {Array<string>} [oemName] Filter by OEM names
1780
- * @param {Array<string>} [codename] Filter by device codenames
1781
- * @param {Array<string>} [modelName] Filter by model names
1782
- * @param {boolean | null} [supported] Supported status
1783
- * @param {Array<string>} [maintainer] Filter by maintainer ID
1784
- * @param {boolean | null} [freezed] Filter by Freezed status
1785
- * @param {boolean | null} [hasReleases] Filter by has releases status
1786
- * @param {number | null} [skip] Skip query results
1787
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1788
- * @param {*} [options] Override http request option.
1789
- * @throws {RequiredError}
1790
- */
1791
- getDevices(id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortDeviceResponse>;
1792
- /**
1793
- * Lists all OEM names
1794
- * @summary Get Oems
1795
- * @param {*} [options] Override http request option.
1796
- * @throws {RequiredError}
1797
- */
1798
- getOems(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseStr>;
1799
- };
1800
- /**
1801
- * DeviceApi - interface
1802
- * @export
1803
- * @interface DeviceApi
1804
- */
1805
- export interface DeviceApiInterface {
1806
- /**
1807
- * 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.
1808
- * @summary Get Device
1809
- * @param {string | null} [deviceId]
1810
- * @param {string | null} [id] Filter by Device ID (deprecated)
1811
- * @param {string | null} [codename] Not recommended to use when you can
1812
- * @param {*} [options] Override http request option.
1813
- * @throws {RequiredError}
1814
- * @memberof DeviceApiInterface
1815
- */
1816
- getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
1817
- /**
1818
- * Gets device info using device ID.
1819
- * @summary Get Device Short
1820
- * @param {string} deviceId
1821
- * @param {*} [options] Override http request option.
1822
- * @deprecated
1823
- * @throws {RequiredError}
1824
- * @memberof DeviceApiInterface
1825
- */
1826
- getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceResponse>;
1827
- /**
1828
- * 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.
1829
- * @summary Get Devices
1830
- * @param {Array<string>} [id] Filter by Device IDs
1831
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
1832
- * @param {Array<string>} [oemName] Filter by OEM names
1833
- * @param {Array<string>} [codename] Filter by device codenames
1834
- * @param {Array<string>} [modelName] Filter by model names
1835
- * @param {boolean | null} [supported] Supported status
1836
- * @param {Array<string>} [maintainer] Filter by maintainer ID
1837
- * @param {boolean | null} [freezed] Filter by Freezed status
1838
- * @param {boolean | null} [hasReleases] Filter by has releases status
1839
- * @param {number | null} [skip] Skip query results
1840
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1841
- * @param {*} [options] Override http request option.
1842
- * @throws {RequiredError}
1843
- * @memberof DeviceApiInterface
1844
- */
1845
- getDevices(id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortDeviceResponse>;
1846
- /**
1847
- * Lists all OEM names
1848
- * @summary Get Oems
1849
- * @param {*} [options] Override http request option.
1850
- * @throws {RequiredError}
1851
- * @memberof DeviceApiInterface
1852
- */
1853
- getOems(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseStr>;
1854
- }
1855
- /**
1856
- * DeviceApi - object-oriented interface
1857
- * @export
1858
- * @class DeviceApi
1859
- * @extends {BaseAPI}
1860
- */
1861
- export declare class DeviceApi extends BaseAPI implements DeviceApiInterface {
1862
- /**
1863
- * 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.
1864
- * @summary Get Device
1865
- * @param {string | null} [deviceId]
1866
- * @param {string | null} [id] Filter by Device ID (deprecated)
1867
- * @param {string | null} [codename] Not recommended to use when you can
1868
- * @param {*} [options] Override http request option.
1869
- * @throws {RequiredError}
1870
- * @memberof DeviceApi
1871
- */
1872
- getDevice(deviceId?: string | null, id?: string | null, codename?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceResponse, any>>;
1873
- /**
1874
- * Gets device info using device ID.
1875
- * @summary Get Device Short
1876
- * @param {string} deviceId
1877
- * @param {*} [options] Override http request option.
1878
- * @deprecated
1879
- * @throws {RequiredError}
1880
- * @memberof DeviceApi
1881
- */
1882
- getDeviceDeprecated(deviceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceResponse, any>>;
1883
- /**
1884
- * 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.
1885
- * @summary Get Devices
1886
- * @param {Array<string>} [id] Filter by Device IDs
1887
- * @param {Array<string>} [id2] Filter by Device IDs (deprecated)
1888
- * @param {Array<string>} [oemName] Filter by OEM names
1889
- * @param {Array<string>} [codename] Filter by device codenames
1890
- * @param {Array<string>} [modelName] Filter by model names
1891
- * @param {boolean | null} [supported] Supported status
1892
- * @param {Array<string>} [maintainer] Filter by maintainer ID
1893
- * @param {boolean | null} [freezed] Filter by Freezed status
1894
- * @param {boolean | null} [hasReleases] Filter by has releases status
1895
- * @param {number | null} [skip] Skip query results
1896
- * @param {number | null} [limit] Limit query results (0 means unlimited)
1897
- * @param {*} [options] Override http request option.
1898
- * @throws {RequiredError}
1899
- * @memberof DeviceApi
1900
- */
1901
- getDevices(id?: Array<string>, id2?: Array<string>, oemName?: Array<string>, codename?: Array<string>, modelName?: Array<string>, supported?: boolean | null, maintainer?: Array<string>, freezed?: boolean | null, hasReleases?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseShortDeviceResponse, any>>;
1902
- /**
1903
- * Lists all OEM names
1904
- * @summary Get Oems
1905
- * @param {*} [options] Override http request option.
1906
- * @throws {RequiredError}
1907
- * @memberof DeviceApi
1908
- */
1909
- getOems(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseStr, any>>;
1910
- }
1911
- /**
1912
- * FoxFactoryApi - axios parameter creator
1913
- * @export
1914
- */
1915
- export declare const FoxFactoryApiAxiosParamCreator: (configuration?: Configuration) => {
1916
- /**
1917
- * Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
1918
- * @summary Cancel Task
1919
- * @param {string} taskId
1920
- * @param {*} [options] Override http request option.
1921
- * @throws {RequiredError}
1922
- */
1923
- cancelTaskFactoryTaskIdCancelPost: (taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1924
- /**
1925
- * Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised. Also deletes any associated artifact files.
1926
- * @summary Delete Task
1927
- * @param {string} taskId
1928
- * @param {*} [options] Override http request option.
1929
- * @throws {RequiredError}
1930
- */
1931
- deleteTaskFactoryTaskIdDelete: (taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1932
- /**
1933
- * Download the artifact file for a specific build task. This endpoint allows maintainers and foxfactory workers to download the artifact file associated with a build task. Parameters: task_id: The ID of the build task
1934
- * @summary Download Artifact
1935
- * @param {string} taskId
1936
- * @param {*} [options] Override http request option.
1937
- * @throws {RequiredError}
1938
- */
1939
- downloadArtifactFactoryTaskIdArtifactGet: (taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1940
- /**
1941
- * Endpoint for clients to get the current status of the worker. If the last update was longer than the defined timeout, worker is considered offline.
1942
- * @summary Factory Status
1943
- * @param {*} [options] Override http request option.
1944
- * @throws {RequiredError}
1945
- */
1946
- factoryStatusFactoryStatusGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1947
- /**
1948
- * Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
1949
- * @summary Get Task
1950
- * @param {string} taskId
1951
- * @param {*} [options] Override http request option.
1952
- * @throws {RequiredError}
1953
- */
1954
- getTaskFactoryTaskIdGet: (taskId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1955
- /**
1956
- * Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
1957
- * @summary List Tasks
1958
- * @param {string | null} [deviceId]
1959
- * @param {*} [options] Override http request option.
1960
- * @throws {RequiredError}
1961
- */
1962
- listTasksFactoryGet: (deviceId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1963
- /**
1964
- * Handles the creation of a new build task including validations for the device existence and its connection to GitLab. It initializes a new task with a pending status and the required details, then saves it to the database before returning the task model.
1965
- * @summary New Task
1966
- * @param {NewBuildTaskBody} newBuildTaskBody
1967
- * @param {*} [options] Override http request option.
1968
- * @throws {RequiredError}
1969
- */
1970
- newTaskFactoryPost: (newBuildTaskBody: NewBuildTaskBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1971
- /**
1972
- * Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated. Allowed only for foxworker users.
1973
- * @summary Update Task
1974
- * @param {string} taskId
1975
- * @param {TaskUpdateBody} taskUpdateBody
1976
- * @param {*} [options] Override http request option.
1977
- * @throws {RequiredError}
1978
- */
1979
- updateTaskFactoryTaskIdPatch: (taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1980
- /**
1981
- * Endpoint for FoxFactory worker to update its status.
1982
- * @summary Update Worker Status
1983
- * @param {string} body
1984
- * @param {*} [options] Override http request option.
1985
- * @throws {RequiredError}
1986
- */
1987
- updateWorkerStatusFactoryUpdateStatusPost: (body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1988
- /**
1989
- * Upload an artifact zip file for a specific build task. This endpoint allows foxfactory workers to upload an artifact zip file, verifies its MD5 hash, and stores it in the appropriate directory. Parameters: task_id: The ID of the build task artifact: The artifact zip file to upload md5_hash: The expected MD5 hash of the artifact file
1990
- * @summary Upload Artifact
1991
- * @param {string} taskId
1992
- * @param {File} artifact
1993
- * @param {string} md5Hash
1994
- * @param {*} [options] Override http request option.
1995
- * @throws {RequiredError}
1996
- */
1997
- uploadArtifactFactoryTaskIdArtifactPost: (taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1998
- };
1999
- /**
2000
- * FoxFactoryApi - functional programming interface
2001
- * @export
2002
- */
2003
- export declare const FoxFactoryApiFp: (configuration?: Configuration) => {
2004
- /**
2005
- * Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
2006
- * @summary Cancel Task
2007
- * @param {string} taskId
2008
- * @param {*} [options] Override http request option.
2009
- * @throws {RequiredError}
2010
- */
2011
- cancelTaskFactoryTaskIdCancelPost(taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildTaskResponse>>;
2012
- /**
2013
- * Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised. Also deletes any associated artifact files.
2014
- * @summary Delete Task
2015
- * @param {string} taskId
2016
- * @param {*} [options] Override http request option.
2017
- * @throws {RequiredError}
2018
- */
2019
- deleteTaskFactoryTaskIdDelete(taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2020
- /**
2021
- * Download the artifact file for a specific build task. This endpoint allows maintainers and foxfactory workers to download the artifact file associated with a build task. Parameters: task_id: The ID of the build task
2022
- * @summary Download Artifact
2023
- * @param {string} taskId
2024
- * @param {*} [options] Override http request option.
2025
- * @throws {RequiredError}
2026
- */
2027
- downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2028
- /**
2029
- * Endpoint for clients to get the current status of the worker. If the last update was longer than the defined timeout, worker is considered offline.
2030
- * @summary Factory Status
2031
- * @param {*} [options] Override http request option.
2032
- * @throws {RequiredError}
2033
- */
2034
- factoryStatusFactoryStatusGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FFStatusResponse>>;
2035
- /**
2036
- * Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
2037
- * @summary Get Task
2038
- * @param {string} taskId
2039
- * @param {*} [options] Override http request option.
2040
- * @throws {RequiredError}
2041
- */
2042
- getTaskFactoryTaskIdGet(taskId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BuildTaskResponse>>;
2043
- /**
2044
- * Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
2045
- * @summary List Tasks
2046
- * @param {string | null} [deviceId]
2047
- * @param {*} [options] Override http request option.
2048
- * @throws {RequiredError}
2049
- */
2050
- listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseBuildTaskShortResponse>>;
2051
- /**
2052
- * Handles the creation of a new build task including validations for the device existence and its connection to GitLab. It initializes a new task with a pending status and the required details, then saves it to the database before returning the task model.
2053
- * @summary New Task
2054
- * @param {NewBuildTaskBody} newBuildTaskBody
2055
- * @param {*} [options] Override http request option.
2056
- * @throws {RequiredError}
2057
- */
2058
- newTaskFactoryPost(newBuildTaskBody: NewBuildTaskBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2059
- /**
2060
- * Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated. Allowed only for foxworker users.
2061
- * @summary Update Task
2062
- * @param {string} taskId
2063
- * @param {TaskUpdateBody} taskUpdateBody
2064
- * @param {*} [options] Override http request option.
2065
- * @throws {RequiredError}
2066
- */
2067
- updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2068
- /**
2069
- * Endpoint for FoxFactory worker to update its status.
2070
- * @summary Update Worker Status
2071
- * @param {string} body
2072
- * @param {*} [options] Override http request option.
2073
- * @throws {RequiredError}
2074
- */
2075
- updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2076
- /**
2077
- * Upload an artifact zip file for a specific build task. This endpoint allows foxfactory workers to upload an artifact zip file, verifies its MD5 hash, and stores it in the appropriate directory. Parameters: task_id: The ID of the build task artifact: The artifact zip file to upload md5_hash: The expected MD5 hash of the artifact file
2078
- * @summary Upload Artifact
2079
- * @param {string} taskId
2080
- * @param {File} artifact
2081
- * @param {string} md5Hash
2082
- * @param {*} [options] Override http request option.
2083
- * @throws {RequiredError}
2084
- */
2085
- uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2086
- };
2087
- /**
2088
- * FoxFactoryApi - factory interface
2089
- * @export
2090
- */
2091
- export declare const FoxFactoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2092
- /**
2093
- * Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
2094
- * @summary Cancel Task
2095
- * @param {string} taskId
2096
- * @param {*} [options] Override http request option.
2097
- * @throws {RequiredError}
2098
- */
2099
- cancelTaskFactoryTaskIdCancelPost(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildTaskResponse>;
2100
- /**
2101
- * Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised. Also deletes any associated artifact files.
2102
- * @summary Delete Task
2103
- * @param {string} taskId
2104
- * @param {*} [options] Override http request option.
2105
- * @throws {RequiredError}
2106
- */
2107
- deleteTaskFactoryTaskIdDelete(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2108
- /**
2109
- * Download the artifact file for a specific build task. This endpoint allows maintainers and foxfactory workers to download the artifact file associated with a build task. Parameters: task_id: The ID of the build task
2110
- * @summary Download Artifact
2111
- * @param {string} taskId
2112
- * @param {*} [options] Override http request option.
2113
- * @throws {RequiredError}
2114
- */
2115
- downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2116
- /**
2117
- * Endpoint for clients to get the current status of the worker. If the last update was longer than the defined timeout, worker is considered offline.
2118
- * @summary Factory Status
2119
- * @param {*} [options] Override http request option.
2120
- * @throws {RequiredError}
2121
- */
2122
- factoryStatusFactoryStatusGet(options?: RawAxiosRequestConfig): AxiosPromise<FFStatusResponse>;
2123
- /**
2124
- * Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
2125
- * @summary Get Task
2126
- * @param {string} taskId
2127
- * @param {*} [options] Override http request option.
2128
- * @throws {RequiredError}
2129
- */
2130
- getTaskFactoryTaskIdGet(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildTaskResponse>;
2131
- /**
2132
- * Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
2133
- * @summary List Tasks
2134
- * @param {string | null} [deviceId]
2135
- * @param {*} [options] Override http request option.
2136
- * @throws {RequiredError}
2137
- */
2138
- listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseBuildTaskShortResponse>;
2139
- /**
2140
- * Handles the creation of a new build task including validations for the device existence and its connection to GitLab. It initializes a new task with a pending status and the required details, then saves it to the database before returning the task model.
2141
- * @summary New Task
2142
- * @param {NewBuildTaskBody} newBuildTaskBody
2143
- * @param {*} [options] Override http request option.
2144
- * @throws {RequiredError}
2145
- */
2146
- newTaskFactoryPost(newBuildTaskBody: NewBuildTaskBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2147
- /**
2148
- * Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated. Allowed only for foxworker users.
2149
- * @summary Update Task
2150
- * @param {string} taskId
2151
- * @param {TaskUpdateBody} taskUpdateBody
2152
- * @param {*} [options] Override http request option.
2153
- * @throws {RequiredError}
2154
- */
2155
- updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2156
- /**
2157
- * Endpoint for FoxFactory worker to update its status.
2158
- * @summary Update Worker Status
2159
- * @param {string} body
2160
- * @param {*} [options] Override http request option.
2161
- * @throws {RequiredError}
2162
- */
2163
- updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2164
- /**
2165
- * Upload an artifact zip file for a specific build task. This endpoint allows foxfactory workers to upload an artifact zip file, verifies its MD5 hash, and stores it in the appropriate directory. Parameters: task_id: The ID of the build task artifact: The artifact zip file to upload md5_hash: The expected MD5 hash of the artifact file
2166
- * @summary Upload Artifact
2167
- * @param {string} taskId
2168
- * @param {File} artifact
2169
- * @param {string} md5Hash
2170
- * @param {*} [options] Override http request option.
2171
- * @throws {RequiredError}
2172
- */
2173
- uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2174
- };
2175
- /**
2176
- * FoxFactoryApi - interface
2177
- * @export
2178
- * @interface FoxFactoryApi
2179
- */
2180
- export interface FoxFactoryApiInterface {
2181
- /**
2182
- * Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
2183
- * @summary Cancel Task
2184
- * @param {string} taskId
2185
- * @param {*} [options] Override http request option.
2186
- * @throws {RequiredError}
2187
- * @memberof FoxFactoryApiInterface
2188
- */
2189
- cancelTaskFactoryTaskIdCancelPost(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildTaskResponse>;
2190
- /**
2191
- * Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised. Also deletes any associated artifact files.
2192
- * @summary Delete Task
2193
- * @param {string} taskId
2194
- * @param {*} [options] Override http request option.
2195
- * @throws {RequiredError}
2196
- * @memberof FoxFactoryApiInterface
2197
- */
2198
- deleteTaskFactoryTaskIdDelete(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2199
- /**
2200
- * Download the artifact file for a specific build task. This endpoint allows maintainers and foxfactory workers to download the artifact file associated with a build task. Parameters: task_id: The ID of the build task
2201
- * @summary Download Artifact
2202
- * @param {string} taskId
2203
- * @param {*} [options] Override http request option.
2204
- * @throws {RequiredError}
2205
- * @memberof FoxFactoryApiInterface
2206
- */
2207
- downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2208
- /**
2209
- * Endpoint for clients to get the current status of the worker. If the last update was longer than the defined timeout, worker is considered offline.
2210
- * @summary Factory Status
2211
- * @param {*} [options] Override http request option.
2212
- * @throws {RequiredError}
2213
- * @memberof FoxFactoryApiInterface
2214
- */
2215
- factoryStatusFactoryStatusGet(options?: RawAxiosRequestConfig): AxiosPromise<FFStatusResponse>;
2216
- /**
2217
- * Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
2218
- * @summary Get Task
2219
- * @param {string} taskId
2220
- * @param {*} [options] Override http request option.
2221
- * @throws {RequiredError}
2222
- * @memberof FoxFactoryApiInterface
2223
- */
2224
- getTaskFactoryTaskIdGet(taskId: string, options?: RawAxiosRequestConfig): AxiosPromise<BuildTaskResponse>;
2225
- /**
2226
- * Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
2227
- * @summary List Tasks
2228
- * @param {string | null} [deviceId]
2229
- * @param {*} [options] Override http request option.
2230
- * @throws {RequiredError}
2231
- * @memberof FoxFactoryApiInterface
2232
- */
2233
- listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseBuildTaskShortResponse>;
2234
- /**
2235
- * Handles the creation of a new build task including validations for the device existence and its connection to GitLab. It initializes a new task with a pending status and the required details, then saves it to the database before returning the task model.
2236
- * @summary New Task
2237
- * @param {NewBuildTaskBody} newBuildTaskBody
2238
- * @param {*} [options] Override http request option.
2239
- * @throws {RequiredError}
2240
- * @memberof FoxFactoryApiInterface
2241
- */
2242
- newTaskFactoryPost(newBuildTaskBody: NewBuildTaskBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2243
- /**
2244
- * Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated. Allowed only for foxworker users.
2245
- * @summary Update Task
2246
- * @param {string} taskId
2247
- * @param {TaskUpdateBody} taskUpdateBody
2248
- * @param {*} [options] Override http request option.
2249
- * @throws {RequiredError}
2250
- * @memberof FoxFactoryApiInterface
2251
- */
2252
- updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2253
- /**
2254
- * Endpoint for FoxFactory worker to update its status.
2255
- * @summary Update Worker Status
2256
- * @param {string} body
2257
- * @param {*} [options] Override http request option.
2258
- * @throws {RequiredError}
2259
- * @memberof FoxFactoryApiInterface
2260
- */
2261
- updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2262
- /**
2263
- * Upload an artifact zip file for a specific build task. This endpoint allows foxfactory workers to upload an artifact zip file, verifies its MD5 hash, and stores it in the appropriate directory. Parameters: task_id: The ID of the build task artifact: The artifact zip file to upload md5_hash: The expected MD5 hash of the artifact file
2264
- * @summary Upload Artifact
2265
- * @param {string} taskId
2266
- * @param {File} artifact
2267
- * @param {string} md5Hash
2268
- * @param {*} [options] Override http request option.
2269
- * @throws {RequiredError}
2270
- * @memberof FoxFactoryApiInterface
2271
- */
2272
- uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2273
- }
2274
- /**
2275
- * FoxFactoryApi - object-oriented interface
2276
- * @export
2277
- * @class FoxFactoryApi
2278
- * @extends {BaseAPI}
2279
- */
2280
- export declare class FoxFactoryApi extends BaseAPI implements FoxFactoryApiInterface {
2281
- /**
2282
- * Cancels a build task given its identifier. The task\'s status is updated to indicate that it is in the process of cancellation. If the task with the specified ID is not found, a 404 HTTP exception is raised.
2283
- * @summary Cancel Task
2284
- * @param {string} taskId
2285
- * @param {*} [options] Override http request option.
2286
- * @throws {RequiredError}
2287
- * @memberof FoxFactoryApi
2288
- */
2289
- cancelTaskFactoryTaskIdCancelPost(taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BuildTaskResponse, any>>;
2290
- /**
2291
- * Deletes a build task given its identifier. If the task with the specified ID is not found, a 404 HTTP exception is raised. Also deletes any associated artifact files.
2292
- * @summary Delete Task
2293
- * @param {string} taskId
2294
- * @param {*} [options] Override http request option.
2295
- * @throws {RequiredError}
2296
- * @memberof FoxFactoryApi
2297
- */
2298
- deleteTaskFactoryTaskIdDelete(taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
2299
- /**
2300
- * Download the artifact file for a specific build task. This endpoint allows maintainers and foxfactory workers to download the artifact file associated with a build task. Parameters: task_id: The ID of the build task
2301
- * @summary Download Artifact
2302
- * @param {string} taskId
2303
- * @param {*} [options] Override http request option.
2304
- * @throws {RequiredError}
2305
- * @memberof FoxFactoryApi
2306
- */
2307
- downloadArtifactFactoryTaskIdArtifactGet(taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
2308
- /**
2309
- * Endpoint for clients to get the current status of the worker. If the last update was longer than the defined timeout, worker is considered offline.
2310
- * @summary Factory Status
2311
- * @param {*} [options] Override http request option.
2312
- * @throws {RequiredError}
2313
- * @memberof FoxFactoryApi
2314
- */
2315
- factoryStatusFactoryStatusGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FFStatusResponse, any>>;
2316
- /**
2317
- * Retrieves the details of a specific build task. This endpoint allows a user to fetch detailed information about a build task by its ID. Access to this endpoint is restricted to users with the \'maintainer\' or \'foxworker\' roles. Depending on the user\'s roles, returned task details may differ. Admin users will receive all task details, while others will have some fields excluded.
2318
- * @summary Get Task
2319
- * @param {string} taskId
2320
- * @param {*} [options] Override http request option.
2321
- * @throws {RequiredError}
2322
- * @memberof FoxFactoryApi
2323
- */
2324
- getTaskFactoryTaskIdGet(taskId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BuildTaskResponse, any>>;
2325
- /**
2326
- * Get a list of all build tasks. This endpoint retrieves all build tasks from the database and returns them as a list of abbreviated responses. Parameters: device_id (ObjectId, optional): Filter tasks by device ID
2327
- * @summary List Tasks
2328
- * @param {string | null} [deviceId]
2329
- * @param {*} [options] Override http request option.
2330
- * @throws {RequiredError}
2331
- * @memberof FoxFactoryApi
2332
- */
2333
- listTasksFactoryGet(deviceId?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseBuildTaskShortResponse, any>>;
2334
- /**
2335
- * Handles the creation of a new build task including validations for the device existence and its connection to GitLab. It initializes a new task with a pending status and the required details, then saves it to the database before returning the task model.
2336
- * @summary New Task
2337
- * @param {NewBuildTaskBody} newBuildTaskBody
2338
- * @param {*} [options] Override http request option.
2339
- * @throws {RequiredError}
2340
- * @memberof FoxFactoryApi
2341
- */
2342
- newTaskFactoryPost(newBuildTaskBody: NewBuildTaskBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
2343
- /**
2344
- * Updates an existing build task by its unique identifier. The function allows updates to the task\'s status and logs. If the task\'s status is set to a value indicating completion, the finished timestamp is also updated. Allowed only for foxworker users.
2345
- * @summary Update Task
2346
- * @param {string} taskId
2347
- * @param {TaskUpdateBody} taskUpdateBody
2348
- * @param {*} [options] Override http request option.
2349
- * @throws {RequiredError}
2350
- * @memberof FoxFactoryApi
2351
- */
2352
- updateTaskFactoryTaskIdPatch(taskId: string, taskUpdateBody: TaskUpdateBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
2353
- /**
2354
- * Endpoint for FoxFactory worker to update its status.
2355
- * @summary Update Worker Status
2356
- * @param {string} body
2357
- * @param {*} [options] Override http request option.
2358
- * @throws {RequiredError}
2359
- * @memberof FoxFactoryApi
2360
- */
2361
- updateWorkerStatusFactoryUpdateStatusPost(body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
2362
- /**
2363
- * Upload an artifact zip file for a specific build task. This endpoint allows foxfactory workers to upload an artifact zip file, verifies its MD5 hash, and stores it in the appropriate directory. Parameters: task_id: The ID of the build task artifact: The artifact zip file to upload md5_hash: The expected MD5 hash of the artifact file
2364
- * @summary Upload Artifact
2365
- * @param {string} taskId
2366
- * @param {File} artifact
2367
- * @param {string} md5Hash
2368
- * @param {*} [options] Override http request option.
2369
- * @throws {RequiredError}
2370
- * @memberof FoxFactoryApi
2371
- */
2372
- uploadArtifactFactoryTaskIdArtifactPost(taskId: string, artifact: File, md5Hash: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
2373
- }
2374
- /**
2375
- * GitlabApi - axios parameter creator
2376
- * @export
2377
- */
2378
- export declare const GitlabApiAxiosParamCreator: (configuration?: Configuration) => {
2379
- /**
2380
- *
2381
- * @summary Device Add Gitlab Repo
2382
- * @param {string} deviceId
2383
- * @param {string} glProjectUrl
2384
- * @param {*} [options] Override http request option.
2385
- * @throws {RequiredError}
2386
- */
2387
- deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost: (deviceId: string, glProjectUrl: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2388
- };
2389
- /**
2390
- * GitlabApi - functional programming interface
2391
- * @export
2392
- */
2393
- export declare const GitlabApiFp: (configuration?: Configuration) => {
2394
- /**
2395
- *
2396
- * @summary Device Add Gitlab Repo
2397
- * @param {string} deviceId
2398
- * @param {string} glProjectUrl
2399
- * @param {*} [options] Override http request option.
2400
- * @throws {RequiredError}
2401
- */
2402
- deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost(deviceId: string, glProjectUrl: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2403
- };
2404
- /**
2405
- * GitlabApi - factory interface
2406
- * @export
2407
- */
2408
- export declare const GitlabApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2409
- /**
2410
- *
2411
- * @summary Device Add Gitlab Repo
2412
- * @param {string} deviceId
2413
- * @param {string} glProjectUrl
2414
- * @param {*} [options] Override http request option.
2415
- * @throws {RequiredError}
2416
- */
2417
- deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost(deviceId: string, glProjectUrl: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2418
- };
2419
- /**
2420
- * GitlabApi - interface
2421
- * @export
2422
- * @interface GitlabApi
2423
- */
2424
- export interface GitlabApiInterface {
2425
- /**
2426
- *
2427
- * @summary Device Add Gitlab Repo
2428
- * @param {string} deviceId
2429
- * @param {string} glProjectUrl
2430
- * @param {*} [options] Override http request option.
2431
- * @throws {RequiredError}
2432
- * @memberof GitlabApiInterface
2433
- */
2434
- deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost(deviceId: string, glProjectUrl: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2435
- }
2436
- /**
2437
- * GitlabApi - object-oriented interface
2438
- * @export
2439
- * @class GitlabApi
2440
- * @extends {BaseAPI}
2441
- */
2442
- export declare class GitlabApi extends BaseAPI implements GitlabApiInterface {
2443
- /**
2444
- *
2445
- * @summary Device Add Gitlab Repo
2446
- * @param {string} deviceId
2447
- * @param {string} glProjectUrl
2448
- * @param {*} [options] Override http request option.
2449
- * @throws {RequiredError}
2450
- * @memberof GitlabApi
2451
- */
2452
- deviceAddGitlabRepoGitlabDeviceDeviceIdGitlabPost(deviceId: string, glProjectUrl: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
2453
- }
2454
- /**
2455
- * InternalApi - axios parameter creator
2456
- * @export
2457
- */
2458
- export declare const InternalApiAxiosParamCreator: (configuration?: Configuration) => {
2459
- /**
2460
- * Change the password for a user.
2461
- * @summary Change Password
2462
- * @param {BodyChangePasswordProfileChangePasswordPost} bodyChangePasswordProfileChangePasswordPost
2463
- * @param {*} [options] Override http request option.
2464
- * @throws {RequiredError}
2465
- */
2466
- changePasswordProfileChangePasswordPost: (bodyChangePasswordProfileChangePasswordPost: BodyChangePasswordProfileChangePasswordPost, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2467
- /**
2468
- * Delete release
2469
- * @summary Del Release
2470
- * @param {string} releaseId
2471
- * @param {*} [options] Override http request option.
2472
- * @throws {RequiredError}
2473
- */
2474
- delReleaseInternalReleasesReleaseIdDelete: (releaseId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2475
- /**
2476
- *
2477
- * @summary Delete User
2478
- * @param {string} userId
2479
- * @param {*} [options] Override http request option.
2480
- * @throws {RequiredError}
2481
- */
2482
- deleteUserInternalUsersUserIdDelete: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2483
- /**
2484
- * Edit Release information
2485
- * @summary Edit Release
2486
- * @param {string} releaseId
2487
- * @param {ReleaseUpdateBody} releaseUpdateBody
2488
- * @param {*} [options] Override http request option.
2489
- * @throws {RequiredError}
2490
- */
2491
- editReleaseInternalReleasesReleaseIdPut: (releaseId: string, releaseUpdateBody: ReleaseUpdateBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2492
- /**
2493
- *
2494
- * @summary Get Device Info
2495
- * @param {string} deviceId
2496
- * @param {*} [options] Override http request option.
2497
- * @throws {RequiredError}
2498
- */
2499
- getDeviceInfoInternalDevicesDeviceIdGet: (deviceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2500
- /**
2501
- * Get a paginated list of logs with optional filtering.
2502
- * @summary Get Logs
2503
- * @param {number} [page]
2504
- * @param {number} [perPage]
2505
- * @param {string | null} [deviceId]
2506
- * @param {string | null} [releaseId]
2507
- * @param {string | null} [userId]
2508
- * @param {boolean | null} [hideVerbose]
2509
- * @param {*} [options] Override http request option.
2510
- * @throws {RequiredError}
2511
- */
2512
- getLogsInternalLogsGet: (page?: number, perPage?: number, deviceId?: string | null, releaseId?: string | null, userId?: string | null, hideVerbose?: boolean | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2513
- /**
2514
- * Get release information
2515
- * @summary Get Release Info
2516
- * @param {string} releaseId
2517
- * @param {*} [options] Override http request option.
2518
- * @throws {RequiredError}
2519
- */
2520
- getReleaseInfoInternalReleasesReleaseIdGet: (releaseId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2521
- /**
2522
- * Download release ZIP directly
2523
- * @summary Get Release Zip
2524
- * @param {string} releaseId
2525
- * @param {*} [options] Override http request option.
2526
- * @throws {RequiredError}
2527
- */
2528
- getReleaseZipInternalReleasesReleaseIdDlGet: (releaseId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2529
- /**
2530
- *
2531
- * @summary Get User By Id
2532
- * @param {string} userId
2533
- * @param {*} [options] Override http request option.
2534
- * @throws {RequiredError}
2535
- */
2536
- getUserByIdInternalUsersUserIdGet: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2537
- /**
2538
- *
2539
- * @summary List Users
2540
- * @param {*} [options] Override http request option.
2541
- * @throws {RequiredError}
2542
- */
2543
- listUsersInternalUsersGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2544
- /**
2545
- * OAuth2 compatible token login, get an access token for future requests
2546
- * @summary Login Oauth
2547
- * @param {string} username
2548
- * @param {string} password
2549
- * @param {number} [minTime]
2550
- * @param {number} [maxTime]
2551
- * @param {string | null} [grantType]
2552
- * @param {string} [scope]
2553
- * @param {string | null} [clientId]
2554
- * @param {string | null} [clientSecret]
2555
- * @param {*} [options] Override http request option.
2556
- * @throws {RequiredError}
2557
- */
2558
- loginOauthAuthLoginPost: (username: string, password: string, minTime?: number, maxTime?: number, grantType?: string | null, scope?: string, clientId?: string | null, clientSecret?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2559
- /**
2560
- *
2561
- * @summary Logout
2562
- * @param {string} body
2563
- * @param {*} [options] Override http request option.
2564
- * @throws {RequiredError}
2565
- */
2566
- logoutAuthLogoutPost: (body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2567
- /**
2568
- *
2569
- * @summary New Device
2570
- * @param {NewDeviceBody} newDeviceBody
2571
- * @param {*} [options] Override http request option.
2572
- * @throws {RequiredError}
2573
- */
2574
- newDeviceInternalDevicesPost: (newDeviceBody: NewDeviceBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2575
- /**
2576
- *
2577
- * @summary New Release
2578
- * @param {string} deviceId
2579
- * @param {File} releaseZip
2580
- * @param {string} md5
2581
- * @param {Array<string>} changelog
2582
- * @param {Array<string>} [bugs]
2583
- * @param {string | null} [notes]
2584
- * @param {boolean} [force]
2585
- * @param {*} [options] Override http request option.
2586
- * @throws {RequiredError}
2587
- */
2588
- newReleaseInternalReleasesPost: (deviceId: string, releaseZip: File, md5: string, changelog: Array<string>, bugs?: Array<string>, notes?: string | null, force?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2589
- /**
2590
- *
2591
- * @summary Renew
2592
- * @param {string} body
2593
- * @param {*} [options] Override http request option.
2594
- * @throws {RequiredError}
2595
- */
2596
- renewAuthRenewPost: (body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2597
- /**
2598
- *
2599
- * @summary Update Device
2600
- * @param {string} deviceId
2601
- * @param {DeviceUpdateBody} deviceUpdateBody
2602
- * @param {*} [options] Override http request option.
2603
- * @throws {RequiredError}
2604
- */
2605
- updateDeviceInternalDevicesDeviceIdPut: (deviceId: string, deviceUpdateBody: DeviceUpdateBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2606
- /**
2607
- *
2608
- * @summary Update User
2609
- * @param {string} userId
2610
- * @param {UserUpdateBody} userUpdateBody
2611
- * @param {*} [options] Override http request option.
2612
- * @throws {RequiredError}
2613
- */
2614
- updateUserInternalUsersUserIdPut: (userId: string, userUpdateBody: UserUpdateBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2615
- };
2616
- /**
2617
- * InternalApi - functional programming interface
2618
- * @export
2619
- */
2620
- export declare const InternalApiFp: (configuration?: Configuration) => {
2621
- /**
2622
- * Change the password for a user.
2623
- * @summary Change Password
2624
- * @param {BodyChangePasswordProfileChangePasswordPost} bodyChangePasswordProfileChangePasswordPost
2625
- * @param {*} [options] Override http request option.
2626
- * @throws {RequiredError}
2627
- */
2628
- changePasswordProfileChangePasswordPost(bodyChangePasswordProfileChangePasswordPost: BodyChangePasswordProfileChangePasswordPost, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2629
- /**
2630
- * Delete release
2631
- * @summary Del Release
2632
- * @param {string} releaseId
2633
- * @param {*} [options] Override http request option.
2634
- * @throws {RequiredError}
2635
- */
2636
- delReleaseInternalReleasesReleaseIdDelete(releaseId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2637
- /**
2638
- *
2639
- * @summary Delete User
2640
- * @param {string} userId
2641
- * @param {*} [options] Override http request option.
2642
- * @throws {RequiredError}
2643
- */
2644
- deleteUserInternalUsersUserIdDelete(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2645
- /**
2646
- * Edit Release information
2647
- * @summary Edit Release
2648
- * @param {string} releaseId
2649
- * @param {ReleaseUpdateBody} releaseUpdateBody
2650
- * @param {*} [options] Override http request option.
2651
- * @throws {RequiredError}
2652
- */
2653
- editReleaseInternalReleasesReleaseIdPut(releaseId: string, releaseUpdateBody: ReleaseUpdateBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2654
- /**
2655
- *
2656
- * @summary Get Device Info
2657
- * @param {string} deviceId
2658
- * @param {*} [options] Override http request option.
2659
- * @throws {RequiredError}
2660
- */
2661
- getDeviceInfoInternalDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInternalResponse>>;
2662
- /**
2663
- * Get a paginated list of logs with optional filtering.
2664
- * @summary Get Logs
2665
- * @param {number} [page]
2666
- * @param {number} [perPage]
2667
- * @param {string | null} [deviceId]
2668
- * @param {string | null} [releaseId]
2669
- * @param {string | null} [userId]
2670
- * @param {boolean | null} [hideVerbose]
2671
- * @param {*} [options] Override http request option.
2672
- * @throws {RequiredError}
2673
- */
2674
- getLogsInternalLogsGet(page?: number, perPage?: number, deviceId?: string | null, releaseId?: string | null, userId?: string | null, hideVerbose?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogListResponse>>;
2675
- /**
2676
- * Get release information
2677
- * @summary Get Release Info
2678
- * @param {string} releaseId
2679
- * @param {*} [options] Override http request option.
2680
- * @throws {RequiredError}
2681
- */
2682
- getReleaseInfoInternalReleasesReleaseIdGet(releaseId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseInternalResponse>>;
2683
- /**
2684
- * Download release ZIP directly
2685
- * @summary Get Release Zip
2686
- * @param {string} releaseId
2687
- * @param {*} [options] Override http request option.
2688
- * @throws {RequiredError}
2689
- */
2690
- getReleaseZipInternalReleasesReleaseIdDlGet(releaseId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2691
- /**
2692
- *
2693
- * @summary Get User By Id
2694
- * @param {string} userId
2695
- * @param {*} [options] Override http request option.
2696
- * @throws {RequiredError}
2697
- */
2698
- getUserByIdInternalUsersUserIdGet(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserInternalResponse>>;
2699
- /**
2700
- *
2701
- * @summary List Users
2702
- * @param {*} [options] Override http request option.
2703
- * @throws {RequiredError}
2704
- */
2705
- listUsersInternalUsersGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseUserShortResponse>>;
2706
- /**
2707
- * OAuth2 compatible token login, get an access token for future requests
2708
- * @summary Login Oauth
2709
- * @param {string} username
2710
- * @param {string} password
2711
- * @param {number} [minTime]
2712
- * @param {number} [maxTime]
2713
- * @param {string | null} [grantType]
2714
- * @param {string} [scope]
2715
- * @param {string | null} [clientId]
2716
- * @param {string | null} [clientSecret]
2717
- * @param {*} [options] Override http request option.
2718
- * @throws {RequiredError}
2719
- */
2720
- loginOauthAuthLoginPost(username: string, password: string, minTime?: number, maxTime?: number, grantType?: string | null, scope?: string, clientId?: string | null, clientSecret?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TokenResponse>>;
2721
- /**
2722
- *
2723
- * @summary Logout
2724
- * @param {string} body
2725
- * @param {*} [options] Override http request option.
2726
- * @throws {RequiredError}
2727
- */
2728
- logoutAuthLogoutPost(body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2729
- /**
2730
- *
2731
- * @summary New Device
2732
- * @param {NewDeviceBody} newDeviceBody
2733
- * @param {*} [options] Override http request option.
2734
- * @throws {RequiredError}
2735
- */
2736
- newDeviceInternalDevicesPost(newDeviceBody: NewDeviceBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
2737
- /**
2738
- *
2739
- * @summary New Release
2740
- * @param {string} deviceId
2741
- * @param {File} releaseZip
2742
- * @param {string} md5
2743
- * @param {Array<string>} changelog
2744
- * @param {Array<string>} [bugs]
2745
- * @param {string | null} [notes]
2746
- * @param {boolean} [force]
2747
- * @param {*} [options] Override http request option.
2748
- * @throws {RequiredError}
2749
- */
2750
- newReleaseInternalReleasesPost(deviceId: string, releaseZip: File, md5: string, changelog: Array<string>, bugs?: Array<string>, notes?: string | null, force?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>>;
2751
- /**
2752
- *
2753
- * @summary Renew
2754
- * @param {string} body
2755
- * @param {*} [options] Override http request option.
2756
- * @throws {RequiredError}
2757
- */
2758
- renewAuthRenewPost(body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
2759
- /**
2760
- *
2761
- * @summary Update Device
2762
- * @param {string} deviceId
2763
- * @param {DeviceUpdateBody} deviceUpdateBody
2764
- * @param {*} [options] Override http request option.
2765
- * @throws {RequiredError}
2766
- */
2767
- updateDeviceInternalDevicesDeviceIdPut(deviceId: string, deviceUpdateBody: DeviceUpdateBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2768
- /**
2769
- *
2770
- * @summary Update User
2771
- * @param {string} userId
2772
- * @param {UserUpdateBody} userUpdateBody
2773
- * @param {*} [options] Override http request option.
2774
- * @throws {RequiredError}
2775
- */
2776
- updateUserInternalUsersUserIdPut(userId: string, userUpdateBody: UserUpdateBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
2777
- };
2778
- /**
2779
- * InternalApi - factory interface
2780
- * @export
2781
- */
2782
- export declare const InternalApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2783
- /**
2784
- * Change the password for a user.
2785
- * @summary Change Password
2786
- * @param {BodyChangePasswordProfileChangePasswordPost} bodyChangePasswordProfileChangePasswordPost
2787
- * @param {*} [options] Override http request option.
2788
- * @throws {RequiredError}
2789
- */
2790
- changePasswordProfileChangePasswordPost(bodyChangePasswordProfileChangePasswordPost: BodyChangePasswordProfileChangePasswordPost, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2791
- /**
2792
- * Delete release
2793
- * @summary Del Release
2794
- * @param {string} releaseId
2795
- * @param {*} [options] Override http request option.
2796
- * @throws {RequiredError}
2797
- */
2798
- delReleaseInternalReleasesReleaseIdDelete(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2799
- /**
2800
- *
2801
- * @summary Delete User
2802
- * @param {string} userId
2803
- * @param {*} [options] Override http request option.
2804
- * @throws {RequiredError}
2805
- */
2806
- deleteUserInternalUsersUserIdDelete(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2807
- /**
2808
- * Edit Release information
2809
- * @summary Edit Release
2810
- * @param {string} releaseId
2811
- * @param {ReleaseUpdateBody} releaseUpdateBody
2812
- * @param {*} [options] Override http request option.
2813
- * @throws {RequiredError}
2814
- */
2815
- editReleaseInternalReleasesReleaseIdPut(releaseId: string, releaseUpdateBody: ReleaseUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2816
- /**
2817
- *
2818
- * @summary Get Device Info
2819
- * @param {string} deviceId
2820
- * @param {*} [options] Override http request option.
2821
- * @throws {RequiredError}
2822
- */
2823
- getDeviceInfoInternalDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceInternalResponse>;
2824
- /**
2825
- * Get a paginated list of logs with optional filtering.
2826
- * @summary Get Logs
2827
- * @param {number} [page]
2828
- * @param {number} [perPage]
2829
- * @param {string | null} [deviceId]
2830
- * @param {string | null} [releaseId]
2831
- * @param {string | null} [userId]
2832
- * @param {boolean | null} [hideVerbose]
2833
- * @param {*} [options] Override http request option.
2834
- * @throws {RequiredError}
2835
- */
2836
- getLogsInternalLogsGet(page?: number, perPage?: number, deviceId?: string | null, releaseId?: string | null, userId?: string | null, hideVerbose?: boolean | null, options?: RawAxiosRequestConfig): AxiosPromise<LogListResponse>;
2837
- /**
2838
- * Get release information
2839
- * @summary Get Release Info
2840
- * @param {string} releaseId
2841
- * @param {*} [options] Override http request option.
2842
- * @throws {RequiredError}
2843
- */
2844
- getReleaseInfoInternalReleasesReleaseIdGet(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseInternalResponse>;
2845
- /**
2846
- * Download release ZIP directly
2847
- * @summary Get Release Zip
2848
- * @param {string} releaseId
2849
- * @param {*} [options] Override http request option.
2850
- * @throws {RequiredError}
2851
- */
2852
- getReleaseZipInternalReleasesReleaseIdDlGet(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2853
- /**
2854
- *
2855
- * @summary Get User By Id
2856
- * @param {string} userId
2857
- * @param {*} [options] Override http request option.
2858
- * @throws {RequiredError}
2859
- */
2860
- getUserByIdInternalUsersUserIdGet(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<UserInternalResponse>;
2861
- /**
2862
- *
2863
- * @summary List Users
2864
- * @param {*} [options] Override http request option.
2865
- * @throws {RequiredError}
2866
- */
2867
- listUsersInternalUsersGet(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseUserShortResponse>;
2868
- /**
2869
- * OAuth2 compatible token login, get an access token for future requests
2870
- * @summary Login Oauth
2871
- * @param {string} username
2872
- * @param {string} password
2873
- * @param {number} [minTime]
2874
- * @param {number} [maxTime]
2875
- * @param {string | null} [grantType]
2876
- * @param {string} [scope]
2877
- * @param {string | null} [clientId]
2878
- * @param {string | null} [clientSecret]
2879
- * @param {*} [options] Override http request option.
2880
- * @throws {RequiredError}
2881
- */
2882
- loginOauthAuthLoginPost(username: string, password: string, minTime?: number, maxTime?: number, grantType?: string | null, scope?: string, clientId?: string | null, clientSecret?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<TokenResponse>;
2883
- /**
2884
- *
2885
- * @summary Logout
2886
- * @param {string} body
2887
- * @param {*} [options] Override http request option.
2888
- * @throws {RequiredError}
2889
- */
2890
- logoutAuthLogoutPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
2891
- /**
2892
- *
2893
- * @summary New Device
2894
- * @param {NewDeviceBody} newDeviceBody
2895
- * @param {*} [options] Override http request option.
2896
- * @throws {RequiredError}
2897
- */
2898
- newDeviceInternalDevicesPost(newDeviceBody: NewDeviceBody, options?: RawAxiosRequestConfig): AxiosPromise<string>;
2899
- /**
2900
- *
2901
- * @summary New Release
2902
- * @param {string} deviceId
2903
- * @param {File} releaseZip
2904
- * @param {string} md5
2905
- * @param {Array<string>} changelog
2906
- * @param {Array<string>} [bugs]
2907
- * @param {string | null} [notes]
2908
- * @param {boolean} [force]
2909
- * @param {*} [options] Override http request option.
2910
- * @throws {RequiredError}
2911
- */
2912
- newReleaseInternalReleasesPost(deviceId: string, releaseZip: File, md5: string, changelog: Array<string>, bugs?: Array<string>, notes?: string | null, force?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
2913
- /**
2914
- *
2915
- * @summary Renew
2916
- * @param {string} body
2917
- * @param {*} [options] Override http request option.
2918
- * @throws {RequiredError}
2919
- */
2920
- renewAuthRenewPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
2921
- /**
2922
- *
2923
- * @summary Update Device
2924
- * @param {string} deviceId
2925
- * @param {DeviceUpdateBody} deviceUpdateBody
2926
- * @param {*} [options] Override http request option.
2927
- * @throws {RequiredError}
2928
- */
2929
- updateDeviceInternalDevicesDeviceIdPut(deviceId: string, deviceUpdateBody: DeviceUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2930
- /**
2931
- *
2932
- * @summary Update User
2933
- * @param {string} userId
2934
- * @param {UserUpdateBody} userUpdateBody
2935
- * @param {*} [options] Override http request option.
2936
- * @throws {RequiredError}
2937
- */
2938
- updateUserInternalUsersUserIdPut(userId: string, userUpdateBody: UserUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2939
- };
2940
- /**
2941
- * InternalApi - interface
2942
- * @export
2943
- * @interface InternalApi
2944
- */
2945
- export interface InternalApiInterface {
2946
- /**
2947
- * Change the password for a user.
2948
- * @summary Change Password
2949
- * @param {BodyChangePasswordProfileChangePasswordPost} bodyChangePasswordProfileChangePasswordPost
2950
- * @param {*} [options] Override http request option.
2951
- * @throws {RequiredError}
2952
- * @memberof InternalApiInterface
2953
- */
2954
- changePasswordProfileChangePasswordPost(bodyChangePasswordProfileChangePasswordPost: BodyChangePasswordProfileChangePasswordPost, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2955
- /**
2956
- * Delete release
2957
- * @summary Del Release
2958
- * @param {string} releaseId
2959
- * @param {*} [options] Override http request option.
2960
- * @throws {RequiredError}
2961
- * @memberof InternalApiInterface
2962
- */
2963
- delReleaseInternalReleasesReleaseIdDelete(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2964
- /**
2965
- *
2966
- * @summary Delete User
2967
- * @param {string} userId
2968
- * @param {*} [options] Override http request option.
2969
- * @throws {RequiredError}
2970
- * @memberof InternalApiInterface
2971
- */
2972
- deleteUserInternalUsersUserIdDelete(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2973
- /**
2974
- * Edit Release information
2975
- * @summary Edit Release
2976
- * @param {string} releaseId
2977
- * @param {ReleaseUpdateBody} releaseUpdateBody
2978
- * @param {*} [options] Override http request option.
2979
- * @throws {RequiredError}
2980
- * @memberof InternalApiInterface
2981
- */
2982
- editReleaseInternalReleasesReleaseIdPut(releaseId: string, releaseUpdateBody: ReleaseUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
2983
- /**
2984
- *
2985
- * @summary Get Device Info
2986
- * @param {string} deviceId
2987
- * @param {*} [options] Override http request option.
2988
- * @throws {RequiredError}
2989
- * @memberof InternalApiInterface
2990
- */
2991
- getDeviceInfoInternalDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeviceInternalResponse>;
2992
- /**
2993
- * Get a paginated list of logs with optional filtering.
2994
- * @summary Get Logs
2995
- * @param {number} [page]
2996
- * @param {number} [perPage]
2997
- * @param {string | null} [deviceId]
2998
- * @param {string | null} [releaseId]
2999
- * @param {string | null} [userId]
3000
- * @param {boolean | null} [hideVerbose]
3001
- * @param {*} [options] Override http request option.
3002
- * @throws {RequiredError}
3003
- * @memberof InternalApiInterface
3004
- */
3005
- getLogsInternalLogsGet(page?: number, perPage?: number, deviceId?: string | null, releaseId?: string | null, userId?: string | null, hideVerbose?: boolean | null, options?: RawAxiosRequestConfig): AxiosPromise<LogListResponse>;
3006
- /**
3007
- * Get release information
3008
- * @summary Get Release Info
3009
- * @param {string} releaseId
3010
- * @param {*} [options] Override http request option.
3011
- * @throws {RequiredError}
3012
- * @memberof InternalApiInterface
3013
- */
3014
- getReleaseInfoInternalReleasesReleaseIdGet(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseInternalResponse>;
3015
- /**
3016
- * Download release ZIP directly
3017
- * @summary Get Release Zip
3018
- * @param {string} releaseId
3019
- * @param {*} [options] Override http request option.
3020
- * @throws {RequiredError}
3021
- * @memberof InternalApiInterface
3022
- */
3023
- getReleaseZipInternalReleasesReleaseIdDlGet(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
3024
- /**
3025
- *
3026
- * @summary Get User By Id
3027
- * @param {string} userId
3028
- * @param {*} [options] Override http request option.
3029
- * @throws {RequiredError}
3030
- * @memberof InternalApiInterface
3031
- */
3032
- getUserByIdInternalUsersUserIdGet(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<UserInternalResponse>;
3033
- /**
3034
- *
3035
- * @summary List Users
3036
- * @param {*} [options] Override http request option.
3037
- * @throws {RequiredError}
3038
- * @memberof InternalApiInterface
3039
- */
3040
- listUsersInternalUsersGet(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseUserShortResponse>;
3041
- /**
3042
- * OAuth2 compatible token login, get an access token for future requests
3043
- * @summary Login Oauth
3044
- * @param {string} username
3045
- * @param {string} password
3046
- * @param {number} [minTime]
3047
- * @param {number} [maxTime]
3048
- * @param {string | null} [grantType]
3049
- * @param {string} [scope]
3050
- * @param {string | null} [clientId]
3051
- * @param {string | null} [clientSecret]
3052
- * @param {*} [options] Override http request option.
3053
- * @throws {RequiredError}
3054
- * @memberof InternalApiInterface
3055
- */
3056
- loginOauthAuthLoginPost(username: string, password: string, minTime?: number, maxTime?: number, grantType?: string | null, scope?: string, clientId?: string | null, clientSecret?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<TokenResponse>;
3057
- /**
3058
- *
3059
- * @summary Logout
3060
- * @param {string} body
3061
- * @param {*} [options] Override http request option.
3062
- * @throws {RequiredError}
3063
- * @memberof InternalApiInterface
3064
- */
3065
- logoutAuthLogoutPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
3066
- /**
3067
- *
3068
- * @summary New Device
3069
- * @param {NewDeviceBody} newDeviceBody
3070
- * @param {*} [options] Override http request option.
3071
- * @throws {RequiredError}
3072
- * @memberof InternalApiInterface
3073
- */
3074
- newDeviceInternalDevicesPost(newDeviceBody: NewDeviceBody, options?: RawAxiosRequestConfig): AxiosPromise<string>;
3075
- /**
3076
- *
3077
- * @summary New Release
3078
- * @param {string} deviceId
3079
- * @param {File} releaseZip
3080
- * @param {string} md5
3081
- * @param {Array<string>} changelog
3082
- * @param {Array<string>} [bugs]
3083
- * @param {string | null} [notes]
3084
- * @param {boolean} [force]
3085
- * @param {*} [options] Override http request option.
3086
- * @throws {RequiredError}
3087
- * @memberof InternalApiInterface
3088
- */
3089
- newReleaseInternalReleasesPost(deviceId: string, releaseZip: File, md5: string, changelog: Array<string>, bugs?: Array<string>, notes?: string | null, force?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
3090
- /**
3091
- *
3092
- * @summary Renew
3093
- * @param {string} body
3094
- * @param {*} [options] Override http request option.
3095
- * @throws {RequiredError}
3096
- * @memberof InternalApiInterface
3097
- */
3098
- renewAuthRenewPost(body: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
3099
- /**
3100
- *
3101
- * @summary Update Device
3102
- * @param {string} deviceId
3103
- * @param {DeviceUpdateBody} deviceUpdateBody
3104
- * @param {*} [options] Override http request option.
3105
- * @throws {RequiredError}
3106
- * @memberof InternalApiInterface
3107
- */
3108
- updateDeviceInternalDevicesDeviceIdPut(deviceId: string, deviceUpdateBody: DeviceUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
3109
- /**
3110
- *
3111
- * @summary Update User
3112
- * @param {string} userId
3113
- * @param {UserUpdateBody} userUpdateBody
3114
- * @param {*} [options] Override http request option.
3115
- * @throws {RequiredError}
3116
- * @memberof InternalApiInterface
3117
- */
3118
- updateUserInternalUsersUserIdPut(userId: string, userUpdateBody: UserUpdateBody, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
3119
- }
3120
- /**
3121
- * InternalApi - object-oriented interface
3122
- * @export
3123
- * @class InternalApi
3124
- * @extends {BaseAPI}
3125
- */
3126
- export declare class InternalApi extends BaseAPI implements InternalApiInterface {
3127
- /**
3128
- * Change the password for a user.
3129
- * @summary Change Password
3130
- * @param {BodyChangePasswordProfileChangePasswordPost} bodyChangePasswordProfileChangePasswordPost
3131
- * @param {*} [options] Override http request option.
3132
- * @throws {RequiredError}
3133
- * @memberof InternalApi
3134
- */
3135
- changePasswordProfileChangePasswordPost(bodyChangePasswordProfileChangePasswordPost: BodyChangePasswordProfileChangePasswordPost, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
3136
- /**
3137
- * Delete release
3138
- * @summary Del Release
3139
- * @param {string} releaseId
3140
- * @param {*} [options] Override http request option.
3141
- * @throws {RequiredError}
3142
- * @memberof InternalApi
3143
- */
3144
- delReleaseInternalReleasesReleaseIdDelete(releaseId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
3145
- /**
3146
- *
3147
- * @summary Delete User
3148
- * @param {string} userId
3149
- * @param {*} [options] Override http request option.
3150
- * @throws {RequiredError}
3151
- * @memberof InternalApi
3152
- */
3153
- deleteUserInternalUsersUserIdDelete(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
3154
- /**
3155
- * Edit Release information
3156
- * @summary Edit Release
3157
- * @param {string} releaseId
3158
- * @param {ReleaseUpdateBody} releaseUpdateBody
3159
- * @param {*} [options] Override http request option.
3160
- * @throws {RequiredError}
3161
- * @memberof InternalApi
3162
- */
3163
- editReleaseInternalReleasesReleaseIdPut(releaseId: string, releaseUpdateBody: ReleaseUpdateBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
3164
- /**
3165
- *
3166
- * @summary Get Device Info
3167
- * @param {string} deviceId
3168
- * @param {*} [options] Override http request option.
3169
- * @throws {RequiredError}
3170
- * @memberof InternalApi
3171
- */
3172
- getDeviceInfoInternalDevicesDeviceIdGet(deviceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeviceInternalResponse, any>>;
3173
- /**
3174
- * Get a paginated list of logs with optional filtering.
3175
- * @summary Get Logs
3176
- * @param {number} [page]
3177
- * @param {number} [perPage]
3178
- * @param {string | null} [deviceId]
3179
- * @param {string | null} [releaseId]
3180
- * @param {string | null} [userId]
3181
- * @param {boolean | null} [hideVerbose]
3182
- * @param {*} [options] Override http request option.
3183
- * @throws {RequiredError}
3184
- * @memberof InternalApi
3185
- */
3186
- getLogsInternalLogsGet(page?: number, perPage?: number, deviceId?: string | null, releaseId?: string | null, userId?: string | null, hideVerbose?: boolean | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LogListResponse, any>>;
3187
- /**
3188
- * Get release information
3189
- * @summary Get Release Info
3190
- * @param {string} releaseId
3191
- * @param {*} [options] Override http request option.
3192
- * @throws {RequiredError}
3193
- * @memberof InternalApi
3194
- */
3195
- getReleaseInfoInternalReleasesReleaseIdGet(releaseId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleaseInternalResponse, any>>;
3196
- /**
3197
- * Download release ZIP directly
3198
- * @summary Get Release Zip
3199
- * @param {string} releaseId
3200
- * @param {*} [options] Override http request option.
3201
- * @throws {RequiredError}
3202
- * @memberof InternalApi
3203
- */
3204
- getReleaseZipInternalReleasesReleaseIdDlGet(releaseId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
3205
- /**
3206
- *
3207
- * @summary Get User By Id
3208
- * @param {string} userId
3209
- * @param {*} [options] Override http request option.
3210
- * @throws {RequiredError}
3211
- * @memberof InternalApi
3212
- */
3213
- getUserByIdInternalUsersUserIdGet(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserInternalResponse, any>>;
3214
- /**
3215
- *
3216
- * @summary List Users
3217
- * @param {*} [options] Override http request option.
3218
- * @throws {RequiredError}
3219
- * @memberof InternalApi
3220
- */
3221
- listUsersInternalUsersGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseUserShortResponse, any>>;
3222
- /**
3223
- * OAuth2 compatible token login, get an access token for future requests
3224
- * @summary Login Oauth
3225
- * @param {string} username
3226
- * @param {string} password
3227
- * @param {number} [minTime]
3228
- * @param {number} [maxTime]
3229
- * @param {string | null} [grantType]
3230
- * @param {string} [scope]
3231
- * @param {string | null} [clientId]
3232
- * @param {string | null} [clientSecret]
3233
- * @param {*} [options] Override http request option.
3234
- * @throws {RequiredError}
3235
- * @memberof InternalApi
3236
- */
3237
- loginOauthAuthLoginPost(username: string, password: string, minTime?: number, maxTime?: number, grantType?: string | null, scope?: string, clientId?: string | null, clientSecret?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TokenResponse, any>>;
3238
- /**
3239
- *
3240
- * @summary Logout
3241
- * @param {string} body
3242
- * @param {*} [options] Override http request option.
3243
- * @throws {RequiredError}
3244
- * @memberof InternalApi
3245
- */
3246
- logoutAuthLogoutPost(body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
3247
- /**
3248
- *
3249
- * @summary New Device
3250
- * @param {NewDeviceBody} newDeviceBody
3251
- * @param {*} [options] Override http request option.
3252
- * @throws {RequiredError}
3253
- * @memberof InternalApi
3254
- */
3255
- newDeviceInternalDevicesPost(newDeviceBody: NewDeviceBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
3256
- /**
3257
- *
3258
- * @summary New Release
3259
- * @param {string} deviceId
3260
- * @param {File} releaseZip
3261
- * @param {string} md5
3262
- * @param {Array<string>} changelog
3263
- * @param {Array<string>} [bugs]
3264
- * @param {string | null} [notes]
3265
- * @param {boolean} [force]
3266
- * @param {*} [options] Override http request option.
3267
- * @throws {RequiredError}
3268
- * @memberof InternalApi
3269
- */
3270
- newReleaseInternalReleasesPost(deviceId: string, releaseZip: File, md5: string, changelog: Array<string>, bugs?: Array<string>, notes?: string | null, force?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleaseResponse, any>>;
3271
- /**
3272
- *
3273
- * @summary Renew
3274
- * @param {string} body
3275
- * @param {*} [options] Override http request option.
3276
- * @throws {RequiredError}
3277
- * @memberof InternalApi
3278
- */
3279
- renewAuthRenewPost(body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
3280
- /**
3281
- *
3282
- * @summary Update Device
3283
- * @param {string} deviceId
3284
- * @param {DeviceUpdateBody} deviceUpdateBody
3285
- * @param {*} [options] Override http request option.
3286
- * @throws {RequiredError}
3287
- * @memberof InternalApi
3288
- */
3289
- updateDeviceInternalDevicesDeviceIdPut(deviceId: string, deviceUpdateBody: DeviceUpdateBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
3290
- /**
3291
- *
3292
- * @summary Update User
3293
- * @param {string} userId
3294
- * @param {UserUpdateBody} userUpdateBody
3295
- * @param {*} [options] Override http request option.
3296
- * @throws {RequiredError}
3297
- * @memberof InternalApi
3298
- */
3299
- updateUserInternalUsersUserIdPut(userId: string, userUpdateBody: UserUpdateBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
3300
- }
3301
- /**
3302
- * ReleaseApi - axios parameter creator
3303
- * @export
3304
- */
3305
- export declare const ReleaseApiAxiosParamCreator: (configuration?: Configuration) => {
3306
- /**
3307
- * 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!
3308
- * @summary Get Release
3309
- * @param {string | null} [releaseId] Release ID
3310
- * @param {string | null} [id] Release ID (deprecated)
3311
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
3312
- * @param {string | null} [filename]
3313
- * @param {*} [options] Override http request option.
3314
- * @throws {RequiredError}
3315
- */
3316
- getRelease: (releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3317
- /**
3318
- * Gets release information using the release ID, nothing to discuss really.
3319
- * @summary Get Release Short
3320
- * @param {string} releaseId
3321
- * @param {*} [options] Override http request option.
3322
- * @deprecated
3323
- * @throws {RequiredError}
3324
- */
3325
- getReleaseDeprecated: (releaseId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3326
- /**
3327
- * 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.
3328
- * @summary Get Releases
3329
- * @param {Array<string>} [id] Filter by Release IDs
3330
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
3331
- * @param {Array<string>} [buildId] Filter by Build IDs
3332
- * @param {Array<string>} [deviceId] Filter by Device IDs
3333
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
3334
- * @param {Array<string>} [codename] Filter by device codenames
3335
- * @param {Array<string>} [version] Filter by release version
3336
- * @param {Array<ReleaseType>} [type] Filter by release type
3337
- * @param {boolean | null} [archived] Filter by the archived status
3338
- * @param {boolean | null} [freezed] Filter by the freezed status
3339
- * @param {string | null} [afterReleaseId] Show releases after the provided one
3340
- * @param {number | null} [afterDate] Show releases after the provided timestamp
3341
- * @param {ReleasesSort} [sort] Sort mode
3342
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
3343
- * @param {number | null} [skip] Skip query results
3344
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3345
- * @param {*} [options] Override http request option.
3346
- * @throws {RequiredError}
3347
- */
3348
- getReleases: (id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3349
- /**
3350
- * 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!
3351
- * @summary Get Updates
3352
- * @param {string} lastKnownId
3353
- * @param {Array<string>} [deviceId] Filter by device ID
3354
- * @param {Array<ReleaseType>} [type] Filter by release type
3355
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
3356
- * @param {number | null} [skip] Skip query results
3357
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3358
- * @param {*} [options] Override http request option.
3359
- * @deprecated
3360
- * @throws {RequiredError}
3361
- */
3362
- getUpdatesDeprecated: (lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3363
- };
3364
- /**
3365
- * ReleaseApi - functional programming interface
3366
- * @export
3367
- */
3368
- export declare const ReleaseApiFp: (configuration?: Configuration) => {
3369
- /**
3370
- * 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!
3371
- * @summary Get Release
3372
- * @param {string | null} [releaseId] Release ID
3373
- * @param {string | null} [id] Release ID (deprecated)
3374
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
3375
- * @param {string | null} [filename]
3376
- * @param {*} [options] Override http request option.
3377
- * @throws {RequiredError}
3378
- */
3379
- getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>>;
3380
- /**
3381
- * Gets release information using the release ID, nothing to discuss really.
3382
- * @summary Get Release Short
3383
- * @param {string} releaseId
3384
- * @param {*} [options] Override http request option.
3385
- * @deprecated
3386
- * @throws {RequiredError}
3387
- */
3388
- getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleaseResponse>>;
3389
- /**
3390
- * 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.
3391
- * @summary Get Releases
3392
- * @param {Array<string>} [id] Filter by Release IDs
3393
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
3394
- * @param {Array<string>} [buildId] Filter by Build IDs
3395
- * @param {Array<string>} [deviceId] Filter by Device IDs
3396
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
3397
- * @param {Array<string>} [codename] Filter by device codenames
3398
- * @param {Array<string>} [version] Filter by release version
3399
- * @param {Array<ReleaseType>} [type] Filter by release type
3400
- * @param {boolean | null} [archived] Filter by the archived status
3401
- * @param {boolean | null} [freezed] Filter by the freezed status
3402
- * @param {string | null} [afterReleaseId] Show releases after the provided one
3403
- * @param {number | null} [afterDate] Show releases after the provided timestamp
3404
- * @param {ReleasesSort} [sort] Sort mode
3405
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
3406
- * @param {number | null} [skip] Skip query results
3407
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3408
- * @param {*} [options] Override http request option.
3409
- * @throws {RequiredError}
3410
- */
3411
- getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResponseGetReleases>>;
3412
- /**
3413
- * 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!
3414
- * @summary Get Updates
3415
- * @param {string} lastKnownId
3416
- * @param {Array<string>} [deviceId] Filter by device ID
3417
- * @param {Array<ReleaseType>} [type] Filter by release type
3418
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
3419
- * @param {number | null} [skip] Skip query results
3420
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3421
- * @param {*} [options] Override http request option.
3422
- * @deprecated
3423
- * @throws {RequiredError}
3424
- */
3425
- getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseShortReleaseResponse>>;
3426
- };
3427
- /**
3428
- * ReleaseApi - factory interface
3429
- * @export
3430
- */
3431
- export declare const ReleaseApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3432
- /**
3433
- * 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!
3434
- * @summary Get Release
3435
- * @param {string | null} [releaseId] Release ID
3436
- * @param {string | null} [id] Release ID (deprecated)
3437
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
3438
- * @param {string | null} [filename]
3439
- * @param {*} [options] Override http request option.
3440
- * @throws {RequiredError}
3441
- */
3442
- getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
3443
- /**
3444
- * Gets release information using the release ID, nothing to discuss really.
3445
- * @summary Get Release Short
3446
- * @param {string} releaseId
3447
- * @param {*} [options] Override http request option.
3448
- * @deprecated
3449
- * @throws {RequiredError}
3450
- */
3451
- getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
3452
- /**
3453
- * 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.
3454
- * @summary Get Releases
3455
- * @param {Array<string>} [id] Filter by Release IDs
3456
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
3457
- * @param {Array<string>} [buildId] Filter by Build IDs
3458
- * @param {Array<string>} [deviceId] Filter by Device IDs
3459
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
3460
- * @param {Array<string>} [codename] Filter by device codenames
3461
- * @param {Array<string>} [version] Filter by release version
3462
- * @param {Array<ReleaseType>} [type] Filter by release type
3463
- * @param {boolean | null} [archived] Filter by the archived status
3464
- * @param {boolean | null} [freezed] Filter by the freezed status
3465
- * @param {string | null} [afterReleaseId] Show releases after the provided one
3466
- * @param {number | null} [afterDate] Show releases after the provided timestamp
3467
- * @param {ReleasesSort} [sort] Sort mode
3468
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
3469
- * @param {number | null} [skip] Skip query results
3470
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3471
- * @param {*} [options] Override http request option.
3472
- * @throws {RequiredError}
3473
- */
3474
- getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ResponseGetReleases>;
3475
- /**
3476
- * 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!
3477
- * @summary Get Updates
3478
- * @param {string} lastKnownId
3479
- * @param {Array<string>} [deviceId] Filter by device ID
3480
- * @param {Array<ReleaseType>} [type] Filter by release type
3481
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
3482
- * @param {number | null} [skip] Skip query results
3483
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3484
- * @param {*} [options] Override http request option.
3485
- * @deprecated
3486
- * @throws {RequiredError}
3487
- */
3488
- getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse>;
3489
- };
3490
- /**
3491
- * ReleaseApi - interface
3492
- * @export
3493
- * @interface ReleaseApi
3494
- */
3495
- export interface ReleaseApiInterface {
3496
- /**
3497
- * 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!
3498
- * @summary Get Release
3499
- * @param {string | null} [releaseId] Release ID
3500
- * @param {string | null} [id] Release ID (deprecated)
3501
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
3502
- * @param {string | null} [filename]
3503
- * @param {*} [options] Override http request option.
3504
- * @throws {RequiredError}
3505
- * @memberof ReleaseApiInterface
3506
- */
3507
- getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
3508
- /**
3509
- * Gets release information using the release ID, nothing to discuss really.
3510
- * @summary Get Release Short
3511
- * @param {string} releaseId
3512
- * @param {*} [options] Override http request option.
3513
- * @deprecated
3514
- * @throws {RequiredError}
3515
- * @memberof ReleaseApiInterface
3516
- */
3517
- getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReleaseResponse>;
3518
- /**
3519
- * 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.
3520
- * @summary Get Releases
3521
- * @param {Array<string>} [id] Filter by Release IDs
3522
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
3523
- * @param {Array<string>} [buildId] Filter by Build IDs
3524
- * @param {Array<string>} [deviceId] Filter by Device IDs
3525
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
3526
- * @param {Array<string>} [codename] Filter by device codenames
3527
- * @param {Array<string>} [version] Filter by release version
3528
- * @param {Array<ReleaseType>} [type] Filter by release type
3529
- * @param {boolean | null} [archived] Filter by the archived status
3530
- * @param {boolean | null} [freezed] Filter by the freezed status
3531
- * @param {string | null} [afterReleaseId] Show releases after the provided one
3532
- * @param {number | null} [afterDate] Show releases after the provided timestamp
3533
- * @param {ReleasesSort} [sort] Sort mode
3534
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
3535
- * @param {number | null} [skip] Skip query results
3536
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3537
- * @param {*} [options] Override http request option.
3538
- * @throws {RequiredError}
3539
- * @memberof ReleaseApiInterface
3540
- */
3541
- getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ResponseGetReleases>;
3542
- /**
3543
- * 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!
3544
- * @summary Get Updates
3545
- * @param {string} lastKnownId
3546
- * @param {Array<string>} [deviceId] Filter by device ID
3547
- * @param {Array<ReleaseType>} [type] Filter by release type
3548
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
3549
- * @param {number | null} [skip] Skip query results
3550
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3551
- * @param {*} [options] Override http request option.
3552
- * @deprecated
3553
- * @throws {RequiredError}
3554
- * @memberof ReleaseApiInterface
3555
- */
3556
- getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseShortReleaseResponse>;
3557
- }
3558
- /**
3559
- * ReleaseApi - object-oriented interface
3560
- * @export
3561
- * @class ReleaseApi
3562
- * @extends {BaseAPI}
3563
- */
3564
- export declare class ReleaseApi extends BaseAPI implements ReleaseApiInterface {
3565
- /**
3566
- * 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!
3567
- * @summary Get Release
3568
- * @param {string | null} [releaseId] Release ID
3569
- * @param {string | null} [id] Release ID (deprecated)
3570
- * @param {string | null} [buildId] Build ID, &#x60;ro.build.fox_id&#x60; prop
3571
- * @param {string | null} [filename]
3572
- * @param {*} [options] Override http request option.
3573
- * @throws {RequiredError}
3574
- * @memberof ReleaseApi
3575
- */
3576
- getRelease(releaseId?: string | null, id?: string | null, buildId?: string | null, filename?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleaseResponse, any>>;
3577
- /**
3578
- * Gets release information using the release ID, nothing to discuss really.
3579
- * @summary Get Release Short
3580
- * @param {string} releaseId
3581
- * @param {*} [options] Override http request option.
3582
- * @deprecated
3583
- * @throws {RequiredError}
3584
- * @memberof ReleaseApi
3585
- */
3586
- getReleaseDeprecated(releaseId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleaseResponse, any>>;
3587
- /**
3588
- * 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.
3589
- * @summary Get Releases
3590
- * @param {Array<string>} [id] Filter by Release IDs
3591
- * @param {Array<string>} [id2] Filter by Release IDs (deprecated)
3592
- * @param {Array<string>} [buildId] Filter by Build IDs
3593
- * @param {Array<string>} [deviceId] Filter by Device IDs
3594
- * @param {Array<string>} [maintainerId] Filter by Maintainer IDs
3595
- * @param {Array<string>} [codename] Filter by device codenames
3596
- * @param {Array<string>} [version] Filter by release version
3597
- * @param {Array<ReleaseType>} [type] Filter by release type
3598
- * @param {boolean | null} [archived] Filter by the archived status
3599
- * @param {boolean | null} [freezed] Filter by the freezed status
3600
- * @param {string | null} [afterReleaseId] Show releases after the provided one
3601
- * @param {number | null} [afterDate] Show releases after the provided timestamp
3602
- * @param {ReleasesSort} [sort] Sort mode
3603
- * @param {boolean | null} [group] Group releases by version + variant. This will change the response!
3604
- * @param {number | null} [skip] Skip query results
3605
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3606
- * @param {*} [options] Override http request option.
3607
- * @throws {RequiredError}
3608
- * @memberof ReleaseApi
3609
- */
3610
- getReleases(id?: Array<string>, id2?: Array<string>, buildId?: Array<string>, deviceId?: Array<string>, maintainerId?: Array<string>, codename?: Array<string>, version?: Array<string>, type?: Array<ReleaseType>, archived?: boolean | null, freezed?: boolean | null, afterReleaseId?: string | null, afterDate?: number | null, sort?: ReleasesSort, group?: boolean | null, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResponseGetReleases, any>>;
3611
- /**
3612
- * 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!
3613
- * @summary Get Updates
3614
- * @param {string} lastKnownId
3615
- * @param {Array<string>} [deviceId] Filter by device ID
3616
- * @param {Array<ReleaseType>} [type] Filter by release type
3617
- * @param {Array<ReleaseType>} [releaseType] Filter by release type (legacy)
3618
- * @param {number | null} [skip] Skip query results
3619
- * @param {number | null} [limit] Limit query results (0 means unlimited)
3620
- * @param {*} [options] Override http request option.
3621
- * @deprecated
3622
- * @throws {RequiredError}
3623
- * @memberof ReleaseApi
3624
- */
3625
- getUpdatesDeprecated(lastKnownId: string, deviceId?: Array<string>, type?: Array<ReleaseType>, releaseType?: Array<ReleaseType>, skip?: number | null, limit?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponseShortReleaseResponse, any>>;
3626
- }
3627
- /**
3628
- * StatsApi - axios parameter creator
3629
- * @export
3630
- */
3631
- export declare const StatsApiAxiosParamCreator: (configuration?: Configuration) => {
3632
- /**
3633
- * 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.
3634
- * @summary Public Stats
3635
- * @param {*} [options] Override http request option.
3636
- * @throws {RequiredError}
3637
- */
3638
- getPublicStats: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3639
- };
3640
- /**
3641
- * StatsApi - functional programming interface
3642
- * @export
3643
- */
3644
- export declare const StatsApiFp: (configuration?: Configuration) => {
3645
- /**
3646
- * 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.
3647
- * @summary Public Stats
3648
- * @param {*} [options] Override http request option.
3649
- * @throws {RequiredError}
3650
- */
3651
- getPublicStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GlobalStatsAggregationModel>>;
3652
- };
3653
- /**
3654
- * StatsApi - factory interface
3655
- * @export
3656
- */
3657
- export declare const StatsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3658
- /**
3659
- * 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.
3660
- * @summary Public Stats
3661
- * @param {*} [options] Override http request option.
3662
- * @throws {RequiredError}
3663
- */
3664
- getPublicStats(options?: RawAxiosRequestConfig): AxiosPromise<GlobalStatsAggregationModel>;
3665
- };
3666
- /**
3667
- * StatsApi - interface
3668
- * @export
3669
- * @interface StatsApi
3670
- */
3671
- export interface StatsApiInterface {
3672
- /**
3673
- * 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.
3674
- * @summary Public Stats
3675
- * @param {*} [options] Override http request option.
3676
- * @throws {RequiredError}
3677
- * @memberof StatsApiInterface
3678
- */
3679
- getPublicStats(options?: RawAxiosRequestConfig): AxiosPromise<GlobalStatsAggregationModel>;
3680
- }
3681
- /**
3682
- * StatsApi - object-oriented interface
3683
- * @export
3684
- * @class StatsApi
3685
- * @extends {BaseAPI}
3686
- */
3687
- export declare class StatsApi extends BaseAPI implements StatsApiInterface {
3688
- /**
3689
- * 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.
3690
- * @summary Public Stats
3691
- * @param {*} [options] Override http request option.
3692
- * @throws {RequiredError}
3693
- * @memberof StatsApi
3694
- */
3695
- getPublicStats(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GlobalStatsAggregationModel, any>>;
3696
- }