@orangefox-recovery/foxclient 6.0.9 → 6.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (226) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/README.md +16 -4
  3. package/dist/apis/DeviceApi.d.ts +1 -1
  4. package/dist/apis/DeviceApi.js +1 -1
  5. package/dist/apis/PasteApi.d.ts +1 -1
  6. package/dist/apis/PasteApi.js +1 -1
  7. package/dist/apis/ReleaseApi.d.ts +5 -5
  8. package/dist/apis/ReleaseApi.js +3 -3
  9. package/dist/apis/ReportApi.d.ts +1 -1
  10. package/dist/apis/ReportApi.js +1 -1
  11. package/dist/apis/StatsApi.d.ts +1 -1
  12. package/dist/apis/StatsApi.js +1 -1
  13. package/dist/apis/UptimeApi.d.ts +1 -1
  14. package/dist/apis/UptimeApi.js +1 -1
  15. package/dist/apis/WikiApi.d.ts +219 -0
  16. package/dist/apis/WikiApi.js +245 -0
  17. package/dist/apis/index.d.ts +1 -0
  18. package/dist/apis/index.js +1 -0
  19. package/dist/esm/apis/DeviceApi.d.ts +1 -1
  20. package/dist/esm/apis/DeviceApi.js +1 -1
  21. package/dist/esm/apis/PasteApi.d.ts +1 -1
  22. package/dist/esm/apis/PasteApi.js +1 -1
  23. package/dist/esm/apis/ReleaseApi.d.ts +5 -5
  24. package/dist/esm/apis/ReleaseApi.js +3 -3
  25. package/dist/esm/apis/ReportApi.d.ts +1 -1
  26. package/dist/esm/apis/ReportApi.js +1 -1
  27. package/dist/esm/apis/StatsApi.d.ts +1 -1
  28. package/dist/esm/apis/StatsApi.js +1 -1
  29. package/dist/esm/apis/UptimeApi.d.ts +1 -1
  30. package/dist/esm/apis/UptimeApi.js +1 -1
  31. package/dist/esm/apis/WikiApi.d.ts +219 -0
  32. package/dist/esm/apis/WikiApi.js +241 -0
  33. package/dist/esm/apis/index.d.ts +1 -0
  34. package/dist/esm/apis/index.js +1 -0
  35. package/dist/esm/models/DeviceResponse.d.ts +1 -1
  36. package/dist/esm/models/DeviceResponse.js +1 -1
  37. package/dist/esm/models/ErrorResponse.d.ts +1 -1
  38. package/dist/esm/models/ErrorResponse.js +1 -1
  39. package/dist/esm/models/GlobalStatsResponse.d.ts +1 -1
  40. package/dist/esm/models/GlobalStatsResponse.js +1 -1
  41. package/dist/esm/models/ListResponseReleaseResponse.d.ts +12 -2
  42. package/dist/esm/models/ListResponseReleaseResponse.js +5 -1
  43. package/dist/esm/models/ListResponseReleaseResponseDataInner.d.ts +1 -1
  44. package/dist/esm/models/ListResponseReleaseResponseDataInner.js +1 -1
  45. package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +12 -2
  46. package/dist/esm/models/ListResponseShortDeviceResponse.js +5 -1
  47. package/dist/esm/models/ListResponseShortDeviceResponseDataInner.d.ts +1 -1
  48. package/dist/esm/models/ListResponseShortDeviceResponseDataInner.js +1 -1
  49. package/dist/esm/models/ListResponseString.d.ts +12 -2
  50. package/dist/esm/models/ListResponseString.js +5 -1
  51. package/dist/esm/models/ListResponseWikiPageShortResponse.d.ts +49 -0
  52. package/dist/esm/models/ListResponseWikiPageShortResponse.js +52 -0
  53. package/dist/esm/models/ListResponseWikiPageShortResponseDataInner.d.ts +99 -0
  54. package/dist/esm/models/ListResponseWikiPageShortResponseDataInner.js +81 -0
  55. package/dist/esm/models/ListResponseWikiSiteResponse.d.ts +49 -0
  56. package/dist/esm/models/ListResponseWikiSiteResponse.js +52 -0
  57. package/dist/esm/models/ListResponseWikiSiteResponseDataInner.d.ts +74 -0
  58. package/dist/esm/models/ListResponseWikiSiteResponseDataInner.js +65 -0
  59. package/dist/esm/models/MaintainerShortResponse.d.ts +1 -1
  60. package/dist/esm/models/MaintainerShortResponse.js +1 -1
  61. package/dist/esm/models/NewReportRequest.d.ts +1 -1
  62. package/dist/esm/models/NewReportRequest.js +1 -1
  63. package/dist/esm/models/PasteInput.d.ts +1 -1
  64. package/dist/esm/models/PasteInput.js +1 -1
  65. package/dist/esm/models/PasteResponse.d.ts +1 -1
  66. package/dist/esm/models/PasteResponse.js +1 -1
  67. package/dist/esm/models/RecoveryImgResponse.d.ts +1 -1
  68. package/dist/esm/models/RecoveryImgResponse.js +1 -1
  69. package/dist/esm/models/ReleaseGroupsResponse.d.ts +1 -1
  70. package/dist/esm/models/ReleaseGroupsResponse.js +1 -1
  71. package/dist/esm/models/ReleaseListResponse.d.ts +1 -1
  72. package/dist/esm/models/ReleaseListResponse.js +1 -1
  73. package/dist/esm/models/ReleaseResponse.d.ts +1 -1
  74. package/dist/esm/models/ReleaseResponse.js +1 -1
  75. package/dist/esm/models/ShortDeviceResponse.d.ts +1 -1
  76. package/dist/esm/models/ShortDeviceResponse.js +1 -1
  77. package/dist/esm/models/ShortReleaseResponse.d.ts +1 -1
  78. package/dist/esm/models/ShortReleaseResponse.js +1 -1
  79. package/dist/esm/models/TokenResponse.d.ts +1 -1
  80. package/dist/esm/models/TokenResponse.js +1 -1
  81. package/dist/esm/models/UptimeHealth.d.ts +1 -1
  82. package/dist/esm/models/UptimeHealth.js +1 -1
  83. package/dist/esm/models/UptimeHealthHost.d.ts +1 -1
  84. package/dist/esm/models/UptimeHealthHost.js +1 -1
  85. package/dist/esm/models/UptimeMonitor.d.ts +1 -1
  86. package/dist/esm/models/UptimeMonitor.js +1 -1
  87. package/dist/esm/models/UptimeMonitorGroup.d.ts +1 -1
  88. package/dist/esm/models/UptimeMonitorGroup.js +1 -1
  89. package/dist/esm/models/UptimeMonitors.d.ts +1 -1
  90. package/dist/esm/models/UptimeMonitors.js +1 -1
  91. package/dist/esm/models/UptimeResponse.d.ts +1 -1
  92. package/dist/esm/models/UptimeResponse.js +1 -1
  93. package/dist/esm/models/WikiPageResponse.d.ts +128 -0
  94. package/dist/esm/models/WikiPageResponse.js +97 -0
  95. package/dist/esm/models/WikiPageShortResponse.d.ts +99 -0
  96. package/dist/esm/models/WikiPageShortResponse.js +81 -0
  97. package/dist/esm/models/WikiSiteResponse.d.ts +74 -0
  98. package/dist/esm/models/WikiSiteResponse.js +65 -0
  99. package/dist/esm/models/index.d.ts +7 -0
  100. package/dist/esm/models/index.js +7 -0
  101. package/dist/esm/runtime.d.ts +1 -1
  102. package/dist/esm/runtime.js +1 -1
  103. package/dist/models/DeviceResponse.d.ts +1 -1
  104. package/dist/models/DeviceResponse.js +1 -1
  105. package/dist/models/ErrorResponse.d.ts +1 -1
  106. package/dist/models/ErrorResponse.js +1 -1
  107. package/dist/models/GlobalStatsResponse.d.ts +1 -1
  108. package/dist/models/GlobalStatsResponse.js +1 -1
  109. package/dist/models/ListResponseReleaseResponse.d.ts +12 -2
  110. package/dist/models/ListResponseReleaseResponse.js +5 -1
  111. package/dist/models/ListResponseReleaseResponseDataInner.d.ts +1 -1
  112. package/dist/models/ListResponseReleaseResponseDataInner.js +1 -1
  113. package/dist/models/ListResponseShortDeviceResponse.d.ts +12 -2
  114. package/dist/models/ListResponseShortDeviceResponse.js +5 -1
  115. package/dist/models/ListResponseShortDeviceResponseDataInner.d.ts +1 -1
  116. package/dist/models/ListResponseShortDeviceResponseDataInner.js +1 -1
  117. package/dist/models/ListResponseString.d.ts +12 -2
  118. package/dist/models/ListResponseString.js +5 -1
  119. package/dist/models/ListResponseWikiPageShortResponse.d.ts +49 -0
  120. package/dist/models/ListResponseWikiPageShortResponse.js +59 -0
  121. package/dist/models/ListResponseWikiPageShortResponseDataInner.d.ts +99 -0
  122. package/dist/models/ListResponseWikiPageShortResponseDataInner.js +88 -0
  123. package/dist/models/ListResponseWikiSiteResponse.d.ts +49 -0
  124. package/dist/models/ListResponseWikiSiteResponse.js +59 -0
  125. package/dist/models/ListResponseWikiSiteResponseDataInner.d.ts +74 -0
  126. package/dist/models/ListResponseWikiSiteResponseDataInner.js +72 -0
  127. package/dist/models/MaintainerShortResponse.d.ts +1 -1
  128. package/dist/models/MaintainerShortResponse.js +1 -1
  129. package/dist/models/NewReportRequest.d.ts +1 -1
  130. package/dist/models/NewReportRequest.js +1 -1
  131. package/dist/models/PasteInput.d.ts +1 -1
  132. package/dist/models/PasteInput.js +1 -1
  133. package/dist/models/PasteResponse.d.ts +1 -1
  134. package/dist/models/PasteResponse.js +1 -1
  135. package/dist/models/RecoveryImgResponse.d.ts +1 -1
  136. package/dist/models/RecoveryImgResponse.js +1 -1
  137. package/dist/models/ReleaseGroupsResponse.d.ts +1 -1
  138. package/dist/models/ReleaseGroupsResponse.js +1 -1
  139. package/dist/models/ReleaseListResponse.d.ts +1 -1
  140. package/dist/models/ReleaseListResponse.js +1 -1
  141. package/dist/models/ReleaseResponse.d.ts +1 -1
  142. package/dist/models/ReleaseResponse.js +1 -1
  143. package/dist/models/ShortDeviceResponse.d.ts +1 -1
  144. package/dist/models/ShortDeviceResponse.js +1 -1
  145. package/dist/models/ShortReleaseResponse.d.ts +1 -1
  146. package/dist/models/ShortReleaseResponse.js +1 -1
  147. package/dist/models/TokenResponse.d.ts +1 -1
  148. package/dist/models/TokenResponse.js +1 -1
  149. package/dist/models/UptimeHealth.d.ts +1 -1
  150. package/dist/models/UptimeHealth.js +1 -1
  151. package/dist/models/UptimeHealthHost.d.ts +1 -1
  152. package/dist/models/UptimeHealthHost.js +1 -1
  153. package/dist/models/UptimeMonitor.d.ts +1 -1
  154. package/dist/models/UptimeMonitor.js +1 -1
  155. package/dist/models/UptimeMonitorGroup.d.ts +1 -1
  156. package/dist/models/UptimeMonitorGroup.js +1 -1
  157. package/dist/models/UptimeMonitors.d.ts +1 -1
  158. package/dist/models/UptimeMonitors.js +1 -1
  159. package/dist/models/UptimeResponse.d.ts +1 -1
  160. package/dist/models/UptimeResponse.js +1 -1
  161. package/dist/models/WikiPageResponse.d.ts +128 -0
  162. package/dist/models/WikiPageResponse.js +104 -0
  163. package/dist/models/WikiPageShortResponse.d.ts +99 -0
  164. package/dist/models/WikiPageShortResponse.js +88 -0
  165. package/dist/models/WikiSiteResponse.d.ts +74 -0
  166. package/dist/models/WikiSiteResponse.js +72 -0
  167. package/dist/models/index.d.ts +7 -0
  168. package/dist/models/index.js +7 -0
  169. package/dist/runtime.d.ts +1 -1
  170. package/dist/runtime.js +1 -1
  171. package/docs/ListResponseReleaseResponse.md +2 -0
  172. package/docs/ListResponseShortDeviceResponse.md +2 -0
  173. package/docs/ListResponseString.md +2 -0
  174. package/docs/ListResponseWikiPageShortResponse.md +38 -0
  175. package/docs/ListResponseWikiPageShortResponseDataInner.md +57 -0
  176. package/docs/ListResponseWikiSiteResponse.md +38 -0
  177. package/docs/ListResponseWikiSiteResponseDataInner.md +48 -0
  178. package/docs/ReleaseApi.md +2 -2
  179. package/docs/ReleaseListResponse.md +2 -0
  180. package/docs/WikiApi.md +360 -0
  181. package/docs/WikiPageResponse.md +66 -0
  182. package/docs/WikiPageShortResponse.md +57 -0
  183. package/docs/WikiSiteResponse.md +48 -0
  184. package/package.json +1 -1
  185. package/src/apis/DeviceApi.ts +1 -1
  186. package/src/apis/PasteApi.ts +1 -1
  187. package/src/apis/ReleaseApi.ts +5 -5
  188. package/src/apis/ReportApi.ts +1 -1
  189. package/src/apis/StatsApi.ts +1 -1
  190. package/src/apis/UptimeApi.ts +1 -1
  191. package/src/apis/WikiApi.ts +452 -0
  192. package/src/apis/index.ts +1 -0
  193. package/src/models/DeviceResponse.ts +1 -1
  194. package/src/models/ErrorResponse.ts +1 -1
  195. package/src/models/GlobalStatsResponse.ts +1 -1
  196. package/src/models/ListResponseReleaseResponse.ts +15 -2
  197. package/src/models/ListResponseReleaseResponseDataInner.ts +1 -1
  198. package/src/models/ListResponseShortDeviceResponse.ts +15 -2
  199. package/src/models/ListResponseShortDeviceResponseDataInner.ts +1 -1
  200. package/src/models/ListResponseString.ts +15 -2
  201. package/src/models/ListResponseWikiPageShortResponse.ts +96 -0
  202. package/src/models/ListResponseWikiPageShortResponseDataInner.ts +163 -0
  203. package/src/models/ListResponseWikiSiteResponse.ts +96 -0
  204. package/src/models/ListResponseWikiSiteResponseDataInner.ts +126 -0
  205. package/src/models/MaintainerShortResponse.ts +1 -1
  206. package/src/models/NewReportRequest.ts +1 -1
  207. package/src/models/PasteInput.ts +1 -1
  208. package/src/models/PasteResponse.ts +1 -1
  209. package/src/models/RecoveryImgResponse.ts +1 -1
  210. package/src/models/ReleaseGroupsResponse.ts +1 -1
  211. package/src/models/ReleaseListResponse.ts +1 -1
  212. package/src/models/ReleaseResponse.ts +1 -1
  213. package/src/models/ShortDeviceResponse.ts +1 -1
  214. package/src/models/ShortReleaseResponse.ts +1 -1
  215. package/src/models/TokenResponse.ts +1 -1
  216. package/src/models/UptimeHealth.ts +1 -1
  217. package/src/models/UptimeHealthHost.ts +1 -1
  218. package/src/models/UptimeMonitor.ts +1 -1
  219. package/src/models/UptimeMonitorGroup.ts +1 -1
  220. package/src/models/UptimeMonitors.ts +1 -1
  221. package/src/models/UptimeResponse.ts +1 -1
  222. package/src/models/WikiPageResponse.ts +205 -0
  223. package/src/models/WikiPageShortResponse.ts +163 -0
  224. package/src/models/WikiSiteResponse.ts +126 -0
  225. package/src/models/index.ts +7 -0
  226. package/src/runtime.ts +1 -1
@@ -11,6 +11,10 @@ docs/ListResponseReleaseResponseDataInner.md
11
11
  docs/ListResponseShortDeviceResponse.md
12
12
  docs/ListResponseShortDeviceResponseDataInner.md
13
13
  docs/ListResponseString.md
14
+ docs/ListResponseWikiPageShortResponse.md
15
+ docs/ListResponseWikiPageShortResponseDataInner.md
16
+ docs/ListResponseWikiSiteResponse.md
17
+ docs/ListResponseWikiSiteResponseDataInner.md
14
18
  docs/MaintainerShortResponse.md
15
19
  docs/NewReportRequest.md
16
20
  docs/PasteApi.md
@@ -33,6 +37,10 @@ docs/UptimeMonitor.md
33
37
  docs/UptimeMonitorGroup.md
34
38
  docs/UptimeMonitors.md
35
39
  docs/UptimeResponse.md
40
+ docs/WikiApi.md
41
+ docs/WikiPageResponse.md
42
+ docs/WikiPageShortResponse.md
43
+ docs/WikiSiteResponse.md
36
44
  package.json
37
45
  src/apis/DeviceApi.ts
38
46
  src/apis/PasteApi.ts
@@ -40,6 +48,7 @@ src/apis/ReleaseApi.ts
40
48
  src/apis/ReportApi.ts
41
49
  src/apis/StatsApi.ts
42
50
  src/apis/UptimeApi.ts
51
+ src/apis/WikiApi.ts
43
52
  src/apis/index.ts
44
53
  src/index.ts
45
54
  src/models/DeviceResponse.ts
@@ -50,6 +59,10 @@ src/models/ListResponseReleaseResponseDataInner.ts
50
59
  src/models/ListResponseShortDeviceResponse.ts
51
60
  src/models/ListResponseShortDeviceResponseDataInner.ts
52
61
  src/models/ListResponseString.ts
62
+ src/models/ListResponseWikiPageShortResponse.ts
63
+ src/models/ListResponseWikiPageShortResponseDataInner.ts
64
+ src/models/ListResponseWikiSiteResponse.ts
65
+ src/models/ListResponseWikiSiteResponseDataInner.ts
53
66
  src/models/MaintainerShortResponse.ts
54
67
  src/models/NewReportRequest.ts
55
68
  src/models/PasteInput.ts
@@ -67,6 +80,9 @@ src/models/UptimeMonitor.ts
67
80
  src/models/UptimeMonitorGroup.ts
68
81
  src/models/UptimeMonitors.ts
69
82
  src/models/UptimeResponse.ts
83
+ src/models/WikiPageResponse.ts
84
+ src/models/WikiPageShortResponse.ts
85
+ src/models/WikiSiteResponse.ts
70
86
  src/models/index.ts
71
87
  src/runtime.ts
72
88
  tsconfig.esm.json
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @orangefox-recovery/foxclient@6.0.9
1
+ # @orangefox-recovery/foxclient@6.1.0
2
2
 
3
3
  A TypeScript SDK client for the api.orangefox.download API.
4
4
 
@@ -64,10 +64,15 @@ All URIs are relative to *https://api.orangefox.download*
64
64
  *ReleaseApi* | [**getRelease**](docs/ReleaseApi.md#getrelease) | **GET** /releases/get | GET /releases/get - Get a single release.
65
65
  *ReleaseApi* | [**getReleaseById**](docs/ReleaseApi.md#getreleasebyid) | **GET** /releases/{release_id} | GET /releases/{release_id} - Get release by ID (deprecated).
66
66
  *ReleaseApi* | [**getUpdatesAfter**](docs/ReleaseApi.md#getupdatesafter) | **GET** /updates/{last_known_id} | GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).
67
- *ReleaseApi* | [**listReleases**](docs/ReleaseApi.md#listreleases) | **GET** /releases | GET /releases/ - List releases with filters.
67
+ *ReleaseApi* | [**listReleases**](docs/ReleaseApi.md#listreleases) | **GET** /releases | Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
68
68
  *ReportApi* | [**newReport**](docs/ReportApi.md#newreportoperation) | **POST** /report/{release_id} | POST /report/{release_id} - Submit a bug report.
69
69
  *StatsApi* | [**getGlobalStats**](docs/StatsApi.md#getglobalstats) | **GET** /stats | GET /stats/ - Get global download statistics.
70
70
  *UptimeApi* | [**getUptime**](docs/UptimeApi.md#getuptime) | **GET** /uptime | GET /uptime - Aggregated public infrastructure status.
71
+ *WikiApi* | [**getAsset**](docs/WikiApi.md#getasset) | **GET** /wiki/{site}/assets/{path} | GET /wiki/{site}/assets/{path} - Serve asset bytes.
72
+ *WikiApi* | [**getPage**](docs/WikiApi.md#getpage) | **GET** /wiki/{site}/pages/{path} | GET /wiki/{site}/pages/{path} - Fetch one published page.
73
+ *WikiApi* | [**getSite**](docs/WikiApi.md#getsite) | **GET** /wiki/sites/{slug} | GET /wiki/sites/{slug} - Fetch one wiki site.
74
+ *WikiApi* | [**listPages**](docs/WikiApi.md#listpages) | **GET** /wiki/{site}/pages | GET /wiki/{site}/pages - List every published page in a site.
75
+ *WikiApi* | [**listSites**](docs/WikiApi.md#listsites) | **GET** /wiki/sites | GET /wiki/sites - List wiki sites.
71
76
 
72
77
 
73
78
  ### Models
@@ -80,6 +85,10 @@ All URIs are relative to *https://api.orangefox.download*
80
85
  - [ListResponseShortDeviceResponse](docs/ListResponseShortDeviceResponse.md)
81
86
  - [ListResponseShortDeviceResponseDataInner](docs/ListResponseShortDeviceResponseDataInner.md)
82
87
  - [ListResponseString](docs/ListResponseString.md)
88
+ - [ListResponseWikiPageShortResponse](docs/ListResponseWikiPageShortResponse.md)
89
+ - [ListResponseWikiPageShortResponseDataInner](docs/ListResponseWikiPageShortResponseDataInner.md)
90
+ - [ListResponseWikiSiteResponse](docs/ListResponseWikiSiteResponse.md)
91
+ - [ListResponseWikiSiteResponseDataInner](docs/ListResponseWikiSiteResponseDataInner.md)
83
92
  - [MaintainerShortResponse](docs/MaintainerShortResponse.md)
84
93
  - [NewReportRequest](docs/NewReportRequest.md)
85
94
  - [PasteInput](docs/PasteInput.md)
@@ -97,6 +106,9 @@ All URIs are relative to *https://api.orangefox.download*
97
106
  - [UptimeMonitorGroup](docs/UptimeMonitorGroup.md)
98
107
  - [UptimeMonitors](docs/UptimeMonitors.md)
99
108
  - [UptimeResponse](docs/UptimeResponse.md)
109
+ - [WikiPageResponse](docs/WikiPageResponse.md)
110
+ - [WikiPageShortResponse](docs/WikiPageShortResponse.md)
111
+ - [WikiSiteResponse](docs/WikiSiteResponse.md)
100
112
 
101
113
  ### Authorization
102
114
 
@@ -114,8 +126,8 @@ This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.or
114
126
  and is automatically generated by the
115
127
  [OpenAPI Generator](https://openapi-generator.tech) project:
116
128
 
117
- - API version: `6.0.9`
118
- - Package version: `6.0.9`
129
+ - API version: `6.1.0`
130
+ - Package version: `6.1.0`
119
131
  - Generator version: `7.21.0`
120
132
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
121
133
 
@@ -2,7 +2,7 @@
2
2
  * Fox API
3
3
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
4
4
  *
5
- * The version of the OpenAPI document: 6.0.9
5
+ * The version of the OpenAPI document: 6.1.0
6
6
  * Contact: admin@orangefox.tech
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Fox API
6
6
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
7
7
  *
8
- * The version of the OpenAPI document: 6.0.9
8
+ * The version of the OpenAPI document: 6.1.0
9
9
  * Contact: admin@orangefox.tech
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Fox API
3
3
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
4
4
  *
5
- * The version of the OpenAPI document: 6.0.9
5
+ * The version of the OpenAPI document: 6.1.0
6
6
  * Contact: admin@orangefox.tech
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Fox API
6
6
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
7
7
  *
8
- * The version of the OpenAPI document: 6.0.9
8
+ * The version of the OpenAPI document: 6.1.0
9
9
  * Contact: admin@orangefox.tech
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Fox API
3
3
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
4
4
  *
5
- * The version of the OpenAPI document: 6.0.9
5
+ * The version of the OpenAPI document: 6.1.0
6
6
  * Contact: admin@orangefox.tech
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -163,7 +163,7 @@ export interface ReleaseApiInterface {
163
163
  listReleasesRequestOpts(requestParameters: ListReleasesRequest): Promise<runtime.RequestOpts>;
164
164
  /**
165
165
  *
166
- * @summary GET /releases/ - List releases with filters.
166
+ * @summary Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
167
167
  * @param {string} [id]
168
168
  * @param {string} [id2]
169
169
  * @param {string} [buildId]
@@ -186,7 +186,7 @@ export interface ReleaseApiInterface {
186
186
  */
187
187
  listReleasesRaw(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseListResponse>>;
188
188
  /**
189
- * GET /releases/ - List releases with filters.
189
+ * Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
190
190
  */
191
191
  listReleases(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseListResponse>;
192
192
  }
@@ -251,11 +251,11 @@ export declare class ReleaseApi extends runtime.BaseAPI implements ReleaseApiInt
251
251
  */
252
252
  listReleasesRequestOpts(requestParameters: ListReleasesRequest): Promise<runtime.RequestOpts>;
253
253
  /**
254
- * GET /releases/ - List releases with filters.
254
+ * Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
255
255
  */
256
256
  listReleasesRaw(requestParameters: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseListResponse>>;
257
257
  /**
258
- * GET /releases/ - List releases with filters.
258
+ * Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
259
259
  */
260
260
  listReleases(requestParameters?: ListReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseListResponse>;
261
261
  }
@@ -5,7 +5,7 @@
5
5
  * Fox API
6
6
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
7
7
  *
8
- * The version of the OpenAPI document: 6.0.9
8
+ * The version of the OpenAPI document: 6.1.0
9
9
  * Contact: admin@orangefox.tech
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -261,7 +261,7 @@ class ReleaseApi extends runtime.BaseAPI {
261
261
  });
262
262
  }
263
263
  /**
264
- * GET /releases/ - List releases with filters.
264
+ * Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
265
265
  */
266
266
  listReleasesRaw(requestParameters, initOverrides) {
267
267
  return __awaiter(this, void 0, void 0, function* () {
@@ -271,7 +271,7 @@ class ReleaseApi extends runtime.BaseAPI {
271
271
  });
272
272
  }
273
273
  /**
274
- * GET /releases/ - List releases with filters.
274
+ * Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
275
275
  */
276
276
  listReleases() {
277
277
  return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
@@ -2,7 +2,7 @@
2
2
  * Fox API
3
3
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
4
4
  *
5
- * The version of the OpenAPI document: 6.0.9
5
+ * The version of the OpenAPI document: 6.1.0
6
6
  * Contact: admin@orangefox.tech
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Fox API
6
6
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
7
7
  *
8
- * The version of the OpenAPI document: 6.0.9
8
+ * The version of the OpenAPI document: 6.1.0
9
9
  * Contact: admin@orangefox.tech
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Fox API
3
3
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
4
4
  *
5
- * The version of the OpenAPI document: 6.0.9
5
+ * The version of the OpenAPI document: 6.1.0
6
6
  * Contact: admin@orangefox.tech
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Fox API
6
6
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
7
7
  *
8
- * The version of the OpenAPI document: 6.0.9
8
+ * The version of the OpenAPI document: 6.1.0
9
9
  * Contact: admin@orangefox.tech
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Fox API
3
3
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
4
4
  *
5
- * The version of the OpenAPI document: 6.0.9
5
+ * The version of the OpenAPI document: 6.1.0
6
6
  * Contact: admin@orangefox.tech
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Fox API
6
6
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
7
7
  *
8
- * The version of the OpenAPI document: 6.0.9
8
+ * The version of the OpenAPI document: 6.1.0
9
9
  * Contact: admin@orangefox.tech
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,219 @@
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: 6.1.0
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 * as runtime from '../runtime';
13
+ import type { ListResponseWikiPageShortResponse, ListResponseWikiSiteResponse, WikiPageResponse, WikiSiteResponse } from '../models/index';
14
+ export interface GetAssetRequest {
15
+ site: string;
16
+ path: string;
17
+ }
18
+ export interface GetPageRequest {
19
+ site: string;
20
+ path: string;
21
+ }
22
+ export interface GetSiteRequest {
23
+ slug: string;
24
+ }
25
+ export interface ListPagesRequest {
26
+ site: string;
27
+ skip?: number | null;
28
+ limit?: number | null;
29
+ }
30
+ export interface ListSitesRequest {
31
+ skip?: number | null;
32
+ limit?: number | null;
33
+ }
34
+ /**
35
+ * WikiApi - interface
36
+ *
37
+ * @export
38
+ * @interface WikiApiInterface
39
+ */
40
+ export interface WikiApiInterface {
41
+ /**
42
+ * Creates request options for getAsset without sending the request
43
+ * @param {string} site Site slug
44
+ * @param {string} path Asset path, e.g. images/waving.png
45
+ * @throws {RequiredError}
46
+ * @memberof WikiApiInterface
47
+ */
48
+ getAssetRequestOpts(requestParameters: GetAssetRequest): Promise<runtime.RequestOpts>;
49
+ /**
50
+ *
51
+ * @summary GET /wiki/{site}/assets/{path} - Serve asset bytes.
52
+ * @param {string} site Site slug
53
+ * @param {string} path Asset path, e.g. images/waving.png
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ * @memberof WikiApiInterface
57
+ */
58
+ getAssetRaw(requestParameters: GetAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
59
+ /**
60
+ * GET /wiki/{site}/assets/{path} - Serve asset bytes.
61
+ */
62
+ getAsset(requestParameters: GetAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
63
+ /**
64
+ * Creates request options for getPage without sending the request
65
+ * @param {string} site Site slug
66
+ * @param {string} path Page path, e.g. Installation/Windows
67
+ * @throws {RequiredError}
68
+ * @memberof WikiApiInterface
69
+ */
70
+ getPageRequestOpts(requestParameters: GetPageRequest): Promise<runtime.RequestOpts>;
71
+ /**
72
+ *
73
+ * @summary GET /wiki/{site}/pages/{path} - Fetch one published page.
74
+ * @param {string} site Site slug
75
+ * @param {string} path Page path, e.g. Installation/Windows
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ * @memberof WikiApiInterface
79
+ */
80
+ getPageRaw(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WikiPageResponse>>;
81
+ /**
82
+ * GET /wiki/{site}/pages/{path} - Fetch one published page.
83
+ */
84
+ getPage(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WikiPageResponse>;
85
+ /**
86
+ * Creates request options for getSite without sending the request
87
+ * @param {string} slug Site slug
88
+ * @throws {RequiredError}
89
+ * @memberof WikiApiInterface
90
+ */
91
+ getSiteRequestOpts(requestParameters: GetSiteRequest): Promise<runtime.RequestOpts>;
92
+ /**
93
+ *
94
+ * @summary GET /wiki/sites/{slug} - Fetch one wiki site.
95
+ * @param {string} slug Site slug
96
+ * @param {*} [options] Override http request option.
97
+ * @throws {RequiredError}
98
+ * @memberof WikiApiInterface
99
+ */
100
+ getSiteRaw(requestParameters: GetSiteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WikiSiteResponse>>;
101
+ /**
102
+ * GET /wiki/sites/{slug} - Fetch one wiki site.
103
+ */
104
+ getSite(requestParameters: GetSiteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WikiSiteResponse>;
105
+ /**
106
+ * Creates request options for listPages without sending the request
107
+ * @param {string} site Site slug
108
+ * @param {number} [skip]
109
+ * @param {number} [limit]
110
+ * @throws {RequiredError}
111
+ * @memberof WikiApiInterface
112
+ */
113
+ listPagesRequestOpts(requestParameters: ListPagesRequest): Promise<runtime.RequestOpts>;
114
+ /**
115
+ * FoxWiki builds its whole navigation tree from one call to this, so it returns the complete flat set (paged at the standard 1000 ceiling) rather than one folder\'s children.
116
+ * @summary GET /wiki/{site}/pages - List every published page in a site.
117
+ * @param {string} site Site slug
118
+ * @param {number} [skip]
119
+ * @param {number} [limit]
120
+ * @param {*} [options] Override http request option.
121
+ * @throws {RequiredError}
122
+ * @memberof WikiApiInterface
123
+ */
124
+ listPagesRaw(requestParameters: ListPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseWikiPageShortResponse>>;
125
+ /**
126
+ * FoxWiki builds its whole navigation tree from one call to this, so it returns the complete flat set (paged at the standard 1000 ceiling) rather than one folder\'s children.
127
+ * GET /wiki/{site}/pages - List every published page in a site.
128
+ */
129
+ listPages(requestParameters: ListPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseWikiPageShortResponse>;
130
+ /**
131
+ * Creates request options for listSites without sending the request
132
+ * @param {number} [skip]
133
+ * @param {number} [limit]
134
+ * @throws {RequiredError}
135
+ * @memberof WikiApiInterface
136
+ */
137
+ listSitesRequestOpts(requestParameters: ListSitesRequest): Promise<runtime.RequestOpts>;
138
+ /**
139
+ *
140
+ * @summary GET /wiki/sites - List wiki sites.
141
+ * @param {number} [skip]
142
+ * @param {number} [limit]
143
+ * @param {*} [options] Override http request option.
144
+ * @throws {RequiredError}
145
+ * @memberof WikiApiInterface
146
+ */
147
+ listSitesRaw(requestParameters: ListSitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseWikiSiteResponse>>;
148
+ /**
149
+ * GET /wiki/sites - List wiki sites.
150
+ */
151
+ listSites(requestParameters: ListSitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseWikiSiteResponse>;
152
+ }
153
+ /**
154
+ *
155
+ */
156
+ export declare class WikiApi extends runtime.BaseAPI implements WikiApiInterface {
157
+ /**
158
+ * Creates request options for getAsset without sending the request
159
+ */
160
+ getAssetRequestOpts(requestParameters: GetAssetRequest): Promise<runtime.RequestOpts>;
161
+ /**
162
+ * GET /wiki/{site}/assets/{path} - Serve asset bytes.
163
+ */
164
+ getAssetRaw(requestParameters: GetAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
165
+ /**
166
+ * GET /wiki/{site}/assets/{path} - Serve asset bytes.
167
+ */
168
+ getAsset(requestParameters: GetAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
169
+ /**
170
+ * Creates request options for getPage without sending the request
171
+ */
172
+ getPageRequestOpts(requestParameters: GetPageRequest): Promise<runtime.RequestOpts>;
173
+ /**
174
+ * GET /wiki/{site}/pages/{path} - Fetch one published page.
175
+ */
176
+ getPageRaw(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WikiPageResponse>>;
177
+ /**
178
+ * GET /wiki/{site}/pages/{path} - Fetch one published page.
179
+ */
180
+ getPage(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WikiPageResponse>;
181
+ /**
182
+ * Creates request options for getSite without sending the request
183
+ */
184
+ getSiteRequestOpts(requestParameters: GetSiteRequest): Promise<runtime.RequestOpts>;
185
+ /**
186
+ * GET /wiki/sites/{slug} - Fetch one wiki site.
187
+ */
188
+ getSiteRaw(requestParameters: GetSiteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WikiSiteResponse>>;
189
+ /**
190
+ * GET /wiki/sites/{slug} - Fetch one wiki site.
191
+ */
192
+ getSite(requestParameters: GetSiteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WikiSiteResponse>;
193
+ /**
194
+ * Creates request options for listPages without sending the request
195
+ */
196
+ listPagesRequestOpts(requestParameters: ListPagesRequest): Promise<runtime.RequestOpts>;
197
+ /**
198
+ * FoxWiki builds its whole navigation tree from one call to this, so it returns the complete flat set (paged at the standard 1000 ceiling) rather than one folder\'s children.
199
+ * GET /wiki/{site}/pages - List every published page in a site.
200
+ */
201
+ listPagesRaw(requestParameters: ListPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseWikiPageShortResponse>>;
202
+ /**
203
+ * FoxWiki builds its whole navigation tree from one call to this, so it returns the complete flat set (paged at the standard 1000 ceiling) rather than one folder\'s children.
204
+ * GET /wiki/{site}/pages - List every published page in a site.
205
+ */
206
+ listPages(requestParameters: ListPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseWikiPageShortResponse>;
207
+ /**
208
+ * Creates request options for listSites without sending the request
209
+ */
210
+ listSitesRequestOpts(requestParameters: ListSitesRequest): Promise<runtime.RequestOpts>;
211
+ /**
212
+ * GET /wiki/sites - List wiki sites.
213
+ */
214
+ listSitesRaw(requestParameters: ListSitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseWikiSiteResponse>>;
215
+ /**
216
+ * GET /wiki/sites - List wiki sites.
217
+ */
218
+ listSites(requestParameters?: ListSitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseWikiSiteResponse>;
219
+ }