@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.
- package/.openapi-generator/FILES +16 -0
- package/README.md +16 -4
- package/dist/apis/DeviceApi.d.ts +1 -1
- package/dist/apis/DeviceApi.js +1 -1
- package/dist/apis/PasteApi.d.ts +1 -1
- package/dist/apis/PasteApi.js +1 -1
- package/dist/apis/ReleaseApi.d.ts +5 -5
- package/dist/apis/ReleaseApi.js +3 -3
- package/dist/apis/ReportApi.d.ts +1 -1
- package/dist/apis/ReportApi.js +1 -1
- package/dist/apis/StatsApi.d.ts +1 -1
- package/dist/apis/StatsApi.js +1 -1
- package/dist/apis/UptimeApi.d.ts +1 -1
- package/dist/apis/UptimeApi.js +1 -1
- package/dist/apis/WikiApi.d.ts +219 -0
- package/dist/apis/WikiApi.js +245 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/DeviceApi.d.ts +1 -1
- package/dist/esm/apis/DeviceApi.js +1 -1
- package/dist/esm/apis/PasteApi.d.ts +1 -1
- package/dist/esm/apis/PasteApi.js +1 -1
- package/dist/esm/apis/ReleaseApi.d.ts +5 -5
- package/dist/esm/apis/ReleaseApi.js +3 -3
- package/dist/esm/apis/ReportApi.d.ts +1 -1
- package/dist/esm/apis/ReportApi.js +1 -1
- package/dist/esm/apis/StatsApi.d.ts +1 -1
- package/dist/esm/apis/StatsApi.js +1 -1
- package/dist/esm/apis/UptimeApi.d.ts +1 -1
- package/dist/esm/apis/UptimeApi.js +1 -1
- package/dist/esm/apis/WikiApi.d.ts +219 -0
- package/dist/esm/apis/WikiApi.js +241 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/DeviceResponse.d.ts +1 -1
- package/dist/esm/models/DeviceResponse.js +1 -1
- package/dist/esm/models/ErrorResponse.d.ts +1 -1
- package/dist/esm/models/ErrorResponse.js +1 -1
- package/dist/esm/models/GlobalStatsResponse.d.ts +1 -1
- package/dist/esm/models/GlobalStatsResponse.js +1 -1
- package/dist/esm/models/ListResponseReleaseResponse.d.ts +12 -2
- package/dist/esm/models/ListResponseReleaseResponse.js +5 -1
- package/dist/esm/models/ListResponseReleaseResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListResponseReleaseResponseDataInner.js +1 -1
- package/dist/esm/models/ListResponseShortDeviceResponse.d.ts +12 -2
- package/dist/esm/models/ListResponseShortDeviceResponse.js +5 -1
- package/dist/esm/models/ListResponseShortDeviceResponseDataInner.d.ts +1 -1
- package/dist/esm/models/ListResponseShortDeviceResponseDataInner.js +1 -1
- package/dist/esm/models/ListResponseString.d.ts +12 -2
- package/dist/esm/models/ListResponseString.js +5 -1
- package/dist/esm/models/ListResponseWikiPageShortResponse.d.ts +49 -0
- package/dist/esm/models/ListResponseWikiPageShortResponse.js +52 -0
- package/dist/esm/models/ListResponseWikiPageShortResponseDataInner.d.ts +99 -0
- package/dist/esm/models/ListResponseWikiPageShortResponseDataInner.js +81 -0
- package/dist/esm/models/ListResponseWikiSiteResponse.d.ts +49 -0
- package/dist/esm/models/ListResponseWikiSiteResponse.js +52 -0
- package/dist/esm/models/ListResponseWikiSiteResponseDataInner.d.ts +74 -0
- package/dist/esm/models/ListResponseWikiSiteResponseDataInner.js +65 -0
- package/dist/esm/models/MaintainerShortResponse.d.ts +1 -1
- package/dist/esm/models/MaintainerShortResponse.js +1 -1
- package/dist/esm/models/NewReportRequest.d.ts +1 -1
- package/dist/esm/models/NewReportRequest.js +1 -1
- package/dist/esm/models/PasteInput.d.ts +1 -1
- package/dist/esm/models/PasteInput.js +1 -1
- package/dist/esm/models/PasteResponse.d.ts +1 -1
- package/dist/esm/models/PasteResponse.js +1 -1
- package/dist/esm/models/RecoveryImgResponse.d.ts +1 -1
- package/dist/esm/models/RecoveryImgResponse.js +1 -1
- package/dist/esm/models/ReleaseGroupsResponse.d.ts +1 -1
- package/dist/esm/models/ReleaseGroupsResponse.js +1 -1
- package/dist/esm/models/ReleaseListResponse.d.ts +1 -1
- package/dist/esm/models/ReleaseListResponse.js +1 -1
- package/dist/esm/models/ReleaseResponse.d.ts +1 -1
- package/dist/esm/models/ReleaseResponse.js +1 -1
- package/dist/esm/models/ShortDeviceResponse.d.ts +1 -1
- package/dist/esm/models/ShortDeviceResponse.js +1 -1
- package/dist/esm/models/ShortReleaseResponse.d.ts +1 -1
- package/dist/esm/models/ShortReleaseResponse.js +1 -1
- package/dist/esm/models/TokenResponse.d.ts +1 -1
- package/dist/esm/models/TokenResponse.js +1 -1
- package/dist/esm/models/UptimeHealth.d.ts +1 -1
- package/dist/esm/models/UptimeHealth.js +1 -1
- package/dist/esm/models/UptimeHealthHost.d.ts +1 -1
- package/dist/esm/models/UptimeHealthHost.js +1 -1
- package/dist/esm/models/UptimeMonitor.d.ts +1 -1
- package/dist/esm/models/UptimeMonitor.js +1 -1
- package/dist/esm/models/UptimeMonitorGroup.d.ts +1 -1
- package/dist/esm/models/UptimeMonitorGroup.js +1 -1
- package/dist/esm/models/UptimeMonitors.d.ts +1 -1
- package/dist/esm/models/UptimeMonitors.js +1 -1
- package/dist/esm/models/UptimeResponse.d.ts +1 -1
- package/dist/esm/models/UptimeResponse.js +1 -1
- package/dist/esm/models/WikiPageResponse.d.ts +128 -0
- package/dist/esm/models/WikiPageResponse.js +97 -0
- package/dist/esm/models/WikiPageShortResponse.d.ts +99 -0
- package/dist/esm/models/WikiPageShortResponse.js +81 -0
- package/dist/esm/models/WikiSiteResponse.d.ts +74 -0
- package/dist/esm/models/WikiSiteResponse.js +65 -0
- package/dist/esm/models/index.d.ts +7 -0
- package/dist/esm/models/index.js +7 -0
- package/dist/esm/runtime.d.ts +1 -1
- package/dist/esm/runtime.js +1 -1
- package/dist/models/DeviceResponse.d.ts +1 -1
- package/dist/models/DeviceResponse.js +1 -1
- package/dist/models/ErrorResponse.d.ts +1 -1
- package/dist/models/ErrorResponse.js +1 -1
- package/dist/models/GlobalStatsResponse.d.ts +1 -1
- package/dist/models/GlobalStatsResponse.js +1 -1
- package/dist/models/ListResponseReleaseResponse.d.ts +12 -2
- package/dist/models/ListResponseReleaseResponse.js +5 -1
- package/dist/models/ListResponseReleaseResponseDataInner.d.ts +1 -1
- package/dist/models/ListResponseReleaseResponseDataInner.js +1 -1
- package/dist/models/ListResponseShortDeviceResponse.d.ts +12 -2
- package/dist/models/ListResponseShortDeviceResponse.js +5 -1
- package/dist/models/ListResponseShortDeviceResponseDataInner.d.ts +1 -1
- package/dist/models/ListResponseShortDeviceResponseDataInner.js +1 -1
- package/dist/models/ListResponseString.d.ts +12 -2
- package/dist/models/ListResponseString.js +5 -1
- package/dist/models/ListResponseWikiPageShortResponse.d.ts +49 -0
- package/dist/models/ListResponseWikiPageShortResponse.js +59 -0
- package/dist/models/ListResponseWikiPageShortResponseDataInner.d.ts +99 -0
- package/dist/models/ListResponseWikiPageShortResponseDataInner.js +88 -0
- package/dist/models/ListResponseWikiSiteResponse.d.ts +49 -0
- package/dist/models/ListResponseWikiSiteResponse.js +59 -0
- package/dist/models/ListResponseWikiSiteResponseDataInner.d.ts +74 -0
- package/dist/models/ListResponseWikiSiteResponseDataInner.js +72 -0
- package/dist/models/MaintainerShortResponse.d.ts +1 -1
- package/dist/models/MaintainerShortResponse.js +1 -1
- package/dist/models/NewReportRequest.d.ts +1 -1
- package/dist/models/NewReportRequest.js +1 -1
- package/dist/models/PasteInput.d.ts +1 -1
- package/dist/models/PasteInput.js +1 -1
- package/dist/models/PasteResponse.d.ts +1 -1
- package/dist/models/PasteResponse.js +1 -1
- package/dist/models/RecoveryImgResponse.d.ts +1 -1
- package/dist/models/RecoveryImgResponse.js +1 -1
- package/dist/models/ReleaseGroupsResponse.d.ts +1 -1
- package/dist/models/ReleaseGroupsResponse.js +1 -1
- package/dist/models/ReleaseListResponse.d.ts +1 -1
- package/dist/models/ReleaseListResponse.js +1 -1
- package/dist/models/ReleaseResponse.d.ts +1 -1
- package/dist/models/ReleaseResponse.js +1 -1
- package/dist/models/ShortDeviceResponse.d.ts +1 -1
- package/dist/models/ShortDeviceResponse.js +1 -1
- package/dist/models/ShortReleaseResponse.d.ts +1 -1
- package/dist/models/ShortReleaseResponse.js +1 -1
- package/dist/models/TokenResponse.d.ts +1 -1
- package/dist/models/TokenResponse.js +1 -1
- package/dist/models/UptimeHealth.d.ts +1 -1
- package/dist/models/UptimeHealth.js +1 -1
- package/dist/models/UptimeHealthHost.d.ts +1 -1
- package/dist/models/UptimeHealthHost.js +1 -1
- package/dist/models/UptimeMonitor.d.ts +1 -1
- package/dist/models/UptimeMonitor.js +1 -1
- package/dist/models/UptimeMonitorGroup.d.ts +1 -1
- package/dist/models/UptimeMonitorGroup.js +1 -1
- package/dist/models/UptimeMonitors.d.ts +1 -1
- package/dist/models/UptimeMonitors.js +1 -1
- package/dist/models/UptimeResponse.d.ts +1 -1
- package/dist/models/UptimeResponse.js +1 -1
- package/dist/models/WikiPageResponse.d.ts +128 -0
- package/dist/models/WikiPageResponse.js +104 -0
- package/dist/models/WikiPageShortResponse.d.ts +99 -0
- package/dist/models/WikiPageShortResponse.js +88 -0
- package/dist/models/WikiSiteResponse.d.ts +74 -0
- package/dist/models/WikiSiteResponse.js +72 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/docs/ListResponseReleaseResponse.md +2 -0
- package/docs/ListResponseShortDeviceResponse.md +2 -0
- package/docs/ListResponseString.md +2 -0
- package/docs/ListResponseWikiPageShortResponse.md +38 -0
- package/docs/ListResponseWikiPageShortResponseDataInner.md +57 -0
- package/docs/ListResponseWikiSiteResponse.md +38 -0
- package/docs/ListResponseWikiSiteResponseDataInner.md +48 -0
- package/docs/ReleaseApi.md +2 -2
- package/docs/ReleaseListResponse.md +2 -0
- package/docs/WikiApi.md +360 -0
- package/docs/WikiPageResponse.md +66 -0
- package/docs/WikiPageShortResponse.md +57 -0
- package/docs/WikiSiteResponse.md +48 -0
- package/package.json +1 -1
- package/src/apis/DeviceApi.ts +1 -1
- package/src/apis/PasteApi.ts +1 -1
- package/src/apis/ReleaseApi.ts +5 -5
- package/src/apis/ReportApi.ts +1 -1
- package/src/apis/StatsApi.ts +1 -1
- package/src/apis/UptimeApi.ts +1 -1
- package/src/apis/WikiApi.ts +452 -0
- package/src/apis/index.ts +1 -0
- package/src/models/DeviceResponse.ts +1 -1
- package/src/models/ErrorResponse.ts +1 -1
- package/src/models/GlobalStatsResponse.ts +1 -1
- package/src/models/ListResponseReleaseResponse.ts +15 -2
- package/src/models/ListResponseReleaseResponseDataInner.ts +1 -1
- package/src/models/ListResponseShortDeviceResponse.ts +15 -2
- package/src/models/ListResponseShortDeviceResponseDataInner.ts +1 -1
- package/src/models/ListResponseString.ts +15 -2
- package/src/models/ListResponseWikiPageShortResponse.ts +96 -0
- package/src/models/ListResponseWikiPageShortResponseDataInner.ts +163 -0
- package/src/models/ListResponseWikiSiteResponse.ts +96 -0
- package/src/models/ListResponseWikiSiteResponseDataInner.ts +126 -0
- package/src/models/MaintainerShortResponse.ts +1 -1
- package/src/models/NewReportRequest.ts +1 -1
- package/src/models/PasteInput.ts +1 -1
- package/src/models/PasteResponse.ts +1 -1
- package/src/models/RecoveryImgResponse.ts +1 -1
- package/src/models/ReleaseGroupsResponse.ts +1 -1
- package/src/models/ReleaseListResponse.ts +1 -1
- package/src/models/ReleaseResponse.ts +1 -1
- package/src/models/ShortDeviceResponse.ts +1 -1
- package/src/models/ShortReleaseResponse.ts +1 -1
- package/src/models/TokenResponse.ts +1 -1
- package/src/models/UptimeHealth.ts +1 -1
- package/src/models/UptimeHealthHost.ts +1 -1
- package/src/models/UptimeMonitor.ts +1 -1
- package/src/models/UptimeMonitorGroup.ts +1 -1
- package/src/models/UptimeMonitors.ts +1 -1
- package/src/models/UptimeResponse.ts +1 -1
- package/src/models/WikiPageResponse.ts +205 -0
- package/src/models/WikiPageShortResponse.ts +163 -0
- package/src/models/WikiSiteResponse.ts +126 -0
- package/src/models/index.ts +7 -0
- package/src/runtime.ts +1 -1
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Fox API
|
|
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
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 6.1.0
|
|
9
|
+
* Contact: admin@orangefox.tech
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.WikiApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const index_1 = require("../models/index");
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
class WikiApi extends runtime.BaseAPI {
|
|
32
|
+
/**
|
|
33
|
+
* Creates request options for getAsset without sending the request
|
|
34
|
+
*/
|
|
35
|
+
getAssetRequestOpts(requestParameters) {
|
|
36
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
37
|
+
if (requestParameters['site'] == null) {
|
|
38
|
+
throw new runtime.RequiredError('site', 'Required parameter "site" was null or undefined when calling getAsset().');
|
|
39
|
+
}
|
|
40
|
+
if (requestParameters['path'] == null) {
|
|
41
|
+
throw new runtime.RequiredError('path', 'Required parameter "path" was null or undefined when calling getAsset().');
|
|
42
|
+
}
|
|
43
|
+
const queryParameters = {};
|
|
44
|
+
const headerParameters = {};
|
|
45
|
+
let urlPath = `/wiki/{site}/assets/{path}`;
|
|
46
|
+
urlPath = urlPath.replace(`{${"site"}}`, encodeURIComponent(String(requestParameters['site'])));
|
|
47
|
+
urlPath = urlPath.replace(`{${"path"}}`, encodeURIComponent(String(requestParameters['path'])));
|
|
48
|
+
return {
|
|
49
|
+
path: urlPath,
|
|
50
|
+
method: 'GET',
|
|
51
|
+
headers: headerParameters,
|
|
52
|
+
query: queryParameters,
|
|
53
|
+
};
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* GET /wiki/{site}/assets/{path} - Serve asset bytes.
|
|
58
|
+
*/
|
|
59
|
+
getAssetRaw(requestParameters, initOverrides) {
|
|
60
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
61
|
+
const requestOptions = yield this.getAssetRequestOpts(requestParameters);
|
|
62
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
63
|
+
return new runtime.VoidApiResponse(response);
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* GET /wiki/{site}/assets/{path} - Serve asset bytes.
|
|
68
|
+
*/
|
|
69
|
+
getAsset(requestParameters, initOverrides) {
|
|
70
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
71
|
+
yield this.getAssetRaw(requestParameters, initOverrides);
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Creates request options for getPage without sending the request
|
|
76
|
+
*/
|
|
77
|
+
getPageRequestOpts(requestParameters) {
|
|
78
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
79
|
+
if (requestParameters['site'] == null) {
|
|
80
|
+
throw new runtime.RequiredError('site', 'Required parameter "site" was null or undefined when calling getPage().');
|
|
81
|
+
}
|
|
82
|
+
if (requestParameters['path'] == null) {
|
|
83
|
+
throw new runtime.RequiredError('path', 'Required parameter "path" was null or undefined when calling getPage().');
|
|
84
|
+
}
|
|
85
|
+
const queryParameters = {};
|
|
86
|
+
const headerParameters = {};
|
|
87
|
+
let urlPath = `/wiki/{site}/pages/{path}`;
|
|
88
|
+
urlPath = urlPath.replace(`{${"site"}}`, encodeURIComponent(String(requestParameters['site'])));
|
|
89
|
+
urlPath = urlPath.replace(`{${"path"}}`, encodeURIComponent(String(requestParameters['path'])));
|
|
90
|
+
return {
|
|
91
|
+
path: urlPath,
|
|
92
|
+
method: 'GET',
|
|
93
|
+
headers: headerParameters,
|
|
94
|
+
query: queryParameters,
|
|
95
|
+
};
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* GET /wiki/{site}/pages/{path} - Fetch one published page.
|
|
100
|
+
*/
|
|
101
|
+
getPageRaw(requestParameters, initOverrides) {
|
|
102
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
103
|
+
const requestOptions = yield this.getPageRequestOpts(requestParameters);
|
|
104
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
105
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WikiPageResponseFromJSON)(jsonValue));
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* GET /wiki/{site}/pages/{path} - Fetch one published page.
|
|
110
|
+
*/
|
|
111
|
+
getPage(requestParameters, initOverrides) {
|
|
112
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
113
|
+
const response = yield this.getPageRaw(requestParameters, initOverrides);
|
|
114
|
+
return yield response.value();
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Creates request options for getSite without sending the request
|
|
119
|
+
*/
|
|
120
|
+
getSiteRequestOpts(requestParameters) {
|
|
121
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
122
|
+
if (requestParameters['slug'] == null) {
|
|
123
|
+
throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getSite().');
|
|
124
|
+
}
|
|
125
|
+
const queryParameters = {};
|
|
126
|
+
const headerParameters = {};
|
|
127
|
+
let urlPath = `/wiki/sites/{slug}`;
|
|
128
|
+
urlPath = urlPath.replace(`{${"slug"}}`, encodeURIComponent(String(requestParameters['slug'])));
|
|
129
|
+
return {
|
|
130
|
+
path: urlPath,
|
|
131
|
+
method: 'GET',
|
|
132
|
+
headers: headerParameters,
|
|
133
|
+
query: queryParameters,
|
|
134
|
+
};
|
|
135
|
+
});
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* GET /wiki/sites/{slug} - Fetch one wiki site.
|
|
139
|
+
*/
|
|
140
|
+
getSiteRaw(requestParameters, initOverrides) {
|
|
141
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
142
|
+
const requestOptions = yield this.getSiteRequestOpts(requestParameters);
|
|
143
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
144
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WikiSiteResponseFromJSON)(jsonValue));
|
|
145
|
+
});
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* GET /wiki/sites/{slug} - Fetch one wiki site.
|
|
149
|
+
*/
|
|
150
|
+
getSite(requestParameters, initOverrides) {
|
|
151
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
152
|
+
const response = yield this.getSiteRaw(requestParameters, initOverrides);
|
|
153
|
+
return yield response.value();
|
|
154
|
+
});
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* Creates request options for listPages without sending the request
|
|
158
|
+
*/
|
|
159
|
+
listPagesRequestOpts(requestParameters) {
|
|
160
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
161
|
+
if (requestParameters['site'] == null) {
|
|
162
|
+
throw new runtime.RequiredError('site', 'Required parameter "site" was null or undefined when calling listPages().');
|
|
163
|
+
}
|
|
164
|
+
const queryParameters = {};
|
|
165
|
+
if (requestParameters['skip'] != null) {
|
|
166
|
+
queryParameters['skip'] = requestParameters['skip'];
|
|
167
|
+
}
|
|
168
|
+
if (requestParameters['limit'] != null) {
|
|
169
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
170
|
+
}
|
|
171
|
+
const headerParameters = {};
|
|
172
|
+
let urlPath = `/wiki/{site}/pages`;
|
|
173
|
+
urlPath = urlPath.replace(`{${"site"}}`, encodeURIComponent(String(requestParameters['site'])));
|
|
174
|
+
return {
|
|
175
|
+
path: urlPath,
|
|
176
|
+
method: 'GET',
|
|
177
|
+
headers: headerParameters,
|
|
178
|
+
query: queryParameters,
|
|
179
|
+
};
|
|
180
|
+
});
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* 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.
|
|
184
|
+
* GET /wiki/{site}/pages - List every published page in a site.
|
|
185
|
+
*/
|
|
186
|
+
listPagesRaw(requestParameters, initOverrides) {
|
|
187
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
188
|
+
const requestOptions = yield this.listPagesRequestOpts(requestParameters);
|
|
189
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
190
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListResponseWikiPageShortResponseFromJSON)(jsonValue));
|
|
191
|
+
});
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* 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.
|
|
195
|
+
* GET /wiki/{site}/pages - List every published page in a site.
|
|
196
|
+
*/
|
|
197
|
+
listPages(requestParameters, initOverrides) {
|
|
198
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
199
|
+
const response = yield this.listPagesRaw(requestParameters, initOverrides);
|
|
200
|
+
return yield response.value();
|
|
201
|
+
});
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Creates request options for listSites without sending the request
|
|
205
|
+
*/
|
|
206
|
+
listSitesRequestOpts(requestParameters) {
|
|
207
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
208
|
+
const queryParameters = {};
|
|
209
|
+
if (requestParameters['skip'] != null) {
|
|
210
|
+
queryParameters['skip'] = requestParameters['skip'];
|
|
211
|
+
}
|
|
212
|
+
if (requestParameters['limit'] != null) {
|
|
213
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
214
|
+
}
|
|
215
|
+
const headerParameters = {};
|
|
216
|
+
let urlPath = `/wiki/sites`;
|
|
217
|
+
return {
|
|
218
|
+
path: urlPath,
|
|
219
|
+
method: 'GET',
|
|
220
|
+
headers: headerParameters,
|
|
221
|
+
query: queryParameters,
|
|
222
|
+
};
|
|
223
|
+
});
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* GET /wiki/sites - List wiki sites.
|
|
227
|
+
*/
|
|
228
|
+
listSitesRaw(requestParameters, initOverrides) {
|
|
229
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
230
|
+
const requestOptions = yield this.listSitesRequestOpts(requestParameters);
|
|
231
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
232
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListResponseWikiSiteResponseFromJSON)(jsonValue));
|
|
233
|
+
});
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* GET /wiki/sites - List wiki sites.
|
|
237
|
+
*/
|
|
238
|
+
listSites() {
|
|
239
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
240
|
+
const response = yield this.listSitesRaw(requestParameters, initOverrides);
|
|
241
|
+
return yield response.value();
|
|
242
|
+
});
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
exports.WikiApi = WikiApi;
|
package/dist/apis/index.d.ts
CHANGED
package/dist/apis/index.js
CHANGED
|
@@ -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
|
|
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).
|
|
@@ -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
|
|
7
|
+
* The version of the OpenAPI document: 6.1.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* 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
|
|
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).
|
|
@@ -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
|
|
7
|
+
* The version of the OpenAPI document: 6.1.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* 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
|
|
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
|
}
|
|
@@ -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
|
|
7
|
+
* The version of the OpenAPI document: 6.1.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -258,7 +258,7 @@ export class ReleaseApi extends runtime.BaseAPI {
|
|
|
258
258
|
});
|
|
259
259
|
}
|
|
260
260
|
/**
|
|
261
|
-
* GET /releases/ - List releases with filters.
|
|
261
|
+
* Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
|
|
262
262
|
*/
|
|
263
263
|
listReleasesRaw(requestParameters, initOverrides) {
|
|
264
264
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -268,7 +268,7 @@ export class ReleaseApi extends runtime.BaseAPI {
|
|
|
268
268
|
});
|
|
269
269
|
}
|
|
270
270
|
/**
|
|
271
|
-
* GET /releases/ - List releases with filters.
|
|
271
|
+
* Check if a release version qualifies as \"featured\" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
|
|
272
272
|
*/
|
|
273
273
|
listReleases() {
|
|
274
274
|
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
|
|
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).
|
|
@@ -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
|
|
7
|
+
* The version of the OpenAPI document: 6.1.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* 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
|
|
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).
|
|
@@ -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
|
|
7
|
+
* The version of the OpenAPI document: 6.1.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* 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
|
|
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).
|
|
@@ -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
|
|
7
|
+
* The version of the OpenAPI document: 6.1.0
|
|
8
8
|
* Contact: admin@orangefox.tech
|
|
9
9
|
*
|
|
10
10
|
* 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
|
+
}
|