@orangefox-recovery/foxinternalclient 5.2.6 → 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 (369) hide show
  1. package/.openapi-generator/FILES +58 -60
  2. package/README.md +3 -122
  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 -6111
  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 -3964
  300. package/dist/api.js +0 -3664
  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 -3964
  308. package/dist/esm/api.js +0 -3633
  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 -1072
  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/PasteApi.md +0 -117
  343. package/docs/PasteInput.md +0 -26
  344. package/docs/PasteOutput.md +0 -26
  345. package/docs/RecoveryImgResponse.md +0 -22
  346. package/docs/ReleaseApi.md +0 -289
  347. package/docs/ReleaseGroupsResponse.md +0 -20
  348. package/docs/ReleaseInternalResponse.md +0 -62
  349. package/docs/ReleaseInternalResponsePropValue.md +0 -18
  350. package/docs/ReleaseResponse.md +0 -56
  351. package/docs/ReleaseStatsResponse.md +0 -24
  352. package/docs/ReleaseType.md +0 -12
  353. package/docs/ReleaseUpdateBody.md +0 -26
  354. package/docs/ReleasesSort.md +0 -10
  355. package/docs/ResponseGetReleases.md +0 -22
  356. package/docs/ShortDeviceResponse.md +0 -38
  357. package/docs/ShortReleaseResponse.md +0 -44
  358. package/docs/StatsApi.md +0 -53
  359. package/docs/TaskUpdateBody.md +0 -22
  360. package/docs/TokenResponse.md +0 -22
  361. package/docs/UserGitlab.md +0 -20
  362. package/docs/UserInternalResponse.md +0 -38
  363. package/docs/UserMail.md +0 -20
  364. package/docs/UserShortResponse.md +0 -26
  365. package/docs/UserTelegram.md +0 -20
  366. package/docs/UserUpdateBody.md +0 -28
  367. package/docs/ValidationError.md +0 -24
  368. package/docs/ValidationErrorLocInner.md +0 -18
  369. package/git_push.sh +0 -57
@@ -1,1072 +0,0 @@
1
- # InternalApi
2
-
3
- All URIs are relative to *https://api.orangefox.download*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**changePasswordProfileChangePasswordPost**](#changepasswordprofilechangepasswordpost) | **POST** /profile/change_password | Change Password|
8
- |[**delReleaseInternalReleasesReleaseIdDelete**](#delreleaseinternalreleasesreleaseiddelete) | **DELETE** /internal/releases/{release_id} | Del Release|
9
- |[**deletePasteInternalPastePasteIdDelete**](#deletepasteinternalpastepasteiddelete) | **DELETE** /internal/paste/{paste_id} | Delete Paste|
10
- |[**deleteUserInternalUsersUserIdDelete**](#deleteuserinternalusersuseriddelete) | **DELETE** /internal/users/{user_id} | Delete User|
11
- |[**editReleaseInternalReleasesReleaseIdPut**](#editreleaseinternalreleasesreleaseidput) | **PUT** /internal/releases/{release_id} | Edit Release|
12
- |[**getDeviceInfoInternalDevicesDeviceIdGet**](#getdeviceinfointernaldevicesdeviceidget) | **GET** /internal/devices/{device_id} | Get Device Info|
13
- |[**getLogsInternalLogsGet**](#getlogsinternallogsget) | **GET** /internal/logs/ | Get Logs|
14
- |[**getReleaseInfoInternalReleasesReleaseIdGet**](#getreleaseinfointernalreleasesreleaseidget) | **GET** /internal/releases/{release_id} | Get Release Info|
15
- |[**getReleaseZipInternalReleasesReleaseIdDlGet**](#getreleasezipinternalreleasesreleaseiddlget) | **GET** /internal/releases/{release_id}/dl | Get Release Zip|
16
- |[**getUserByIdInternalUsersUserIdGet**](#getuserbyidinternalusersuseridget) | **GET** /internal/users/{user_id} | Get User By Id|
17
- |[**listUsersInternalUsersGet**](#listusersinternalusersget) | **GET** /internal/users/ | List Users|
18
- |[**loginOauthAuthLoginPost**](#loginoauthauthloginpost) | **POST** /auth/login | Login Oauth|
19
- |[**logoutAuthLogoutPost**](#logoutauthlogoutpost) | **POST** /auth/logout | Logout|
20
- |[**newDeviceInternalDevicesPost**](#newdeviceinternaldevicespost) | **POST** /internal/devices/ | New Device|
21
- |[**newReleaseInternalReleasesPost**](#newreleaseinternalreleasespost) | **POST** /internal/releases/ | New Release|
22
- |[**renewAuthRenewPost**](#renewauthrenewpost) | **POST** /auth/renew | Renew|
23
- |[**updateDeviceInternalDevicesDeviceIdPut**](#updatedeviceinternaldevicesdeviceidput) | **PUT** /internal/devices/{device_id} | Update Device|
24
- |[**updatePasteInternalPastePasteIdPut**](#updatepasteinternalpastepasteidput) | **PUT** /internal/paste/{paste_id} | Update Paste|
25
- |[**updateUserInternalUsersUserIdPut**](#updateuserinternalusersuseridput) | **PUT** /internal/users/{user_id} | Update User|
26
-
27
- # **changePasswordProfileChangePasswordPost**
28
- > boolean changePasswordProfileChangePasswordPost(bodyChangePasswordProfileChangePasswordPost)
29
-
30
- Change the password for a user.
31
-
32
- ### Example
33
-
34
- ```typescript
35
- import {
36
- InternalApi,
37
- Configuration,
38
- BodyChangePasswordProfileChangePasswordPost
39
- } from '@orangefox-recovery/foxinternalclient';
40
-
41
- const configuration = new Configuration();
42
- const apiInstance = new InternalApi(configuration);
43
-
44
- let bodyChangePasswordProfileChangePasswordPost: BodyChangePasswordProfileChangePasswordPost; //
45
-
46
- const { status, data } = await apiInstance.changePasswordProfileChangePasswordPost(
47
- bodyChangePasswordProfileChangePasswordPost
48
- );
49
- ```
50
-
51
- ### Parameters
52
-
53
- |Name | Type | Description | Notes|
54
- |------------- | ------------- | ------------- | -------------|
55
- | **bodyChangePasswordProfileChangePasswordPost** | **BodyChangePasswordProfileChangePasswordPost**| | |
56
-
57
-
58
- ### Return type
59
-
60
- **boolean**
61
-
62
- ### Authorization
63
-
64
- No authorization required
65
-
66
- ### HTTP request headers
67
-
68
- - **Content-Type**: application/json
69
- - **Accept**: application/json
70
-
71
-
72
- ### HTTP response details
73
- | Status code | Description | Response headers |
74
- |-------------|-------------|------------------|
75
- |**200** | Successful Response | - |
76
- |**422** | Validation Error | - |
77
-
78
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
79
-
80
- # **delReleaseInternalReleasesReleaseIdDelete**
81
- > boolean delReleaseInternalReleasesReleaseIdDelete()
82
-
83
- Delete release
84
-
85
- ### Example
86
-
87
- ```typescript
88
- import {
89
- InternalApi,
90
- Configuration
91
- } from '@orangefox-recovery/foxinternalclient';
92
-
93
- const configuration = new Configuration();
94
- const apiInstance = new InternalApi(configuration);
95
-
96
- let releaseId: string; // (default to undefined)
97
-
98
- const { status, data } = await apiInstance.delReleaseInternalReleasesReleaseIdDelete(
99
- releaseId
100
- );
101
- ```
102
-
103
- ### Parameters
104
-
105
- |Name | Type | Description | Notes|
106
- |------------- | ------------- | ------------- | -------------|
107
- | **releaseId** | [**string**] | | defaults to undefined|
108
-
109
-
110
- ### Return type
111
-
112
- **boolean**
113
-
114
- ### Authorization
115
-
116
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
117
-
118
- ### HTTP request headers
119
-
120
- - **Content-Type**: Not defined
121
- - **Accept**: application/json
122
-
123
-
124
- ### HTTP response details
125
- | Status code | Description | Response headers |
126
- |-------------|-------------|------------------|
127
- |**200** | Successful Response | - |
128
- |**422** | Validation Error | - |
129
-
130
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
131
-
132
- # **deletePasteInternalPastePasteIdDelete**
133
- > deletePasteInternalPastePasteIdDelete()
134
-
135
- Delete a paste by ID. Requires admin permissions.
136
-
137
- ### Example
138
-
139
- ```typescript
140
- import {
141
- InternalApi,
142
- Configuration
143
- } from '@orangefox-recovery/foxinternalclient';
144
-
145
- const configuration = new Configuration();
146
- const apiInstance = new InternalApi(configuration);
147
-
148
- let pasteId: string; // (default to undefined)
149
-
150
- const { status, data } = await apiInstance.deletePasteInternalPastePasteIdDelete(
151
- pasteId
152
- );
153
- ```
154
-
155
- ### Parameters
156
-
157
- |Name | Type | Description | Notes|
158
- |------------- | ------------- | ------------- | -------------|
159
- | **pasteId** | [**string**] | | defaults to undefined|
160
-
161
-
162
- ### Return type
163
-
164
- void (empty response body)
165
-
166
- ### Authorization
167
-
168
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
169
-
170
- ### HTTP request headers
171
-
172
- - **Content-Type**: Not defined
173
- - **Accept**: application/json
174
-
175
-
176
- ### HTTP response details
177
- | Status code | Description | Response headers |
178
- |-------------|-------------|------------------|
179
- |**204** | Successful Response | - |
180
- |**404** | Item not found | - |
181
- |**429** | Too many requests | - |
182
- |**422** | Validation Error | - |
183
-
184
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
185
-
186
- # **deleteUserInternalUsersUserIdDelete**
187
- > boolean deleteUserInternalUsersUserIdDelete()
188
-
189
-
190
- ### Example
191
-
192
- ```typescript
193
- import {
194
- InternalApi,
195
- Configuration
196
- } from '@orangefox-recovery/foxinternalclient';
197
-
198
- const configuration = new Configuration();
199
- const apiInstance = new InternalApi(configuration);
200
-
201
- let userId: string; // (default to undefined)
202
-
203
- const { status, data } = await apiInstance.deleteUserInternalUsersUserIdDelete(
204
- userId
205
- );
206
- ```
207
-
208
- ### Parameters
209
-
210
- |Name | Type | Description | Notes|
211
- |------------- | ------------- | ------------- | -------------|
212
- | **userId** | [**string**] | | defaults to undefined|
213
-
214
-
215
- ### Return type
216
-
217
- **boolean**
218
-
219
- ### Authorization
220
-
221
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
222
-
223
- ### HTTP request headers
224
-
225
- - **Content-Type**: Not defined
226
- - **Accept**: application/json
227
-
228
-
229
- ### HTTP response details
230
- | Status code | Description | Response headers |
231
- |-------------|-------------|------------------|
232
- |**200** | Successful Response | - |
233
- |**422** | Validation Error | - |
234
-
235
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
236
-
237
- # **editReleaseInternalReleasesReleaseIdPut**
238
- > boolean editReleaseInternalReleasesReleaseIdPut(releaseUpdateBody)
239
-
240
- Edit Release information
241
-
242
- ### Example
243
-
244
- ```typescript
245
- import {
246
- InternalApi,
247
- Configuration,
248
- ReleaseUpdateBody
249
- } from '@orangefox-recovery/foxinternalclient';
250
-
251
- const configuration = new Configuration();
252
- const apiInstance = new InternalApi(configuration);
253
-
254
- let releaseId: string; // (default to undefined)
255
- let releaseUpdateBody: ReleaseUpdateBody; //
256
-
257
- const { status, data } = await apiInstance.editReleaseInternalReleasesReleaseIdPut(
258
- releaseId,
259
- releaseUpdateBody
260
- );
261
- ```
262
-
263
- ### Parameters
264
-
265
- |Name | Type | Description | Notes|
266
- |------------- | ------------- | ------------- | -------------|
267
- | **releaseUpdateBody** | **ReleaseUpdateBody**| | |
268
- | **releaseId** | [**string**] | | defaults to undefined|
269
-
270
-
271
- ### Return type
272
-
273
- **boolean**
274
-
275
- ### Authorization
276
-
277
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
278
-
279
- ### HTTP request headers
280
-
281
- - **Content-Type**: application/json
282
- - **Accept**: application/json
283
-
284
-
285
- ### HTTP response details
286
- | Status code | Description | Response headers |
287
- |-------------|-------------|------------------|
288
- |**200** | Successful Response | - |
289
- |**422** | Validation Error | - |
290
-
291
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
292
-
293
- # **getDeviceInfoInternalDevicesDeviceIdGet**
294
- > DeviceInternalResponse getDeviceInfoInternalDevicesDeviceIdGet()
295
-
296
-
297
- ### Example
298
-
299
- ```typescript
300
- import {
301
- InternalApi,
302
- Configuration
303
- } from '@orangefox-recovery/foxinternalclient';
304
-
305
- const configuration = new Configuration();
306
- const apiInstance = new InternalApi(configuration);
307
-
308
- let deviceId: string; // (default to undefined)
309
-
310
- const { status, data } = await apiInstance.getDeviceInfoInternalDevicesDeviceIdGet(
311
- deviceId
312
- );
313
- ```
314
-
315
- ### Parameters
316
-
317
- |Name | Type | Description | Notes|
318
- |------------- | ------------- | ------------- | -------------|
319
- | **deviceId** | [**string**] | | defaults to undefined|
320
-
321
-
322
- ### Return type
323
-
324
- **DeviceInternalResponse**
325
-
326
- ### Authorization
327
-
328
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
329
-
330
- ### HTTP request headers
331
-
332
- - **Content-Type**: Not defined
333
- - **Accept**: application/json
334
-
335
-
336
- ### HTTP response details
337
- | Status code | Description | Response headers |
338
- |-------------|-------------|------------------|
339
- |**200** | Successful Response | - |
340
- |**422** | Validation Error | - |
341
-
342
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
343
-
344
- # **getLogsInternalLogsGet**
345
- > LogListResponse getLogsInternalLogsGet()
346
-
347
- Get a paginated list of logs with optional filtering.
348
-
349
- ### Example
350
-
351
- ```typescript
352
- import {
353
- InternalApi,
354
- Configuration
355
- } from '@orangefox-recovery/foxinternalclient';
356
-
357
- const configuration = new Configuration();
358
- const apiInstance = new InternalApi(configuration);
359
-
360
- let page: number; // (optional) (default to 1)
361
- let perPage: number; // (optional) (default to 20)
362
- let deviceId: string; // (optional) (default to undefined)
363
- let releaseId: string; // (optional) (default to undefined)
364
- let userId: string; // (optional) (default to undefined)
365
- let hideVerbose: boolean; // (optional) (default to undefined)
366
-
367
- const { status, data } = await apiInstance.getLogsInternalLogsGet(
368
- page,
369
- perPage,
370
- deviceId,
371
- releaseId,
372
- userId,
373
- hideVerbose
374
- );
375
- ```
376
-
377
- ### Parameters
378
-
379
- |Name | Type | Description | Notes|
380
- |------------- | ------------- | ------------- | -------------|
381
- | **page** | [**number**] | | (optional) defaults to 1|
382
- | **perPage** | [**number**] | | (optional) defaults to 20|
383
- | **deviceId** | [**string**] | | (optional) defaults to undefined|
384
- | **releaseId** | [**string**] | | (optional) defaults to undefined|
385
- | **userId** | [**string**] | | (optional) defaults to undefined|
386
- | **hideVerbose** | [**boolean**] | | (optional) defaults to undefined|
387
-
388
-
389
- ### Return type
390
-
391
- **LogListResponse**
392
-
393
- ### Authorization
394
-
395
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
396
-
397
- ### HTTP request headers
398
-
399
- - **Content-Type**: Not defined
400
- - **Accept**: application/json
401
-
402
-
403
- ### HTTP response details
404
- | Status code | Description | Response headers |
405
- |-------------|-------------|------------------|
406
- |**200** | Successful Response | - |
407
- |**422** | Validation Error | - |
408
-
409
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
410
-
411
- # **getReleaseInfoInternalReleasesReleaseIdGet**
412
- > ReleaseInternalResponse getReleaseInfoInternalReleasesReleaseIdGet()
413
-
414
- Get release information
415
-
416
- ### Example
417
-
418
- ```typescript
419
- import {
420
- InternalApi,
421
- Configuration
422
- } from '@orangefox-recovery/foxinternalclient';
423
-
424
- const configuration = new Configuration();
425
- const apiInstance = new InternalApi(configuration);
426
-
427
- let releaseId: string; // (default to undefined)
428
-
429
- const { status, data } = await apiInstance.getReleaseInfoInternalReleasesReleaseIdGet(
430
- releaseId
431
- );
432
- ```
433
-
434
- ### Parameters
435
-
436
- |Name | Type | Description | Notes|
437
- |------------- | ------------- | ------------- | -------------|
438
- | **releaseId** | [**string**] | | defaults to undefined|
439
-
440
-
441
- ### Return type
442
-
443
- **ReleaseInternalResponse**
444
-
445
- ### Authorization
446
-
447
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
448
-
449
- ### HTTP request headers
450
-
451
- - **Content-Type**: Not defined
452
- - **Accept**: application/json
453
-
454
-
455
- ### HTTP response details
456
- | Status code | Description | Response headers |
457
- |-------------|-------------|------------------|
458
- |**200** | Successful Response | - |
459
- |**422** | Validation Error | - |
460
-
461
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
462
-
463
- # **getReleaseZipInternalReleasesReleaseIdDlGet**
464
- > boolean getReleaseZipInternalReleasesReleaseIdDlGet()
465
-
466
- Download release ZIP directly
467
-
468
- ### Example
469
-
470
- ```typescript
471
- import {
472
- InternalApi,
473
- Configuration
474
- } from '@orangefox-recovery/foxinternalclient';
475
-
476
- const configuration = new Configuration();
477
- const apiInstance = new InternalApi(configuration);
478
-
479
- let releaseId: string; // (default to undefined)
480
-
481
- const { status, data } = await apiInstance.getReleaseZipInternalReleasesReleaseIdDlGet(
482
- releaseId
483
- );
484
- ```
485
-
486
- ### Parameters
487
-
488
- |Name | Type | Description | Notes|
489
- |------------- | ------------- | ------------- | -------------|
490
- | **releaseId** | [**string**] | | defaults to undefined|
491
-
492
-
493
- ### Return type
494
-
495
- **boolean**
496
-
497
- ### Authorization
498
-
499
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
500
-
501
- ### HTTP request headers
502
-
503
- - **Content-Type**: Not defined
504
- - **Accept**: application/json
505
-
506
-
507
- ### HTTP response details
508
- | Status code | Description | Response headers |
509
- |-------------|-------------|------------------|
510
- |**200** | Successful Response | - |
511
- |**422** | Validation Error | - |
512
-
513
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
514
-
515
- # **getUserByIdInternalUsersUserIdGet**
516
- > UserInternalResponse getUserByIdInternalUsersUserIdGet()
517
-
518
-
519
- ### Example
520
-
521
- ```typescript
522
- import {
523
- InternalApi,
524
- Configuration
525
- } from '@orangefox-recovery/foxinternalclient';
526
-
527
- const configuration = new Configuration();
528
- const apiInstance = new InternalApi(configuration);
529
-
530
- let userId: string; // (default to undefined)
531
-
532
- const { status, data } = await apiInstance.getUserByIdInternalUsersUserIdGet(
533
- userId
534
- );
535
- ```
536
-
537
- ### Parameters
538
-
539
- |Name | Type | Description | Notes|
540
- |------------- | ------------- | ------------- | -------------|
541
- | **userId** | [**string**] | | defaults to undefined|
542
-
543
-
544
- ### Return type
545
-
546
- **UserInternalResponse**
547
-
548
- ### Authorization
549
-
550
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
551
-
552
- ### HTTP request headers
553
-
554
- - **Content-Type**: Not defined
555
- - **Accept**: application/json
556
-
557
-
558
- ### HTTP response details
559
- | Status code | Description | Response headers |
560
- |-------------|-------------|------------------|
561
- |**200** | Successful Response | - |
562
- |**422** | Validation Error | - |
563
-
564
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
565
-
566
- # **listUsersInternalUsersGet**
567
- > ListResponseUserShortResponse listUsersInternalUsersGet()
568
-
569
-
570
- ### Example
571
-
572
- ```typescript
573
- import {
574
- InternalApi,
575
- Configuration
576
- } from '@orangefox-recovery/foxinternalclient';
577
-
578
- const configuration = new Configuration();
579
- const apiInstance = new InternalApi(configuration);
580
-
581
- const { status, data } = await apiInstance.listUsersInternalUsersGet();
582
- ```
583
-
584
- ### Parameters
585
- This endpoint does not have any parameters.
586
-
587
-
588
- ### Return type
589
-
590
- **ListResponseUserShortResponse**
591
-
592
- ### Authorization
593
-
594
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
595
-
596
- ### HTTP request headers
597
-
598
- - **Content-Type**: Not defined
599
- - **Accept**: application/json
600
-
601
-
602
- ### HTTP response details
603
- | Status code | Description | Response headers |
604
- |-------------|-------------|------------------|
605
- |**200** | Successful Response | - |
606
-
607
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
608
-
609
- # **loginOauthAuthLoginPost**
610
- > TokenResponse loginOauthAuthLoginPost()
611
-
612
- OAuth2 compatible token login, get an access token for future requests
613
-
614
- ### Example
615
-
616
- ```typescript
617
- import {
618
- InternalApi,
619
- Configuration
620
- } from '@orangefox-recovery/foxinternalclient';
621
-
622
- const configuration = new Configuration();
623
- const apiInstance = new InternalApi(configuration);
624
-
625
- let username: string; // (default to undefined)
626
- let password: string; // (default to undefined)
627
- let minTime: number; // (optional) (default to 0.3)
628
- let maxTime: number; // (optional) (default to 1)
629
- let grantType: string; // (optional) (default to undefined)
630
- let scope: string; // (optional) (default to '')
631
- let clientId: string; // (optional) (default to undefined)
632
- let clientSecret: string; // (optional) (default to undefined)
633
-
634
- const { status, data } = await apiInstance.loginOauthAuthLoginPost(
635
- username,
636
- password,
637
- minTime,
638
- maxTime,
639
- grantType,
640
- scope,
641
- clientId,
642
- clientSecret
643
- );
644
- ```
645
-
646
- ### Parameters
647
-
648
- |Name | Type | Description | Notes|
649
- |------------- | ------------- | ------------- | -------------|
650
- | **username** | [**string**] | | defaults to undefined|
651
- | **password** | [**string**] | | defaults to undefined|
652
- | **minTime** | [**number**] | | (optional) defaults to 0.3|
653
- | **maxTime** | [**number**] | | (optional) defaults to 1|
654
- | **grantType** | [**string**] | | (optional) defaults to undefined|
655
- | **scope** | [**string**] | | (optional) defaults to ''|
656
- | **clientId** | [**string**] | | (optional) defaults to undefined|
657
- | **clientSecret** | [**string**] | | (optional) defaults to undefined|
658
-
659
-
660
- ### Return type
661
-
662
- **TokenResponse**
663
-
664
- ### Authorization
665
-
666
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
667
-
668
- ### HTTP request headers
669
-
670
- - **Content-Type**: application/x-www-form-urlencoded
671
- - **Accept**: application/json
672
-
673
-
674
- ### HTTP response details
675
- | Status code | Description | Response headers |
676
- |-------------|-------------|------------------|
677
- |**200** | Successful Response | - |
678
- |**422** | Validation Error | - |
679
-
680
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
681
-
682
- # **logoutAuthLogoutPost**
683
- > any logoutAuthLogoutPost(body)
684
-
685
-
686
- ### Example
687
-
688
- ```typescript
689
- import {
690
- InternalApi,
691
- Configuration
692
- } from '@orangefox-recovery/foxinternalclient';
693
-
694
- const configuration = new Configuration();
695
- const apiInstance = new InternalApi(configuration);
696
-
697
- let body: string; //
698
-
699
- const { status, data } = await apiInstance.logoutAuthLogoutPost(
700
- body
701
- );
702
- ```
703
-
704
- ### Parameters
705
-
706
- |Name | Type | Description | Notes|
707
- |------------- | ------------- | ------------- | -------------|
708
- | **body** | **string**| | |
709
-
710
-
711
- ### Return type
712
-
713
- **any**
714
-
715
- ### Authorization
716
-
717
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
718
-
719
- ### HTTP request headers
720
-
721
- - **Content-Type**: application/json
722
- - **Accept**: application/json
723
-
724
-
725
- ### HTTP response details
726
- | Status code | Description | Response headers |
727
- |-------------|-------------|------------------|
728
- |**200** | Successful Response | - |
729
- |**422** | Validation Error | - |
730
-
731
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
732
-
733
- # **newDeviceInternalDevicesPost**
734
- > string newDeviceInternalDevicesPost(newDeviceBody)
735
-
736
-
737
- ### Example
738
-
739
- ```typescript
740
- import {
741
- InternalApi,
742
- Configuration,
743
- NewDeviceBody
744
- } from '@orangefox-recovery/foxinternalclient';
745
-
746
- const configuration = new Configuration();
747
- const apiInstance = new InternalApi(configuration);
748
-
749
- let newDeviceBody: NewDeviceBody; //
750
-
751
- const { status, data } = await apiInstance.newDeviceInternalDevicesPost(
752
- newDeviceBody
753
- );
754
- ```
755
-
756
- ### Parameters
757
-
758
- |Name | Type | Description | Notes|
759
- |------------- | ------------- | ------------- | -------------|
760
- | **newDeviceBody** | **NewDeviceBody**| | |
761
-
762
-
763
- ### Return type
764
-
765
- **string**
766
-
767
- ### Authorization
768
-
769
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
770
-
771
- ### HTTP request headers
772
-
773
- - **Content-Type**: application/json
774
- - **Accept**: application/json
775
-
776
-
777
- ### HTTP response details
778
- | Status code | Description | Response headers |
779
- |-------------|-------------|------------------|
780
- |**200** | Successful Response | - |
781
- |**422** | Validation Error | - |
782
-
783
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
784
-
785
- # **newReleaseInternalReleasesPost**
786
- > ReleaseResponse newReleaseInternalReleasesPost()
787
-
788
-
789
- ### Example
790
-
791
- ```typescript
792
- import {
793
- InternalApi,
794
- Configuration
795
- } from '@orangefox-recovery/foxinternalclient';
796
-
797
- const configuration = new Configuration();
798
- const apiInstance = new InternalApi(configuration);
799
-
800
- let deviceId: string; // (default to undefined)
801
- let releaseZip: File; // (default to undefined)
802
- let md5: string; // (default to undefined)
803
- let changelog: Array<string>; // (default to undefined)
804
- let bugs: Array<string>; // (optional) (default to undefined)
805
- let notes: string; // (optional) (default to undefined)
806
- let force: boolean; // (optional) (default to false)
807
-
808
- const { status, data } = await apiInstance.newReleaseInternalReleasesPost(
809
- deviceId,
810
- releaseZip,
811
- md5,
812
- changelog,
813
- bugs,
814
- notes,
815
- force
816
- );
817
- ```
818
-
819
- ### Parameters
820
-
821
- |Name | Type | Description | Notes|
822
- |------------- | ------------- | ------------- | -------------|
823
- | **deviceId** | [**string**] | | defaults to undefined|
824
- | **releaseZip** | [**File**] | | defaults to undefined|
825
- | **md5** | [**string**] | | defaults to undefined|
826
- | **changelog** | **Array&lt;string&gt;** | | defaults to undefined|
827
- | **bugs** | **Array&lt;string&gt;** | | (optional) defaults to undefined|
828
- | **notes** | [**string**] | | (optional) defaults to undefined|
829
- | **force** | [**boolean**] | | (optional) defaults to false|
830
-
831
-
832
- ### Return type
833
-
834
- **ReleaseResponse**
835
-
836
- ### Authorization
837
-
838
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
839
-
840
- ### HTTP request headers
841
-
842
- - **Content-Type**: multipart/form-data
843
- - **Accept**: application/json
844
-
845
-
846
- ### HTTP response details
847
- | Status code | Description | Response headers |
848
- |-------------|-------------|------------------|
849
- |**200** | Successful Response | - |
850
- |**422** | Validation Error | - |
851
-
852
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
853
-
854
- # **renewAuthRenewPost**
855
- > string renewAuthRenewPost(body)
856
-
857
-
858
- ### Example
859
-
860
- ```typescript
861
- import {
862
- InternalApi,
863
- Configuration
864
- } from '@orangefox-recovery/foxinternalclient';
865
-
866
- const configuration = new Configuration();
867
- const apiInstance = new InternalApi(configuration);
868
-
869
- let body: string; //
870
-
871
- const { status, data } = await apiInstance.renewAuthRenewPost(
872
- body
873
- );
874
- ```
875
-
876
- ### Parameters
877
-
878
- |Name | Type | Description | Notes|
879
- |------------- | ------------- | ------------- | -------------|
880
- | **body** | **string**| | |
881
-
882
-
883
- ### Return type
884
-
885
- **string**
886
-
887
- ### Authorization
888
-
889
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
890
-
891
- ### HTTP request headers
892
-
893
- - **Content-Type**: application/json
894
- - **Accept**: application/json
895
-
896
-
897
- ### HTTP response details
898
- | Status code | Description | Response headers |
899
- |-------------|-------------|------------------|
900
- |**200** | Successful Response | - |
901
- |**422** | Validation Error | - |
902
-
903
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
904
-
905
- # **updateDeviceInternalDevicesDeviceIdPut**
906
- > boolean updateDeviceInternalDevicesDeviceIdPut(deviceUpdateBody)
907
-
908
-
909
- ### Example
910
-
911
- ```typescript
912
- import {
913
- InternalApi,
914
- Configuration,
915
- DeviceUpdateBody
916
- } from '@orangefox-recovery/foxinternalclient';
917
-
918
- const configuration = new Configuration();
919
- const apiInstance = new InternalApi(configuration);
920
-
921
- let deviceId: string; // (default to undefined)
922
- let deviceUpdateBody: DeviceUpdateBody; //
923
-
924
- const { status, data } = await apiInstance.updateDeviceInternalDevicesDeviceIdPut(
925
- deviceId,
926
- deviceUpdateBody
927
- );
928
- ```
929
-
930
- ### Parameters
931
-
932
- |Name | Type | Description | Notes|
933
- |------------- | ------------- | ------------- | -------------|
934
- | **deviceUpdateBody** | **DeviceUpdateBody**| | |
935
- | **deviceId** | [**string**] | | defaults to undefined|
936
-
937
-
938
- ### Return type
939
-
940
- **boolean**
941
-
942
- ### Authorization
943
-
944
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
945
-
946
- ### HTTP request headers
947
-
948
- - **Content-Type**: application/json
949
- - **Accept**: application/json
950
-
951
-
952
- ### HTTP response details
953
- | Status code | Description | Response headers |
954
- |-------------|-------------|------------------|
955
- |**200** | Successful Response | - |
956
- |**422** | Validation Error | - |
957
-
958
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
959
-
960
- # **updatePasteInternalPastePasteIdPut**
961
- > PasteOutput updatePasteInternalPastePasteIdPut(pasteInput)
962
-
963
- Update a paste by ID. Requires admin permissions.
964
-
965
- ### Example
966
-
967
- ```typescript
968
- import {
969
- InternalApi,
970
- Configuration,
971
- PasteInput
972
- } from '@orangefox-recovery/foxinternalclient';
973
-
974
- const configuration = new Configuration();
975
- const apiInstance = new InternalApi(configuration);
976
-
977
- let pasteId: string; // (default to undefined)
978
- let pasteInput: PasteInput; //
979
-
980
- const { status, data } = await apiInstance.updatePasteInternalPastePasteIdPut(
981
- pasteId,
982
- pasteInput
983
- );
984
- ```
985
-
986
- ### Parameters
987
-
988
- |Name | Type | Description | Notes|
989
- |------------- | ------------- | ------------- | -------------|
990
- | **pasteInput** | **PasteInput**| | |
991
- | **pasteId** | [**string**] | | defaults to undefined|
992
-
993
-
994
- ### Return type
995
-
996
- **PasteOutput**
997
-
998
- ### Authorization
999
-
1000
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
1001
-
1002
- ### HTTP request headers
1003
-
1004
- - **Content-Type**: application/json
1005
- - **Accept**: application/json
1006
-
1007
-
1008
- ### HTTP response details
1009
- | Status code | Description | Response headers |
1010
- |-------------|-------------|------------------|
1011
- |**200** | Successful Response | - |
1012
- |**404** | Item not found | - |
1013
- |**429** | Too many requests | - |
1014
- |**422** | Validation Error | - |
1015
-
1016
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1017
-
1018
- # **updateUserInternalUsersUserIdPut**
1019
- > boolean updateUserInternalUsersUserIdPut(userUpdateBody)
1020
-
1021
-
1022
- ### Example
1023
-
1024
- ```typescript
1025
- import {
1026
- InternalApi,
1027
- Configuration,
1028
- UserUpdateBody
1029
- } from '@orangefox-recovery/foxinternalclient';
1030
-
1031
- const configuration = new Configuration();
1032
- const apiInstance = new InternalApi(configuration);
1033
-
1034
- let userId: string; // (default to undefined)
1035
- let userUpdateBody: UserUpdateBody; //
1036
-
1037
- const { status, data } = await apiInstance.updateUserInternalUsersUserIdPut(
1038
- userId,
1039
- userUpdateBody
1040
- );
1041
- ```
1042
-
1043
- ### Parameters
1044
-
1045
- |Name | Type | Description | Notes|
1046
- |------------- | ------------- | ------------- | -------------|
1047
- | **userUpdateBody** | **UserUpdateBody**| | |
1048
- | **userId** | [**string**] | | defaults to undefined|
1049
-
1050
-
1051
- ### Return type
1052
-
1053
- **boolean**
1054
-
1055
- ### Authorization
1056
-
1057
- [oauth2_password](../README.md#oauth2_password), [bearer_auth](../README.md#bearer_auth)
1058
-
1059
- ### HTTP request headers
1060
-
1061
- - **Content-Type**: application/json
1062
- - **Accept**: application/json
1063
-
1064
-
1065
- ### HTTP response details
1066
- | Status code | Description | Response headers |
1067
- |-------------|-------------|------------------|
1068
- |**200** | Successful Response | - |
1069
- |**422** | Validation Error | - |
1070
-
1071
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1072
-