@libretexts/cxone-expert-node 1.0.0 → 1.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.
- package/README.md +39 -39
- package/dist/cxone-expert-node.cjs.development.js +1511 -0
- package/dist/cxone-expert-node.cjs.development.js.map +1 -0
- package/dist/cxone-expert-node.cjs.production.min.js +2 -0
- package/dist/cxone-expert-node.cjs.production.min.js.map +1 -0
- package/dist/cxone-expert-node.esm.js +1505 -0
- package/dist/cxone-expert-node.esm.js.map +1 -0
- package/dist/index.d.ts +32 -0
- package/dist/index.js +8 -0
- package/dist/modules/archive.d.ts +18 -0
- package/dist/modules/auth.d.ts +8 -0
- package/dist/modules/contextMaps.d.ts +10 -0
- package/dist/modules/events.d.ts +15 -0
- package/dist/modules/files.d.ts +23 -0
- package/dist/modules/groups.d.ts +11 -0
- package/dist/modules/pages.d.ts +68 -0
- package/dist/modules/requests.d.ts +14 -0
- package/dist/modules/site.d.ts +22 -0
- package/dist/modules/users.d.ts +16 -0
- package/dist/types/archive.d.ts +78 -0
- package/dist/types/auth.d.ts +11 -0
- package/dist/types/contextMaps.d.ts +34 -0
- package/dist/types/events.d.ts +68 -0
- package/dist/types/files.d.ts +61 -0
- package/dist/types/groups.d.ts +57 -0
- package/dist/types/index.d.ts +19 -0
- package/dist/types/pages.d.ts +737 -0
- package/dist/types/requests.d.ts +9 -0
- package/dist/types/security.d.ts +57 -0
- package/dist/types/site.d.ts +254 -0
- package/dist/types/users.d.ts +81 -0
- package/dist/utils.d.ts +2 -0
- package/license.md +20 -20
- package/package.json +16 -5
- package/src/index.ts +105 -35
- package/src/modules/archive.ts +186 -0
- package/src/modules/auth.ts +35 -31
- package/src/modules/contextMaps.ts +56 -0
- package/src/modules/events.ts +140 -0
- package/src/modules/files.ts +291 -0
- package/src/modules/groups.ts +79 -0
- package/src/modules/pages.ts +1236 -73
- package/src/modules/requests.ts +67 -67
- package/src/modules/site.ts +266 -0
- package/src/modules/users.ts +161 -0
- package/src/types/archive.ts +101 -0
- package/src/types/auth.ts +13 -13
- package/src/types/contextMaps.ts +46 -0
- package/src/types/events.ts +91 -0
- package/src/types/files.ts +87 -0
- package/src/types/groups.ts +74 -0
- package/src/types/index.ts +21 -14
- package/src/types/pages.ts +858 -171
- package/src/types/requests.ts +10 -10
- package/src/types/security.ts +60 -47
- package/src/types/site.ts +304 -0
- package/src/types/users.ts +101 -0
- package/src/utils.ts +8 -8
- package/.github/workflows/release.yaml +0 -37
- package/.releaserc.json +0 -15
- package/tsconfig.json +0 -26
package/src/types/pages.ts
CHANGED
|
@@ -1,172 +1,859 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
export type
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
1
|
+
import {
|
|
2
|
+
BaseQueryParams,
|
|
3
|
+
PaginationQueryParams,
|
|
4
|
+
RequestModeQueryParam,
|
|
5
|
+
} from "./requests";
|
|
6
|
+
import { ExpertUser, PageSecurity } from "./security";
|
|
7
|
+
|
|
8
|
+
export type GetPagesParams = {
|
|
9
|
+
startpage?: boolean;
|
|
10
|
+
format?: "html" | "xml" | "google";
|
|
11
|
+
authenticate?: boolean;
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
export type GetPagesResponse = {
|
|
15
|
+
"@id"?: string;
|
|
16
|
+
"@guid"?: string;
|
|
17
|
+
"@draft.state"?: string;
|
|
18
|
+
"@href"?: string;
|
|
19
|
+
"@deleted"?: string;
|
|
20
|
+
"date.created"?: string;
|
|
21
|
+
language?: string;
|
|
22
|
+
namespace?: string;
|
|
23
|
+
path?: Partial<PagePath> | "";
|
|
24
|
+
subpages?: Partial<Subpages> | "";
|
|
25
|
+
title?: string;
|
|
26
|
+
"uri.ui"?: string;
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
export type GetPageParams = {
|
|
30
|
+
format?: "html" | "xhtml";
|
|
31
|
+
revision?: string;
|
|
32
|
+
include?: "contents" | "prevnext";
|
|
33
|
+
includeDeleted?: boolean;
|
|
34
|
+
mode?: RequestModeQueryParam;
|
|
35
|
+
exclude?: string;
|
|
36
|
+
} & BaseQueryParams;
|
|
37
|
+
|
|
38
|
+
export type GetPageResponse = Partial<PageBase> & Partial<PageExtended>;
|
|
39
|
+
|
|
40
|
+
export type GetPageContentsParams = {
|
|
41
|
+
overview?: boolean;
|
|
42
|
+
include?: boolean;
|
|
43
|
+
reltopath?: string;
|
|
44
|
+
relto?: number;
|
|
45
|
+
pageid?: number;
|
|
46
|
+
includes?: "overview" | "tags" | "overview,tags";
|
|
47
|
+
format?: "html" | "xhtml" | "text" | "dekicode";
|
|
48
|
+
highlight?: string;
|
|
49
|
+
revision?: string;
|
|
50
|
+
mode: RequestModeQueryParam;
|
|
51
|
+
section?: string;
|
|
52
|
+
} & BaseQueryParams;
|
|
53
|
+
|
|
54
|
+
export type GetPageContentsResponse = {
|
|
55
|
+
"@revision"?: string;
|
|
56
|
+
"@type"?: string;
|
|
57
|
+
"@title"?: string;
|
|
58
|
+
body?: string[] | "";
|
|
59
|
+
head?: string;
|
|
60
|
+
tail?: string;
|
|
61
|
+
};
|
|
62
|
+
|
|
63
|
+
export type GetPageContentsExplainParams = {
|
|
64
|
+
overview?: boolean;
|
|
65
|
+
include?: string;
|
|
66
|
+
reltopath?: string;
|
|
67
|
+
relto?: number;
|
|
68
|
+
pageid?: number;
|
|
69
|
+
includes?: "overview" | "tags" | "overview,tags";
|
|
70
|
+
format?: "html" | "xhtml" | "text" | "dekicode";
|
|
71
|
+
highlight?: string;
|
|
72
|
+
revision?: string;
|
|
73
|
+
mode: RequestModeQueryParam;
|
|
74
|
+
section?: string;
|
|
75
|
+
} & BaseQueryParams;
|
|
76
|
+
|
|
77
|
+
export type GetPageContentsExplainResponse = {
|
|
78
|
+
"@elapsed"?: string;
|
|
79
|
+
"@id"?: string;
|
|
80
|
+
"@Path"?: string;
|
|
81
|
+
"@version"?: string;
|
|
82
|
+
calls?: {
|
|
83
|
+
"@elapsed"?: string;
|
|
84
|
+
"@count-total"?: string;
|
|
85
|
+
"@count-unique"?: string;
|
|
86
|
+
expr?: exprCall | exprCall[] | "";
|
|
87
|
+
import?: importCall | importCall[] | "";
|
|
88
|
+
page?: pageCall | pageCall[] | "";
|
|
89
|
+
property?: propertyCall | propertyCall[] | "";
|
|
90
|
+
template?: templateCall | templateCall[] | "";
|
|
91
|
+
}
|
|
92
|
+
"data-stats"?: {
|
|
93
|
+
entry?: Entry | Entry[] | "";
|
|
94
|
+
}
|
|
95
|
+
"db-summary"?: {
|
|
96
|
+
"@elapsed"?: string;
|
|
97
|
+
"@count"?: string;
|
|
98
|
+
query?: Query | Query[] | "";
|
|
99
|
+
}
|
|
100
|
+
"hs-summary"?: {
|
|
101
|
+
"@elapsed"?: string;
|
|
102
|
+
"@count"?: string;
|
|
103
|
+
query?: Query | Query[] | "";
|
|
104
|
+
}
|
|
105
|
+
"redis-summary"?: {
|
|
106
|
+
"@elapsed"?: string;
|
|
107
|
+
"@count"?: string;
|
|
108
|
+
query?: Query | Query[] | "";
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export type GetPageDiffParams = {
|
|
113
|
+
diff?: "combined" | "all";
|
|
114
|
+
previous?: string;
|
|
115
|
+
format?: "html" | "xhtml";
|
|
116
|
+
mode?: RequestModeQueryParam;
|
|
117
|
+
revision?: string;
|
|
118
|
+
} & BaseQueryParams;
|
|
119
|
+
|
|
120
|
+
export type GetPageDiffResponse = {
|
|
121
|
+
"@type"?: string;
|
|
122
|
+
"#text"?: string;
|
|
123
|
+
};
|
|
124
|
+
|
|
125
|
+
export type GetPageExplainParams = GetPageParams;
|
|
126
|
+
|
|
127
|
+
export type GetPageExplainResponse = GetPageResponse;
|
|
128
|
+
|
|
129
|
+
export type GetPageExportTokenParams = {
|
|
130
|
+
recursive?: boolean;
|
|
131
|
+
token?: string;
|
|
132
|
+
pageid?: number;
|
|
133
|
+
reltopath?: string;
|
|
134
|
+
relto?: number;
|
|
135
|
+
dryrun?: boolean;
|
|
136
|
+
};
|
|
137
|
+
|
|
138
|
+
export type GetPageExportTokenFilenameParams = GetPageExportTokenParams;
|
|
139
|
+
|
|
140
|
+
export type GetPageFilesSubPagesParams = BaseQueryParams;
|
|
141
|
+
|
|
142
|
+
export type GetPageFilesSubPagesResponse = {
|
|
143
|
+
"@id"?: string;
|
|
144
|
+
"@guid"?: string;
|
|
145
|
+
"@draft.state"?: string;
|
|
146
|
+
"@href"?: string;
|
|
147
|
+
"@deleted"?: string;
|
|
148
|
+
"date.created"?: string;
|
|
149
|
+
files?: {
|
|
150
|
+
"@count?": string;
|
|
151
|
+
"@href?": string;
|
|
152
|
+
file?: Partial<PageFile> | Partial<PageFile>[] | "";
|
|
153
|
+
} | "";
|
|
154
|
+
language?: string;
|
|
155
|
+
namespace?: string;
|
|
156
|
+
path?: Partial<PagePath> | "";
|
|
157
|
+
subpages?: Partial<page_subpage> | "";
|
|
158
|
+
title?: string;
|
|
159
|
+
"uri.ui"?: string;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
export type GetPageFilesParams = BaseQueryParams & PaginationQueryParams;
|
|
163
|
+
|
|
164
|
+
export type GetPageFilesResponse = {
|
|
165
|
+
"@count": string;
|
|
166
|
+
"@offset": string;
|
|
167
|
+
"@totalcount": string;
|
|
168
|
+
"@href": string;
|
|
169
|
+
file?: Partial<PageFile> | Partial<PageFile>[] | "";
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
export type GetPageFileParams = {
|
|
173
|
+
includeDeleted?: boolean;
|
|
174
|
+
revision?: string;
|
|
175
|
+
size?: "original" | "thumb" | "webview" | "bestfit" | "custom";
|
|
176
|
+
format?: "jpg" | "png" | "bmp" | "gif";
|
|
177
|
+
ratio?: "fixed" | "var";
|
|
178
|
+
width?: number;
|
|
179
|
+
height?: number;
|
|
180
|
+
} & BaseQueryParams;
|
|
181
|
+
|
|
182
|
+
export type GetPageFileDescriptionParams = {
|
|
183
|
+
revision?: string;
|
|
184
|
+
} & BaseQueryParams;
|
|
185
|
+
|
|
186
|
+
export type GetPageFileInfoParams = {
|
|
187
|
+
includeDeleted?: boolean;
|
|
188
|
+
revision?: string;
|
|
189
|
+
} & BaseQueryParams;
|
|
190
|
+
|
|
191
|
+
export type GetPageFileInfoResponse = Partial<PageFile>;
|
|
192
|
+
|
|
193
|
+
export type GetPageFileRevisionsParams = {
|
|
194
|
+
changefilter?: "CONTENT" | "NAME" | "LANGUAGE" | "META" | "DELETEFLAG" | "PARENT";
|
|
195
|
+
} & BaseQueryParams;
|
|
196
|
+
|
|
197
|
+
export type GetPageFileRevisionsResponse = {
|
|
198
|
+
"@count"?: string;
|
|
199
|
+
"@totalcount"?: string;
|
|
200
|
+
"@href"?: string;
|
|
201
|
+
file?: Partial<PageFile> | Partial<PageFile>[] | "";
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
export type GetPageFindParams = {
|
|
205
|
+
tags?: string;
|
|
206
|
+
missingclarifications?: string;
|
|
207
|
+
since?: string;
|
|
208
|
+
upto?: string;
|
|
209
|
+
include?: string;
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
export type GetPageFindResponse = {
|
|
213
|
+
"@count"?: string;
|
|
214
|
+
"@totalcount"?: string;
|
|
215
|
+
page?: "" | (Partial<PageBase> & Partial<Tags>) | (Partial<PageBase> & Partial<Tags>)[];
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
export type GetPageInfoParams = {
|
|
219
|
+
exclude?: string;
|
|
220
|
+
} & BaseQueryParams;
|
|
221
|
+
|
|
222
|
+
export type GetPageInfoResponse = Partial<PageBase>;
|
|
223
|
+
|
|
224
|
+
export type GetPageLinksParams = {
|
|
225
|
+
dir: "from" | "to";
|
|
226
|
+
} & BaseQueryParams;
|
|
227
|
+
|
|
228
|
+
export type GetPageLinksResponse = {
|
|
229
|
+
"@count"?: string;
|
|
230
|
+
page?: Partial<PageBase> | Partial<PageBase>[] | "";
|
|
231
|
+
}
|
|
232
|
+
|
|
233
|
+
export type GetPagePdfParams = {
|
|
234
|
+
showtoc?: boolean;
|
|
235
|
+
format?: "pdf" | "html";
|
|
236
|
+
authenticate?: boolean;
|
|
237
|
+
stylesheet?: string;
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
export type GetPagePdfFilenameParams = GetPagePdfParams;
|
|
241
|
+
|
|
242
|
+
export type GetPagePropertiesParams = {
|
|
243
|
+
depth?: number;
|
|
244
|
+
name?: string;
|
|
245
|
+
contentcutoff?: number;
|
|
246
|
+
} & BaseQueryParams;
|
|
247
|
+
|
|
248
|
+
export type GetPagePropertiesResponse = {
|
|
249
|
+
"@count"?: string;
|
|
250
|
+
"@href"?: string;
|
|
251
|
+
property?: Partial<PageProperty> | Partial<PageProperty>[] | "";
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
export type GetPagePropertiesKeyParams = BaseQueryParams;
|
|
255
|
+
|
|
256
|
+
export type GetPagePropertiesKeyInfoParams = {
|
|
257
|
+
contentcutoff?: number;
|
|
258
|
+
} & BaseQueryParams;
|
|
259
|
+
|
|
260
|
+
export type GetPagePropertiesKeyInfoResponse = Partial<PageProperty> | Partial<PageProperty>[] | "";
|
|
261
|
+
|
|
262
|
+
export type GetPageRatingsParams = BaseQueryParams;
|
|
263
|
+
|
|
264
|
+
export type GetPageRatingsResponse = PageRating;
|
|
265
|
+
|
|
266
|
+
export type GetPageRevisionsParams = {
|
|
267
|
+
revision?: string;
|
|
268
|
+
deleted?: boolean;
|
|
269
|
+
} & BaseQueryParams & PaginationQueryParams;
|
|
270
|
+
|
|
271
|
+
export type GetPageRevisionsResponse = {
|
|
272
|
+
page?: (Partial<PageBase> & Partial<PageExtended>) | (Partial<PageBase> & Partial<PageExtended>)[] | "";
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
export type GetPageSecurityParams = BaseQueryParams & {
|
|
276
|
+
export?: boolean;
|
|
277
|
+
};
|
|
278
|
+
|
|
279
|
+
export type GetPageSecurityResponse = Partial<PageSecurity>;
|
|
280
|
+
|
|
281
|
+
export type GetPageSubPagesParams = BaseQueryParams & PaginationQueryParams;
|
|
282
|
+
|
|
283
|
+
export type GetPageSubPagesResponse = Partial<page_subpage>;
|
|
284
|
+
|
|
285
|
+
export type GetPageTagsParams = {
|
|
286
|
+
exports?: boolean;
|
|
287
|
+
} & BaseQueryParams;
|
|
288
|
+
|
|
289
|
+
export type GetPageTagsResponse = Partial<Tags>;
|
|
290
|
+
|
|
291
|
+
export type GetPageTreeParams = {
|
|
292
|
+
startpage?: boolean;
|
|
293
|
+
format?: "html" | "xml" | "google";
|
|
294
|
+
include?: string;
|
|
295
|
+
authenticate?: boolean;
|
|
296
|
+
};
|
|
297
|
+
|
|
298
|
+
export type GetPageTreeResponse = {
|
|
299
|
+
page: Partial<GetPagesResponse>;
|
|
300
|
+
};
|
|
301
|
+
|
|
302
|
+
export type GetPageBookParams = {
|
|
303
|
+
format?: "html" | "pdf";
|
|
304
|
+
title?: string;
|
|
305
|
+
showtoc?: boolean;
|
|
306
|
+
authenticate?: boolean;
|
|
307
|
+
stylesheet?: string;
|
|
308
|
+
pageids: number;
|
|
309
|
+
filename?: string;
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
export type GetPageBookFilenameParams = GetPageBookParams;
|
|
313
|
+
|
|
314
|
+
export type GetPagesCsvParams = {
|
|
315
|
+
filename?: string;
|
|
316
|
+
pageids: string;
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
export type GetPagesPopularParams = BaseQueryParams & PaginationQueryParams;
|
|
320
|
+
|
|
321
|
+
export type GetPagesPopularResponse = {
|
|
322
|
+
"@count"?: string;
|
|
323
|
+
"@href"?: string;
|
|
324
|
+
page?: (Partial<PageBase> & Partial<PageExtended>) | (Partial<PageBase> & Partial<PageExtended>)[] | "";
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
export type PostPageContentsParams = {
|
|
328
|
+
ordered?: boolean;
|
|
329
|
+
restriction?: string;
|
|
330
|
+
importtime?: string;
|
|
331
|
+
overwrite?: boolean;
|
|
332
|
+
reltopath?: string;
|
|
333
|
+
relto?: number;
|
|
334
|
+
abort?: "never" | "modified" | "exists";
|
|
335
|
+
xpath?: string;
|
|
336
|
+
section?: number;
|
|
337
|
+
title?: string;
|
|
338
|
+
comment?: string;
|
|
339
|
+
edittime: string;
|
|
340
|
+
authenticate?: boolean;
|
|
341
|
+
redirects?: number;
|
|
342
|
+
tidy?: "remove" | "convert";
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
export type PostPageContentsResponse = {
|
|
346
|
+
edit: {
|
|
347
|
+
"@status": "success" | "conflict";
|
|
348
|
+
page: {
|
|
349
|
+
"@id": number;
|
|
350
|
+
"@href": string;
|
|
351
|
+
title: string;
|
|
352
|
+
path: string;
|
|
353
|
+
};
|
|
354
|
+
"page.base": {
|
|
355
|
+
"@id": number;
|
|
356
|
+
"@revision": number;
|
|
357
|
+
"@href": string;
|
|
358
|
+
title: string;
|
|
359
|
+
path: string;
|
|
360
|
+
"date.edited": string;
|
|
361
|
+
"user.author": {
|
|
362
|
+
"@id": number;
|
|
363
|
+
"@href": string;
|
|
364
|
+
nick: string;
|
|
365
|
+
username: string;
|
|
366
|
+
email: string;
|
|
367
|
+
};
|
|
368
|
+
description: string;
|
|
369
|
+
contents: {
|
|
370
|
+
"@type": string;
|
|
371
|
+
"@href": string;
|
|
372
|
+
};
|
|
373
|
+
};
|
|
374
|
+
"page.overwritten"?: {
|
|
375
|
+
"@id": number;
|
|
376
|
+
"@revision": number;
|
|
377
|
+
"@href": string;
|
|
378
|
+
title: string;
|
|
379
|
+
path: string;
|
|
380
|
+
"date.edited": string;
|
|
381
|
+
"user.author": {
|
|
382
|
+
"@id": number;
|
|
383
|
+
"@href": string;
|
|
384
|
+
nick: string;
|
|
385
|
+
username: string;
|
|
386
|
+
email: string;
|
|
387
|
+
};
|
|
388
|
+
description: string;
|
|
389
|
+
contents: {
|
|
390
|
+
"@type": string;
|
|
391
|
+
"@href": string;
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
};
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
export type DeletePageParams = {
|
|
398
|
+
recursive?: boolean;
|
|
399
|
+
} & BaseQueryParams;
|
|
400
|
+
|
|
401
|
+
export type DeletePageResponse = {
|
|
402
|
+
deletedPages?: {
|
|
403
|
+
"@count"?: number;
|
|
404
|
+
page?: Partial<DeletedPage> | Partial<DeletedPage>[] | "";
|
|
405
|
+
}
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
export type PostPageAllowedParams = {
|
|
409
|
+
permissions?: string;
|
|
410
|
+
}
|
|
411
|
+
|
|
412
|
+
export type PostPageAllowedResponse = {
|
|
413
|
+
users?: {
|
|
414
|
+
user: Partial<Allowed> | Partial<Allowed>[] | "";
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
|
|
418
|
+
export type PostCopyPageParams = {
|
|
419
|
+
to: string;
|
|
420
|
+
title?: string;
|
|
421
|
+
abort?: 'never' | 'exists';
|
|
422
|
+
recursive?: boolean;
|
|
423
|
+
tags?: boolean;
|
|
424
|
+
attachments?: boolean;
|
|
425
|
+
} & BaseQueryParams;
|
|
426
|
+
|
|
427
|
+
export type PostCopyPageResponse = {
|
|
428
|
+
'pages.copied?': {
|
|
429
|
+
"@count"?: string;
|
|
430
|
+
page?: Partial<PageBase> | Partial<PageBase>[] | "";
|
|
431
|
+
} | "";
|
|
432
|
+
}
|
|
433
|
+
|
|
434
|
+
export type DeletePageFileNameParams = BaseQueryParams;
|
|
435
|
+
|
|
436
|
+
export type HeadPageFileNameParams = {
|
|
437
|
+
includeDeleted?: boolean;
|
|
438
|
+
revision?: string;
|
|
439
|
+
size?: "original" | "thumb" | "webview" | "bestfit" | "custom";
|
|
440
|
+
format?: "jpg" | "png" | "bmp" | "gif";
|
|
441
|
+
ratio?: "fixed" | "var";
|
|
442
|
+
width?: number;
|
|
443
|
+
height?: number;
|
|
444
|
+
} & BaseQueryParams;
|
|
445
|
+
|
|
446
|
+
export type PutPageFileNameParams = {
|
|
447
|
+
description?: string;
|
|
448
|
+
} & BaseQueryParams;
|
|
449
|
+
|
|
450
|
+
export type PutPageFileNameResponse = Partial<PageFile>;
|
|
451
|
+
|
|
452
|
+
export type DeletePageFileNameDescriptionParams = BaseQueryParams;
|
|
453
|
+
|
|
454
|
+
export type DeletePageFileNameDescriptionResponse = Partial<PageFile> & {
|
|
455
|
+
properties?: {
|
|
456
|
+
"@count"?: string;
|
|
457
|
+
"@href"?: string;
|
|
458
|
+
property?: Partial<PageProperty> | Partial<PageProperty>[] | "";
|
|
459
|
+
}
|
|
460
|
+
};
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
export type PutPageFileNameDescriptionParams = BaseQueryParams;
|
|
464
|
+
|
|
465
|
+
export type PutPageFileNameDescriptionResponse = Partial<PageFile> & {
|
|
466
|
+
properties?: {
|
|
467
|
+
"@count"?: string;
|
|
468
|
+
"@href"?: string;
|
|
469
|
+
property?: Partial<PageProperty> | Partial<PageProperty>[] | "";
|
|
470
|
+
}
|
|
471
|
+
};
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
export type PutPageFileNamePropertiesKeyParams = {
|
|
475
|
+
description?: string;
|
|
476
|
+
etag?: string;
|
|
477
|
+
abort?: "never" | "modified" | "exists";
|
|
478
|
+
} & BaseQueryParams;
|
|
479
|
+
|
|
480
|
+
export type PutPageFileNamePropertiesKeyResponse = PageProperty;
|
|
481
|
+
|
|
482
|
+
export type PutPageImportParams = {
|
|
483
|
+
behavior?: "sync" | "async";
|
|
484
|
+
filename?: string;
|
|
485
|
+
pageid?: number;
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
export type PutPageMoveParams = {
|
|
489
|
+
parentid?: number;
|
|
490
|
+
name?: string;
|
|
491
|
+
title?: string;
|
|
492
|
+
to?: string;
|
|
493
|
+
} & BaseQueryParams;
|
|
494
|
+
|
|
495
|
+
export type PutPageMoveResponse = {
|
|
496
|
+
"page.moved?": {
|
|
497
|
+
"@count"?: string;
|
|
498
|
+
page?: Partial<PageBase> | Partial<PageBase>[] | "";
|
|
499
|
+
} | "";
|
|
500
|
+
};
|
|
501
|
+
|
|
502
|
+
export type PutPageOrderParams = {
|
|
503
|
+
afterid?: number;
|
|
504
|
+
};
|
|
505
|
+
|
|
506
|
+
export type PostPagePropertiesParams = {
|
|
507
|
+
abort?: "never" | "modified" | "exists";
|
|
508
|
+
description?: string;
|
|
509
|
+
} & BaseQueryParams;
|
|
510
|
+
|
|
511
|
+
export type PostPagePropertiesResponse = PageProperty;
|
|
512
|
+
|
|
513
|
+
export type PutPagePropertiesParams = BaseQueryParams;
|
|
514
|
+
|
|
515
|
+
export type PutPagePropertiesResponse = {
|
|
516
|
+
properties?: {
|
|
517
|
+
"@count"?: string;
|
|
518
|
+
"@href"?: string;
|
|
519
|
+
property?: Partial<PageProperty> | Partial<PageProperty>[] | "";
|
|
520
|
+
}
|
|
521
|
+
};
|
|
522
|
+
|
|
523
|
+
export type DeletePagePropertiesKeyParams = BaseQueryParams;
|
|
524
|
+
|
|
525
|
+
export type PutPagePropertiesKeyParams = {
|
|
526
|
+
abort?: "never" | "modified" | "exists";
|
|
527
|
+
description?: string;
|
|
528
|
+
etag?: string;
|
|
529
|
+
} & BaseQueryParams;
|
|
530
|
+
|
|
531
|
+
export type PutPagePropertiesKeyResponse = PageProperty;
|
|
532
|
+
|
|
533
|
+
export type PostPageRatingsParams = {
|
|
534
|
+
score: number;
|
|
535
|
+
} & BaseQueryParams;
|
|
536
|
+
|
|
537
|
+
export type PostPageRevertParams = {
|
|
538
|
+
verbose?: boolean;
|
|
539
|
+
abort?: "never" | "conflict";
|
|
540
|
+
fromrevision?: string;
|
|
541
|
+
} & BaseQueryParams;
|
|
542
|
+
|
|
543
|
+
export type DeletePageSecurityParams = BaseQueryParams;
|
|
544
|
+
|
|
545
|
+
export type PostPageSecurityParams = {
|
|
546
|
+
cascade?: "none" | "delta";
|
|
547
|
+
} & BaseQueryParams;
|
|
548
|
+
|
|
549
|
+
export type PostPageSecurityResponse = Partial<PageSecurity>;
|
|
550
|
+
|
|
551
|
+
export type PutPageSecurityParams = {
|
|
552
|
+
cascade?: "none" | "delta" | "absolute";
|
|
553
|
+
} & BaseQueryParams;
|
|
554
|
+
|
|
555
|
+
export type PutPageSecurityResponse = Partial<PageSecurity>;
|
|
556
|
+
|
|
557
|
+
export type PutPageTagsParams = BaseQueryParams;
|
|
558
|
+
|
|
559
|
+
export type PutPageTagsResponse = Partial<Tags>;
|
|
560
|
+
|
|
561
|
+
export type PagePath = {
|
|
562
|
+
"@seo": string;
|
|
563
|
+
"@type": string;
|
|
564
|
+
"#text": string;
|
|
565
|
+
};
|
|
566
|
+
|
|
567
|
+
export type Subpages = {
|
|
568
|
+
page: Partial<Subpage>[] | Partial<Subpage>;
|
|
569
|
+
};
|
|
570
|
+
|
|
571
|
+
export type Subpage = {
|
|
572
|
+
"@id": string;
|
|
573
|
+
"@guid": string;
|
|
574
|
+
"@draft.state": string;
|
|
575
|
+
"@href": string;
|
|
576
|
+
"@deleted": string;
|
|
577
|
+
"date.created": string;
|
|
578
|
+
language: string;
|
|
579
|
+
namespace: string;
|
|
580
|
+
path: Partial<PagePath> | "";
|
|
581
|
+
subpages: Subpages | "";
|
|
582
|
+
title: string;
|
|
583
|
+
"uri.ui": string;
|
|
584
|
+
};
|
|
585
|
+
|
|
586
|
+
export type PageBase = {
|
|
587
|
+
"@id": string;
|
|
588
|
+
"@guid": string;
|
|
589
|
+
"@draft.state": string;
|
|
590
|
+
"@href": string;
|
|
591
|
+
"@deleted": string;
|
|
592
|
+
"@revision": string;
|
|
593
|
+
"@terminal": string;
|
|
594
|
+
"@subpages": string;
|
|
595
|
+
"@files": string;
|
|
596
|
+
article: string;
|
|
597
|
+
"date.created": string;
|
|
598
|
+
"date.modified": string;
|
|
599
|
+
language: string;
|
|
600
|
+
namespace: string;
|
|
601
|
+
path: Partial<PagePath> | "";
|
|
602
|
+
restriction: string;
|
|
603
|
+
security: Partial<PageSecurity> | "";
|
|
604
|
+
title: string;
|
|
605
|
+
"uri.ui": string;
|
|
606
|
+
};
|
|
607
|
+
|
|
608
|
+
export type PageExtended = {
|
|
609
|
+
"@unpublish": string;
|
|
610
|
+
aliases: {
|
|
611
|
+
[key: string]: string;
|
|
612
|
+
} | "";
|
|
613
|
+
comments: {
|
|
614
|
+
"@count"?: string;
|
|
615
|
+
"@href"?: string;
|
|
616
|
+
} | "";
|
|
617
|
+
contents: Partial<Contents> | "";
|
|
618
|
+
"contents.alt": {
|
|
619
|
+
"@type": string;
|
|
620
|
+
"@href": string;
|
|
621
|
+
} | "";
|
|
622
|
+
"date.edited": string;
|
|
623
|
+
description: string;
|
|
624
|
+
files: {
|
|
625
|
+
"@count?": string;
|
|
626
|
+
"@href?": string;
|
|
627
|
+
file?: Partial<PageFile> | Partial<PageFile>[] | "";
|
|
628
|
+
} | "";
|
|
629
|
+
inbound: {
|
|
630
|
+
"@count"?: string;
|
|
631
|
+
page?: Partial<PageBase> | Partial<PageBase>[] | "";
|
|
632
|
+
} | "";
|
|
633
|
+
"language.effective": string;
|
|
634
|
+
metrics: {
|
|
635
|
+
"metric.charcount"?: string;
|
|
636
|
+
"metric.views"?: string;
|
|
637
|
+
} | "";
|
|
638
|
+
outbound: {
|
|
639
|
+
"@count"?: string;
|
|
640
|
+
page?: Partial<PageBase> | Partial<PageBase>[] | "";
|
|
641
|
+
} | "";
|
|
642
|
+
"page.parent": Partial<PageBase> | "";
|
|
643
|
+
"page.redirectedfrom": string;
|
|
644
|
+
properties: {
|
|
645
|
+
"@count"?: string;
|
|
646
|
+
"@href"?: string;
|
|
647
|
+
property?: PageProperty[];
|
|
648
|
+
} | "";
|
|
649
|
+
rating: Partial<PageRating> | "";
|
|
650
|
+
revisions: Partial<PageRevision> | "";
|
|
651
|
+
"revisions.archive": Partial<PageRevision> | "";
|
|
652
|
+
subpages: {
|
|
653
|
+
"@href"?: string;
|
|
654
|
+
} | "";
|
|
655
|
+
summary: string;
|
|
656
|
+
tags: Partial<Tags> | "";
|
|
657
|
+
timeuuid: string;
|
|
658
|
+
"user.author": Partial<ExpertUser> | "";
|
|
659
|
+
"user.createdby": Partial<ExpertUser> | "";
|
|
660
|
+
};
|
|
661
|
+
|
|
662
|
+
export type PageRating = {
|
|
663
|
+
"@score": string;
|
|
664
|
+
"@count": string;
|
|
665
|
+
"@seated.score": string;
|
|
666
|
+
"@seated.count": string;
|
|
667
|
+
"@unseated.score": string;
|
|
668
|
+
"@unseated.count": string;
|
|
669
|
+
"@anonymous.score": string;
|
|
670
|
+
"@anonymous.count": string;
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
export type PageRevision = {
|
|
674
|
+
"@count": string;
|
|
675
|
+
"@deprecated": string;
|
|
676
|
+
"@totalcount": string;
|
|
677
|
+
"@href": string;
|
|
678
|
+
};
|
|
679
|
+
|
|
680
|
+
export type PageFile = {
|
|
681
|
+
"@id": string;
|
|
682
|
+
"@revision": string;
|
|
683
|
+
"@res-id": string;
|
|
684
|
+
"@href": string;
|
|
685
|
+
"@res-is-head": string;
|
|
686
|
+
"@res-is-deleted": string;
|
|
687
|
+
"@res-rev-is-deleted": string;
|
|
688
|
+
"@res-contents-id": string;
|
|
689
|
+
"alt-text": string;
|
|
690
|
+
contents: Partial<Contents> | "";
|
|
691
|
+
"contents.preview": Partial<ContentsPreview> | Partial<ContentsPreview>[] | "";
|
|
692
|
+
"date.created": string;
|
|
693
|
+
"date.last-modified": string;
|
|
694
|
+
description: string;
|
|
695
|
+
filename: string;
|
|
696
|
+
"page.parent": Partial<PageBase> | "";
|
|
697
|
+
revisions: Partial<PageRevision> | "";
|
|
698
|
+
"user-action": {
|
|
699
|
+
"@type"?: string;
|
|
700
|
+
} | "";
|
|
701
|
+
"user.createdBy": Partial<ExpertUser> | "";
|
|
702
|
+
};
|
|
703
|
+
|
|
704
|
+
export type PageTag = {
|
|
705
|
+
"@value": string;
|
|
706
|
+
"@id": string;
|
|
707
|
+
"@href": string;
|
|
708
|
+
title: string;
|
|
709
|
+
type: string;
|
|
710
|
+
uri: string;
|
|
711
|
+
related: {
|
|
712
|
+
"@count"?: string;
|
|
713
|
+
page?: Partial<PageBase> | Partial<PageBase>[] | "";
|
|
714
|
+
} | "";
|
|
715
|
+
};
|
|
716
|
+
|
|
717
|
+
export type Contents = {
|
|
718
|
+
"@type": string;
|
|
719
|
+
"@size": string;
|
|
720
|
+
"@width": string;
|
|
721
|
+
"@height": string;
|
|
722
|
+
"@href": string;
|
|
723
|
+
"#text": string;
|
|
724
|
+
properties: {
|
|
725
|
+
property: Partial<PageProperty> | Partial<PageProperty>[] | "";
|
|
726
|
+
} | "";
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
export type ContentsPreview = {
|
|
730
|
+
"@rel": string;
|
|
731
|
+
"@type": string;
|
|
732
|
+
"@maxwidth": string;
|
|
733
|
+
"@maxheight": string;
|
|
734
|
+
"@href": string;
|
|
735
|
+
"@etag": string;
|
|
736
|
+
};
|
|
737
|
+
|
|
738
|
+
export type Tags = {
|
|
739
|
+
"@count"?: string;
|
|
740
|
+
"@href"?: string;
|
|
741
|
+
tag?: Partial<PageTag> | Partial<PageTag>[] | "";
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
export type PageProperty = {
|
|
745
|
+
"@etag": string;
|
|
746
|
+
"@href": string;
|
|
747
|
+
"@name": string;
|
|
748
|
+
"@resid": string;
|
|
749
|
+
"@resource-is-deleted": string;
|
|
750
|
+
"@resource-rev-is-deleted": string;
|
|
751
|
+
"@revision": string;
|
|
752
|
+
"change-description": string;
|
|
753
|
+
contents: Pick<Contents, '@href' | '@size' | '#text' | '@type'>;
|
|
754
|
+
"date.modified": string;
|
|
755
|
+
"user.modified": ExpertUser;
|
|
756
|
+
}
|
|
757
|
+
|
|
758
|
+
export type page_subpage = {
|
|
759
|
+
"@totalcount": string;
|
|
760
|
+
"@count": string;
|
|
761
|
+
"@href": string;
|
|
762
|
+
"page.subpage": Partial<PageBase> | Partial<PageBase>[] | "";
|
|
763
|
+
}
|
|
764
|
+
|
|
765
|
+
export type exprCall = {
|
|
766
|
+
"@name": string;
|
|
767
|
+
"@elapsed": string;
|
|
768
|
+
"@avg": string;
|
|
769
|
+
"@max": string;
|
|
770
|
+
"@percent": string;
|
|
771
|
+
"@count": string;
|
|
772
|
+
"@mode": string;
|
|
773
|
+
function: functionCall | functionCall[] | "";
|
|
774
|
+
}
|
|
775
|
+
|
|
776
|
+
export type functionCall = {
|
|
777
|
+
"@name": string;
|
|
778
|
+
"@elapsed": string;
|
|
779
|
+
"@avg": string;
|
|
780
|
+
"@max": string;
|
|
781
|
+
"@percent": string;
|
|
782
|
+
"@count": string;
|
|
783
|
+
"@mode": string;
|
|
784
|
+
"@location": string;
|
|
785
|
+
expr: exprCall | exprCall[] | "";
|
|
786
|
+
}
|
|
787
|
+
|
|
788
|
+
export type importCall = {
|
|
789
|
+
"@name": string;
|
|
790
|
+
"@elapsed": string;
|
|
791
|
+
"@avg": string;
|
|
792
|
+
"@max": string;
|
|
793
|
+
"@percent": string;
|
|
794
|
+
"@count": string;
|
|
795
|
+
"@mode": string;
|
|
796
|
+
"@recursive": string;
|
|
797
|
+
"@location": string;
|
|
798
|
+
import: importCall | importCall[] | "";
|
|
799
|
+
}
|
|
800
|
+
|
|
801
|
+
export type pageCall = {
|
|
802
|
+
"@name": string;
|
|
803
|
+
"@elapsed": string;
|
|
804
|
+
"@avg": string;
|
|
805
|
+
"@max": string;
|
|
806
|
+
"@percent": string;
|
|
807
|
+
"@count": string;
|
|
808
|
+
"@mode": string;
|
|
809
|
+
import: importCall | importCall[] | "";
|
|
810
|
+
template: templateCall | templateCall[] | "";
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
export type propertyCall = {
|
|
814
|
+
"@name": string;
|
|
815
|
+
"@elapsed": string;
|
|
816
|
+
"@avg": string;
|
|
817
|
+
"@max": string;
|
|
818
|
+
"@percent": string;
|
|
819
|
+
"@count": string;
|
|
820
|
+
"@mode": string;
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
export type templateCall = {
|
|
824
|
+
"@name": string;
|
|
825
|
+
"@elapsed": string;
|
|
826
|
+
"@avg": string;
|
|
827
|
+
"@max": string;
|
|
828
|
+
"@percent": string;
|
|
829
|
+
"@count": string;
|
|
830
|
+
"@mode": string;
|
|
831
|
+
"@location": string;
|
|
832
|
+
function: functionCall | functionCall[] | "";
|
|
833
|
+
property: propertyCall | propertyCall[] | "";
|
|
834
|
+
template: templateCall | templateCall[] | "";
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
export type Entry = {
|
|
838
|
+
"@name": string;
|
|
839
|
+
"@value": string;
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
export type Query = {
|
|
843
|
+
"@name": string;
|
|
844
|
+
"@elapsed": string;
|
|
845
|
+
"@average": string;
|
|
846
|
+
"@max": string;
|
|
847
|
+
"@count": string;
|
|
848
|
+
}
|
|
849
|
+
|
|
850
|
+
export type DeletedPage = {
|
|
851
|
+
"@id": number;
|
|
852
|
+
"@href": string;
|
|
853
|
+
title: string;
|
|
854
|
+
path: string;
|
|
855
|
+
}
|
|
856
|
+
|
|
857
|
+
export type Allowed = {
|
|
858
|
+
"@id": string;
|
|
172
859
|
}
|