trilium-api 1.0.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/.github/workflows/ci.yml +37 -0
- package/.github/workflows/publish.yml +86 -0
- package/LICENSE +661 -0
- package/README.md +836 -0
- package/package.json +32 -0
- package/src/client.test.ts +477 -0
- package/src/client.ts +91 -0
- package/src/demo-mapper.ts +166 -0
- package/src/demo-search.ts +108 -0
- package/src/demo.ts +126 -0
- package/src/generated/trilium.d.ts +1758 -0
- package/src/index.ts +35 -0
- package/src/mapper.test.ts +638 -0
- package/src/mapper.ts +534 -0
- package/tsconfig.json +42 -0
|
@@ -0,0 +1,1758 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/create-note": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
get?: never;
|
|
15
|
+
put?: never;
|
|
16
|
+
/** @description Create a note and place it into the note tree */
|
|
17
|
+
post: operations["createNote"];
|
|
18
|
+
delete?: never;
|
|
19
|
+
options?: never;
|
|
20
|
+
head?: never;
|
|
21
|
+
patch?: never;
|
|
22
|
+
trace?: never;
|
|
23
|
+
};
|
|
24
|
+
"/notes": {
|
|
25
|
+
parameters: {
|
|
26
|
+
query?: never;
|
|
27
|
+
header?: never;
|
|
28
|
+
path?: never;
|
|
29
|
+
cookie?: never;
|
|
30
|
+
};
|
|
31
|
+
/** @description Search notes */
|
|
32
|
+
get: operations["searchNotes"];
|
|
33
|
+
put?: never;
|
|
34
|
+
post?: never;
|
|
35
|
+
delete?: never;
|
|
36
|
+
options?: never;
|
|
37
|
+
head?: never;
|
|
38
|
+
patch?: never;
|
|
39
|
+
trace?: never;
|
|
40
|
+
};
|
|
41
|
+
"/notes/{noteId}": {
|
|
42
|
+
parameters: {
|
|
43
|
+
query?: never;
|
|
44
|
+
header?: never;
|
|
45
|
+
path: {
|
|
46
|
+
noteId: components["schemas"]["EntityId"];
|
|
47
|
+
};
|
|
48
|
+
cookie?: never;
|
|
49
|
+
};
|
|
50
|
+
/** @description Returns a note identified by its ID */
|
|
51
|
+
get: operations["getNoteById"];
|
|
52
|
+
put?: never;
|
|
53
|
+
post?: never;
|
|
54
|
+
/** @description deletes a single note based on the noteId supplied */
|
|
55
|
+
delete: operations["deleteNoteById"];
|
|
56
|
+
options?: never;
|
|
57
|
+
head?: never;
|
|
58
|
+
/** @description patch a note identified by the noteId with changes in the body */
|
|
59
|
+
patch: operations["patchNoteById"];
|
|
60
|
+
trace?: never;
|
|
61
|
+
};
|
|
62
|
+
"/notes/{noteId}/content": {
|
|
63
|
+
parameters: {
|
|
64
|
+
query?: never;
|
|
65
|
+
header?: never;
|
|
66
|
+
path: {
|
|
67
|
+
noteId: components["schemas"]["EntityId"];
|
|
68
|
+
};
|
|
69
|
+
cookie?: never;
|
|
70
|
+
};
|
|
71
|
+
/** @description Returns note content identified by its ID */
|
|
72
|
+
get: operations["getNoteContent"];
|
|
73
|
+
/** @description Updates note content identified by its ID */
|
|
74
|
+
put: operations["putNoteContentById"];
|
|
75
|
+
post?: never;
|
|
76
|
+
delete?: never;
|
|
77
|
+
options?: never;
|
|
78
|
+
head?: never;
|
|
79
|
+
patch?: never;
|
|
80
|
+
trace?: never;
|
|
81
|
+
};
|
|
82
|
+
"/notes/{noteId}/export": {
|
|
83
|
+
parameters: {
|
|
84
|
+
query?: {
|
|
85
|
+
format?: "html" | "markdown" | "share";
|
|
86
|
+
};
|
|
87
|
+
header?: never;
|
|
88
|
+
path: {
|
|
89
|
+
noteId: components["schemas"]["EntityId"];
|
|
90
|
+
};
|
|
91
|
+
cookie?: never;
|
|
92
|
+
};
|
|
93
|
+
/** @description Exports ZIP file export of a given note subtree. To export whole document, use "root" for noteId */
|
|
94
|
+
get: operations["exportNoteSubtree"];
|
|
95
|
+
put?: never;
|
|
96
|
+
post?: never;
|
|
97
|
+
delete?: never;
|
|
98
|
+
options?: never;
|
|
99
|
+
head?: never;
|
|
100
|
+
patch?: never;
|
|
101
|
+
trace?: never;
|
|
102
|
+
};
|
|
103
|
+
"/notes/{noteId}/import": {
|
|
104
|
+
parameters: {
|
|
105
|
+
query?: never;
|
|
106
|
+
header?: never;
|
|
107
|
+
path: {
|
|
108
|
+
noteId: components["schemas"]["EntityId"];
|
|
109
|
+
};
|
|
110
|
+
cookie?: never;
|
|
111
|
+
};
|
|
112
|
+
get?: never;
|
|
113
|
+
put?: never;
|
|
114
|
+
/** @description Imports ZIP file into a given note. */
|
|
115
|
+
post: operations["importZip"];
|
|
116
|
+
delete?: never;
|
|
117
|
+
options?: never;
|
|
118
|
+
head?: never;
|
|
119
|
+
patch?: never;
|
|
120
|
+
trace?: never;
|
|
121
|
+
};
|
|
122
|
+
"/notes/{noteId}/revision": {
|
|
123
|
+
parameters: {
|
|
124
|
+
query?: {
|
|
125
|
+
format?: "html" | "markdown";
|
|
126
|
+
};
|
|
127
|
+
header?: never;
|
|
128
|
+
path: {
|
|
129
|
+
noteId: components["schemas"]["EntityId"];
|
|
130
|
+
};
|
|
131
|
+
cookie?: never;
|
|
132
|
+
};
|
|
133
|
+
get?: never;
|
|
134
|
+
put?: never;
|
|
135
|
+
/** @description Create a note revision for the given note */
|
|
136
|
+
post: operations["createRevision"];
|
|
137
|
+
delete?: never;
|
|
138
|
+
options?: never;
|
|
139
|
+
head?: never;
|
|
140
|
+
patch?: never;
|
|
141
|
+
trace?: never;
|
|
142
|
+
};
|
|
143
|
+
"/branches": {
|
|
144
|
+
parameters: {
|
|
145
|
+
query?: never;
|
|
146
|
+
header?: never;
|
|
147
|
+
path?: never;
|
|
148
|
+
cookie?: never;
|
|
149
|
+
};
|
|
150
|
+
get?: never;
|
|
151
|
+
put?: never;
|
|
152
|
+
/** @description Create a branch (clone a note to a different location in the tree). In case there is a branch between parent note and child note already, then this will update the existing branch with prefix, notePosition and isExpanded. */
|
|
153
|
+
post: operations["postBranch"];
|
|
154
|
+
delete?: never;
|
|
155
|
+
options?: never;
|
|
156
|
+
head?: never;
|
|
157
|
+
patch?: never;
|
|
158
|
+
trace?: never;
|
|
159
|
+
};
|
|
160
|
+
"/branches/{branchId}": {
|
|
161
|
+
parameters: {
|
|
162
|
+
query?: never;
|
|
163
|
+
header?: never;
|
|
164
|
+
path: {
|
|
165
|
+
branchId: components["schemas"]["EntityId"];
|
|
166
|
+
};
|
|
167
|
+
cookie?: never;
|
|
168
|
+
};
|
|
169
|
+
/** @description Returns a branch identified by its ID */
|
|
170
|
+
get: operations["getBranchById"];
|
|
171
|
+
put?: never;
|
|
172
|
+
post?: never;
|
|
173
|
+
/** @description deletes a branch based on the branchId supplied. If this is the last branch of the (child) note, then the note is deleted as well. */
|
|
174
|
+
delete: operations["deleteBranchById"];
|
|
175
|
+
options?: never;
|
|
176
|
+
head?: never;
|
|
177
|
+
/** @description patch a branch identified by the branchId with changes in the body. Only prefix and notePosition can be updated. If you want to update other properties, you need to delete the old branch and create a new one. */
|
|
178
|
+
patch: operations["patchBranchById"];
|
|
179
|
+
trace?: never;
|
|
180
|
+
};
|
|
181
|
+
"/attachments": {
|
|
182
|
+
parameters: {
|
|
183
|
+
query?: never;
|
|
184
|
+
header?: never;
|
|
185
|
+
path?: never;
|
|
186
|
+
cookie?: never;
|
|
187
|
+
};
|
|
188
|
+
get?: never;
|
|
189
|
+
put?: never;
|
|
190
|
+
/** @description create an attachment */
|
|
191
|
+
post: operations["postAttachment"];
|
|
192
|
+
delete?: never;
|
|
193
|
+
options?: never;
|
|
194
|
+
head?: never;
|
|
195
|
+
patch?: never;
|
|
196
|
+
trace?: never;
|
|
197
|
+
};
|
|
198
|
+
"/attachments/{attachmentId}": {
|
|
199
|
+
parameters: {
|
|
200
|
+
query?: never;
|
|
201
|
+
header?: never;
|
|
202
|
+
path: {
|
|
203
|
+
attachmentId: components["schemas"]["EntityId"];
|
|
204
|
+
};
|
|
205
|
+
cookie?: never;
|
|
206
|
+
};
|
|
207
|
+
/** @description Returns an attachment identified by its ID */
|
|
208
|
+
get: operations["getAttachmentById"];
|
|
209
|
+
put?: never;
|
|
210
|
+
post?: never;
|
|
211
|
+
/** @description deletes an attachment based on the attachmentId supplied. */
|
|
212
|
+
delete: operations["deleteAttachmentById"];
|
|
213
|
+
options?: never;
|
|
214
|
+
head?: never;
|
|
215
|
+
/** @description patch an attachment identified by the attachmentId with changes in the body. Only role, mime, title, and position are patchable. */
|
|
216
|
+
patch: operations["patchAttachmentById"];
|
|
217
|
+
trace?: never;
|
|
218
|
+
};
|
|
219
|
+
"/attachments/{attachmentId}/content": {
|
|
220
|
+
parameters: {
|
|
221
|
+
query?: never;
|
|
222
|
+
header?: never;
|
|
223
|
+
path: {
|
|
224
|
+
attachmentId: components["schemas"]["EntityId"];
|
|
225
|
+
};
|
|
226
|
+
cookie?: never;
|
|
227
|
+
};
|
|
228
|
+
/** @description Returns attachment content identified by its ID */
|
|
229
|
+
get: operations["getAttachmentContent"];
|
|
230
|
+
/** @description Updates attachment content identified by its ID */
|
|
231
|
+
put: operations["putAttachmentContentById"];
|
|
232
|
+
post?: never;
|
|
233
|
+
delete?: never;
|
|
234
|
+
options?: never;
|
|
235
|
+
head?: never;
|
|
236
|
+
patch?: never;
|
|
237
|
+
trace?: never;
|
|
238
|
+
};
|
|
239
|
+
"/attributes": {
|
|
240
|
+
parameters: {
|
|
241
|
+
query?: never;
|
|
242
|
+
header?: never;
|
|
243
|
+
path?: never;
|
|
244
|
+
cookie?: never;
|
|
245
|
+
};
|
|
246
|
+
get?: never;
|
|
247
|
+
put?: never;
|
|
248
|
+
/** @description create an attribute for a given note */
|
|
249
|
+
post: operations["postAttribute"];
|
|
250
|
+
delete?: never;
|
|
251
|
+
options?: never;
|
|
252
|
+
head?: never;
|
|
253
|
+
patch?: never;
|
|
254
|
+
trace?: never;
|
|
255
|
+
};
|
|
256
|
+
"/attributes/{attributeId}": {
|
|
257
|
+
parameters: {
|
|
258
|
+
query?: never;
|
|
259
|
+
header?: never;
|
|
260
|
+
path: {
|
|
261
|
+
attributeId: components["schemas"]["EntityId"];
|
|
262
|
+
};
|
|
263
|
+
cookie?: never;
|
|
264
|
+
};
|
|
265
|
+
/** @description Returns an attribute identified by its ID */
|
|
266
|
+
get: operations["getAttributeById"];
|
|
267
|
+
put?: never;
|
|
268
|
+
post?: never;
|
|
269
|
+
/** @description deletes an attribute based on the attributeId supplied. */
|
|
270
|
+
delete: operations["deleteAttributeById"];
|
|
271
|
+
options?: never;
|
|
272
|
+
head?: never;
|
|
273
|
+
/** @description patch an attribute identified by the attributeId with changes in the body. For labels, only value and position can be updated. For relations, only position can be updated. If you want to modify other properties, you need to delete the old attribute and create a new one. */
|
|
274
|
+
patch: operations["patchAttributeById"];
|
|
275
|
+
trace?: never;
|
|
276
|
+
};
|
|
277
|
+
"/refresh-note-ordering/{parentNoteId}": {
|
|
278
|
+
parameters: {
|
|
279
|
+
query?: never;
|
|
280
|
+
header?: never;
|
|
281
|
+
path: {
|
|
282
|
+
parentNoteId: components["schemas"]["EntityId"];
|
|
283
|
+
};
|
|
284
|
+
cookie?: never;
|
|
285
|
+
};
|
|
286
|
+
get?: never;
|
|
287
|
+
put?: never;
|
|
288
|
+
/** @description notePositions in branches are not automatically pushed to connected clients and need a specific instruction. If you want your changes to be in effect immediately, call this service after setting branches' notePosition. Note that you need to supply "parentNoteId" of branch(es) with changed positions. */
|
|
289
|
+
post: operations["postRefreshNoteOrdering"];
|
|
290
|
+
delete?: never;
|
|
291
|
+
options?: never;
|
|
292
|
+
head?: never;
|
|
293
|
+
patch?: never;
|
|
294
|
+
trace?: never;
|
|
295
|
+
};
|
|
296
|
+
"/inbox/{date}": {
|
|
297
|
+
parameters: {
|
|
298
|
+
query?: never;
|
|
299
|
+
header?: never;
|
|
300
|
+
path?: never;
|
|
301
|
+
cookie?: never;
|
|
302
|
+
};
|
|
303
|
+
/** @description returns an "inbox" note, into which note can be created. Date will be used depending on whether the inbox is a fixed note (identified with #inbox label) or a day note in a journal. */
|
|
304
|
+
get: operations["getInboxNote"];
|
|
305
|
+
put?: never;
|
|
306
|
+
post?: never;
|
|
307
|
+
delete?: never;
|
|
308
|
+
options?: never;
|
|
309
|
+
head?: never;
|
|
310
|
+
patch?: never;
|
|
311
|
+
trace?: never;
|
|
312
|
+
};
|
|
313
|
+
"/calendar/days/{date}": {
|
|
314
|
+
parameters: {
|
|
315
|
+
query?: never;
|
|
316
|
+
header?: never;
|
|
317
|
+
path?: never;
|
|
318
|
+
cookie?: never;
|
|
319
|
+
};
|
|
320
|
+
/** @description returns a day note for a given date. Gets created if doesn't exist. */
|
|
321
|
+
get: operations["getDayNote"];
|
|
322
|
+
put?: never;
|
|
323
|
+
post?: never;
|
|
324
|
+
delete?: never;
|
|
325
|
+
options?: never;
|
|
326
|
+
head?: never;
|
|
327
|
+
patch?: never;
|
|
328
|
+
trace?: never;
|
|
329
|
+
};
|
|
330
|
+
"/calendar/weeks/{date}": {
|
|
331
|
+
parameters: {
|
|
332
|
+
query?: never;
|
|
333
|
+
header?: never;
|
|
334
|
+
path?: never;
|
|
335
|
+
cookie?: never;
|
|
336
|
+
};
|
|
337
|
+
/** @description returns a week note for a given date. Gets created if doesn't exist. */
|
|
338
|
+
get: operations["getWeekFirstDayNote"];
|
|
339
|
+
put?: never;
|
|
340
|
+
post?: never;
|
|
341
|
+
delete?: never;
|
|
342
|
+
options?: never;
|
|
343
|
+
head?: never;
|
|
344
|
+
patch?: never;
|
|
345
|
+
trace?: never;
|
|
346
|
+
};
|
|
347
|
+
"/calendar/months/{month}": {
|
|
348
|
+
parameters: {
|
|
349
|
+
query?: never;
|
|
350
|
+
header?: never;
|
|
351
|
+
path?: never;
|
|
352
|
+
cookie?: never;
|
|
353
|
+
};
|
|
354
|
+
/** @description returns a week note for a given date. Gets created if doesn't exist. */
|
|
355
|
+
get: operations["getMonthNote"];
|
|
356
|
+
put?: never;
|
|
357
|
+
post?: never;
|
|
358
|
+
delete?: never;
|
|
359
|
+
options?: never;
|
|
360
|
+
head?: never;
|
|
361
|
+
patch?: never;
|
|
362
|
+
trace?: never;
|
|
363
|
+
};
|
|
364
|
+
"/calendar/years/{year}": {
|
|
365
|
+
parameters: {
|
|
366
|
+
query?: never;
|
|
367
|
+
header?: never;
|
|
368
|
+
path?: never;
|
|
369
|
+
cookie?: never;
|
|
370
|
+
};
|
|
371
|
+
/** @description returns a week note for a given date. Gets created if doesn't exist. */
|
|
372
|
+
get: operations["getYearNote"];
|
|
373
|
+
put?: never;
|
|
374
|
+
post?: never;
|
|
375
|
+
delete?: never;
|
|
376
|
+
options?: never;
|
|
377
|
+
head?: never;
|
|
378
|
+
patch?: never;
|
|
379
|
+
trace?: never;
|
|
380
|
+
};
|
|
381
|
+
"/auth/login": {
|
|
382
|
+
parameters: {
|
|
383
|
+
query?: never;
|
|
384
|
+
header?: never;
|
|
385
|
+
path?: never;
|
|
386
|
+
cookie?: never;
|
|
387
|
+
};
|
|
388
|
+
get?: never;
|
|
389
|
+
put?: never;
|
|
390
|
+
/** @description get an ETAPI token based on password for further use with ETAPI */
|
|
391
|
+
post: operations["login"];
|
|
392
|
+
delete?: never;
|
|
393
|
+
options?: never;
|
|
394
|
+
head?: never;
|
|
395
|
+
patch?: never;
|
|
396
|
+
trace?: never;
|
|
397
|
+
};
|
|
398
|
+
"/auth/logout": {
|
|
399
|
+
parameters: {
|
|
400
|
+
query?: never;
|
|
401
|
+
header?: never;
|
|
402
|
+
path?: never;
|
|
403
|
+
cookie?: never;
|
|
404
|
+
};
|
|
405
|
+
get?: never;
|
|
406
|
+
put?: never;
|
|
407
|
+
/** @description logout (delete/deactivate) an ETAPI token */
|
|
408
|
+
post: operations["logout"];
|
|
409
|
+
delete?: never;
|
|
410
|
+
options?: never;
|
|
411
|
+
head?: never;
|
|
412
|
+
patch?: never;
|
|
413
|
+
trace?: never;
|
|
414
|
+
};
|
|
415
|
+
"/app-info": {
|
|
416
|
+
parameters: {
|
|
417
|
+
query?: never;
|
|
418
|
+
header?: never;
|
|
419
|
+
path?: never;
|
|
420
|
+
cookie?: never;
|
|
421
|
+
};
|
|
422
|
+
/** @description returns information about the running Trilium instance */
|
|
423
|
+
get: operations["getAppInfo"];
|
|
424
|
+
put?: never;
|
|
425
|
+
post?: never;
|
|
426
|
+
delete?: never;
|
|
427
|
+
options?: never;
|
|
428
|
+
head?: never;
|
|
429
|
+
patch?: never;
|
|
430
|
+
trace?: never;
|
|
431
|
+
};
|
|
432
|
+
"/backup/{backupName}": {
|
|
433
|
+
parameters: {
|
|
434
|
+
query?: never;
|
|
435
|
+
header?: never;
|
|
436
|
+
path: {
|
|
437
|
+
/** @description If the backupName is e.g. "now", then the backup will be written to "backup-now.db" file */
|
|
438
|
+
backupName: components["schemas"]["StringId"];
|
|
439
|
+
};
|
|
440
|
+
cookie?: never;
|
|
441
|
+
};
|
|
442
|
+
get?: never;
|
|
443
|
+
/** @description Create a database backup under a given name */
|
|
444
|
+
put: operations["createBackup"];
|
|
445
|
+
post?: never;
|
|
446
|
+
delete?: never;
|
|
447
|
+
options?: never;
|
|
448
|
+
head?: never;
|
|
449
|
+
patch?: never;
|
|
450
|
+
trace?: never;
|
|
451
|
+
};
|
|
452
|
+
}
|
|
453
|
+
export type webhooks = Record<string, never>;
|
|
454
|
+
export interface components {
|
|
455
|
+
schemas: {
|
|
456
|
+
CreateNoteDef: {
|
|
457
|
+
/** @description Note ID of the parent note in the tree */
|
|
458
|
+
parentNoteId: components["schemas"]["EntityId"];
|
|
459
|
+
title: string;
|
|
460
|
+
/** @enum {string} */
|
|
461
|
+
type: "text" | "code" | "file" | "image" | "search" | "book" | "relationMap" | "render";
|
|
462
|
+
/**
|
|
463
|
+
* @description this needs to be specified only for note types 'code', 'file', 'image'.
|
|
464
|
+
* @example application/json
|
|
465
|
+
*/
|
|
466
|
+
mime?: string;
|
|
467
|
+
content: string;
|
|
468
|
+
/** @description Position of the note in the parent. Normal ordering is 10, 20, 30 ... So if you want to create a note on the first position, use e.g. 5, for second position 15, for last e.g. 1000000 */
|
|
469
|
+
notePosition?: number;
|
|
470
|
+
/** @description Prefix is branch (placement) specific title prefix for the note. Let's say you have your note placed into two different places in the tree, but you want to change the title a bit in one of the placements. For this you can use prefix. */
|
|
471
|
+
prefix?: string;
|
|
472
|
+
/** @description true if this note (as a folder) should appear expanded */
|
|
473
|
+
isExpanded?: boolean;
|
|
474
|
+
/** @description DON'T specify unless you want to force a specific noteId */
|
|
475
|
+
noteId?: components["schemas"]["EntityId"];
|
|
476
|
+
/** @description DON'T specify unless you want to force a specific branchId */
|
|
477
|
+
branchId?: components["schemas"]["EntityId"];
|
|
478
|
+
/** @description Local timestap of the note creation. Specify only if you want to override the default (current datetime in the current timezone/offset). */
|
|
479
|
+
dateCreated?: components["schemas"]["LocalDateTime"];
|
|
480
|
+
/** @description UTC timestap of the note creation. Specify only if you want to override the default (current datetime). */
|
|
481
|
+
utcDateCreated?: components["schemas"]["UtcDateTime"];
|
|
482
|
+
};
|
|
483
|
+
Note: {
|
|
484
|
+
readonly noteId?: components["schemas"]["EntityId"];
|
|
485
|
+
title?: string;
|
|
486
|
+
/** @enum {string} */
|
|
487
|
+
type?: "text" | "code" | "render" | "file" | "image" | "search" | "relationMap" | "book" | "noteMap" | "mermaid" | "webView" | "shortcut" | "doc" | "contentWidget" | "launcher";
|
|
488
|
+
mime?: string;
|
|
489
|
+
readonly isProtected?: boolean;
|
|
490
|
+
/** @description ID of the blob object which effectively serves as a content hash */
|
|
491
|
+
blobId?: string;
|
|
492
|
+
readonly attributes?: components["schemas"]["AttributeList"];
|
|
493
|
+
readonly parentNoteIds?: components["schemas"]["EntityIdList"];
|
|
494
|
+
readonly childNoteIds?: components["schemas"]["EntityIdList"];
|
|
495
|
+
readonly parentBranchIds?: components["schemas"]["EntityIdList"];
|
|
496
|
+
readonly childBranchIds?: components["schemas"]["EntityIdList"];
|
|
497
|
+
dateCreated?: components["schemas"]["LocalDateTime"];
|
|
498
|
+
readonly dateModified?: components["schemas"]["LocalDateTime"];
|
|
499
|
+
utcDateCreated?: components["schemas"]["UtcDateTime"];
|
|
500
|
+
readonly utcDateModified?: components["schemas"]["UtcDateTime"];
|
|
501
|
+
};
|
|
502
|
+
/** @description Branch places the note into the tree, it represents the relationship between a parent note and child note */
|
|
503
|
+
Branch: {
|
|
504
|
+
branchId?: components["schemas"]["EntityId"];
|
|
505
|
+
/** @description identifies the child note */
|
|
506
|
+
readonly noteId?: components["schemas"]["EntityId"];
|
|
507
|
+
/** @description identifies the parent note */
|
|
508
|
+
readonly parentNoteId?: components["schemas"]["EntityId"];
|
|
509
|
+
prefix?: string;
|
|
510
|
+
/** Format: int32 */
|
|
511
|
+
notePosition?: number;
|
|
512
|
+
isExpanded?: boolean;
|
|
513
|
+
readonly utcDateModified?: components["schemas"]["UtcDateTime"];
|
|
514
|
+
};
|
|
515
|
+
NoteWithBranch: {
|
|
516
|
+
note?: components["schemas"]["Note"];
|
|
517
|
+
branch?: components["schemas"]["Branch"];
|
|
518
|
+
};
|
|
519
|
+
/** @description Attachment is owned by a note, has title and content */
|
|
520
|
+
Attachment: {
|
|
521
|
+
readonly attachmentId?: components["schemas"]["EntityId"];
|
|
522
|
+
/** @description identifies the owner of the attachment, is either noteId or revisionId */
|
|
523
|
+
ownerId?: components["schemas"]["EntityId"];
|
|
524
|
+
role?: string;
|
|
525
|
+
mime?: string;
|
|
526
|
+
title?: string;
|
|
527
|
+
/** Format: int32 */
|
|
528
|
+
position?: number;
|
|
529
|
+
/** @description ID of the blob object which effectively serves as a content hash */
|
|
530
|
+
blobId?: string;
|
|
531
|
+
readonly dateModified?: components["schemas"]["LocalDateTime"];
|
|
532
|
+
readonly utcDateModified?: components["schemas"]["UtcDateTime"];
|
|
533
|
+
readonly utcDateScheduledForErasureSince?: components["schemas"]["UtcDateTime"];
|
|
534
|
+
/** Format: int32 */
|
|
535
|
+
contentLength?: number;
|
|
536
|
+
};
|
|
537
|
+
CreateAttachment: {
|
|
538
|
+
/** @description identifies the owner of the attachment, is either noteId or revisionId */
|
|
539
|
+
ownerId?: components["schemas"]["EntityId"];
|
|
540
|
+
role?: string;
|
|
541
|
+
mime?: string;
|
|
542
|
+
title?: string;
|
|
543
|
+
content?: string;
|
|
544
|
+
/** Format: int32 */
|
|
545
|
+
position?: number;
|
|
546
|
+
};
|
|
547
|
+
/** @description Attribute (Label, Relation) is a key-value record attached to a note. */
|
|
548
|
+
Attribute: {
|
|
549
|
+
attributeId?: components["schemas"]["EntityId"];
|
|
550
|
+
/** @description identifies the child note */
|
|
551
|
+
readonly noteId?: components["schemas"]["EntityId"];
|
|
552
|
+
/** @enum {string} */
|
|
553
|
+
type?: "label" | "relation";
|
|
554
|
+
/** @example shareCss */
|
|
555
|
+
name?: string;
|
|
556
|
+
value?: string;
|
|
557
|
+
/** Format: int32 */
|
|
558
|
+
position?: number;
|
|
559
|
+
isInheritable?: boolean;
|
|
560
|
+
readonly utcDateModified?: components["schemas"]["UtcDateTime"];
|
|
561
|
+
};
|
|
562
|
+
AttributeList: components["schemas"]["Attribute"][];
|
|
563
|
+
SearchResponse: {
|
|
564
|
+
results: components["schemas"]["Note"][];
|
|
565
|
+
/** @description debugging info on parsing the search query enabled with &debug=true parameter */
|
|
566
|
+
debugInfo?: Record<string, never>;
|
|
567
|
+
};
|
|
568
|
+
/** @example evnnmvHTCgIn */
|
|
569
|
+
EntityId: string;
|
|
570
|
+
/** @example my_ID */
|
|
571
|
+
StringId: string;
|
|
572
|
+
EntityIdList: components["schemas"]["EntityId"][];
|
|
573
|
+
/** @example 2021-12-31 20:18:11.930+0100 */
|
|
574
|
+
LocalDateTime: string;
|
|
575
|
+
/** @example 2021-12-31 19:18:11.930Z */
|
|
576
|
+
UtcDateTime: string;
|
|
577
|
+
AppInfo: {
|
|
578
|
+
/**
|
|
579
|
+
* @description Trilium version
|
|
580
|
+
* @example 0.50.2
|
|
581
|
+
*/
|
|
582
|
+
appVersion?: string;
|
|
583
|
+
/**
|
|
584
|
+
* Format: int32
|
|
585
|
+
* @description DB version
|
|
586
|
+
* @example 194
|
|
587
|
+
*/
|
|
588
|
+
dbVersion?: number;
|
|
589
|
+
/**
|
|
590
|
+
* Format: int32
|
|
591
|
+
* @description Sync protocol version
|
|
592
|
+
* @example 25
|
|
593
|
+
*/
|
|
594
|
+
syncVersion?: number;
|
|
595
|
+
/**
|
|
596
|
+
* Format: date-time
|
|
597
|
+
* @description build date
|
|
598
|
+
* @example 2022-02-09T22:52:36+01:00
|
|
599
|
+
*/
|
|
600
|
+
buildDate?: string;
|
|
601
|
+
/**
|
|
602
|
+
* @description git build revision
|
|
603
|
+
* @example 23daaa2387a0655685377f0a541d154aeec2aae8
|
|
604
|
+
*/
|
|
605
|
+
buildRevision?: string;
|
|
606
|
+
/**
|
|
607
|
+
* @description data directory where Trilium stores files
|
|
608
|
+
* @example /home/user/data
|
|
609
|
+
*/
|
|
610
|
+
dataDirectory?: string;
|
|
611
|
+
/**
|
|
612
|
+
* @description version of the supported Trilium Web Clipper protocol
|
|
613
|
+
* @example 1
|
|
614
|
+
*/
|
|
615
|
+
clipperProtocolVersion?: string;
|
|
616
|
+
/**
|
|
617
|
+
* @description current UTC date time
|
|
618
|
+
* @example 2022-03-07T21:54:25.277Z
|
|
619
|
+
*/
|
|
620
|
+
utcDateTime?: string;
|
|
621
|
+
};
|
|
622
|
+
Error: {
|
|
623
|
+
/**
|
|
624
|
+
* Format: int32
|
|
625
|
+
* @description HTTP status, identical to the one given in HTTP response
|
|
626
|
+
* @example 400
|
|
627
|
+
*/
|
|
628
|
+
status: number;
|
|
629
|
+
/**
|
|
630
|
+
* @description stable string constant
|
|
631
|
+
* @example NOTE_IS_PROTECTED
|
|
632
|
+
*/
|
|
633
|
+
code: string;
|
|
634
|
+
/**
|
|
635
|
+
* @description Human readable error, potentially with more details,
|
|
636
|
+
* @example Note 'evnnmvHTCgIn' is protected and cannot be modified through ETAPI
|
|
637
|
+
*/
|
|
638
|
+
message: string;
|
|
639
|
+
};
|
|
640
|
+
};
|
|
641
|
+
responses: never;
|
|
642
|
+
parameters: never;
|
|
643
|
+
requestBodies: never;
|
|
644
|
+
headers: never;
|
|
645
|
+
pathItems: never;
|
|
646
|
+
}
|
|
647
|
+
export type $defs = Record<string, never>;
|
|
648
|
+
export interface operations {
|
|
649
|
+
createNote: {
|
|
650
|
+
parameters: {
|
|
651
|
+
query?: never;
|
|
652
|
+
header?: never;
|
|
653
|
+
path?: never;
|
|
654
|
+
cookie?: never;
|
|
655
|
+
};
|
|
656
|
+
requestBody: {
|
|
657
|
+
content: {
|
|
658
|
+
"application/json": components["schemas"]["CreateNoteDef"];
|
|
659
|
+
};
|
|
660
|
+
};
|
|
661
|
+
responses: {
|
|
662
|
+
/** @description note created */
|
|
663
|
+
201: {
|
|
664
|
+
headers: {
|
|
665
|
+
[name: string]: unknown;
|
|
666
|
+
};
|
|
667
|
+
content: {
|
|
668
|
+
"application/json; charset=utf-8": components["schemas"]["NoteWithBranch"];
|
|
669
|
+
};
|
|
670
|
+
};
|
|
671
|
+
/** @description unexpected error */
|
|
672
|
+
default: {
|
|
673
|
+
headers: {
|
|
674
|
+
[name: string]: unknown;
|
|
675
|
+
};
|
|
676
|
+
content: {
|
|
677
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
678
|
+
};
|
|
679
|
+
};
|
|
680
|
+
};
|
|
681
|
+
};
|
|
682
|
+
searchNotes: {
|
|
683
|
+
parameters: {
|
|
684
|
+
query: {
|
|
685
|
+
/** @description search query string as described in https://triliumnext.github.io/Docs/Wiki/search.html */
|
|
686
|
+
search: string;
|
|
687
|
+
/** @description enable fast search (fulltext doesn't look into content) */
|
|
688
|
+
fastSearch?: boolean;
|
|
689
|
+
/** @description search by default ignores archived notes. Set to 'true' to includes archived notes into search results. */
|
|
690
|
+
includeArchivedNotes?: boolean;
|
|
691
|
+
/** @description search only in a subtree identified by the subtree noteId. By default whole tree is searched. */
|
|
692
|
+
ancestorNoteId?: components["schemas"]["EntityId"];
|
|
693
|
+
/** @description define how deep in the tree should the notes be searched */
|
|
694
|
+
ancestorDepth?: string;
|
|
695
|
+
/**
|
|
696
|
+
* @description name of the property/label to order search results by
|
|
697
|
+
* @example [
|
|
698
|
+
* "title",
|
|
699
|
+
* "#publicationDate",
|
|
700
|
+
* "isProtected",
|
|
701
|
+
* "isArchived",
|
|
702
|
+
* "dateCreated",
|
|
703
|
+
* "dateModified",
|
|
704
|
+
* "utcDateCreated",
|
|
705
|
+
* "utcDateModified",
|
|
706
|
+
* "parentCount",
|
|
707
|
+
* "childrenCount",
|
|
708
|
+
* "attributeCount",
|
|
709
|
+
* "labelCount",
|
|
710
|
+
* "ownedLabelCount",
|
|
711
|
+
* "relationCount",
|
|
712
|
+
* "ownedRelationCount",
|
|
713
|
+
* "relationCountIncludingLinks",
|
|
714
|
+
* "ownedRelationCountIncludingLinks",
|
|
715
|
+
* "targetRelationCount",
|
|
716
|
+
* "targetRelationCountIncludingLinks",
|
|
717
|
+
* "contentSize",
|
|
718
|
+
* "contentAndAttachmentsSize",
|
|
719
|
+
* "contentAndAttachmentsAndRevisionsSize",
|
|
720
|
+
* "revisionCount"
|
|
721
|
+
* ]
|
|
722
|
+
*/
|
|
723
|
+
orderBy?: string;
|
|
724
|
+
/** @description order direction, ascending or descending */
|
|
725
|
+
orderDirection?: "asc" | "desc";
|
|
726
|
+
/**
|
|
727
|
+
* @description limit the number of results you want to receive
|
|
728
|
+
* @example 10
|
|
729
|
+
*/
|
|
730
|
+
limit?: number;
|
|
731
|
+
/** @description set to true to get debug information in the response (search query parsing) */
|
|
732
|
+
debug?: boolean;
|
|
733
|
+
};
|
|
734
|
+
header?: never;
|
|
735
|
+
path?: never;
|
|
736
|
+
cookie?: never;
|
|
737
|
+
};
|
|
738
|
+
requestBody?: never;
|
|
739
|
+
responses: {
|
|
740
|
+
/** @description search response */
|
|
741
|
+
200: {
|
|
742
|
+
headers: {
|
|
743
|
+
[name: string]: unknown;
|
|
744
|
+
};
|
|
745
|
+
content: {
|
|
746
|
+
"application/json; charset=utf-8": components["schemas"]["SearchResponse"];
|
|
747
|
+
};
|
|
748
|
+
};
|
|
749
|
+
/** @description unexpected error */
|
|
750
|
+
default: {
|
|
751
|
+
headers: {
|
|
752
|
+
[name: string]: unknown;
|
|
753
|
+
};
|
|
754
|
+
content: {
|
|
755
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
756
|
+
};
|
|
757
|
+
};
|
|
758
|
+
};
|
|
759
|
+
};
|
|
760
|
+
getNoteById: {
|
|
761
|
+
parameters: {
|
|
762
|
+
query?: never;
|
|
763
|
+
header?: never;
|
|
764
|
+
path: {
|
|
765
|
+
noteId: components["schemas"]["EntityId"];
|
|
766
|
+
};
|
|
767
|
+
cookie?: never;
|
|
768
|
+
};
|
|
769
|
+
requestBody?: never;
|
|
770
|
+
responses: {
|
|
771
|
+
/** @description note response */
|
|
772
|
+
200: {
|
|
773
|
+
headers: {
|
|
774
|
+
[name: string]: unknown;
|
|
775
|
+
};
|
|
776
|
+
content: {
|
|
777
|
+
"application/json; charset=utf-8": components["schemas"]["Note"];
|
|
778
|
+
};
|
|
779
|
+
};
|
|
780
|
+
/** @description unexpected error */
|
|
781
|
+
default: {
|
|
782
|
+
headers: {
|
|
783
|
+
[name: string]: unknown;
|
|
784
|
+
};
|
|
785
|
+
content: {
|
|
786
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
787
|
+
};
|
|
788
|
+
};
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
deleteNoteById: {
|
|
792
|
+
parameters: {
|
|
793
|
+
query?: never;
|
|
794
|
+
header?: never;
|
|
795
|
+
path: {
|
|
796
|
+
noteId: components["schemas"]["EntityId"];
|
|
797
|
+
};
|
|
798
|
+
cookie?: never;
|
|
799
|
+
};
|
|
800
|
+
requestBody?: never;
|
|
801
|
+
responses: {
|
|
802
|
+
/** @description note deleted */
|
|
803
|
+
204: {
|
|
804
|
+
headers: {
|
|
805
|
+
[name: string]: unknown;
|
|
806
|
+
};
|
|
807
|
+
content?: never;
|
|
808
|
+
};
|
|
809
|
+
/** @description unexpected error */
|
|
810
|
+
default: {
|
|
811
|
+
headers: {
|
|
812
|
+
[name: string]: unknown;
|
|
813
|
+
};
|
|
814
|
+
content: {
|
|
815
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
816
|
+
};
|
|
817
|
+
};
|
|
818
|
+
};
|
|
819
|
+
};
|
|
820
|
+
patchNoteById: {
|
|
821
|
+
parameters: {
|
|
822
|
+
query?: never;
|
|
823
|
+
header?: never;
|
|
824
|
+
path: {
|
|
825
|
+
noteId: components["schemas"]["EntityId"];
|
|
826
|
+
};
|
|
827
|
+
cookie?: never;
|
|
828
|
+
};
|
|
829
|
+
requestBody: {
|
|
830
|
+
content: {
|
|
831
|
+
"application/json": components["schemas"]["Note"];
|
|
832
|
+
};
|
|
833
|
+
};
|
|
834
|
+
responses: {
|
|
835
|
+
/** @description note updated */
|
|
836
|
+
200: {
|
|
837
|
+
headers: {
|
|
838
|
+
[name: string]: unknown;
|
|
839
|
+
};
|
|
840
|
+
content: {
|
|
841
|
+
"application/json; charset=utf-8": components["schemas"]["Note"];
|
|
842
|
+
};
|
|
843
|
+
};
|
|
844
|
+
/** @description unexpected error */
|
|
845
|
+
default: {
|
|
846
|
+
headers: {
|
|
847
|
+
[name: string]: unknown;
|
|
848
|
+
};
|
|
849
|
+
content: {
|
|
850
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
851
|
+
};
|
|
852
|
+
};
|
|
853
|
+
};
|
|
854
|
+
};
|
|
855
|
+
getNoteContent: {
|
|
856
|
+
parameters: {
|
|
857
|
+
query?: never;
|
|
858
|
+
header?: never;
|
|
859
|
+
path: {
|
|
860
|
+
noteId: components["schemas"]["EntityId"];
|
|
861
|
+
};
|
|
862
|
+
cookie?: never;
|
|
863
|
+
};
|
|
864
|
+
requestBody?: never;
|
|
865
|
+
responses: {
|
|
866
|
+
/** @description note content response */
|
|
867
|
+
200: {
|
|
868
|
+
headers: {
|
|
869
|
+
[name: string]: unknown;
|
|
870
|
+
};
|
|
871
|
+
content: {
|
|
872
|
+
"text/html": string;
|
|
873
|
+
};
|
|
874
|
+
};
|
|
875
|
+
};
|
|
876
|
+
};
|
|
877
|
+
putNoteContentById: {
|
|
878
|
+
parameters: {
|
|
879
|
+
query?: never;
|
|
880
|
+
header?: never;
|
|
881
|
+
path: {
|
|
882
|
+
noteId: components["schemas"]["EntityId"];
|
|
883
|
+
};
|
|
884
|
+
cookie?: never;
|
|
885
|
+
};
|
|
886
|
+
/** @description html content of note */
|
|
887
|
+
requestBody: {
|
|
888
|
+
content: {
|
|
889
|
+
"text/plain": string;
|
|
890
|
+
};
|
|
891
|
+
};
|
|
892
|
+
responses: {
|
|
893
|
+
/** @description note content updated */
|
|
894
|
+
204: {
|
|
895
|
+
headers: {
|
|
896
|
+
[name: string]: unknown;
|
|
897
|
+
};
|
|
898
|
+
content?: never;
|
|
899
|
+
};
|
|
900
|
+
};
|
|
901
|
+
};
|
|
902
|
+
exportNoteSubtree: {
|
|
903
|
+
parameters: {
|
|
904
|
+
query?: {
|
|
905
|
+
format?: "html" | "markdown" | "share";
|
|
906
|
+
};
|
|
907
|
+
header?: never;
|
|
908
|
+
path: {
|
|
909
|
+
noteId: components["schemas"]["EntityId"];
|
|
910
|
+
};
|
|
911
|
+
cookie?: never;
|
|
912
|
+
};
|
|
913
|
+
requestBody?: never;
|
|
914
|
+
responses: {
|
|
915
|
+
/** @description export ZIP file */
|
|
916
|
+
200: {
|
|
917
|
+
headers: {
|
|
918
|
+
[name: string]: unknown;
|
|
919
|
+
};
|
|
920
|
+
content: {
|
|
921
|
+
"application/zip": string;
|
|
922
|
+
};
|
|
923
|
+
};
|
|
924
|
+
/** @description unexpected error */
|
|
925
|
+
default: {
|
|
926
|
+
headers: {
|
|
927
|
+
[name: string]: unknown;
|
|
928
|
+
};
|
|
929
|
+
content: {
|
|
930
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
931
|
+
};
|
|
932
|
+
};
|
|
933
|
+
};
|
|
934
|
+
};
|
|
935
|
+
importZip: {
|
|
936
|
+
parameters: {
|
|
937
|
+
query?: never;
|
|
938
|
+
header?: never;
|
|
939
|
+
path: {
|
|
940
|
+
noteId: components["schemas"]["EntityId"];
|
|
941
|
+
};
|
|
942
|
+
cookie?: never;
|
|
943
|
+
};
|
|
944
|
+
requestBody?: never;
|
|
945
|
+
responses: {
|
|
946
|
+
/** @description note created */
|
|
947
|
+
201: {
|
|
948
|
+
headers: {
|
|
949
|
+
[name: string]: unknown;
|
|
950
|
+
};
|
|
951
|
+
content: {
|
|
952
|
+
"application/json; charset=utf-8": components["schemas"]["NoteWithBranch"];
|
|
953
|
+
};
|
|
954
|
+
};
|
|
955
|
+
/** @description unexpected error */
|
|
956
|
+
default: {
|
|
957
|
+
headers: {
|
|
958
|
+
[name: string]: unknown;
|
|
959
|
+
};
|
|
960
|
+
content: {
|
|
961
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
962
|
+
};
|
|
963
|
+
};
|
|
964
|
+
};
|
|
965
|
+
};
|
|
966
|
+
createRevision: {
|
|
967
|
+
parameters: {
|
|
968
|
+
query?: {
|
|
969
|
+
format?: "html" | "markdown";
|
|
970
|
+
};
|
|
971
|
+
header?: never;
|
|
972
|
+
path: {
|
|
973
|
+
noteId: components["schemas"]["EntityId"];
|
|
974
|
+
};
|
|
975
|
+
cookie?: never;
|
|
976
|
+
};
|
|
977
|
+
requestBody?: never;
|
|
978
|
+
responses: {
|
|
979
|
+
/** @description revision has been created */
|
|
980
|
+
204: {
|
|
981
|
+
headers: {
|
|
982
|
+
[name: string]: unknown;
|
|
983
|
+
};
|
|
984
|
+
content?: never;
|
|
985
|
+
};
|
|
986
|
+
/** @description unexpected error */
|
|
987
|
+
default: {
|
|
988
|
+
headers: {
|
|
989
|
+
[name: string]: unknown;
|
|
990
|
+
};
|
|
991
|
+
content: {
|
|
992
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
993
|
+
};
|
|
994
|
+
};
|
|
995
|
+
};
|
|
996
|
+
};
|
|
997
|
+
postBranch: {
|
|
998
|
+
parameters: {
|
|
999
|
+
query?: never;
|
|
1000
|
+
header?: never;
|
|
1001
|
+
path?: never;
|
|
1002
|
+
cookie?: never;
|
|
1003
|
+
};
|
|
1004
|
+
requestBody: {
|
|
1005
|
+
content: {
|
|
1006
|
+
"application/json": components["schemas"]["Branch"];
|
|
1007
|
+
};
|
|
1008
|
+
};
|
|
1009
|
+
responses: {
|
|
1010
|
+
/** @description branch updated (branch between parent note and child note already existed) */
|
|
1011
|
+
200: {
|
|
1012
|
+
headers: {
|
|
1013
|
+
[name: string]: unknown;
|
|
1014
|
+
};
|
|
1015
|
+
content: {
|
|
1016
|
+
"application/json; charset=utf-8": components["schemas"]["Branch"];
|
|
1017
|
+
};
|
|
1018
|
+
};
|
|
1019
|
+
/** @description branch created */
|
|
1020
|
+
201: {
|
|
1021
|
+
headers: {
|
|
1022
|
+
[name: string]: unknown;
|
|
1023
|
+
};
|
|
1024
|
+
content: {
|
|
1025
|
+
"application/json; charset=utf-8": components["schemas"]["Branch"];
|
|
1026
|
+
};
|
|
1027
|
+
};
|
|
1028
|
+
/** @description unexpected error */
|
|
1029
|
+
default: {
|
|
1030
|
+
headers: {
|
|
1031
|
+
[name: string]: unknown;
|
|
1032
|
+
};
|
|
1033
|
+
content: {
|
|
1034
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
};
|
|
1038
|
+
};
|
|
1039
|
+
getBranchById: {
|
|
1040
|
+
parameters: {
|
|
1041
|
+
query?: never;
|
|
1042
|
+
header?: never;
|
|
1043
|
+
path: {
|
|
1044
|
+
branchId: components["schemas"]["EntityId"];
|
|
1045
|
+
};
|
|
1046
|
+
cookie?: never;
|
|
1047
|
+
};
|
|
1048
|
+
requestBody?: never;
|
|
1049
|
+
responses: {
|
|
1050
|
+
/** @description branch response */
|
|
1051
|
+
200: {
|
|
1052
|
+
headers: {
|
|
1053
|
+
[name: string]: unknown;
|
|
1054
|
+
};
|
|
1055
|
+
content: {
|
|
1056
|
+
"application/json; charset=utf-8": components["schemas"]["Branch"];
|
|
1057
|
+
};
|
|
1058
|
+
};
|
|
1059
|
+
/** @description unexpected error */
|
|
1060
|
+
default: {
|
|
1061
|
+
headers: {
|
|
1062
|
+
[name: string]: unknown;
|
|
1063
|
+
};
|
|
1064
|
+
content: {
|
|
1065
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1066
|
+
};
|
|
1067
|
+
};
|
|
1068
|
+
};
|
|
1069
|
+
};
|
|
1070
|
+
deleteBranchById: {
|
|
1071
|
+
parameters: {
|
|
1072
|
+
query?: never;
|
|
1073
|
+
header?: never;
|
|
1074
|
+
path: {
|
|
1075
|
+
branchId: components["schemas"]["EntityId"];
|
|
1076
|
+
};
|
|
1077
|
+
cookie?: never;
|
|
1078
|
+
};
|
|
1079
|
+
requestBody?: never;
|
|
1080
|
+
responses: {
|
|
1081
|
+
/** @description branch deleted */
|
|
1082
|
+
204: {
|
|
1083
|
+
headers: {
|
|
1084
|
+
[name: string]: unknown;
|
|
1085
|
+
};
|
|
1086
|
+
content?: never;
|
|
1087
|
+
};
|
|
1088
|
+
/** @description unexpected error */
|
|
1089
|
+
default: {
|
|
1090
|
+
headers: {
|
|
1091
|
+
[name: string]: unknown;
|
|
1092
|
+
};
|
|
1093
|
+
content: {
|
|
1094
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1095
|
+
};
|
|
1096
|
+
};
|
|
1097
|
+
};
|
|
1098
|
+
};
|
|
1099
|
+
patchBranchById: {
|
|
1100
|
+
parameters: {
|
|
1101
|
+
query?: never;
|
|
1102
|
+
header?: never;
|
|
1103
|
+
path: {
|
|
1104
|
+
branchId: components["schemas"]["EntityId"];
|
|
1105
|
+
};
|
|
1106
|
+
cookie?: never;
|
|
1107
|
+
};
|
|
1108
|
+
requestBody: {
|
|
1109
|
+
content: {
|
|
1110
|
+
"application/json": components["schemas"]["Branch"];
|
|
1111
|
+
};
|
|
1112
|
+
};
|
|
1113
|
+
responses: {
|
|
1114
|
+
/** @description branch updated */
|
|
1115
|
+
200: {
|
|
1116
|
+
headers: {
|
|
1117
|
+
[name: string]: unknown;
|
|
1118
|
+
};
|
|
1119
|
+
content: {
|
|
1120
|
+
"application/json; charset=utf-8": components["schemas"]["Branch"];
|
|
1121
|
+
};
|
|
1122
|
+
};
|
|
1123
|
+
/** @description unexpected error */
|
|
1124
|
+
default: {
|
|
1125
|
+
headers: {
|
|
1126
|
+
[name: string]: unknown;
|
|
1127
|
+
};
|
|
1128
|
+
content: {
|
|
1129
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1130
|
+
};
|
|
1131
|
+
};
|
|
1132
|
+
};
|
|
1133
|
+
};
|
|
1134
|
+
postAttachment: {
|
|
1135
|
+
parameters: {
|
|
1136
|
+
query?: never;
|
|
1137
|
+
header?: never;
|
|
1138
|
+
path?: never;
|
|
1139
|
+
cookie?: never;
|
|
1140
|
+
};
|
|
1141
|
+
requestBody: {
|
|
1142
|
+
content: {
|
|
1143
|
+
"application/json": components["schemas"]["CreateAttachment"];
|
|
1144
|
+
};
|
|
1145
|
+
};
|
|
1146
|
+
responses: {
|
|
1147
|
+
/** @description attachment created */
|
|
1148
|
+
201: {
|
|
1149
|
+
headers: {
|
|
1150
|
+
[name: string]: unknown;
|
|
1151
|
+
};
|
|
1152
|
+
content: {
|
|
1153
|
+
"application/json; charset=utf-8": components["schemas"]["Attachment"];
|
|
1154
|
+
};
|
|
1155
|
+
};
|
|
1156
|
+
/** @description unexpected error */
|
|
1157
|
+
default: {
|
|
1158
|
+
headers: {
|
|
1159
|
+
[name: string]: unknown;
|
|
1160
|
+
};
|
|
1161
|
+
content: {
|
|
1162
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1163
|
+
};
|
|
1164
|
+
};
|
|
1165
|
+
};
|
|
1166
|
+
};
|
|
1167
|
+
getAttachmentById: {
|
|
1168
|
+
parameters: {
|
|
1169
|
+
query?: never;
|
|
1170
|
+
header?: never;
|
|
1171
|
+
path: {
|
|
1172
|
+
attachmentId: components["schemas"]["EntityId"];
|
|
1173
|
+
};
|
|
1174
|
+
cookie?: never;
|
|
1175
|
+
};
|
|
1176
|
+
requestBody?: never;
|
|
1177
|
+
responses: {
|
|
1178
|
+
/** @description attachment response */
|
|
1179
|
+
200: {
|
|
1180
|
+
headers: {
|
|
1181
|
+
[name: string]: unknown;
|
|
1182
|
+
};
|
|
1183
|
+
content: {
|
|
1184
|
+
"application/json; charset=utf-8": components["schemas"]["Attachment"];
|
|
1185
|
+
};
|
|
1186
|
+
};
|
|
1187
|
+
/** @description unexpected error */
|
|
1188
|
+
default: {
|
|
1189
|
+
headers: {
|
|
1190
|
+
[name: string]: unknown;
|
|
1191
|
+
};
|
|
1192
|
+
content: {
|
|
1193
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1194
|
+
};
|
|
1195
|
+
};
|
|
1196
|
+
};
|
|
1197
|
+
};
|
|
1198
|
+
deleteAttachmentById: {
|
|
1199
|
+
parameters: {
|
|
1200
|
+
query?: never;
|
|
1201
|
+
header?: never;
|
|
1202
|
+
path: {
|
|
1203
|
+
attachmentId: components["schemas"]["EntityId"];
|
|
1204
|
+
};
|
|
1205
|
+
cookie?: never;
|
|
1206
|
+
};
|
|
1207
|
+
requestBody?: never;
|
|
1208
|
+
responses: {
|
|
1209
|
+
/** @description attachment deleted */
|
|
1210
|
+
204: {
|
|
1211
|
+
headers: {
|
|
1212
|
+
[name: string]: unknown;
|
|
1213
|
+
};
|
|
1214
|
+
content?: never;
|
|
1215
|
+
};
|
|
1216
|
+
/** @description unexpected error */
|
|
1217
|
+
default: {
|
|
1218
|
+
headers: {
|
|
1219
|
+
[name: string]: unknown;
|
|
1220
|
+
};
|
|
1221
|
+
content: {
|
|
1222
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1223
|
+
};
|
|
1224
|
+
};
|
|
1225
|
+
};
|
|
1226
|
+
};
|
|
1227
|
+
patchAttachmentById: {
|
|
1228
|
+
parameters: {
|
|
1229
|
+
query?: never;
|
|
1230
|
+
header?: never;
|
|
1231
|
+
path: {
|
|
1232
|
+
attachmentId: components["schemas"]["EntityId"];
|
|
1233
|
+
};
|
|
1234
|
+
cookie?: never;
|
|
1235
|
+
};
|
|
1236
|
+
requestBody: {
|
|
1237
|
+
content: {
|
|
1238
|
+
"application/json": components["schemas"]["Attachment"];
|
|
1239
|
+
};
|
|
1240
|
+
};
|
|
1241
|
+
responses: {
|
|
1242
|
+
/** @description attribute updated */
|
|
1243
|
+
200: {
|
|
1244
|
+
headers: {
|
|
1245
|
+
[name: string]: unknown;
|
|
1246
|
+
};
|
|
1247
|
+
content: {
|
|
1248
|
+
"application/json; charset=utf-8": components["schemas"]["Attachment"];
|
|
1249
|
+
};
|
|
1250
|
+
};
|
|
1251
|
+
/** @description unexpected error */
|
|
1252
|
+
default: {
|
|
1253
|
+
headers: {
|
|
1254
|
+
[name: string]: unknown;
|
|
1255
|
+
};
|
|
1256
|
+
content: {
|
|
1257
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1258
|
+
};
|
|
1259
|
+
};
|
|
1260
|
+
};
|
|
1261
|
+
};
|
|
1262
|
+
getAttachmentContent: {
|
|
1263
|
+
parameters: {
|
|
1264
|
+
query?: never;
|
|
1265
|
+
header?: never;
|
|
1266
|
+
path: {
|
|
1267
|
+
attachmentId: components["schemas"]["EntityId"];
|
|
1268
|
+
};
|
|
1269
|
+
cookie?: never;
|
|
1270
|
+
};
|
|
1271
|
+
requestBody?: never;
|
|
1272
|
+
responses: {
|
|
1273
|
+
/** @description attachment content response */
|
|
1274
|
+
200: {
|
|
1275
|
+
headers: {
|
|
1276
|
+
[name: string]: unknown;
|
|
1277
|
+
};
|
|
1278
|
+
content: {
|
|
1279
|
+
"text/html": string;
|
|
1280
|
+
};
|
|
1281
|
+
};
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
putAttachmentContentById: {
|
|
1285
|
+
parameters: {
|
|
1286
|
+
query?: never;
|
|
1287
|
+
header?: never;
|
|
1288
|
+
path: {
|
|
1289
|
+
attachmentId: components["schemas"]["EntityId"];
|
|
1290
|
+
};
|
|
1291
|
+
cookie?: never;
|
|
1292
|
+
};
|
|
1293
|
+
/** @description html content of attachment */
|
|
1294
|
+
requestBody: {
|
|
1295
|
+
content: {
|
|
1296
|
+
"text/plain": string;
|
|
1297
|
+
};
|
|
1298
|
+
};
|
|
1299
|
+
responses: {
|
|
1300
|
+
/** @description attachment content updated */
|
|
1301
|
+
204: {
|
|
1302
|
+
headers: {
|
|
1303
|
+
[name: string]: unknown;
|
|
1304
|
+
};
|
|
1305
|
+
content?: never;
|
|
1306
|
+
};
|
|
1307
|
+
};
|
|
1308
|
+
};
|
|
1309
|
+
postAttribute: {
|
|
1310
|
+
parameters: {
|
|
1311
|
+
query?: never;
|
|
1312
|
+
header?: never;
|
|
1313
|
+
path?: never;
|
|
1314
|
+
cookie?: never;
|
|
1315
|
+
};
|
|
1316
|
+
requestBody: {
|
|
1317
|
+
content: {
|
|
1318
|
+
"application/json": components["schemas"]["Attribute"];
|
|
1319
|
+
};
|
|
1320
|
+
};
|
|
1321
|
+
responses: {
|
|
1322
|
+
/** @description attribute created */
|
|
1323
|
+
201: {
|
|
1324
|
+
headers: {
|
|
1325
|
+
[name: string]: unknown;
|
|
1326
|
+
};
|
|
1327
|
+
content: {
|
|
1328
|
+
"application/json; charset=utf-8": components["schemas"]["Attribute"];
|
|
1329
|
+
};
|
|
1330
|
+
};
|
|
1331
|
+
/** @description unexpected error */
|
|
1332
|
+
default: {
|
|
1333
|
+
headers: {
|
|
1334
|
+
[name: string]: unknown;
|
|
1335
|
+
};
|
|
1336
|
+
content: {
|
|
1337
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1338
|
+
};
|
|
1339
|
+
};
|
|
1340
|
+
};
|
|
1341
|
+
};
|
|
1342
|
+
getAttributeById: {
|
|
1343
|
+
parameters: {
|
|
1344
|
+
query?: never;
|
|
1345
|
+
header?: never;
|
|
1346
|
+
path: {
|
|
1347
|
+
attributeId: components["schemas"]["EntityId"];
|
|
1348
|
+
};
|
|
1349
|
+
cookie?: never;
|
|
1350
|
+
};
|
|
1351
|
+
requestBody?: never;
|
|
1352
|
+
responses: {
|
|
1353
|
+
/** @description attribute response */
|
|
1354
|
+
200: {
|
|
1355
|
+
headers: {
|
|
1356
|
+
[name: string]: unknown;
|
|
1357
|
+
};
|
|
1358
|
+
content: {
|
|
1359
|
+
"application/json; charset=utf-8": components["schemas"]["Attribute"];
|
|
1360
|
+
};
|
|
1361
|
+
};
|
|
1362
|
+
/** @description unexpected error */
|
|
1363
|
+
default: {
|
|
1364
|
+
headers: {
|
|
1365
|
+
[name: string]: unknown;
|
|
1366
|
+
};
|
|
1367
|
+
content: {
|
|
1368
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1369
|
+
};
|
|
1370
|
+
};
|
|
1371
|
+
};
|
|
1372
|
+
};
|
|
1373
|
+
deleteAttributeById: {
|
|
1374
|
+
parameters: {
|
|
1375
|
+
query?: never;
|
|
1376
|
+
header?: never;
|
|
1377
|
+
path: {
|
|
1378
|
+
attributeId: components["schemas"]["EntityId"];
|
|
1379
|
+
};
|
|
1380
|
+
cookie?: never;
|
|
1381
|
+
};
|
|
1382
|
+
requestBody?: never;
|
|
1383
|
+
responses: {
|
|
1384
|
+
/** @description attribute deleted */
|
|
1385
|
+
204: {
|
|
1386
|
+
headers: {
|
|
1387
|
+
[name: string]: unknown;
|
|
1388
|
+
};
|
|
1389
|
+
content?: never;
|
|
1390
|
+
};
|
|
1391
|
+
/** @description unexpected error */
|
|
1392
|
+
default: {
|
|
1393
|
+
headers: {
|
|
1394
|
+
[name: string]: unknown;
|
|
1395
|
+
};
|
|
1396
|
+
content: {
|
|
1397
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
};
|
|
1401
|
+
};
|
|
1402
|
+
patchAttributeById: {
|
|
1403
|
+
parameters: {
|
|
1404
|
+
query?: never;
|
|
1405
|
+
header?: never;
|
|
1406
|
+
path: {
|
|
1407
|
+
attributeId: components["schemas"]["EntityId"];
|
|
1408
|
+
};
|
|
1409
|
+
cookie?: never;
|
|
1410
|
+
};
|
|
1411
|
+
requestBody: {
|
|
1412
|
+
content: {
|
|
1413
|
+
"application/json": components["schemas"]["Attribute"];
|
|
1414
|
+
};
|
|
1415
|
+
};
|
|
1416
|
+
responses: {
|
|
1417
|
+
/** @description attribute updated */
|
|
1418
|
+
200: {
|
|
1419
|
+
headers: {
|
|
1420
|
+
[name: string]: unknown;
|
|
1421
|
+
};
|
|
1422
|
+
content: {
|
|
1423
|
+
"application/json; charset=utf-8": components["schemas"]["Attribute"];
|
|
1424
|
+
};
|
|
1425
|
+
};
|
|
1426
|
+
/** @description unexpected error */
|
|
1427
|
+
default: {
|
|
1428
|
+
headers: {
|
|
1429
|
+
[name: string]: unknown;
|
|
1430
|
+
};
|
|
1431
|
+
content: {
|
|
1432
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1433
|
+
};
|
|
1434
|
+
};
|
|
1435
|
+
};
|
|
1436
|
+
};
|
|
1437
|
+
postRefreshNoteOrdering: {
|
|
1438
|
+
parameters: {
|
|
1439
|
+
query?: never;
|
|
1440
|
+
header?: never;
|
|
1441
|
+
path: {
|
|
1442
|
+
parentNoteId: components["schemas"]["EntityId"];
|
|
1443
|
+
};
|
|
1444
|
+
cookie?: never;
|
|
1445
|
+
};
|
|
1446
|
+
requestBody?: never;
|
|
1447
|
+
responses: {
|
|
1448
|
+
/** @description note ordering will be asynchronously updated in all connected clients */
|
|
1449
|
+
204: {
|
|
1450
|
+
headers: {
|
|
1451
|
+
[name: string]: unknown;
|
|
1452
|
+
};
|
|
1453
|
+
content?: never;
|
|
1454
|
+
};
|
|
1455
|
+
/** @description unexpected error */
|
|
1456
|
+
default: {
|
|
1457
|
+
headers: {
|
|
1458
|
+
[name: string]: unknown;
|
|
1459
|
+
};
|
|
1460
|
+
content: {
|
|
1461
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1462
|
+
};
|
|
1463
|
+
};
|
|
1464
|
+
};
|
|
1465
|
+
};
|
|
1466
|
+
getInboxNote: {
|
|
1467
|
+
parameters: {
|
|
1468
|
+
query?: never;
|
|
1469
|
+
header?: never;
|
|
1470
|
+
path: {
|
|
1471
|
+
/** @example 2022-02-22 */
|
|
1472
|
+
date: string;
|
|
1473
|
+
};
|
|
1474
|
+
cookie?: never;
|
|
1475
|
+
};
|
|
1476
|
+
requestBody?: never;
|
|
1477
|
+
responses: {
|
|
1478
|
+
/** @description inbox note */
|
|
1479
|
+
200: {
|
|
1480
|
+
headers: {
|
|
1481
|
+
[name: string]: unknown;
|
|
1482
|
+
};
|
|
1483
|
+
content: {
|
|
1484
|
+
"application/json; charset=utf-8": components["schemas"]["Note"];
|
|
1485
|
+
};
|
|
1486
|
+
};
|
|
1487
|
+
/** @description unexpected error */
|
|
1488
|
+
default: {
|
|
1489
|
+
headers: {
|
|
1490
|
+
[name: string]: unknown;
|
|
1491
|
+
};
|
|
1492
|
+
content: {
|
|
1493
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1494
|
+
};
|
|
1495
|
+
};
|
|
1496
|
+
};
|
|
1497
|
+
};
|
|
1498
|
+
getDayNote: {
|
|
1499
|
+
parameters: {
|
|
1500
|
+
query?: never;
|
|
1501
|
+
header?: never;
|
|
1502
|
+
path: {
|
|
1503
|
+
/** @example 2022-02-22 */
|
|
1504
|
+
date: string;
|
|
1505
|
+
};
|
|
1506
|
+
cookie?: never;
|
|
1507
|
+
};
|
|
1508
|
+
requestBody?: never;
|
|
1509
|
+
responses: {
|
|
1510
|
+
/** @description day note */
|
|
1511
|
+
200: {
|
|
1512
|
+
headers: {
|
|
1513
|
+
[name: string]: unknown;
|
|
1514
|
+
};
|
|
1515
|
+
content: {
|
|
1516
|
+
"application/json; charset=utf-8": components["schemas"]["Note"];
|
|
1517
|
+
};
|
|
1518
|
+
};
|
|
1519
|
+
/** @description unexpected error */
|
|
1520
|
+
default: {
|
|
1521
|
+
headers: {
|
|
1522
|
+
[name: string]: unknown;
|
|
1523
|
+
};
|
|
1524
|
+
content: {
|
|
1525
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1526
|
+
};
|
|
1527
|
+
};
|
|
1528
|
+
};
|
|
1529
|
+
};
|
|
1530
|
+
getWeekFirstDayNote: {
|
|
1531
|
+
parameters: {
|
|
1532
|
+
query?: never;
|
|
1533
|
+
header?: never;
|
|
1534
|
+
path: {
|
|
1535
|
+
/** @example 2022-02-22 */
|
|
1536
|
+
date: string;
|
|
1537
|
+
};
|
|
1538
|
+
cookie?: never;
|
|
1539
|
+
};
|
|
1540
|
+
requestBody?: never;
|
|
1541
|
+
responses: {
|
|
1542
|
+
/** @description week note */
|
|
1543
|
+
200: {
|
|
1544
|
+
headers: {
|
|
1545
|
+
[name: string]: unknown;
|
|
1546
|
+
};
|
|
1547
|
+
content: {
|
|
1548
|
+
"application/json; charset=utf-8": components["schemas"]["Note"];
|
|
1549
|
+
};
|
|
1550
|
+
};
|
|
1551
|
+
/** @description unexpected error */
|
|
1552
|
+
default: {
|
|
1553
|
+
headers: {
|
|
1554
|
+
[name: string]: unknown;
|
|
1555
|
+
};
|
|
1556
|
+
content: {
|
|
1557
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1558
|
+
};
|
|
1559
|
+
};
|
|
1560
|
+
};
|
|
1561
|
+
};
|
|
1562
|
+
getMonthNote: {
|
|
1563
|
+
parameters: {
|
|
1564
|
+
query?: never;
|
|
1565
|
+
header?: never;
|
|
1566
|
+
path: {
|
|
1567
|
+
/** @example 2022-02 */
|
|
1568
|
+
month: string;
|
|
1569
|
+
};
|
|
1570
|
+
cookie?: never;
|
|
1571
|
+
};
|
|
1572
|
+
requestBody?: never;
|
|
1573
|
+
responses: {
|
|
1574
|
+
/** @description month note */
|
|
1575
|
+
200: {
|
|
1576
|
+
headers: {
|
|
1577
|
+
[name: string]: unknown;
|
|
1578
|
+
};
|
|
1579
|
+
content: {
|
|
1580
|
+
"application/json; charset=utf-8": components["schemas"]["Note"];
|
|
1581
|
+
};
|
|
1582
|
+
};
|
|
1583
|
+
/** @description unexpected error */
|
|
1584
|
+
default: {
|
|
1585
|
+
headers: {
|
|
1586
|
+
[name: string]: unknown;
|
|
1587
|
+
};
|
|
1588
|
+
content: {
|
|
1589
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1590
|
+
};
|
|
1591
|
+
};
|
|
1592
|
+
};
|
|
1593
|
+
};
|
|
1594
|
+
getYearNote: {
|
|
1595
|
+
parameters: {
|
|
1596
|
+
query?: never;
|
|
1597
|
+
header?: never;
|
|
1598
|
+
path: {
|
|
1599
|
+
/** @example 2022-02 */
|
|
1600
|
+
year: string;
|
|
1601
|
+
};
|
|
1602
|
+
cookie?: never;
|
|
1603
|
+
};
|
|
1604
|
+
requestBody?: never;
|
|
1605
|
+
responses: {
|
|
1606
|
+
/** @description year note */
|
|
1607
|
+
200: {
|
|
1608
|
+
headers: {
|
|
1609
|
+
[name: string]: unknown;
|
|
1610
|
+
};
|
|
1611
|
+
content: {
|
|
1612
|
+
"application/json; charset=utf-8": components["schemas"]["Note"];
|
|
1613
|
+
};
|
|
1614
|
+
};
|
|
1615
|
+
/** @description unexpected error */
|
|
1616
|
+
default: {
|
|
1617
|
+
headers: {
|
|
1618
|
+
[name: string]: unknown;
|
|
1619
|
+
};
|
|
1620
|
+
content: {
|
|
1621
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1622
|
+
};
|
|
1623
|
+
};
|
|
1624
|
+
};
|
|
1625
|
+
};
|
|
1626
|
+
login: {
|
|
1627
|
+
parameters: {
|
|
1628
|
+
query?: never;
|
|
1629
|
+
header?: never;
|
|
1630
|
+
path?: never;
|
|
1631
|
+
cookie?: never;
|
|
1632
|
+
};
|
|
1633
|
+
requestBody: {
|
|
1634
|
+
content: {
|
|
1635
|
+
"application/json": {
|
|
1636
|
+
/** @description user's password used to e.g. login to Trilium server and/or protect notes */
|
|
1637
|
+
password?: string;
|
|
1638
|
+
};
|
|
1639
|
+
};
|
|
1640
|
+
};
|
|
1641
|
+
responses: {
|
|
1642
|
+
/** @description auth token */
|
|
1643
|
+
201: {
|
|
1644
|
+
headers: {
|
|
1645
|
+
[name: string]: unknown;
|
|
1646
|
+
};
|
|
1647
|
+
content: {
|
|
1648
|
+
"application/json; charset=utf-8": {
|
|
1649
|
+
/** @example Bc4bFn0Ffiok_4NpbVCDnFz7B2WU+pdhW8B5Ne3DiR5wXrEyqdjgRIsk= */
|
|
1650
|
+
authToken?: string;
|
|
1651
|
+
};
|
|
1652
|
+
};
|
|
1653
|
+
};
|
|
1654
|
+
/** @description Client IP has been blacklisted because too many requests (possibly failed authentications) were made within a short time frame, try again later */
|
|
1655
|
+
429: {
|
|
1656
|
+
headers: {
|
|
1657
|
+
[name: string]: unknown;
|
|
1658
|
+
};
|
|
1659
|
+
content?: never;
|
|
1660
|
+
};
|
|
1661
|
+
/** @description unexpected error */
|
|
1662
|
+
default: {
|
|
1663
|
+
headers: {
|
|
1664
|
+
[name: string]: unknown;
|
|
1665
|
+
};
|
|
1666
|
+
content: {
|
|
1667
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1668
|
+
};
|
|
1669
|
+
};
|
|
1670
|
+
};
|
|
1671
|
+
};
|
|
1672
|
+
logout: {
|
|
1673
|
+
parameters: {
|
|
1674
|
+
query?: never;
|
|
1675
|
+
header?: never;
|
|
1676
|
+
path?: never;
|
|
1677
|
+
cookie?: never;
|
|
1678
|
+
};
|
|
1679
|
+
requestBody?: never;
|
|
1680
|
+
responses: {
|
|
1681
|
+
/** @description logout successful */
|
|
1682
|
+
204: {
|
|
1683
|
+
headers: {
|
|
1684
|
+
[name: string]: unknown;
|
|
1685
|
+
};
|
|
1686
|
+
content?: never;
|
|
1687
|
+
};
|
|
1688
|
+
/** @description unexpected error */
|
|
1689
|
+
default: {
|
|
1690
|
+
headers: {
|
|
1691
|
+
[name: string]: unknown;
|
|
1692
|
+
};
|
|
1693
|
+
content: {
|
|
1694
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1695
|
+
};
|
|
1696
|
+
};
|
|
1697
|
+
};
|
|
1698
|
+
};
|
|
1699
|
+
getAppInfo: {
|
|
1700
|
+
parameters: {
|
|
1701
|
+
query?: never;
|
|
1702
|
+
header?: never;
|
|
1703
|
+
path?: never;
|
|
1704
|
+
cookie?: never;
|
|
1705
|
+
};
|
|
1706
|
+
requestBody?: never;
|
|
1707
|
+
responses: {
|
|
1708
|
+
/** @description app info */
|
|
1709
|
+
200: {
|
|
1710
|
+
headers: {
|
|
1711
|
+
[name: string]: unknown;
|
|
1712
|
+
};
|
|
1713
|
+
content: {
|
|
1714
|
+
"application/json; charset=utf-8": components["schemas"]["AppInfo"];
|
|
1715
|
+
};
|
|
1716
|
+
};
|
|
1717
|
+
/** @description unexpected error */
|
|
1718
|
+
default: {
|
|
1719
|
+
headers: {
|
|
1720
|
+
[name: string]: unknown;
|
|
1721
|
+
};
|
|
1722
|
+
content: {
|
|
1723
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1724
|
+
};
|
|
1725
|
+
};
|
|
1726
|
+
};
|
|
1727
|
+
};
|
|
1728
|
+
createBackup: {
|
|
1729
|
+
parameters: {
|
|
1730
|
+
query?: never;
|
|
1731
|
+
header?: never;
|
|
1732
|
+
path: {
|
|
1733
|
+
/** @description If the backupName is e.g. "now", then the backup will be written to "backup-now.db" file */
|
|
1734
|
+
backupName: components["schemas"]["StringId"];
|
|
1735
|
+
};
|
|
1736
|
+
cookie?: never;
|
|
1737
|
+
};
|
|
1738
|
+
requestBody?: never;
|
|
1739
|
+
responses: {
|
|
1740
|
+
/** @description backup has been created */
|
|
1741
|
+
204: {
|
|
1742
|
+
headers: {
|
|
1743
|
+
[name: string]: unknown;
|
|
1744
|
+
};
|
|
1745
|
+
content?: never;
|
|
1746
|
+
};
|
|
1747
|
+
/** @description unexpected error */
|
|
1748
|
+
default: {
|
|
1749
|
+
headers: {
|
|
1750
|
+
[name: string]: unknown;
|
|
1751
|
+
};
|
|
1752
|
+
content: {
|
|
1753
|
+
"application/json; charset=utf-8": components["schemas"]["Error"];
|
|
1754
|
+
};
|
|
1755
|
+
};
|
|
1756
|
+
};
|
|
1757
|
+
};
|
|
1758
|
+
}
|