@orangefox-recovery/foxclient 6.0.10 → 6.1.1

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 (235) hide show
  1. package/.openapi-generator/FILES +18 -0
  2. package/README.md +16 -3
  3. package/dist/apis/DeviceApi.d.ts +1 -1
  4. package/dist/apis/DeviceApi.js +35 -2
  5. package/dist/apis/PasteApi.d.ts +1 -1
  6. package/dist/apis/PasteApi.js +35 -2
  7. package/dist/apis/ReleaseApi.d.ts +5 -5
  8. package/dist/apis/ReleaseApi.js +35 -2
  9. package/dist/apis/ReportApi.d.ts +1 -1
  10. package/dist/apis/ReportApi.js +35 -2
  11. package/dist/apis/StatsApi.d.ts +1 -1
  12. package/dist/apis/StatsApi.js +35 -2
  13. package/dist/apis/UptimeApi.d.ts +1 -1
  14. package/dist/apis/UptimeApi.js +35 -2
  15. package/dist/apis/WikiApi.d.ts +219 -0
  16. package/dist/apis/WikiApi.js +278 -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 +1 -1
  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 +15 -1
  70. package/dist/esm/models/ReleaseGroupsResponse.js +5 -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/ReleaseSort.d.ts +31 -0
  76. package/dist/esm/models/ReleaseSort.js +49 -0
  77. package/dist/esm/models/ShortDeviceResponse.d.ts +1 -1
  78. package/dist/esm/models/ShortDeviceResponse.js +1 -1
  79. package/dist/esm/models/ShortReleaseResponse.d.ts +1 -1
  80. package/dist/esm/models/ShortReleaseResponse.js +1 -1
  81. package/dist/esm/models/TokenResponse.d.ts +1 -1
  82. package/dist/esm/models/TokenResponse.js +1 -1
  83. package/dist/esm/models/UptimeHealth.d.ts +1 -1
  84. package/dist/esm/models/UptimeHealth.js +1 -1
  85. package/dist/esm/models/UptimeHealthHost.d.ts +1 -1
  86. package/dist/esm/models/UptimeHealthHost.js +1 -1
  87. package/dist/esm/models/UptimeMonitor.d.ts +1 -1
  88. package/dist/esm/models/UptimeMonitor.js +1 -1
  89. package/dist/esm/models/UptimeMonitorGroup.d.ts +1 -1
  90. package/dist/esm/models/UptimeMonitorGroup.js +1 -1
  91. package/dist/esm/models/UptimeMonitors.d.ts +1 -1
  92. package/dist/esm/models/UptimeMonitors.js +1 -1
  93. package/dist/esm/models/UptimeResponse.d.ts +1 -1
  94. package/dist/esm/models/UptimeResponse.js +1 -1
  95. package/dist/esm/models/WikiPageResponse.d.ts +128 -0
  96. package/dist/esm/models/WikiPageResponse.js +97 -0
  97. package/dist/esm/models/WikiPageShortResponse.d.ts +99 -0
  98. package/dist/esm/models/WikiPageShortResponse.js +81 -0
  99. package/dist/esm/models/WikiSiteResponse.d.ts +74 -0
  100. package/dist/esm/models/WikiSiteResponse.js +65 -0
  101. package/dist/esm/models/index.d.ts +8 -0
  102. package/dist/esm/models/index.js +8 -0
  103. package/dist/esm/runtime.d.ts +1 -1
  104. package/dist/esm/runtime.js +1 -1
  105. package/dist/models/DeviceResponse.d.ts +1 -1
  106. package/dist/models/DeviceResponse.js +1 -1
  107. package/dist/models/ErrorResponse.d.ts +1 -1
  108. package/dist/models/ErrorResponse.js +1 -1
  109. package/dist/models/GlobalStatsResponse.d.ts +1 -1
  110. package/dist/models/GlobalStatsResponse.js +1 -1
  111. package/dist/models/ListResponseReleaseResponse.d.ts +12 -2
  112. package/dist/models/ListResponseReleaseResponse.js +5 -1
  113. package/dist/models/ListResponseReleaseResponseDataInner.d.ts +1 -1
  114. package/dist/models/ListResponseReleaseResponseDataInner.js +1 -1
  115. package/dist/models/ListResponseShortDeviceResponse.d.ts +12 -2
  116. package/dist/models/ListResponseShortDeviceResponse.js +5 -1
  117. package/dist/models/ListResponseShortDeviceResponseDataInner.d.ts +1 -1
  118. package/dist/models/ListResponseShortDeviceResponseDataInner.js +1 -1
  119. package/dist/models/ListResponseString.d.ts +12 -2
  120. package/dist/models/ListResponseString.js +5 -1
  121. package/dist/models/ListResponseWikiPageShortResponse.d.ts +49 -0
  122. package/dist/models/ListResponseWikiPageShortResponse.js +59 -0
  123. package/dist/models/ListResponseWikiPageShortResponseDataInner.d.ts +99 -0
  124. package/dist/models/ListResponseWikiPageShortResponseDataInner.js +88 -0
  125. package/dist/models/ListResponseWikiSiteResponse.d.ts +49 -0
  126. package/dist/models/ListResponseWikiSiteResponse.js +59 -0
  127. package/dist/models/ListResponseWikiSiteResponseDataInner.d.ts +74 -0
  128. package/dist/models/ListResponseWikiSiteResponseDataInner.js +72 -0
  129. package/dist/models/MaintainerShortResponse.d.ts +1 -1
  130. package/dist/models/MaintainerShortResponse.js +1 -1
  131. package/dist/models/NewReportRequest.d.ts +1 -1
  132. package/dist/models/NewReportRequest.js +1 -1
  133. package/dist/models/PasteInput.d.ts +1 -1
  134. package/dist/models/PasteInput.js +1 -1
  135. package/dist/models/PasteResponse.d.ts +1 -1
  136. package/dist/models/PasteResponse.js +1 -1
  137. package/dist/models/RecoveryImgResponse.d.ts +1 -1
  138. package/dist/models/RecoveryImgResponse.js +1 -1
  139. package/dist/models/ReleaseGroupsResponse.d.ts +15 -1
  140. package/dist/models/ReleaseGroupsResponse.js +5 -1
  141. package/dist/models/ReleaseListResponse.d.ts +1 -1
  142. package/dist/models/ReleaseListResponse.js +1 -1
  143. package/dist/models/ReleaseResponse.d.ts +1 -1
  144. package/dist/models/ReleaseResponse.js +1 -1
  145. package/dist/models/ReleaseSort.d.ts +31 -0
  146. package/dist/models/ReleaseSort.js +57 -0
  147. package/dist/models/ShortDeviceResponse.d.ts +1 -1
  148. package/dist/models/ShortDeviceResponse.js +1 -1
  149. package/dist/models/ShortReleaseResponse.d.ts +1 -1
  150. package/dist/models/ShortReleaseResponse.js +1 -1
  151. package/dist/models/TokenResponse.d.ts +1 -1
  152. package/dist/models/TokenResponse.js +1 -1
  153. package/dist/models/UptimeHealth.d.ts +1 -1
  154. package/dist/models/UptimeHealth.js +1 -1
  155. package/dist/models/UptimeHealthHost.d.ts +1 -1
  156. package/dist/models/UptimeHealthHost.js +1 -1
  157. package/dist/models/UptimeMonitor.d.ts +1 -1
  158. package/dist/models/UptimeMonitor.js +1 -1
  159. package/dist/models/UptimeMonitorGroup.d.ts +1 -1
  160. package/dist/models/UptimeMonitorGroup.js +1 -1
  161. package/dist/models/UptimeMonitors.d.ts +1 -1
  162. package/dist/models/UptimeMonitors.js +1 -1
  163. package/dist/models/UptimeResponse.d.ts +1 -1
  164. package/dist/models/UptimeResponse.js +1 -1
  165. package/dist/models/WikiPageResponse.d.ts +128 -0
  166. package/dist/models/WikiPageResponse.js +104 -0
  167. package/dist/models/WikiPageShortResponse.d.ts +99 -0
  168. package/dist/models/WikiPageShortResponse.js +88 -0
  169. package/dist/models/WikiSiteResponse.d.ts +74 -0
  170. package/dist/models/WikiSiteResponse.js +72 -0
  171. package/dist/models/index.d.ts +8 -0
  172. package/dist/models/index.js +8 -0
  173. package/dist/runtime.d.ts +1 -1
  174. package/dist/runtime.js +1 -1
  175. package/docs/ListResponseReleaseResponse.md +2 -0
  176. package/docs/ListResponseShortDeviceResponse.md +2 -0
  177. package/docs/ListResponseString.md +2 -0
  178. package/docs/ListResponseWikiPageShortResponse.md +38 -0
  179. package/docs/ListResponseWikiPageShortResponseDataInner.md +57 -0
  180. package/docs/ListResponseWikiSiteResponse.md +38 -0
  181. package/docs/ListResponseWikiSiteResponseDataInner.md +48 -0
  182. package/docs/ReleaseApi.md +3 -3
  183. package/docs/ReleaseGroupsResponse.md +3 -0
  184. package/docs/ReleaseListResponse.md +2 -0
  185. package/docs/ReleaseSort.md +33 -0
  186. package/docs/WikiApi.md +360 -0
  187. package/docs/WikiPageResponse.md +66 -0
  188. package/docs/WikiPageShortResponse.md +57 -0
  189. package/docs/WikiSiteResponse.md +48 -0
  190. package/package.json +2 -2
  191. package/src/apis/DeviceApi.ts +1 -1
  192. package/src/apis/PasteApi.ts +1 -1
  193. package/src/apis/ReleaseApi.ts +7 -4
  194. package/src/apis/ReportApi.ts +1 -1
  195. package/src/apis/StatsApi.ts +1 -1
  196. package/src/apis/UptimeApi.ts +1 -1
  197. package/src/apis/WikiApi.ts +452 -0
  198. package/src/apis/index.ts +1 -0
  199. package/src/models/DeviceResponse.ts +1 -1
  200. package/src/models/ErrorResponse.ts +1 -1
  201. package/src/models/GlobalStatsResponse.ts +1 -1
  202. package/src/models/ListResponseReleaseResponse.ts +15 -2
  203. package/src/models/ListResponseReleaseResponseDataInner.ts +1 -1
  204. package/src/models/ListResponseShortDeviceResponse.ts +15 -2
  205. package/src/models/ListResponseShortDeviceResponseDataInner.ts +1 -1
  206. package/src/models/ListResponseString.ts +15 -2
  207. package/src/models/ListResponseWikiPageShortResponse.ts +96 -0
  208. package/src/models/ListResponseWikiPageShortResponseDataInner.ts +163 -0
  209. package/src/models/ListResponseWikiSiteResponse.ts +96 -0
  210. package/src/models/ListResponseWikiSiteResponseDataInner.ts +126 -0
  211. package/src/models/MaintainerShortResponse.ts +1 -1
  212. package/src/models/NewReportRequest.ts +1 -1
  213. package/src/models/PasteInput.ts +1 -1
  214. package/src/models/PasteResponse.ts +1 -1
  215. package/src/models/RecoveryImgResponse.ts +1 -1
  216. package/src/models/ReleaseGroupsResponse.ts +18 -1
  217. package/src/models/ReleaseListResponse.ts +1 -1
  218. package/src/models/ReleaseResponse.ts +1 -1
  219. package/src/models/ReleaseSort.ts +59 -0
  220. package/src/models/ShortDeviceResponse.ts +1 -1
  221. package/src/models/ShortReleaseResponse.ts +1 -1
  222. package/src/models/TokenResponse.ts +1 -1
  223. package/src/models/UptimeHealth.ts +1 -1
  224. package/src/models/UptimeHealthHost.ts +1 -1
  225. package/src/models/UptimeMonitor.ts +1 -1
  226. package/src/models/UptimeMonitorGroup.ts +1 -1
  227. package/src/models/UptimeMonitors.ts +1 -1
  228. package/src/models/UptimeResponse.ts +1 -1
  229. package/src/models/WikiPageResponse.ts +205 -0
  230. package/src/models/WikiPageShortResponse.ts +163 -0
  231. package/src/models/WikiSiteResponse.ts +126 -0
  232. package/src/models/index.ts +8 -0
  233. package/src/runtime.ts +1 -1
  234. package/tsconfig.esm.json +2 -1
  235. package/tsconfig.json +4 -3
@@ -0,0 +1,452 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Fox API
5
+ * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
+ *
7
+ * The version of the OpenAPI document: 6.1.1
8
+ * Contact: admin@orangefox.tech
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import * as runtime from '../runtime';
17
+ import type {
18
+ ErrorResponse,
19
+ ListResponseWikiPageShortResponse,
20
+ ListResponseWikiSiteResponse,
21
+ WikiPageResponse,
22
+ WikiSiteResponse,
23
+ } from '../models/index';
24
+ import {
25
+ ErrorResponseFromJSON,
26
+ ErrorResponseToJSON,
27
+ ListResponseWikiPageShortResponseFromJSON,
28
+ ListResponseWikiPageShortResponseToJSON,
29
+ ListResponseWikiSiteResponseFromJSON,
30
+ ListResponseWikiSiteResponseToJSON,
31
+ WikiPageResponseFromJSON,
32
+ WikiPageResponseToJSON,
33
+ WikiSiteResponseFromJSON,
34
+ WikiSiteResponseToJSON,
35
+ } from '../models/index';
36
+
37
+ export interface GetAssetRequest {
38
+ site: string;
39
+ path: string;
40
+ }
41
+
42
+ export interface GetPageRequest {
43
+ site: string;
44
+ path: string;
45
+ }
46
+
47
+ export interface GetSiteRequest {
48
+ slug: string;
49
+ }
50
+
51
+ export interface ListPagesRequest {
52
+ site: string;
53
+ skip?: number | null;
54
+ limit?: number | null;
55
+ }
56
+
57
+ export interface ListSitesRequest {
58
+ skip?: number | null;
59
+ limit?: number | null;
60
+ }
61
+
62
+ /**
63
+ * WikiApi - interface
64
+ *
65
+ * @export
66
+ * @interface WikiApiInterface
67
+ */
68
+ export interface WikiApiInterface {
69
+ /**
70
+ * Creates request options for getAsset without sending the request
71
+ * @param {string} site Site slug
72
+ * @param {string} path Asset path, e.g. images/waving.png
73
+ * @throws {RequiredError}
74
+ * @memberof WikiApiInterface
75
+ */
76
+ getAssetRequestOpts(requestParameters: GetAssetRequest): Promise<runtime.RequestOpts>;
77
+
78
+ /**
79
+ *
80
+ * @summary GET /wiki/{site}/assets/{path} - Serve asset bytes.
81
+ * @param {string} site Site slug
82
+ * @param {string} path Asset path, e.g. images/waving.png
83
+ * @param {*} [options] Override http request option.
84
+ * @throws {RequiredError}
85
+ * @memberof WikiApiInterface
86
+ */
87
+ getAssetRaw(requestParameters: GetAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
88
+
89
+ /**
90
+ * GET /wiki/{site}/assets/{path} - Serve asset bytes.
91
+ */
92
+ getAsset(requestParameters: GetAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
93
+
94
+ /**
95
+ * Creates request options for getPage without sending the request
96
+ * @param {string} site Site slug
97
+ * @param {string} path Page path, e.g. Installation/Windows
98
+ * @throws {RequiredError}
99
+ * @memberof WikiApiInterface
100
+ */
101
+ getPageRequestOpts(requestParameters: GetPageRequest): Promise<runtime.RequestOpts>;
102
+
103
+ /**
104
+ *
105
+ * @summary GET /wiki/{site}/pages/{path} - Fetch one published page.
106
+ * @param {string} site Site slug
107
+ * @param {string} path Page path, e.g. Installation/Windows
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ * @memberof WikiApiInterface
111
+ */
112
+ getPageRaw(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WikiPageResponse>>;
113
+
114
+ /**
115
+ * GET /wiki/{site}/pages/{path} - Fetch one published page.
116
+ */
117
+ getPage(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WikiPageResponse>;
118
+
119
+ /**
120
+ * Creates request options for getSite without sending the request
121
+ * @param {string} slug Site slug
122
+ * @throws {RequiredError}
123
+ * @memberof WikiApiInterface
124
+ */
125
+ getSiteRequestOpts(requestParameters: GetSiteRequest): Promise<runtime.RequestOpts>;
126
+
127
+ /**
128
+ *
129
+ * @summary GET /wiki/sites/{slug} - Fetch one wiki site.
130
+ * @param {string} slug Site slug
131
+ * @param {*} [options] Override http request option.
132
+ * @throws {RequiredError}
133
+ * @memberof WikiApiInterface
134
+ */
135
+ getSiteRaw(requestParameters: GetSiteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WikiSiteResponse>>;
136
+
137
+ /**
138
+ * GET /wiki/sites/{slug} - Fetch one wiki site.
139
+ */
140
+ getSite(requestParameters: GetSiteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WikiSiteResponse>;
141
+
142
+ /**
143
+ * Creates request options for listPages without sending the request
144
+ * @param {string} site Site slug
145
+ * @param {number} [skip]
146
+ * @param {number} [limit]
147
+ * @throws {RequiredError}
148
+ * @memberof WikiApiInterface
149
+ */
150
+ listPagesRequestOpts(requestParameters: ListPagesRequest): Promise<runtime.RequestOpts>;
151
+
152
+ /**
153
+ * 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.
154
+ * @summary GET /wiki/{site}/pages - List every published page in a site.
155
+ * @param {string} site Site slug
156
+ * @param {number} [skip]
157
+ * @param {number} [limit]
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ * @memberof WikiApiInterface
161
+ */
162
+ listPagesRaw(requestParameters: ListPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseWikiPageShortResponse>>;
163
+
164
+ /**
165
+ * 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.
166
+ * GET /wiki/{site}/pages - List every published page in a site.
167
+ */
168
+ listPages(requestParameters: ListPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseWikiPageShortResponse>;
169
+
170
+ /**
171
+ * Creates request options for listSites without sending the request
172
+ * @param {number} [skip]
173
+ * @param {number} [limit]
174
+ * @throws {RequiredError}
175
+ * @memberof WikiApiInterface
176
+ */
177
+ listSitesRequestOpts(requestParameters: ListSitesRequest): Promise<runtime.RequestOpts>;
178
+
179
+ /**
180
+ *
181
+ * @summary GET /wiki/sites - List wiki sites.
182
+ * @param {number} [skip]
183
+ * @param {number} [limit]
184
+ * @param {*} [options] Override http request option.
185
+ * @throws {RequiredError}
186
+ * @memberof WikiApiInterface
187
+ */
188
+ listSitesRaw(requestParameters: ListSitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseWikiSiteResponse>>;
189
+
190
+ /**
191
+ * GET /wiki/sites - List wiki sites.
192
+ */
193
+ listSites(requestParameters: ListSitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseWikiSiteResponse>;
194
+
195
+ }
196
+
197
+ /**
198
+ *
199
+ */
200
+ export class WikiApi extends runtime.BaseAPI implements WikiApiInterface {
201
+
202
+ /**
203
+ * Creates request options for getAsset without sending the request
204
+ */
205
+ async getAssetRequestOpts(requestParameters: GetAssetRequest): Promise<runtime.RequestOpts> {
206
+ if (requestParameters['site'] == null) {
207
+ throw new runtime.RequiredError(
208
+ 'site',
209
+ 'Required parameter "site" was null or undefined when calling getAsset().'
210
+ );
211
+ }
212
+
213
+ if (requestParameters['path'] == null) {
214
+ throw new runtime.RequiredError(
215
+ 'path',
216
+ 'Required parameter "path" was null or undefined when calling getAsset().'
217
+ );
218
+ }
219
+
220
+ const queryParameters: any = {};
221
+
222
+ const headerParameters: runtime.HTTPHeaders = {};
223
+
224
+
225
+ let urlPath = `/wiki/{site}/assets/{path}`;
226
+ urlPath = urlPath.replace(`{${"site"}}`, encodeURIComponent(String(requestParameters['site'])));
227
+ urlPath = urlPath.replace(`{${"path"}}`, encodeURIComponent(String(requestParameters['path'])));
228
+
229
+ return {
230
+ path: urlPath,
231
+ method: 'GET',
232
+ headers: headerParameters,
233
+ query: queryParameters,
234
+ };
235
+ }
236
+
237
+ /**
238
+ * GET /wiki/{site}/assets/{path} - Serve asset bytes.
239
+ */
240
+ async getAssetRaw(requestParameters: GetAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
241
+ const requestOptions = await this.getAssetRequestOpts(requestParameters);
242
+ const response = await this.request(requestOptions, initOverrides);
243
+
244
+ return new runtime.VoidApiResponse(response);
245
+ }
246
+
247
+ /**
248
+ * GET /wiki/{site}/assets/{path} - Serve asset bytes.
249
+ */
250
+ async getAsset(requestParameters: GetAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
251
+ await this.getAssetRaw(requestParameters, initOverrides);
252
+ }
253
+
254
+ /**
255
+ * Creates request options for getPage without sending the request
256
+ */
257
+ async getPageRequestOpts(requestParameters: GetPageRequest): Promise<runtime.RequestOpts> {
258
+ if (requestParameters['site'] == null) {
259
+ throw new runtime.RequiredError(
260
+ 'site',
261
+ 'Required parameter "site" was null or undefined when calling getPage().'
262
+ );
263
+ }
264
+
265
+ if (requestParameters['path'] == null) {
266
+ throw new runtime.RequiredError(
267
+ 'path',
268
+ 'Required parameter "path" was null or undefined when calling getPage().'
269
+ );
270
+ }
271
+
272
+ const queryParameters: any = {};
273
+
274
+ const headerParameters: runtime.HTTPHeaders = {};
275
+
276
+
277
+ let urlPath = `/wiki/{site}/pages/{path}`;
278
+ urlPath = urlPath.replace(`{${"site"}}`, encodeURIComponent(String(requestParameters['site'])));
279
+ urlPath = urlPath.replace(`{${"path"}}`, encodeURIComponent(String(requestParameters['path'])));
280
+
281
+ return {
282
+ path: urlPath,
283
+ method: 'GET',
284
+ headers: headerParameters,
285
+ query: queryParameters,
286
+ };
287
+ }
288
+
289
+ /**
290
+ * GET /wiki/{site}/pages/{path} - Fetch one published page.
291
+ */
292
+ async getPageRaw(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WikiPageResponse>> {
293
+ const requestOptions = await this.getPageRequestOpts(requestParameters);
294
+ const response = await this.request(requestOptions, initOverrides);
295
+
296
+ return new runtime.JSONApiResponse(response, (jsonValue) => WikiPageResponseFromJSON(jsonValue));
297
+ }
298
+
299
+ /**
300
+ * GET /wiki/{site}/pages/{path} - Fetch one published page.
301
+ */
302
+ async getPage(requestParameters: GetPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WikiPageResponse> {
303
+ const response = await this.getPageRaw(requestParameters, initOverrides);
304
+ return await response.value();
305
+ }
306
+
307
+ /**
308
+ * Creates request options for getSite without sending the request
309
+ */
310
+ async getSiteRequestOpts(requestParameters: GetSiteRequest): Promise<runtime.RequestOpts> {
311
+ if (requestParameters['slug'] == null) {
312
+ throw new runtime.RequiredError(
313
+ 'slug',
314
+ 'Required parameter "slug" was null or undefined when calling getSite().'
315
+ );
316
+ }
317
+
318
+ const queryParameters: any = {};
319
+
320
+ const headerParameters: runtime.HTTPHeaders = {};
321
+
322
+
323
+ let urlPath = `/wiki/sites/{slug}`;
324
+ urlPath = urlPath.replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug'])));
325
+
326
+ return {
327
+ path: urlPath,
328
+ method: 'GET',
329
+ headers: headerParameters,
330
+ query: queryParameters,
331
+ };
332
+ }
333
+
334
+ /**
335
+ * GET /wiki/sites/{slug} - Fetch one wiki site.
336
+ */
337
+ async getSiteRaw(requestParameters: GetSiteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WikiSiteResponse>> {
338
+ const requestOptions = await this.getSiteRequestOpts(requestParameters);
339
+ const response = await this.request(requestOptions, initOverrides);
340
+
341
+ return new runtime.JSONApiResponse(response, (jsonValue) => WikiSiteResponseFromJSON(jsonValue));
342
+ }
343
+
344
+ /**
345
+ * GET /wiki/sites/{slug} - Fetch one wiki site.
346
+ */
347
+ async getSite(requestParameters: GetSiteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WikiSiteResponse> {
348
+ const response = await this.getSiteRaw(requestParameters, initOverrides);
349
+ return await response.value();
350
+ }
351
+
352
+ /**
353
+ * Creates request options for listPages without sending the request
354
+ */
355
+ async listPagesRequestOpts(requestParameters: ListPagesRequest): Promise<runtime.RequestOpts> {
356
+ if (requestParameters['site'] == null) {
357
+ throw new runtime.RequiredError(
358
+ 'site',
359
+ 'Required parameter "site" was null or undefined when calling listPages().'
360
+ );
361
+ }
362
+
363
+ const queryParameters: any = {};
364
+
365
+ if (requestParameters['skip'] != null) {
366
+ queryParameters['skip'] = requestParameters['skip'];
367
+ }
368
+
369
+ if (requestParameters['limit'] != null) {
370
+ queryParameters['limit'] = requestParameters['limit'];
371
+ }
372
+
373
+ const headerParameters: runtime.HTTPHeaders = {};
374
+
375
+
376
+ let urlPath = `/wiki/{site}/pages`;
377
+ urlPath = urlPath.replace(`{${"site"}}`, encodeURIComponent(String(requestParameters['site'])));
378
+
379
+ return {
380
+ path: urlPath,
381
+ method: 'GET',
382
+ headers: headerParameters,
383
+ query: queryParameters,
384
+ };
385
+ }
386
+
387
+ /**
388
+ * 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.
389
+ * GET /wiki/{site}/pages - List every published page in a site.
390
+ */
391
+ async listPagesRaw(requestParameters: ListPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseWikiPageShortResponse>> {
392
+ const requestOptions = await this.listPagesRequestOpts(requestParameters);
393
+ const response = await this.request(requestOptions, initOverrides);
394
+
395
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListResponseWikiPageShortResponseFromJSON(jsonValue));
396
+ }
397
+
398
+ /**
399
+ * 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.
400
+ * GET /wiki/{site}/pages - List every published page in a site.
401
+ */
402
+ async listPages(requestParameters: ListPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseWikiPageShortResponse> {
403
+ const response = await this.listPagesRaw(requestParameters, initOverrides);
404
+ return await response.value();
405
+ }
406
+
407
+ /**
408
+ * Creates request options for listSites without sending the request
409
+ */
410
+ async listSitesRequestOpts(requestParameters: ListSitesRequest): Promise<runtime.RequestOpts> {
411
+ const queryParameters: any = {};
412
+
413
+ if (requestParameters['skip'] != null) {
414
+ queryParameters['skip'] = requestParameters['skip'];
415
+ }
416
+
417
+ if (requestParameters['limit'] != null) {
418
+ queryParameters['limit'] = requestParameters['limit'];
419
+ }
420
+
421
+ const headerParameters: runtime.HTTPHeaders = {};
422
+
423
+
424
+ let urlPath = `/wiki/sites`;
425
+
426
+ return {
427
+ path: urlPath,
428
+ method: 'GET',
429
+ headers: headerParameters,
430
+ query: queryParameters,
431
+ };
432
+ }
433
+
434
+ /**
435
+ * GET /wiki/sites - List wiki sites.
436
+ */
437
+ async listSitesRaw(requestParameters: ListSitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseWikiSiteResponse>> {
438
+ const requestOptions = await this.listSitesRequestOpts(requestParameters);
439
+ const response = await this.request(requestOptions, initOverrides);
440
+
441
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListResponseWikiSiteResponseFromJSON(jsonValue));
442
+ }
443
+
444
+ /**
445
+ * GET /wiki/sites - List wiki sites.
446
+ */
447
+ async listSites(requestParameters: ListSitesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseWikiSiteResponse> {
448
+ const response = await this.listSitesRaw(requestParameters, initOverrides);
449
+ return await response.value();
450
+ }
451
+
452
+ }
package/src/apis/index.ts CHANGED
@@ -6,3 +6,4 @@ export * from './ReleaseApi';
6
6
  export * from './ReportApi';
7
7
  export * from './StatsApi';
8
8
  export * from './UptimeApi';
9
+ export * from './WikiApi';
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 6.0.10
7
+ * The version of the OpenAPI document: 6.1.1
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 6.0.10
7
+ * The version of the OpenAPI document: 6.1.1
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 6.0.10
7
+ * The version of the OpenAPI document: 6.1.1
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 6.0.10
7
+ * The version of the OpenAPI document: 6.1.1
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,7 +28,7 @@ import {
28
28
  */
29
29
  export interface ListResponseReleaseResponse {
30
30
  /**
31
- *
31
+ * Number of items in *this page*, not the size of the collection.
32
32
  * @type {number}
33
33
  * @memberof ListResponseReleaseResponse
34
34
  */
@@ -39,6 +39,16 @@ export interface ListResponseReleaseResponse {
39
39
  * @memberof ListResponseReleaseResponse
40
40
  */
41
41
  data: Array<ListResponseReleaseResponseDataInner>;
42
+ /**
43
+ * Whether further items exist beyond this page.
44
+ *
45
+ * List endpoints now apply a default page size, so `count` alone cannot
46
+ * tell a caller whether it has seen everything; without this a client
47
+ * would silently process a truncated result set.
48
+ * @type {boolean}
49
+ * @memberof ListResponseReleaseResponse
50
+ */
51
+ hasMore: boolean;
42
52
  }
43
53
 
44
54
  /**
@@ -47,6 +57,7 @@ export interface ListResponseReleaseResponse {
47
57
  export function instanceOfListResponseReleaseResponse(value: object): value is ListResponseReleaseResponse {
48
58
  if (!('count' in value) || value['count'] === undefined) return false;
49
59
  if (!('data' in value) || value['data'] === undefined) return false;
60
+ if (!('hasMore' in value) || value['hasMore'] === undefined) return false;
50
61
  return true;
51
62
  }
52
63
 
@@ -62,6 +73,7 @@ export function ListResponseReleaseResponseFromJSONTyped(json: any, ignoreDiscri
62
73
 
63
74
  'count': json['count'],
64
75
  'data': ((json['data'] as Array<any>).map(ListResponseReleaseResponseDataInnerFromJSON)),
76
+ 'hasMore': json['has_more'],
65
77
  };
66
78
  }
67
79
 
@@ -78,6 +90,7 @@ export function ListResponseReleaseResponseToJSONTyped(value?: ListResponseRelea
78
90
 
79
91
  'count': value['count'],
80
92
  'data': ((value['data'] as Array<any>).map(ListResponseReleaseResponseDataInnerToJSON)),
93
+ 'has_more': value['hasMore'],
81
94
  };
82
95
  }
83
96
 
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 6.0.10
7
+ * The version of the OpenAPI document: 6.1.1
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 6.0.10
7
+ * The version of the OpenAPI document: 6.1.1
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,7 +28,7 @@ import {
28
28
  */
29
29
  export interface ListResponseShortDeviceResponse {
30
30
  /**
31
- *
31
+ * Number of items in *this page*, not the size of the collection.
32
32
  * @type {number}
33
33
  * @memberof ListResponseShortDeviceResponse
34
34
  */
@@ -39,6 +39,16 @@ export interface ListResponseShortDeviceResponse {
39
39
  * @memberof ListResponseShortDeviceResponse
40
40
  */
41
41
  data: Array<ListResponseShortDeviceResponseDataInner>;
42
+ /**
43
+ * Whether further items exist beyond this page.
44
+ *
45
+ * List endpoints now apply a default page size, so `count` alone cannot
46
+ * tell a caller whether it has seen everything; without this a client
47
+ * would silently process a truncated result set.
48
+ * @type {boolean}
49
+ * @memberof ListResponseShortDeviceResponse
50
+ */
51
+ hasMore: boolean;
42
52
  }
43
53
 
44
54
  /**
@@ -47,6 +57,7 @@ export interface ListResponseShortDeviceResponse {
47
57
  export function instanceOfListResponseShortDeviceResponse(value: object): value is ListResponseShortDeviceResponse {
48
58
  if (!('count' in value) || value['count'] === undefined) return false;
49
59
  if (!('data' in value) || value['data'] === undefined) return false;
60
+ if (!('hasMore' in value) || value['hasMore'] === undefined) return false;
50
61
  return true;
51
62
  }
52
63
 
@@ -62,6 +73,7 @@ export function ListResponseShortDeviceResponseFromJSONTyped(json: any, ignoreDi
62
73
 
63
74
  'count': json['count'],
64
75
  'data': ((json['data'] as Array<any>).map(ListResponseShortDeviceResponseDataInnerFromJSON)),
76
+ 'hasMore': json['has_more'],
65
77
  };
66
78
  }
67
79
 
@@ -78,6 +90,7 @@ export function ListResponseShortDeviceResponseToJSONTyped(value?: ListResponseS
78
90
 
79
91
  'count': value['count'],
80
92
  'data': ((value['data'] as Array<any>).map(ListResponseShortDeviceResponseDataInnerToJSON)),
93
+ 'has_more': value['hasMore'],
81
94
  };
82
95
  }
83
96
 
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 6.0.10
7
+ * The version of the OpenAPI document: 6.1.1
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Fox API
5
5
  * Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application\'s access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
6
6
  *
7
- * The version of the OpenAPI document: 6.0.10
7
+ * The version of the OpenAPI document: 6.1.1
8
8
  * Contact: admin@orangefox.tech
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface ListResponseString {
22
22
  /**
23
- *
23
+ * Number of items in *this page*, not the size of the collection.
24
24
  * @type {number}
25
25
  * @memberof ListResponseString
26
26
  */
@@ -31,6 +31,16 @@ export interface ListResponseString {
31
31
  * @memberof ListResponseString
32
32
  */
33
33
  data: Array<string>;
34
+ /**
35
+ * Whether further items exist beyond this page.
36
+ *
37
+ * List endpoints now apply a default page size, so `count` alone cannot
38
+ * tell a caller whether it has seen everything; without this a client
39
+ * would silently process a truncated result set.
40
+ * @type {boolean}
41
+ * @memberof ListResponseString
42
+ */
43
+ hasMore: boolean;
34
44
  }
35
45
 
36
46
  /**
@@ -39,6 +49,7 @@ export interface ListResponseString {
39
49
  export function instanceOfListResponseString(value: object): value is ListResponseString {
40
50
  if (!('count' in value) || value['count'] === undefined) return false;
41
51
  if (!('data' in value) || value['data'] === undefined) return false;
52
+ if (!('hasMore' in value) || value['hasMore'] === undefined) return false;
42
53
  return true;
43
54
  }
44
55
 
@@ -54,6 +65,7 @@ export function ListResponseStringFromJSONTyped(json: any, ignoreDiscriminator:
54
65
 
55
66
  'count': json['count'],
56
67
  'data': json['data'],
68
+ 'hasMore': json['has_more'],
57
69
  };
58
70
  }
59
71
 
@@ -70,6 +82,7 @@ export function ListResponseStringToJSONTyped(value?: ListResponseString | null,
70
82
 
71
83
  'count': value['count'],
72
84
  'data': value['data'],
85
+ 'has_more': value['hasMore'],
73
86
  };
74
87
  }
75
88