@growi/sdk-typescript 1.0.0-RC.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +210 -0
  4. package/README_JP.md +211 -0
  5. package/dist/apiv1/index.d.ts +22 -0
  6. package/dist/apiv1/index.d.ts.map +1 -0
  7. package/dist/apiv1/index.js +3 -0
  8. package/dist/apiv1/index.js.map +1 -0
  9. package/dist/apiv3/index.d.ts +245 -0
  10. package/dist/apiv3/index.d.ts.map +1 -0
  11. package/dist/apiv3/index.js +3 -0
  12. package/dist/apiv3/index.js.map +1 -0
  13. package/dist/generated/v1/index.d.ts +47 -0
  14. package/dist/generated/v1/index.d.ts.map +1 -0
  15. package/dist/generated/v1/index.js +131 -0
  16. package/dist/generated/v1/index.js.map +1 -0
  17. package/dist/generated/v1/index.schemas.d.ts +491 -0
  18. package/dist/generated/v1/index.schemas.d.ts.map +1 -0
  19. package/dist/generated/v1/index.schemas.js +12 -0
  20. package/dist/generated/v1/index.schemas.js.map +1 -0
  21. package/dist/generated/v3/index.d.ts +493 -0
  22. package/dist/generated/v3/index.d.ts.map +1 -0
  23. package/dist/generated/v3/index.js +1981 -0
  24. package/dist/generated/v3/index.js.map +1 -0
  25. package/dist/generated/v3/index.schemas.d.ts +3548 -0
  26. package/dist/generated/v3/index.schemas.d.ts.map +1 -0
  27. package/dist/generated/v3/index.schemas.js +30 -0
  28. package/dist/generated/v3/index.schemas.js.map +1 -0
  29. package/dist/index.d.ts +6 -0
  30. package/dist/index.d.ts.map +1 -0
  31. package/dist/index.js +5 -0
  32. package/dist/index.js.map +1 -0
  33. package/dist/utils/axios-instance.d.ts +5 -0
  34. package/dist/utils/axios-instance.d.ts.map +1 -0
  35. package/dist/utils/axios-instance.js +19 -0
  36. package/dist/utils/axios-instance.js.map +1 -0
  37. package/package.json +53 -0
  38. package/src/apiv1/index.ts +7 -0
  39. package/src/apiv3/index.ts +7 -0
  40. package/src/generated/v1/index.schemas.ts +554 -0
  41. package/src/generated/v1/index.ts +231 -0
  42. package/src/generated/v3/index.schemas.ts +3891 -0
  43. package/src/generated/v3/index.ts +3362 -0
  44. package/src/index.ts +8 -0
  45. package/src/utils/axios-instance.ts +23 -0
@@ -0,0 +1,3548 @@
1
+ /**
2
+ * Generated by orval v7.9.0 🍺
3
+ * Do not edit manually.
4
+ * GROWI REST API v3
5
+ * OpenAPI spec version: 7.2.6-RC.0
6
+ */
7
+ export interface SyncStatus {
8
+ isExecutingSync?: boolean;
9
+ totalCount?: number;
10
+ count?: number;
11
+ }
12
+ export type ActivityResponseSerializedPaginationResultDocsItemSnapshot = {
13
+ username?: string;
14
+ _id?: string;
15
+ };
16
+ export type ActivityResponseSerializedPaginationResultDocsItemUser = {
17
+ _id?: string;
18
+ isGravatarEnabled?: boolean;
19
+ isEmailPublished?: boolean;
20
+ lang?: string;
21
+ status?: number;
22
+ admin?: boolean;
23
+ readOnly?: boolean;
24
+ isInvitationEmailSended?: boolean;
25
+ isQuestionnaireEnabled?: boolean;
26
+ name?: string;
27
+ username?: string;
28
+ createdAt?: string;
29
+ updatedAt?: string;
30
+ __v?: number;
31
+ imageUrlCached?: string;
32
+ lastLoginAt?: string;
33
+ email?: string;
34
+ };
35
+ export type ActivityResponseSerializedPaginationResultDocsItem = {
36
+ _id?: string;
37
+ id?: string;
38
+ ip?: string;
39
+ endpoint?: string;
40
+ targetModel?: string;
41
+ target?: string;
42
+ action?: string;
43
+ snapshot?: ActivityResponseSerializedPaginationResultDocsItemSnapshot;
44
+ createdAt?: string;
45
+ __v?: number;
46
+ user?: ActivityResponseSerializedPaginationResultDocsItemUser;
47
+ };
48
+ export type ActivityResponseSerializedPaginationResult = {
49
+ docs?: ActivityResponseSerializedPaginationResultDocsItem[];
50
+ totalDocs?: number;
51
+ offset?: number;
52
+ limit?: number;
53
+ totalPages?: number;
54
+ page?: number;
55
+ pagingCounter?: number;
56
+ hasPrevPage?: boolean;
57
+ hasNextPage?: boolean;
58
+ /** @nullable */
59
+ prevPage?: number | null;
60
+ /** @nullable */
61
+ nextPage?: number | null;
62
+ };
63
+ export interface ActivityResponse {
64
+ serializedPaginationResult?: ActivityResponseSerializedPaginationResult;
65
+ }
66
+ /**
67
+ * environment variables
68
+ */
69
+ export type SystemInformationParamsEnvVars = {
70
+ [key: string]: string;
71
+ };
72
+ export interface SystemInformationParams {
73
+ /** GROWI version or '-' */
74
+ growiVersion?: string;
75
+ /** node version or '-' */
76
+ nodeVersion?: string;
77
+ /** npm version or '-' */
78
+ npmVersion?: string;
79
+ /** pnpm version or '-' */
80
+ pnpmVersion?: string;
81
+ /** environment variables */
82
+ envVars?: SystemInformationParamsEnvVars;
83
+ /** This value is true if this GROWI is compatible v5. */
84
+ isV5Compatible?: boolean;
85
+ /** This value is true if this site is maintenance mode. */
86
+ isMaintenanceMode?: boolean;
87
+ }
88
+ /**
89
+ * installed plugins
90
+ */
91
+ export type InstalledPluginsParamsInstalledPlugins = {
92
+ [key: string]: unknown;
93
+ };
94
+ export interface InstalledPluginsParams {
95
+ /** installed plugins */
96
+ installedPlugins?: InstalledPluginsParamsInstalledPlugins;
97
+ }
98
+ /**
99
+ * AppSettingParams
100
+ */
101
+ export interface AppSettingParams {
102
+ azureReferenceFileWithRelayMode?: boolean;
103
+ azureUseOnlyEnvVars?: boolean;
104
+ /** confidential show on page header */
105
+ confidential?: string;
106
+ envAzureClientId?: string;
107
+ envAzureClientSecret?: string;
108
+ envAzureStorageAccountName?: string;
109
+ envAzureStorageContainerName?: string;
110
+ envFileUploadType?: string;
111
+ envGcsApiKeyJsonPath?: string;
112
+ envGcsBucket?: string;
113
+ envGcsUploadNamespace?: string;
114
+ envSiteUrl?: string;
115
+ fileUpload?: boolean;
116
+ fileUploadType?: string;
117
+ fromAddress?: string;
118
+ gcsApiKeyJsonPath?: string;
119
+ gcsBucket?: string;
120
+ gcsReferenceFileWithRelayMode?: boolean;
121
+ gcsUploadNamespace?: string;
122
+ gcsUseOnlyEnvVars?: boolean;
123
+ globalLang?: string;
124
+ isAppSiteUrlHashed?: boolean;
125
+ isEmailPublishedForNewUser?: boolean;
126
+ isMaintenanceMode?: boolean;
127
+ isQuestionnaireEnabled?: boolean;
128
+ isV5Compatible?: boolean;
129
+ s3AccessKeyId?: string;
130
+ s3Bucket?: string;
131
+ s3CustomEndpoint?: string;
132
+ s3ReferenceFileWithRelayMode?: boolean;
133
+ s3Region?: string;
134
+ siteUrl?: string;
135
+ siteUrlUseOnlyEnvVars?: boolean;
136
+ smtpHost?: string;
137
+ smtpPassword?: string;
138
+ smtpPort?: string;
139
+ smtpUser?: string;
140
+ useOnlyEnvVarForFileUploadType?: boolean;
141
+ }
142
+ /**
143
+ * AppSettingPutParams
144
+ */
145
+ export interface AppSettingPutParams {
146
+ /** title of the site */
147
+ title?: string;
148
+ /** confidential show on page header */
149
+ confidential?: string;
150
+ /** global language */
151
+ globalLang?: string;
152
+ /** is email published for new user, or not */
153
+ isEmailPublishedForNewUser?: boolean;
154
+ /** is file upload enabled, or not */
155
+ fileUpload?: boolean;
156
+ }
157
+ /**
158
+ * SiteUrlSettingParams
159
+ */
160
+ export interface SiteUrlSettingParams {
161
+ /** Site URL. e.g. https://example.com, https://example.com:8080 */
162
+ siteUrl?: string;
163
+ /** environment variable 'APP_SITE_URL' */
164
+ envSiteUrl?: string;
165
+ }
166
+ /**
167
+ * SmtpSettingParams
168
+ */
169
+ export interface SmtpSettingParams {
170
+ /** host name of client's smtp server */
171
+ smtpHost?: string;
172
+ /** port of client's smtp server */
173
+ smtpPort?: string;
174
+ /** user name of client's smtp server */
175
+ smtpUser?: string;
176
+ /** password of client's smtp server */
177
+ smtpPassword?: string;
178
+ /** e-mail address */
179
+ fromAddress?: string;
180
+ }
181
+ /**
182
+ * SmtpSettingResponseParams
183
+ */
184
+ export interface SmtpSettingResponseParams {
185
+ /** is mailer setup, or not */
186
+ isMailerSetup?: boolean;
187
+ /** host name of client's smtp server */
188
+ smtpHost?: string;
189
+ /** port of client's smtp server */
190
+ smtpPort?: string;
191
+ /** user name of client's smtp server */
192
+ smtpUser?: string;
193
+ /** password of client's smtp server */
194
+ smtpPassword?: string;
195
+ /** e-mail address */
196
+ fromAddress?: string;
197
+ }
198
+ /**
199
+ * SesSettingParams
200
+ */
201
+ export interface SesSettingParams {
202
+ /** e-mail address used as from address of mail which sent from GROWI app */
203
+ from?: string;
204
+ /** transmission method */
205
+ transmissionMethod?: string;
206
+ /** accesskey id for authentification of AWS */
207
+ sesAccessKeyId?: string;
208
+ /** secret key for authentification of AWS */
209
+ sesSecretAccessKey?: string;
210
+ }
211
+ /**
212
+ * SesSettingParams
213
+ */
214
+ export interface SesSettingResponseParams {
215
+ /** is mailer setup, or not */
216
+ isMailerSetup?: boolean;
217
+ /** e-mail address used as from address of mail which sent from GROWI app */
218
+ from?: string;
219
+ /** transmission method */
220
+ transmissionMethod?: string;
221
+ /** accesskey id for authentification of AWS */
222
+ sesAccessKeyId?: string;
223
+ /** secret key for authentification of AWS */
224
+ sesSecretAccessKey?: string;
225
+ }
226
+ /**
227
+ * FileUploadTypeParams
228
+ */
229
+ export interface FileUploadSettingParams {
230
+ /** fileUploadType */
231
+ fileUploadType?: string;
232
+ /** region of AWS S3 */
233
+ s3Region?: string;
234
+ /** custom endpoint of AWS S3 */
235
+ s3CustomEndpoint?: string;
236
+ /** AWS S3 bucket name */
237
+ s3Bucket?: string;
238
+ /** accesskey id for authentification of AWS */
239
+ s3AccessKeyId?: string;
240
+ /** secret key for authentification of AWS */
241
+ s3SecretAccessKey?: string;
242
+ /** is enable internal stream system for s3 file request */
243
+ s3ReferenceFileWithRelayMode?: boolean;
244
+ /** apiKeyJsonPath of gcp */
245
+ gcsApiKeyJsonPath?: string;
246
+ /** bucket name of gcs */
247
+ gcsBucket?: string;
248
+ /** name space of gcs */
249
+ gcsUploadNamespace?: string;
250
+ /** is enable internal stream system for gcs file request */
251
+ gcsReferenceFileWithRelayMode?: boolean;
252
+ /** tenant id of azure */
253
+ azureTenantId?: string;
254
+ /** client id of azure */
255
+ azureClientId?: string;
256
+ /** client secret of azure */
257
+ azureClientSecret?: string;
258
+ /** storage account name of azure */
259
+ azureStorageAccountName?: string;
260
+ /** storage container name of azure */
261
+ azureStorageContainerName?: string;
262
+ /** is enable internal stream system for azure file request */
263
+ azureReferenceFileWithRelayMode?: boolean;
264
+ }
265
+ /**
266
+ * QuestionnaireSettingParams
267
+ */
268
+ export interface QuestionnaireSettingParams {
269
+ /** is questionnaire enabled, or not */
270
+ isQuestionnaireEnabled?: boolean;
271
+ /** is app site url hashed, or not */
272
+ isAppSiteUrlHashed?: boolean;
273
+ }
274
+ /**
275
+ * AttachmentPaginateResult
276
+ */
277
+ export interface AttachmentPaginateResult {
278
+ docs?: Attachment[];
279
+ totalDocs?: number;
280
+ limit?: number;
281
+ totalPages?: number;
282
+ page?: number;
283
+ offset?: number;
284
+ prevPage?: number;
285
+ nextPage?: number;
286
+ hasNextPage?: boolean;
287
+ hasPrevPage?: boolean;
288
+ pagingCounter?: number;
289
+ }
290
+ /**
291
+ * Attachment
292
+ */
293
+ export interface Attachment {
294
+ /** attachment ID */
295
+ id?: string;
296
+ /** attachment ID */
297
+ _id?: string;
298
+ /** attachment version */
299
+ __v?: number;
300
+ /** attachment type */
301
+ attachmentType?: string;
302
+ /** file format in MIME */
303
+ fileFormat?: string;
304
+ /** file name */
305
+ fileName?: string;
306
+ /** original file name */
307
+ originalName?: string;
308
+ creator?: User;
309
+ /** page ID attached at */
310
+ page?: string;
311
+ /** date created at */
312
+ createdAt?: string;
313
+ /** temporary URL expired at */
314
+ temporaryUrlExpiredAt?: string;
315
+ /** file size */
316
+ fileSize?: number;
317
+ /** file path proxied */
318
+ filePathProxied?: string;
319
+ /** download path proxied */
320
+ downloadPathProxied?: string;
321
+ /** temporary URL cached */
322
+ temporaryUrlCached?: string;
323
+ }
324
+ export type BookmarkFolderBookmarksItemPageAllOf = {
325
+ /** Page ID */
326
+ id?: string;
327
+ /** Parent page ID */
328
+ parent?: string;
329
+ /** Number of descendants */
330
+ descendantCount?: number;
331
+ /** Whether the page is empty */
332
+ isEmpty?: boolean;
333
+ /** List of granted groups */
334
+ grantedGroups?: string[];
335
+ /** Creator user ID */
336
+ creator?: string;
337
+ /** Length of the latest revision body */
338
+ latestRevisionBodyLength?: number;
339
+ };
340
+ /**
341
+ * Pages that are bookmarked in the folder
342
+ */
343
+ export type BookmarkFolderBookmarksItemPage = Page & BookmarkFolderBookmarksItemPageAllOf;
344
+ export type BookmarkFolderBookmarksItem = {
345
+ /** Bookmark ID */
346
+ _id?: string;
347
+ /** User ID of the bookmarker */
348
+ user?: string;
349
+ /** Date and time when the bookmark was created */
350
+ createdAt?: string;
351
+ /** Version of the bookmark */
352
+ __v?: number;
353
+ /** Pages that are bookmarked in the folder */
354
+ page?: BookmarkFolderBookmarksItemPage;
355
+ };
356
+ /**
357
+ * Bookmark Folder
358
+ */
359
+ export interface BookmarkFolder {
360
+ /** Bookmark Folder ID */
361
+ _id?: string;
362
+ /** Version of the bookmark folder */
363
+ __v?: number;
364
+ /** Name of the bookmark folder */
365
+ name?: string;
366
+ /** Owner user ID of the bookmark folder */
367
+ owner?: string;
368
+ bookmarks?: BookmarkFolderBookmarksItem[];
369
+ childFolder?: BookmarkFolder[];
370
+ }
371
+ /**
372
+ * Bookmark
373
+ */
374
+ export interface Bookmark {
375
+ /** page ID */
376
+ _id?: string;
377
+ /** DB record version */
378
+ __v?: number;
379
+ /** date created at */
380
+ createdAt?: string;
381
+ page?: Page;
382
+ user?: ObjectId;
383
+ }
384
+ /**
385
+ * User Root Bookmarks
386
+ */
387
+ export interface Bookmarks {
388
+ userRootBookmarks?: Bookmark[];
389
+ }
390
+ /**
391
+ * BookmarkParams
392
+ */
393
+ export interface BookmarkParams {
394
+ /** page ID */
395
+ pageId?: string;
396
+ /** boolean for bookmark status */
397
+ bool?: boolean;
398
+ }
399
+ /**
400
+ * BookmarkInfo
401
+ */
402
+ export interface BookmarkInfo {
403
+ /** how many people bookmarked the page */
404
+ sumOfBookmarks?: number;
405
+ /** Whether the request user bookmarked (will be returned if the user is included in the request) */
406
+ isBookmarked?: boolean;
407
+ /** page ID */
408
+ pageId?: string;
409
+ bookmarkedUsers?: User[];
410
+ }
411
+ /**
412
+ * CustomizeLayout
413
+ */
414
+ export interface CustomizeLayout {
415
+ isContainerFluid?: boolean;
416
+ }
417
+ /**
418
+ * CustomizeTheme
419
+ */
420
+ export interface CustomizeTheme {
421
+ theme?: string;
422
+ }
423
+ /**
424
+ * CustomizeFunction
425
+ */
426
+ export interface CustomizeFunction {
427
+ isEnabledTimeline?: boolean;
428
+ isEnabledAttachTitleHeader?: boolean;
429
+ pageLimitationS?: number;
430
+ pageLimitationM?: number;
431
+ isEnabledStaleNotification?: boolean;
432
+ isAllReplyShown?: boolean;
433
+ isSearchScopeChildrenAsDefault?: boolean;
434
+ }
435
+ /**
436
+ * CustomizeHighlight
437
+ */
438
+ export interface CustomizeHighlight {
439
+ highlightJsStyle?: string;
440
+ highlightJsStyleBorder?: boolean;
441
+ }
442
+ /**
443
+ * CustomizeHighlight Response
444
+ */
445
+ export interface CustomizeHighlightResponse {
446
+ styleName?: string;
447
+ styleBorder?: boolean;
448
+ }
449
+ /**
450
+ * CustomizeTitle
451
+ */
452
+ export interface CustomizeTitle {
453
+ customizeTitle?: string;
454
+ }
455
+ /**
456
+ * CustomizeNoscript
457
+ */
458
+ export interface CustomizeNoscript {
459
+ customizeNoscript?: string;
460
+ }
461
+ /**
462
+ * CustomizeCss
463
+ */
464
+ export interface CustomizeCss {
465
+ customizeCss?: string;
466
+ }
467
+ /**
468
+ * CustomizeScript
469
+ */
470
+ export interface CustomizeScript {
471
+ customizeScript?: string;
472
+ }
473
+ /**
474
+ * Customize Setting
475
+ */
476
+ export interface CustomizeSetting {
477
+ isEnabledTimeline?: boolean;
478
+ isEnabledAttachTitleHeader?: boolean;
479
+ pageLimitationS?: number;
480
+ pageLimitationM?: number;
481
+ pageLimitationL?: number;
482
+ pageLimitationXL?: number;
483
+ isEnabledStaleNotification?: boolean;
484
+ isAllReplyShown?: boolean;
485
+ isSearchScopeChildrenAsDefault?: boolean;
486
+ isEnabledMarp?: boolean;
487
+ styleName?: string;
488
+ styleBorder?: string;
489
+ customizeTitle?: string;
490
+ customizeScript?: string;
491
+ customizeCss?: string;
492
+ customizeNoscript?: string;
493
+ }
494
+ export interface ThemesMetadata {
495
+ /** The name of the plugin theme. */
496
+ name?: string;
497
+ /** Path to the theme manifest file. */
498
+ manifestKey?: string;
499
+ /** The color scheme type (e.g., light or dark). */
500
+ schemeType?: string;
501
+ /** Light mode background color (hex). */
502
+ lightBg?: string;
503
+ /** Dark mode background color (hex). */
504
+ darkBg?: string;
505
+ /** Light mode sidebar color (hex). */
506
+ lightSidebar?: string;
507
+ /** Dark mode sidebar color (hex). */
508
+ darkSidebar?: string;
509
+ /** Light mode icon color (hex). */
510
+ lightIcon?: string;
511
+ /** Dark mode icon color (hex). */
512
+ darkIcon?: string;
513
+ /** Color of the create button (hex). */
514
+ createBtn?: string;
515
+ }
516
+ /**
517
+ * Customize Sidebar
518
+ */
519
+ export interface CustomizeSidebar {
520
+ /** The flag whether sidebar is collapsed mode or not. */
521
+ isSidebarCollapsedMode?: boolean;
522
+ /** The flag whether sidebar is closed at dock mode or not. */
523
+ isSidebarClosedAtDockMode?: boolean;
524
+ }
525
+ /**
526
+ * Customize Presentation
527
+ */
528
+ export interface CustomizePresentation {
529
+ /** The flag whether Marp is enabled or not. */
530
+ isEnabledMarp?: boolean;
531
+ }
532
+ /**
533
+ * Customize Logo
534
+ */
535
+ export interface CustomizeLogo {
536
+ /** The flag whether the logo is default or not. */
537
+ isDefaultLogo?: boolean;
538
+ }
539
+ export interface ExportStatus {
540
+ zipFileStats?: ExportZipFileStat[];
541
+ isExporting?: boolean;
542
+ /** @nullable */
543
+ progressList?: string[] | null;
544
+ }
545
+ export interface ExportZipFileStat {
546
+ meta?: ExportMeta;
547
+ fileName?: string;
548
+ zipFilePath?: string;
549
+ fileStat?: ExportFileStat;
550
+ innerFileStats?: ExportInnerFileStat[];
551
+ }
552
+ export type ExportMetaEnvVars = {
553
+ [key: string]: string;
554
+ };
555
+ export interface ExportMeta {
556
+ version?: string;
557
+ url?: string;
558
+ passwordSeed?: string;
559
+ exportedAt?: string;
560
+ envVars?: ExportMetaEnvVars;
561
+ }
562
+ export interface ExportFileStat {
563
+ dev?: number;
564
+ mode?: number;
565
+ nlink?: number;
566
+ uid?: number;
567
+ gid?: number;
568
+ rdev?: number;
569
+ blksize?: number;
570
+ ino?: number;
571
+ size?: number;
572
+ blocks?: number;
573
+ atime?: string;
574
+ mtime?: string;
575
+ ctime?: string;
576
+ birthtime?: string;
577
+ }
578
+ /**
579
+ * progress data for each exporting collections
580
+ */
581
+ export type ExportInnerFileStatMetaProgressListItem = {
582
+ [key: string]: unknown;
583
+ };
584
+ export type ExportInnerFileStatMeta = {
585
+ progressList?: ExportInnerFileStatMetaProgressListItem[];
586
+ /** whether the current exporting job exists or not */
587
+ isExporting?: boolean;
588
+ };
589
+ export interface ExportInnerFileStat {
590
+ fileName?: string;
591
+ collectionName?: string;
592
+ meta?: ExportInnerFileStatMeta;
593
+ }
594
+ export interface PasswordResetRequest {
595
+ email?: string;
596
+ }
597
+ export interface PasswordResetResponse {
598
+ message?: string;
599
+ error?: string;
600
+ }
601
+ export type GrowiInfoAttachmentInfo = {
602
+ type?: string;
603
+ writable?: boolean;
604
+ bucket?: string;
605
+ customEndpoint?: string;
606
+ uploadNamespace?: string;
607
+ accountName?: string;
608
+ containerName?: string;
609
+ };
610
+ export interface GrowiInfo {
611
+ /** The version of the GROWI */
612
+ version?: string;
613
+ /** The upper limit of the number of users */
614
+ userUpperLimit?: number;
615
+ fileUploadDisabled?: boolean;
616
+ /** The total limit of the file upload size */
617
+ fileUploadTotalLimit?: number;
618
+ attachmentInfo?: GrowiInfoAttachmentInfo;
619
+ }
620
+ export type HealthcheckInfoSearchInfoStatus = (typeof HealthcheckInfoSearchInfoStatus)[keyof typeof HealthcheckInfoSearchInfoStatus];
621
+ export declare const HealthcheckInfoSearchInfoStatus: {
622
+ readonly green: "green";
623
+ readonly yellow: "yellow";
624
+ readonly red: "red";
625
+ };
626
+ export type HealthcheckInfoSearchInfo = {
627
+ cluster_name?: string;
628
+ status?: HealthcheckInfoSearchInfoStatus;
629
+ timed_out?: boolean;
630
+ number_of_nodes?: number;
631
+ number_of_data_nodes?: number;
632
+ active_primary_shards?: number;
633
+ active_shards?: number;
634
+ relocating_shards?: number;
635
+ initializing_shards?: number;
636
+ unassigned_shards?: number;
637
+ delayed_unassigned_shards?: number;
638
+ number_of_pending_tasks?: number;
639
+ number_of_in_flight_fetch?: number;
640
+ task_max_waiting_in_queue_millis?: number;
641
+ active_shards_percent_as_number?: number;
642
+ };
643
+ /**
644
+ * Information of middlewares
645
+ */
646
+ export interface HealthcheckInfo {
647
+ /** OK */
648
+ mongo?: string;
649
+ searchInfo?: HealthcheckInfoSearchInfo;
650
+ }
651
+ /**
652
+ * Import mode
653
+ */
654
+ export type GrowiArchiveImportOptionMode = (typeof GrowiArchiveImportOptionMode)[keyof typeof GrowiArchiveImportOptionMode];
655
+ export declare const GrowiArchiveImportOptionMode: {
656
+ readonly insert: "insert";
657
+ readonly upsert: "upsert";
658
+ readonly flushAndInsert: "flushAndInsert";
659
+ };
660
+ /**
661
+ * GrowiArchiveImportOption
662
+ */
663
+ export interface GrowiArchiveImportOption {
664
+ /** Import mode */
665
+ mode?: GrowiArchiveImportOptionMode;
666
+ }
667
+ /**
668
+ * the property object
669
+ */
670
+ export type ImportStatusZipFileStat = {
671
+ [key: string]: unknown;
672
+ };
673
+ /**
674
+ * progress data for each exporting collections
675
+ */
676
+ export type ImportStatusProgressListItem = {
677
+ [key: string]: unknown;
678
+ };
679
+ /**
680
+ * ImportStatus
681
+ */
682
+ export interface ImportStatus {
683
+ /** whether the version of the uploaded data is the same as the current GROWI version */
684
+ isTheSameVersion?: boolean;
685
+ /** the property object */
686
+ zipFileStat?: ImportStatusZipFileStat;
687
+ progressList?: ImportStatusProgressListItem[];
688
+ /** whether the current importing job exists or not */
689
+ isImporting?: boolean;
690
+ }
691
+ export type FileImportResponseMetaEnvVars = {
692
+ ELASTICSEARCH_URI?: string;
693
+ };
694
+ export type FileImportResponseMeta = {
695
+ version?: string;
696
+ url?: string;
697
+ passwordSeed?: string;
698
+ exportedAt?: string;
699
+ envVars?: FileImportResponseMetaEnvVars;
700
+ };
701
+ export type FileImportResponseFileStat = {
702
+ dev?: number;
703
+ mode?: number;
704
+ nlink?: number;
705
+ uid?: number;
706
+ gid?: number;
707
+ rdev?: number;
708
+ blksize?: number;
709
+ ino?: number;
710
+ size?: number;
711
+ blocks?: number;
712
+ atime?: string;
713
+ mtime?: string;
714
+ ctime?: string;
715
+ birthtime?: string;
716
+ };
717
+ export type FileImportResponseInnerFileStatsItem = {
718
+ fileName?: string;
719
+ collectionName?: string;
720
+ /** @nullable */
721
+ size?: number | null;
722
+ };
723
+ export interface FileImportResponse {
724
+ meta?: FileImportResponseMeta;
725
+ fileName?: string;
726
+ zipFilePath?: string;
727
+ fileStat?: FileImportResponseFileStat;
728
+ innerFileStats?: FileImportResponseInnerFileStatsItem[];
729
+ }
730
+ export interface InAppNotificationListResponse {
731
+ docs?: InAppNotificationDocument[];
732
+ /** Total number of in app notification documents */
733
+ totalDocs?: number;
734
+ /** Offset value */
735
+ offset?: number;
736
+ /** Limit per page */
737
+ limit?: number;
738
+ /** Total pages available */
739
+ totalPages?: number;
740
+ /** Current page number */
741
+ page?: number;
742
+ /** Indicator for previous page */
743
+ hasPrevPage?: boolean;
744
+ /** Indicator for next page */
745
+ hasNextPage?: boolean;
746
+ /** Previous page number or null */
747
+ prevPage?: string;
748
+ /** Next page number or null */
749
+ nextPage?: string;
750
+ }
751
+ export interface InAppNotificationDocument {
752
+ /** In app notification document ID */
753
+ _id?: string;
754
+ /** Action performed on the in app notification document */
755
+ action?: string;
756
+ /** Snapshot details in JSON format */
757
+ snapshot?: string;
758
+ target?: Page;
759
+ user?: User;
760
+ /** Creation timestamp */
761
+ createdAt?: string;
762
+ /** Status of the in app notification document */
763
+ status?: string;
764
+ /** Model of the target */
765
+ targetModel?: string;
766
+ /** In app notification document ID */
767
+ id?: string;
768
+ actionUsers?: User[];
769
+ }
770
+ /**
771
+ * MarkdownParams
772
+ */
773
+ export interface MarkdownParams {
774
+ /** enable lineBreak */
775
+ isEnabledLinebreaks?: boolean;
776
+ /** enable lineBreak in comment */
777
+ isEnabledLinebreaksInComments?: boolean;
778
+ /** preferred indent size */
779
+ adminPreferredIndentSize?: number;
780
+ /** force indent size */
781
+ isIndentSizeForced?: boolean;
782
+ /** enable xss */
783
+ isEnabledXss?: boolean;
784
+ /** number of xss option */
785
+ xssOption?: number;
786
+ /** array of tag whitelist */
787
+ tagWhitelist?: string[];
788
+ /** attr whitelist */
789
+ attrWhitelist?: string;
790
+ }
791
+ /**
792
+ * LineBreakParams
793
+ */
794
+ export interface LineBreakParams {
795
+ /** enable lineBreak */
796
+ isEnabledLinebreaks?: boolean;
797
+ /** enable lineBreak in comment */
798
+ isEnabledLinebreaksInComments?: boolean;
799
+ }
800
+ /**
801
+ * PresentationParams
802
+ */
803
+ export interface PresentationParams {
804
+ /** number of pageBreakSeparator */
805
+ pageBreakSeparator?: number;
806
+ /** string of pageBreakCustomSeparator */
807
+ pageBreakCustomSeparator?: string;
808
+ }
809
+ /**
810
+ * XssParams
811
+ */
812
+ export interface XssParams {
813
+ /** enable xss */
814
+ isEnabledXss?: boolean;
815
+ /** number of xss option */
816
+ xssOption?: number;
817
+ /** array of tag whitelist */
818
+ tagWhitelist?: string[];
819
+ /** attr whitelist */
820
+ attrWhitelist?: string;
821
+ }
822
+ /**
823
+ * IndentParams
824
+ */
825
+ export interface IndentParams {
826
+ /** preferred indent size */
827
+ adminPreferredIndentSize?: number;
828
+ /** force indent size */
829
+ isIndentSizeForced?: boolean;
830
+ }
831
+ export interface NotificationParams {
832
+ /** status of slack integration */
833
+ isSlackbotConfigured?: boolean;
834
+ /** status of slack legacy integration */
835
+ isSlackLegacyConfigured?: boolean;
836
+ /** current bot type */
837
+ currentBotType?: string;
838
+ userNotifications?: UserNotification[];
839
+ /** Whether to notify on owner page */
840
+ isNotificationForOwnerPageEnabled?: boolean;
841
+ /** Whether to notify on group page */
842
+ isNotificationForGroupPageEnabled?: boolean;
843
+ /** global notifications */
844
+ globalNotifications?: GlobalNotificationParams[];
845
+ }
846
+ export interface UserNotification {
847
+ /** slack channel name without '#' */
848
+ channel?: string;
849
+ /** path name of wiki */
850
+ pathPattern?: string;
851
+ /** created date */
852
+ createdAt?: string;
853
+ /** user who set notification */
854
+ creator?: User;
855
+ /** path pattern prefix */
856
+ patternPrefix?: string;
857
+ /** path pattern prefix2 */
858
+ patternPrefix2?: string;
859
+ /** provider */
860
+ provider?: string;
861
+ /** updated date */
862
+ updatedAt?: string;
863
+ /** version */
864
+ __v?: number;
865
+ /** id */
866
+ _id?: string;
867
+ }
868
+ export interface UserNotificationParams {
869
+ /** path name of wiki */
870
+ pathPattern?: string;
871
+ /** slack channel name without '#' */
872
+ channel?: string;
873
+ }
874
+ export interface NotifyForPageGrant {
875
+ /** Whether to notify on owner page */
876
+ isNotificationForOwnerPageEnabled?: boolean;
877
+ /** Whether to notify on group page */
878
+ isNotificationForGroupPageEnabled?: boolean;
879
+ }
880
+ export interface GlobalNotification {
881
+ /** id */
882
+ _id?: string;
883
+ /** is notification enabled */
884
+ isEnabled?: boolean;
885
+ /** trigger events for notify */
886
+ triggerEvents?: string[];
887
+ /** type of notification */
888
+ __t?: string;
889
+ /** channels for notify */
890
+ slackChannels?: string;
891
+ /** trigger path for notify */
892
+ triggerPath?: string;
893
+ /** version */
894
+ __v?: number;
895
+ }
896
+ export interface GlobalNotificationParams {
897
+ /** What is type for notify */
898
+ notifyType?: string;
899
+ /** email for notify */
900
+ toEmail?: string;
901
+ /** channels for notify */
902
+ slackChannels?: string;
903
+ /** trigger path for notify */
904
+ triggerPath?: string;
905
+ /** trigger events for notify */
906
+ triggerEvents?: string[];
907
+ }
908
+ /**
909
+ * LikeParams
910
+ */
911
+ export interface LikeParams {
912
+ /** page ID */
913
+ pageId?: string;
914
+ /** boolean for like status */
915
+ bool?: boolean;
916
+ }
917
+ /**
918
+ * PageInfo
919
+ */
920
+ export interface PageInfo {
921
+ /** Whether the page is liked by the logged in user */
922
+ isLiked?: boolean;
923
+ /** Number of users who have liked the page */
924
+ sumOfLikers: number;
925
+ /** Ids of users who have liked the page */
926
+ likerIds: string[];
927
+ /** Number of users who have seen the page */
928
+ sumOfSeenUsers: number;
929
+ /** Ids of users who have seen the page */
930
+ seenUserIds: string[];
931
+ }
932
+ /**
933
+ * PageParams
934
+ */
935
+ export interface PageParams {
936
+ /** page ID */
937
+ pageId: string;
938
+ }
939
+ /**
940
+ * personal settings
941
+ */
942
+ export interface PersonalSettings {
943
+ name?: string;
944
+ email?: string;
945
+ lang?: string;
946
+ isEmailPublished?: boolean;
947
+ slackMemberId?: string;
948
+ }
949
+ /**
950
+ * passwords for update
951
+ */
952
+ export interface Passwords {
953
+ oldPassword?: string;
954
+ newPassword?: string;
955
+ newPasswordConfirm?: string;
956
+ }
957
+ /**
958
+ * Ldap account for associate
959
+ */
960
+ export interface AssociateUser {
961
+ username?: string;
962
+ password?: string;
963
+ }
964
+ /**
965
+ * Ldap account for disassociate
966
+ */
967
+ export interface DisassociateUser {
968
+ providerType?: string;
969
+ accountId?: string;
970
+ }
971
+ /**
972
+ * Revision
973
+ */
974
+ export interface Revision {
975
+ /** The revision ID */
976
+ _id?: ObjectId;
977
+ /** format */
978
+ format?: string;
979
+ /** The ID of the page the revision belongs to */
980
+ pageId?: string;
981
+ /** The content of the revision */
982
+ body?: RevisionBody;
983
+ author?: ObjectId;
984
+ /** The origin of the revision */
985
+ origin?: string;
986
+ /** Whether the revision has differences to the previous one */
987
+ hasDiffToPrev?: boolean;
988
+ /** date created at */
989
+ createdAt?: string;
990
+ /** DB record version */
991
+ __v?: number;
992
+ /** path */
993
+ path?: string;
994
+ }
995
+ export type IndicesGrowi = {
996
+ uuid?: string;
997
+ health?: string;
998
+ status?: string;
999
+ primaries?: SearchIndex;
1000
+ total?: SearchIndex;
1001
+ };
1002
+ export type IndicesAliasesGrowiAliasesGrowiAlias = {
1003
+ [key: string]: unknown;
1004
+ };
1005
+ export type IndicesAliasesGrowiAliases = {
1006
+ 'growi-alias'?: IndicesAliasesGrowiAliasesGrowiAlias;
1007
+ };
1008
+ export type IndicesAliasesGrowi = {
1009
+ aliases?: IndicesAliasesGrowiAliases;
1010
+ };
1011
+ export type IndicesAliases = {
1012
+ growi?: IndicesAliasesGrowi;
1013
+ };
1014
+ export interface Indices {
1015
+ growi?: IndicesGrowi;
1016
+ aliases?: IndicesAliases;
1017
+ isNormalized?: boolean;
1018
+ }
1019
+ export type SearchIndexDocs = {
1020
+ count?: number;
1021
+ deleted?: number;
1022
+ };
1023
+ export type SearchIndexStore = {
1024
+ size_in_bytes?: number;
1025
+ total_data_set_size_in_bytes?: number;
1026
+ reserved_in_bytes?: number;
1027
+ };
1028
+ export type SearchIndexIndexing = {
1029
+ index_total?: number;
1030
+ index_time_in_millis?: number;
1031
+ index_current?: number;
1032
+ index_failed?: number;
1033
+ delete_total?: number;
1034
+ delete_time_in_millis?: number;
1035
+ delete_current?: number;
1036
+ noop_update_total?: number;
1037
+ is_throttled?: boolean;
1038
+ throttle_time_in_millis?: number;
1039
+ write_load?: number;
1040
+ };
1041
+ export interface SearchIndex {
1042
+ docs?: SearchIndexDocs;
1043
+ store?: SearchIndexStore;
1044
+ indexing?: SearchIndexIndexing;
1045
+ }
1046
+ export interface GeneralSetting {
1047
+ /** type of restrictGuestMode */
1048
+ restrictGuestMode?: string;
1049
+ /** type of pageDeletionAuthority */
1050
+ pageDeletionAuthority?: string;
1051
+ /** type of pageRecursiveDeletionAuthority */
1052
+ pageRecursiveDeletionAuthority?: string;
1053
+ /** type of pageRecursiveCompleteDeletionAuthority */
1054
+ pageRecursiveCompleteDeletionAuthority?: string;
1055
+ /** enable all group membership required for page complete deletion */
1056
+ isAllGroupMembershipRequiredForPageCompleteDeletion?: boolean;
1057
+ /** type of pageDeletionAuthority */
1058
+ pageCompleteDeletionAuthority?: string;
1059
+ /** enable hide by owner */
1060
+ hideRestrictedByOwner?: boolean;
1061
+ /** enable hide by group */
1062
+ hideRestrictedByGroup?: boolean;
1063
+ /** enable user homepage deletion */
1064
+ isUsersHomepageDeletionEnabled?: boolean;
1065
+ /** enable force delete user homepage on user deletion */
1066
+ isForceDeleteUserHomepageOnUserDeletion?: boolean;
1067
+ /** enable rom user allowed to comment */
1068
+ isRomUserAllowedToComment?: boolean;
1069
+ /** type of wikiMode */
1070
+ wikiMode?: string;
1071
+ /** max age of session */
1072
+ sessionMaxAge?: number;
1073
+ }
1074
+ export interface ShareLinkSetting {
1075
+ /** disable link sharing */
1076
+ disableLinkSharing?: boolean;
1077
+ }
1078
+ export interface LocalSetting {
1079
+ /** use only env vars for some options */
1080
+ useOnlyEnvVarsForSomeOptions?: boolean;
1081
+ /** enable password reset */
1082
+ isPasswordResetEnabled?: boolean;
1083
+ /** enable email authentication */
1084
+ isEmailAuthenticationEnabled?: boolean;
1085
+ /** local setting mode */
1086
+ isLocalEnabled?: boolean;
1087
+ /** type of registrationMode */
1088
+ registrationMode?: string;
1089
+ /** array of regsitrationList */
1090
+ registrationWhitelist?: string[];
1091
+ }
1092
+ export interface GeneralAuthSetting {
1093
+ /** local setting mode */
1094
+ isLocalEnabled?: boolean;
1095
+ /** ldap setting mode */
1096
+ isLdapEnabled?: boolean;
1097
+ /** saml setting mode */
1098
+ isSamlEnabled?: boolean;
1099
+ /** oidc setting mode */
1100
+ isOidcEnabled?: boolean;
1101
+ /** google setting mode */
1102
+ isGoogleEnabled?: boolean;
1103
+ /** github setting mode */
1104
+ isGitHubEnabled?: boolean;
1105
+ }
1106
+ export interface LdapAuthSetting {
1107
+ /** server url for ldap */
1108
+ serverUrl?: string;
1109
+ /** enable user bind */
1110
+ isUserBind?: boolean;
1111
+ /** the query used to bind with the directory service */
1112
+ ldapBindDN?: string;
1113
+ /** the password that is entered in the login page will be used to bind */
1114
+ ldapBindDNPassword?: string;
1115
+ /** the query used to locate the authenticated user */
1116
+ ldapSearchFilter?: string;
1117
+ /** specification of mappings for username when creating new users */
1118
+ ldapAttrMapUsername?: string;
1119
+ /** local account automatically linked the user name matched */
1120
+ isSameUsernameTreatedAsIdenticalUser?: boolean;
1121
+ /** specification of mappings for mail address when creating new users */
1122
+ ldapAttrMapMail?: string;
1123
+ /** Specification of mappings for full name address when creating new users */
1124
+ ldapAttrMapName?: string;
1125
+ /** the base DN from which to search for groups. */
1126
+ ldapGroupSearchBase?: string;
1127
+ /** the query used to filter for groups */
1128
+ ldapGroupSearchFilter?: string;
1129
+ /** The property of user object to use in dn interpolation of Group Search Filter */
1130
+ ldapGroupDnProperty?: string;
1131
+ }
1132
+ export interface SamlAuthSetting {
1133
+ /** array of missing mandatory config keys */
1134
+ missingMandatoryConfigKeys?: string[];
1135
+ /** use only env vars for some options */
1136
+ useOnlyEnvVarsForSomeOptions?: boolean;
1137
+ /** entry point for saml */
1138
+ samlEntryPoint?: string;
1139
+ /** issuer for saml */
1140
+ samlIssuer?: string;
1141
+ /** issuer for saml */
1142
+ samlEnvVarIssuer?: string;
1143
+ /** certificate for saml */
1144
+ samlCert?: string;
1145
+ /** certificate for saml */
1146
+ samlEnvVarCert?: string;
1147
+ /** attribute mapping id for saml */
1148
+ samlAttrMapId?: string;
1149
+ /** attribute mapping user name for saml */
1150
+ samlAttrMapUserName?: string;
1151
+ /** attribute mapping mail for saml */
1152
+ samlAttrMapMail?: string;
1153
+ /** attribute mapping id for saml */
1154
+ samlEnvVarAttrMapId?: string;
1155
+ /** attribute mapping user name for saml */
1156
+ samlEnvVarAttrMapUserName?: string;
1157
+ /** attribute mapping mail for saml */
1158
+ samlEnvVarAttrMapMail?: string;
1159
+ /** attribute mapping first name for saml */
1160
+ samlAttrMapFirstName?: string;
1161
+ /** attribute mapping last name for saml */
1162
+ samlAttrMapLastName?: string;
1163
+ /** attribute mapping first name for saml */
1164
+ samlEnvVarAttrMapFirstName?: string;
1165
+ /** attribute mapping last name for saml */
1166
+ samlEnvVarAttrMapLastName?: string;
1167
+ /** local account automatically linked the user name matched */
1168
+ isSameUsernameTreatedAsIdenticalUser?: boolean;
1169
+ /** local account automatically linked the email matched */
1170
+ isSameEmailTreatedAsIdenticalUser?: boolean;
1171
+ /** ABLCRule for saml */
1172
+ samlABLCRule?: string;
1173
+ /** ABLCRule for saml */
1174
+ samlEnvVarABLCRule?: string;
1175
+ }
1176
+ export interface OidcAuthSetting {
1177
+ /** provider name for oidc */
1178
+ oidcProviderName?: string;
1179
+ /** issuer host for oidc */
1180
+ oidcIssuerHost?: string;
1181
+ /** authorization endpoint for oidc */
1182
+ oidcAuthorizationEndpoint?: string;
1183
+ /** token endpoint for oidc */
1184
+ oidcTokenEndpoint?: string;
1185
+ /** revocation endpoint for oidc */
1186
+ oidcRevocationEndpoint?: string;
1187
+ /** introspection endpoint for oidc */
1188
+ oidcIntrospectionEndpoint?: string;
1189
+ /** userinfo endpoint for oidc */
1190
+ oidcUserInfoEndpoint?: string;
1191
+ /** end session endpoint for oidc */
1192
+ oidcEndSessionEndpoint?: string;
1193
+ /** registration endpoint for oidc */
1194
+ oidcRegistrationEndpoint?: string;
1195
+ /** JSON Web Key Set URI for oidc */
1196
+ oidcJWKSUri?: string;
1197
+ /** client id for oidc */
1198
+ oidcClientId?: string;
1199
+ /** client secret for oidc */
1200
+ oidcClientSecret?: string;
1201
+ /** attr map id for oidc */
1202
+ oidcAttrMapId?: string;
1203
+ /** attr map username for oidc */
1204
+ oidcAttrMapUserName?: string;
1205
+ /** attr map name for oidc */
1206
+ oidcAttrMapName?: string;
1207
+ /** attr map mail for oidc */
1208
+ oidcAttrMapMail?: string;
1209
+ /** local account automatically linked the user name matched */
1210
+ isSameUsernameTreatedAsIdenticalUser?: boolean;
1211
+ /** local account automatically linked the email matched */
1212
+ isSameEmailTreatedAsIdenticalUser?: boolean;
1213
+ }
1214
+ export interface GitHubOAuthSetting {
1215
+ /** key of comsumer */
1216
+ githubClientId?: string;
1217
+ /** password of comsumer */
1218
+ githubClientSecret?: string;
1219
+ /** local account automatically linked the email matched */
1220
+ isSameUsernameTreatedAsIdenticalUser?: boolean;
1221
+ }
1222
+ export interface GoogleOAuthSetting {
1223
+ /** key of comsumer */
1224
+ googleClientId?: string;
1225
+ /** password of comsumer */
1226
+ googleClientSecret?: string;
1227
+ /** local account automatically linked the email matched */
1228
+ isSameUsernameTreatedAsIdenticalUser?: boolean;
1229
+ }
1230
+ export type ShareLinkRelatedPage = {
1231
+ /** The unique identifier of the related page */
1232
+ _id?: string;
1233
+ /** The path of the related page */
1234
+ path?: string;
1235
+ };
1236
+ export interface ShareLink {
1237
+ /** The unique identifier of the share link */
1238
+ _id?: string;
1239
+ relatedPage?: ShareLinkRelatedPage;
1240
+ /** The expiration date of the share link */
1241
+ expiredAt?: string;
1242
+ /** The description of the share link */
1243
+ description?: string;
1244
+ /** The creation date of the share link */
1245
+ createdAt?: string;
1246
+ /** The version key */
1247
+ __v?: number;
1248
+ }
1249
+ export interface ShareLinkSimple {
1250
+ /** The unique identifier of the related page */
1251
+ relatedPage?: string;
1252
+ /** The expiration date of the share link */
1253
+ expiredAt?: string;
1254
+ /** The description of the share link */
1255
+ description?: string;
1256
+ /** The creation date of the share link */
1257
+ createdAt?: string;
1258
+ /** The version key */
1259
+ __v?: number;
1260
+ /** The unique identifier of the share link */
1261
+ _id?: string;
1262
+ }
1263
+ export interface SlackConfigurationParams {
1264
+ /** incoming webhooks url */
1265
+ webhookUrl?: string;
1266
+ /** use incoming webhooks even if Slack App settings are enabled */
1267
+ isIncomingWebhookPrioritized?: boolean;
1268
+ /** OAuth access token */
1269
+ slackToken?: string;
1270
+ }
1271
+ /**
1272
+ * BotType
1273
+ */
1274
+ export interface BotType {
1275
+ currentBotType?: string;
1276
+ }
1277
+ /**
1278
+ * SlackIntegration
1279
+ */
1280
+ export interface SlackIntegration {
1281
+ currentBotType?: string;
1282
+ }
1283
+ export type StatisticsUserResponseDataActive = {
1284
+ total?: number;
1285
+ admin?: number;
1286
+ };
1287
+ export type StatisticsUserResponseDataInactive = {
1288
+ total?: number;
1289
+ registered?: number;
1290
+ suspended?: number;
1291
+ deleted?: number;
1292
+ invited?: number;
1293
+ };
1294
+ export type StatisticsUserResponseData = {
1295
+ total?: number;
1296
+ active?: StatisticsUserResponseDataActive;
1297
+ inactive?: StatisticsUserResponseDataInactive;
1298
+ };
1299
+ export interface StatisticsUserResponse {
1300
+ data?: StatisticsUserResponseData;
1301
+ }
1302
+ /**
1303
+ * User
1304
+ */
1305
+ export interface User {
1306
+ /** user ID */
1307
+ _id?: string;
1308
+ /** language */
1309
+ lang?: string;
1310
+ /** status */
1311
+ status?: number;
1312
+ /** whether the admin */
1313
+ admin?: boolean;
1314
+ /** E-Mail address */
1315
+ email?: string;
1316
+ /** username */
1317
+ username?: string;
1318
+ /** full name */
1319
+ name?: string;
1320
+ /** date created at */
1321
+ createdAt?: string;
1322
+ /** cached image URL */
1323
+ imageUrlCached?: string;
1324
+ /** whether the email is published */
1325
+ isEmailPublished?: boolean;
1326
+ /** whether the gravatar is enabled */
1327
+ isGravatarEnabled?: boolean;
1328
+ /** whether the invitation email is sent */
1329
+ isInvitationEmailSended?: boolean;
1330
+ /** whether the questionnaire is enabled */
1331
+ isQuestionnaireEnabled?: boolean;
1332
+ /** datetime last login at */
1333
+ lastLoginAt?: string;
1334
+ /** whether the user is read only */
1335
+ readOnly?: boolean;
1336
+ /** datetime updated at */
1337
+ updatedAt?: string;
1338
+ /** DB record version */
1339
+ __v?: number;
1340
+ }
1341
+ export type ErrorV3Stack = {
1342
+ [key: string]: unknown;
1343
+ };
1344
+ export type ErrorV3Args = {
1345
+ [key: string]: unknown;
1346
+ };
1347
+ /**
1348
+ * Error for APIv3
1349
+ */
1350
+ export interface ErrorV3 {
1351
+ message?: string;
1352
+ code?: string;
1353
+ stack?: ErrorV3Stack;
1354
+ args?: ErrorV3Args;
1355
+ }
1356
+ /**
1357
+ * Object ID
1358
+ */
1359
+ export type ObjectId = string;
1360
+ /**
1361
+ * Page path
1362
+ */
1363
+ export type PagePath = string;
1364
+ /**
1365
+ * Grant for page
1366
+ */
1367
+ export type PageGrant = number;
1368
+ /**
1369
+ * extend data
1370
+ */
1371
+ export type PageExtended = {
1372
+ [key: string]: unknown;
1373
+ };
1374
+ /**
1375
+ * status
1376
+ */
1377
+ export type PageStatus = (typeof PageStatus)[keyof typeof PageStatus];
1378
+ export declare const PageStatus: {
1379
+ readonly wip: "wip";
1380
+ readonly published: "published";
1381
+ readonly deleted: "deleted";
1382
+ readonly deprecated: "deprecated";
1383
+ };
1384
+ /**
1385
+ * Page
1386
+ */
1387
+ export interface Page {
1388
+ _id?: ObjectId;
1389
+ /** DB record version */
1390
+ __v?: number;
1391
+ /** count of comments */
1392
+ commentCount?: number;
1393
+ /** date created at */
1394
+ createdAt?: string;
1395
+ creator?: User;
1396
+ /** extend data */
1397
+ extended?: PageExtended;
1398
+ grant?: PageGrant;
1399
+ /** granted users */
1400
+ grantedUsers?: string[];
1401
+ lastUpdateUser?: User;
1402
+ /** granted users */
1403
+ liker?: string[];
1404
+ path?: PagePath;
1405
+ /** page revision */
1406
+ revision?: string;
1407
+ /** granted users */
1408
+ seenUsers?: string[];
1409
+ /** status */
1410
+ status?: PageStatus;
1411
+ /** date updated at */
1412
+ updatedAt?: string;
1413
+ }
1414
+ /**
1415
+ * Offset for pagination
1416
+ */
1417
+ export type Offset = number;
1418
+ /**
1419
+ * Limit for pagination
1420
+ */
1421
+ export type Limit = number;
1422
+ export type PaginateResultDocsItem = {
1423
+ [key: string]: unknown;
1424
+ };
1425
+ /**
1426
+ * PaginateResult
1427
+ */
1428
+ export interface PaginateResult {
1429
+ /** Array of documents */
1430
+ docs?: PaginateResultDocsItem[];
1431
+ /** Total number of documents in collection that match a query */
1432
+ totalDocs?: number;
1433
+ limit?: Limit;
1434
+ /** Availability of prev page. */
1435
+ hasPrevPage?: number;
1436
+ /** Availability of next page. */
1437
+ hasNextPage?: number;
1438
+ /** Current page number */
1439
+ page?: number;
1440
+ /** Total number of pages. */
1441
+ totalPages?: number;
1442
+ /** Only if specified or default page/offset values were used */
1443
+ offset?: Offset;
1444
+ /** Previous page number if available or NULL */
1445
+ prefPage?: number;
1446
+ /** Next page number if available or NULL */
1447
+ nextPage?: number;
1448
+ /** The starting sl. number of first document. */
1449
+ pagingCounter?: number;
1450
+ /** Object of pagination meta data (Default false). */
1451
+ meta?: number;
1452
+ }
1453
+ export type V1PaginateResultMeta = {
1454
+ /** Total number of documents in collection that match a query */
1455
+ total?: number;
1456
+ limit?: Limit;
1457
+ /** Only if specified or default page/offset values were used */
1458
+ offset?: Offset;
1459
+ };
1460
+ /**
1461
+ * Object of pagination meta data.
1462
+ */
1463
+ export type V1PaginateResultData = {
1464
+ [key: string]: unknown;
1465
+ };
1466
+ /**
1467
+ * Paginate result v1
1468
+ */
1469
+ export interface V1PaginateResult {
1470
+ meta?: V1PaginateResultMeta;
1471
+ /** Object of pagination meta data. */
1472
+ data?: V1PaginateResultData;
1473
+ }
1474
+ /**
1475
+ * Revision content body
1476
+ */
1477
+ export type RevisionBody = string;
1478
+ /**
1479
+ * Tags
1480
+ */
1481
+ export type Tags = TagName[];
1482
+ /**
1483
+ * Tag name
1484
+ */
1485
+ export type TagName = string;
1486
+ /**
1487
+ * Tag
1488
+ */
1489
+ export interface Tag {
1490
+ /** tag ID */
1491
+ _id?: string;
1492
+ name?: TagName;
1493
+ /** Count of tagged pages */
1494
+ count?: number;
1495
+ }
1496
+ /**
1497
+ * API is succeeded
1498
+ */
1499
+ export type V1ResponseOK = boolean;
1500
+ /**
1501
+ * Response v1
1502
+ */
1503
+ export interface V1Response {
1504
+ ok?: V1ResponseOK;
1505
+ }
1506
+ /**
1507
+ * Forbidden
1508
+ */
1509
+ export type N403Response = void;
1510
+ /**
1511
+ * Internal Server Error
1512
+ */
1513
+ export type N500Response = void;
1514
+ export type GetExternalUserGroupRelationsParams = {
1515
+ /**
1516
+ * The group IDs to get relations for
1517
+ */
1518
+ groupIds?: string[];
1519
+ /**
1520
+ * The child group IDs to get relations for
1521
+ */
1522
+ childGroupIds?: string[];
1523
+ };
1524
+ export type GetExternalUserGroupRelations200UserGroupRelationsItem = {
1525
+ [key: string]: unknown;
1526
+ };
1527
+ export type GetExternalUserGroupRelations200RelationsOfChildGroupsItem = {
1528
+ [key: string]: unknown;
1529
+ };
1530
+ export type GetExternalUserGroupRelations200 = {
1531
+ userGroupRelations?: GetExternalUserGroupRelations200UserGroupRelationsItem[];
1532
+ relationsOfChildGroups?: GetExternalUserGroupRelations200RelationsOfChildGroupsItem[];
1533
+ };
1534
+ export type GetExternalUserGroupsParams = {
1535
+ /**
1536
+ * Page number for pagination
1537
+ */
1538
+ page?: number;
1539
+ /**
1540
+ * Number of items per page
1541
+ */
1542
+ limit?: number;
1543
+ /**
1544
+ * Offset for pagination
1545
+ */
1546
+ offset?: number;
1547
+ /**
1548
+ * Whether to enable pagination
1549
+ */
1550
+ pagination?: boolean;
1551
+ };
1552
+ export type GetExternalUserGroups200UserGroupsItem = {
1553
+ [key: string]: unknown;
1554
+ };
1555
+ export type GetExternalUserGroups200 = {
1556
+ userGroups?: GetExternalUserGroups200UserGroupsItem[];
1557
+ totalUserGroups?: number;
1558
+ pagingLimit?: number;
1559
+ };
1560
+ export type GetExternalUserGroupsAncestorsParams = {
1561
+ /**
1562
+ * The ID of the user group to get ancestors for
1563
+ */
1564
+ groupId: string;
1565
+ };
1566
+ export type GetExternalUserGroupsAncestors200AncestorUserGroupsItem = {
1567
+ [key: string]: unknown;
1568
+ };
1569
+ export type GetExternalUserGroupsAncestors200 = {
1570
+ ancestorUserGroups?: GetExternalUserGroupsAncestors200AncestorUserGroupsItem[];
1571
+ };
1572
+ export type GetExternalUserGroupsChildrenParams = {
1573
+ /**
1574
+ * The IDs of the parent user groups
1575
+ */
1576
+ parentIds?: string[];
1577
+ /**
1578
+ * Whether to include grandchild user groups
1579
+ */
1580
+ includeGrandChildren?: boolean;
1581
+ };
1582
+ export type GetExternalUserGroupsChildren200ChildUserGroupsItem = {
1583
+ [key: string]: unknown;
1584
+ };
1585
+ export type GetExternalUserGroupsChildren200GrandChildUserGroupsItem = {
1586
+ [key: string]: unknown;
1587
+ };
1588
+ export type GetExternalUserGroupsChildren200 = {
1589
+ childUserGroups?: GetExternalUserGroupsChildren200ChildUserGroupsItem[];
1590
+ grandChildUserGroups?: GetExternalUserGroupsChildren200GrandChildUserGroupsItem[];
1591
+ };
1592
+ export type GetExternalUserGroupsId200UserGroup = {
1593
+ [key: string]: unknown;
1594
+ };
1595
+ export type GetExternalUserGroupsId200 = {
1596
+ userGroup?: GetExternalUserGroupsId200UserGroup;
1597
+ };
1598
+ export type DeleteExternalUserGroupsIdParams = {
1599
+ /**
1600
+ * The action to perform on group delete
1601
+ */
1602
+ actionName: string;
1603
+ /**
1604
+ * The ID of the user group to transfer to
1605
+ */
1606
+ transferToUserGroupId?: string;
1607
+ /**
1608
+ * The type of the user group to transfer to
1609
+ */
1610
+ transferToUserGroupType?: string;
1611
+ };
1612
+ export type DeleteExternalUserGroupsId200UserGroupsItem = {
1613
+ [key: string]: unknown;
1614
+ };
1615
+ export type DeleteExternalUserGroupsId200 = {
1616
+ userGroups?: DeleteExternalUserGroupsId200UserGroupsItem[];
1617
+ };
1618
+ export type PutExternalUserGroupsIdBody = {
1619
+ description?: string;
1620
+ };
1621
+ export type PutExternalUserGroupsId200UserGroup = {
1622
+ [key: string]: unknown;
1623
+ };
1624
+ export type PutExternalUserGroupsId200 = {
1625
+ userGroup?: PutExternalUserGroupsId200UserGroup;
1626
+ };
1627
+ export type GetExternalUserGroupsIdExternalUserGroupRelations200UserGroupRelationsItem = {
1628
+ [key: string]: unknown;
1629
+ };
1630
+ export type GetExternalUserGroupsIdExternalUserGroupRelations200 = {
1631
+ userGroupRelations?: GetExternalUserGroupsIdExternalUserGroupRelations200UserGroupRelationsItem[];
1632
+ };
1633
+ export type GetExternalUserGroupsLdapSyncSettings200 = {
1634
+ ldapGroupSearchBase?: string;
1635
+ ldapGroupMembershipAttribute?: string;
1636
+ ldapGroupMembershipAttributeType?: string;
1637
+ ldapGroupChildGroupAttribute?: string;
1638
+ autoGenerateUserOnLdapGroupSync?: boolean;
1639
+ preserveDeletedLdapGroups?: boolean;
1640
+ ldapGroupNameAttribute?: string;
1641
+ ldapGroupDescriptionAttribute?: string;
1642
+ };
1643
+ export type PutExternalUserGroupsLdapSyncSettingsBody = {
1644
+ ldapGroupSearchBase?: string;
1645
+ ldapGroupMembershipAttribute?: string;
1646
+ ldapGroupMembershipAttributeType?: string;
1647
+ ldapGroupChildGroupAttribute?: string;
1648
+ autoGenerateUserOnLdapGroupSync?: boolean;
1649
+ preserveDeletedLdapGroups?: boolean;
1650
+ ldapGroupNameAttribute?: string;
1651
+ ldapGroupDescriptionAttribute?: string;
1652
+ };
1653
+ export type PutExternalUserGroupsLdapSyncSettings204 = {
1654
+ [key: string]: unknown;
1655
+ };
1656
+ export type GetExternalUserGroupsKeycloakSyncSettings200 = {
1657
+ keycloakHost?: string;
1658
+ keycloakGroupRealm?: string;
1659
+ keycloakGroupSyncClientRealm?: string;
1660
+ keycloakGroupSyncClientID?: string;
1661
+ keycloakGroupSyncClientSecret?: string;
1662
+ autoGenerateUserOnKeycloakGroupSync?: boolean;
1663
+ preserveDeletedKeycloakGroups?: boolean;
1664
+ keycloakGroupDescriptionAttribute?: string;
1665
+ };
1666
+ export type PutExternalUserGroupsKeycloakSyncSettingsBody = {
1667
+ keycloakHost?: string;
1668
+ keycloakGroupRealm?: string;
1669
+ keycloakGroupSyncClientRealm?: string;
1670
+ keycloakGroupSyncClientID?: string;
1671
+ keycloakGroupSyncClientSecret?: string;
1672
+ autoGenerateUserOnKeycloakGroupSync?: boolean;
1673
+ preserveDeletedKeycloakGroups?: boolean;
1674
+ keycloakGroupDescriptionAttribute?: string;
1675
+ };
1676
+ export type PutExternalUserGroupsKeycloakSyncSettings204 = {
1677
+ [key: string]: unknown;
1678
+ };
1679
+ export type PutExternalUserGroupsLdapSync202 = {
1680
+ [key: string]: unknown;
1681
+ };
1682
+ export type PutExternalUserGroupsKeycloakSync202 = {
1683
+ [key: string]: unknown;
1684
+ };
1685
+ export type GetQuestionnaireOrders200QuestionnaireOrdersItem = {
1686
+ [key: string]: unknown;
1687
+ };
1688
+ export type GetQuestionnaireOrders200 = {
1689
+ questionnaireOrders?: GetQuestionnaireOrders200QuestionnaireOrdersItem[];
1690
+ };
1691
+ export type GetQuestionnaireIsEnabled200 = {
1692
+ isEnabled?: boolean;
1693
+ };
1694
+ export type PostQuestionnaireProactiveAnswerBody = {
1695
+ [key: string]: unknown;
1696
+ };
1697
+ export type PostQuestionnaireProactiveAnswer200 = {
1698
+ [key: string]: unknown;
1699
+ };
1700
+ export type PutQuestionnaireAnswerBody = {
1701
+ [key: string]: unknown;
1702
+ };
1703
+ export type PutQuestionnaireAnswer201 = {
1704
+ [key: string]: unknown;
1705
+ };
1706
+ export type PutQuestionnaireAnswer204 = {
1707
+ [key: string]: unknown;
1708
+ };
1709
+ export type PutQuestionnaireSkipBody = {
1710
+ [key: string]: unknown;
1711
+ };
1712
+ export type PutQuestionnaireSkip201 = {
1713
+ [key: string]: unknown;
1714
+ };
1715
+ export type PutQuestionnaireSkip204 = {
1716
+ [key: string]: unknown;
1717
+ };
1718
+ export type PutQuestionnaireDenyBody = {
1719
+ [key: string]: unknown;
1720
+ };
1721
+ export type PutQuestionnaireDeny201 = {
1722
+ [key: string]: unknown;
1723
+ };
1724
+ export type PutQuestionnaireDeny204 = {
1725
+ [key: string]: unknown;
1726
+ };
1727
+ export type GetTemplatesParams = {
1728
+ /**
1729
+ * Whether to include invalid templates
1730
+ */
1731
+ includeInvalidTemplates?: boolean;
1732
+ };
1733
+ export type GetTemplates200Summaries = {
1734
+ [key: string]: {
1735
+ id?: string;
1736
+ isDefault?: boolean;
1737
+ isValid?: boolean;
1738
+ locale?: string;
1739
+ title?: string;
1740
+ };
1741
+ };
1742
+ export type GetTemplates200 = {
1743
+ summaries?: GetTemplates200Summaries;
1744
+ };
1745
+ export type GetTemplatesPresetTemplatesTemplateIdLocale200 = {
1746
+ markdown?: string;
1747
+ };
1748
+ export type GetTemplatesPluginTemplatesOrganizationIdReposIdTemplateIdLocale200 = {
1749
+ markdown?: string;
1750
+ };
1751
+ export type PostPluginsBodyPluginInstallerForm = {
1752
+ url?: string;
1753
+ ghBranch?: string;
1754
+ ghTag?: string;
1755
+ };
1756
+ export type PostPluginsBody = {
1757
+ pluginInstallerForm?: PostPluginsBodyPluginInstallerForm;
1758
+ };
1759
+ export type PostPlugins200 = {
1760
+ /** The name of the installed plugin */
1761
+ pluginName?: string;
1762
+ };
1763
+ export type PutPluginsIdActivate200 = {
1764
+ /** The name of the activated plugin */
1765
+ pluginName?: string;
1766
+ };
1767
+ export type DeletePluginsIdRemove200 = {
1768
+ /** The name of the removed plugin */
1769
+ pluginName?: string;
1770
+ };
1771
+ export type GetActivityParams = {
1772
+ limit?: number;
1773
+ offset?: number;
1774
+ searchFilter?: string;
1775
+ };
1776
+ export type GetAdminHome200 = {
1777
+ adminHomeParams?: SystemInformationParams;
1778
+ };
1779
+ export type GetAppSettings200 = {
1780
+ appSettingsParams?: AppSettingParams;
1781
+ };
1782
+ export type PutAppSettingsAppSetting200 = {
1783
+ appSettingParams?: AppSettingPutParams;
1784
+ };
1785
+ export type PutAppSettingsSiteUrlSetting200SiteUrlSettingParams = {
1786
+ /** Site URL. e.g. https://example.com, https://example.com:3000 */
1787
+ siteUrl?: string;
1788
+ };
1789
+ export type PutAppSettingsSiteUrlSetting200 = {
1790
+ siteUrlSettingParams?: PutAppSettingsSiteUrlSetting200SiteUrlSettingParams;
1791
+ };
1792
+ export type PutAppSettingsSmtpSetting200 = {
1793
+ mailSettingParams?: SmtpSettingResponseParams;
1794
+ };
1795
+ /**
1796
+ * Empty object
1797
+ */
1798
+ export type PostAppSettingsSmtpTest200 = {
1799
+ [key: string]: unknown;
1800
+ };
1801
+ export type PutAppSettingsFileUploadSettings200 = {
1802
+ responseParams?: FileUploadSettingParams;
1803
+ };
1804
+ export type PutAppSettingsQuestionnaireSettings200 = {
1805
+ responseParams?: QuestionnaireSettingParams;
1806
+ };
1807
+ export type PostAppSettingsV5SchemaMigration200 = {
1808
+ /** is V5 compatible, or not */
1809
+ isV5Compatible?: boolean;
1810
+ };
1811
+ export type PostAppSettingsMaintenanceModeBody = {
1812
+ /** flag for maintenance mode */
1813
+ flag?: boolean;
1814
+ };
1815
+ export type PostAppSettingsMaintenanceMode200 = {
1816
+ /** true if maintenance mode is enabled */
1817
+ flag?: boolean;
1818
+ };
1819
+ export type GetAttachmentListParams = {
1820
+ /**
1821
+ * page id
1822
+ */
1823
+ pageId: string;
1824
+ /**
1825
+ * page number
1826
+ */
1827
+ pageNumber?: number;
1828
+ /**
1829
+ * limit
1830
+ */
1831
+ limit?: number;
1832
+ };
1833
+ export type GetAttachmentLimitParams = {
1834
+ fileSize: number;
1835
+ };
1836
+ export type GetAttachmentLimit200 = {
1837
+ /** uploadable */
1838
+ isUploadable?: boolean;
1839
+ };
1840
+ export type PostAttachmentBodyOne = {
1841
+ /** */
1842
+ page_id?: string;
1843
+ /** attachment data */
1844
+ file?: Blob;
1845
+ };
1846
+ export type PostAttachmentBodyTwo = {
1847
+ /** */
1848
+ page_id?: string;
1849
+ /** attachment data */
1850
+ file?: Blob;
1851
+ };
1852
+ export type PostAttachment200 = {
1853
+ page?: Page;
1854
+ attachment?: Attachment;
1855
+ revision?: string;
1856
+ };
1857
+ export type GetAttachmentId200 = {
1858
+ attachment?: Attachment;
1859
+ };
1860
+ export type PostBookmarkFolderBody = {
1861
+ /**
1862
+ * Name of the bookmark folder
1863
+ */
1864
+ name?: string;
1865
+ /** Parent folder ID */
1866
+ parent?: string;
1867
+ };
1868
+ export type PostBookmarkFolder200 = {
1869
+ bookmarkFolder?: BookmarkFolder;
1870
+ };
1871
+ export type PutBookmarkFolderBody = {
1872
+ /** Bookmark Folder ID */
1873
+ bookmarkFolderId?: string;
1874
+ /**
1875
+ * Name of the bookmark folder
1876
+ */
1877
+ name?: string;
1878
+ /** Parent folder ID */
1879
+ parent?: string;
1880
+ /** Child folders */
1881
+ childFolder?: BookmarkFolder[];
1882
+ };
1883
+ export type PutBookmarkFolder200 = {
1884
+ bookmarkFolder?: BookmarkFolder;
1885
+ };
1886
+ export type GetBookmarkFolderListUserId200 = {
1887
+ bookmarkFolderItems?: BookmarkFolder[];
1888
+ };
1889
+ export type DeleteBookmarkFolderId200 = {
1890
+ /** Number of deleted folders */
1891
+ deletedCount?: number;
1892
+ };
1893
+ export type PostBookmarkFolderAddBookmarkToFolderBody = {
1894
+ /**
1895
+ * Page ID
1896
+ */
1897
+ pageId?: string;
1898
+ /**
1899
+ * Folder ID
1900
+ * @nullable
1901
+ */
1902
+ folderId?: string | null;
1903
+ };
1904
+ export type PostBookmarkFolderAddBookmarkToFolder200 = {
1905
+ bookmarkFolder?: BookmarkFolder;
1906
+ };
1907
+ export type PutBookmarkFolderUpdateBookmarkBody = {
1908
+ /**
1909
+ * Page ID
1910
+ */
1911
+ pageId?: string;
1912
+ /** Bookmark status */
1913
+ status?: string;
1914
+ };
1915
+ export type PutBookmarkFolderUpdateBookmark200 = {
1916
+ bookmarkFolder?: BookmarkFolder;
1917
+ };
1918
+ export type GetBookmarksInfoParams = {
1919
+ /**
1920
+ * page id
1921
+ */
1922
+ pageId?: string;
1923
+ };
1924
+ export type PutBookmarks200 = {
1925
+ bookmark?: Bookmark;
1926
+ };
1927
+ export type GetCustomizeSetting200 = {
1928
+ /** customize params */
1929
+ customizeParams?: CustomizeSetting;
1930
+ };
1931
+ export type PutCustomizeSettingLayout200 = {
1932
+ /** customized params */
1933
+ customizedParams?: CustomizeLayout;
1934
+ };
1935
+ export type GetCustomizeSettingTheme200 = {
1936
+ /** The current theme name. */
1937
+ currentTheme?: string;
1938
+ /** Metadata for available plugin themes. */
1939
+ pluginThemesMetadatas?: ThemesMetadata[];
1940
+ };
1941
+ export type PutCustomizeSettingTheme200 = {
1942
+ customizedParams?: CustomizeTheme;
1943
+ };
1944
+ export type PutCustomizeSettingSidebar200 = {
1945
+ customizedParams?: CustomizeSidebar;
1946
+ };
1947
+ export type PutCustomizeSettingFunction200 = {
1948
+ customizedParams?: CustomizeFunction;
1949
+ };
1950
+ export type PutCustomizeSettingPresentation200 = {
1951
+ customizedParams?: CustomizePresentation;
1952
+ };
1953
+ export type PutCustomizeSettingHighlight200 = {
1954
+ customizedParams?: CustomizeHighlightResponse;
1955
+ };
1956
+ export type PutCustomizeSettingCustomizeTitle200 = {
1957
+ customizedParams?: CustomizeTitle;
1958
+ };
1959
+ export type PutCustomizeSettingCustomizeNoscript200 = {
1960
+ customizedParams?: CustomizeNoscript;
1961
+ };
1962
+ export type PutCustomizeSettingCustomizeCss200 = {
1963
+ customizedParams?: CustomizeCss;
1964
+ };
1965
+ export type PutCustomizeSettingCustomizeScript200 = {
1966
+ customizedParams?: CustomizeScript;
1967
+ };
1968
+ export type PutCustomizeSettingCustomizeLogo200 = {
1969
+ customizedParams?: CustomizeLogo;
1970
+ };
1971
+ export type PutCustomizeSettingUploadBrandLogoBody = {
1972
+ file?: Blob;
1973
+ };
1974
+ export type PutCustomizeSettingUploadBrandLogo200AttachmentAllOf = {
1975
+ creator?: string;
1976
+ page?: unknown;
1977
+ temporaryUrlExpiredAt?: unknown;
1978
+ temporaryUrlCached?: unknown;
1979
+ };
1980
+ export type PutCustomizeSettingUploadBrandLogo200Attachment = Attachment & PutCustomizeSettingUploadBrandLogo200AttachmentAllOf;
1981
+ export type PutCustomizeSettingUploadBrandLogo200 = {
1982
+ attachment?: PutCustomizeSettingUploadBrandLogo200Attachment;
1983
+ };
1984
+ export type GetExportStatus200 = {
1985
+ /** whether the request is succeeded or not */
1986
+ ok?: boolean;
1987
+ status?: ExportStatus;
1988
+ };
1989
+ export type PostExportBody = {
1990
+ collections?: string[];
1991
+ };
1992
+ export type PostExport200 = {
1993
+ /** whether the request is succeeded */
1994
+ ok?: boolean;
1995
+ };
1996
+ export type DeleteExportFileName200 = {
1997
+ /** whether the request is succeeded */
1998
+ ok?: boolean;
1999
+ };
2000
+ export type PostForgotPasswordBody = {
2001
+ /** Email address of the user requesting password reset */
2002
+ email?: string;
2003
+ };
2004
+ export type PostForgotPassword200 = {
2005
+ [key: string]: unknown;
2006
+ };
2007
+ export type PutForgotPasswordBody = {
2008
+ /** New password */
2009
+ newPassword?: string;
2010
+ };
2011
+ export type PutForgotPassword200 = {
2012
+ userData?: User;
2013
+ };
2014
+ export type GetG2gTransferFiles200FilesItem = {
2015
+ /** The name of the file */
2016
+ name?: string;
2017
+ /** The size of the file */
2018
+ size?: number;
2019
+ };
2020
+ export type GetG2gTransferFiles200 = {
2021
+ files?: GetG2gTransferFiles200FilesItem[];
2022
+ };
2023
+ /**
2024
+ * The map of options for each collection
2025
+ */
2026
+ export type PostG2gTransferBodyOptionsMap = {
2027
+ [key: string]: unknown;
2028
+ };
2029
+ /**
2030
+ * The map of upload configurations
2031
+ */
2032
+ export type PostG2gTransferBodyUploadConfigs = {
2033
+ [key: string]: unknown;
2034
+ };
2035
+ export type PostG2gTransferBody = {
2036
+ /** The zip file of the data to be transferred */
2037
+ file?: Blob;
2038
+ /** The list of MongoDB collections to be transferred */
2039
+ collections?: string[];
2040
+ /** The map of options for each collection */
2041
+ optionsMap?: PostG2gTransferBodyOptionsMap;
2042
+ /** The ID of the operator user */
2043
+ operatorUserId?: string;
2044
+ /** The map of upload configurations */
2045
+ uploadConfigs?: PostG2gTransferBodyUploadConfigs;
2046
+ };
2047
+ export type PostG2gTransfer200 = {
2048
+ /** The message of the result */
2049
+ message?: string;
2050
+ };
2051
+ /**
2052
+ * Metadata of the attachment
2053
+ */
2054
+ export type PostG2gTransferAttachmentBodyAttachmentMetadata = {
2055
+ [key: string]: unknown;
2056
+ };
2057
+ export type PostG2gTransferAttachmentBody = {
2058
+ /** The zip file of the data to be transferred */
2059
+ file?: Blob;
2060
+ /** Metadata of the attachment */
2061
+ attachmentMetadata?: PostG2gTransferAttachmentBodyAttachmentMetadata;
2062
+ };
2063
+ export type PostG2gTransferAttachment200 = {
2064
+ /** The message of the result */
2065
+ message?: string;
2066
+ };
2067
+ export type GetG2gTransferGrowiInfo200 = {
2068
+ growiInfo?: GrowiInfo;
2069
+ };
2070
+ export type PostG2gTransferGenerateKeyBody = {
2071
+ /** The URL of the GROWI */
2072
+ appSiteUrl?: string;
2073
+ };
2074
+ export type PostG2gTransferGenerateKey200 = {
2075
+ /** The transfer key */
2076
+ transferKey?: string;
2077
+ };
2078
+ /**
2079
+ * The map of options for each collection
2080
+ */
2081
+ export type PostG2gTransferTransferBodyOptionsMap = {
2082
+ [key: string]: unknown;
2083
+ };
2084
+ export type PostG2gTransferTransferBody = {
2085
+ /** The transfer key */
2086
+ transferKey?: string;
2087
+ /** The list of MongoDB collections to be transferred */
2088
+ collections?: string[];
2089
+ /** The map of options for each collection */
2090
+ optionsMap?: PostG2gTransferTransferBodyOptionsMap;
2091
+ };
2092
+ export type PostG2gTransferTransfer200 = {
2093
+ /** The message of the result */
2094
+ message?: string;
2095
+ };
2096
+ export type GetHealthcheckParams = {
2097
+ /**
2098
+ * The list of services to check health
2099
+ */
2100
+ checkServices?: GetHealthcheckCheckServicesItem[];
2101
+ /**
2102
+ * Check services and responds 503 if either of these is unhealthy
2103
+ */
2104
+ strictly?: boolean;
2105
+ };
2106
+ export type GetHealthcheckCheckServicesItem = (typeof GetHealthcheckCheckServicesItem)[keyof typeof GetHealthcheckCheckServicesItem];
2107
+ export declare const GetHealthcheckCheckServicesItem: {
2108
+ readonly mongo: "mongo";
2109
+ readonly search: "search";
2110
+ };
2111
+ /**
2112
+ * Don't select checkServices
2113
+ */
2114
+ export type GetHealthcheck200OneOf = {
2115
+ status?: string;
2116
+ };
2117
+ /**
2118
+ * Select checkServices
2119
+ */
2120
+ export type GetHealthcheck200OneOfTwo = {
2121
+ info?: HealthcheckInfo;
2122
+ };
2123
+ export type GetHealthcheck200 = GetHealthcheck200OneOf | GetHealthcheck200OneOfTwo;
2124
+ export type GetHealthcheck503ErrorsItem = {
2125
+ message?: string;
2126
+ code?: string;
2127
+ };
2128
+ export type GetHealthcheck503 = {
2129
+ /** Errors */
2130
+ errors?: GetHealthcheck503ErrorsItem[];
2131
+ info?: HealthcheckInfo;
2132
+ };
2133
+ /**
2134
+ * import settings params
2135
+ */
2136
+ export type GetImport200ImportSettingsParams = {
2137
+ /** the team name of esa.io */
2138
+ esaTeamName?: string;
2139
+ /** the access token of esa.io */
2140
+ esaAccessToken?: string;
2141
+ /** the team name of qiita.com */
2142
+ qiitaTeamName?: string;
2143
+ /** the access token of qiita.com */
2144
+ qiitaAccessToken?: string;
2145
+ };
2146
+ export type GetImport200 = {
2147
+ /** import settings params */
2148
+ importSettingsParams?: GetImport200ImportSettingsParams;
2149
+ };
2150
+ /**
2151
+ * the array of importing option that have collection name as the key
2152
+
2153
+ */
2154
+ export type PostImportBodyOptions = {
2155
+ [key: string]: GrowiArchiveImportOption[];
2156
+ };
2157
+ export type PostImportBody = {
2158
+ /** the file name of zip file */
2159
+ fileName?: string;
2160
+ /** collection names to import */
2161
+ collections?: string[];
2162
+ /** the array of importing option that have collection name as the key
2163
+ */
2164
+ options?: PostImportBodyOptions;
2165
+ };
2166
+ export type GetImportStatus200 = {
2167
+ status?: ImportStatus;
2168
+ };
2169
+ export type PostImportUploadBody = {
2170
+ file?: Blob;
2171
+ };
2172
+ export type GetInAppNotificationListParams = {
2173
+ /**
2174
+ * The number of notifications to get
2175
+ */
2176
+ limit?: number;
2177
+ /**
2178
+ * The number of notifications to skip
2179
+ */
2180
+ offset?: number;
2181
+ /**
2182
+ * The status to categorize. 'UNOPENED' or 'OPENED'.
2183
+ */
2184
+ status?: string;
2185
+ };
2186
+ export type GetInAppNotificationStatus200 = {
2187
+ /** Count of unread notifications */
2188
+ count?: number;
2189
+ };
2190
+ export type PostInAppNotificationOpenBody = {
2191
+ /** Notification ID */
2192
+ id: string;
2193
+ };
2194
+ export type PostInAppNotificationOpen200 = {
2195
+ [key: string]: unknown;
2196
+ };
2197
+ export type PostInstallerBodyRegisterForm = {
2198
+ name?: string;
2199
+ username?: string;
2200
+ email?: string;
2201
+ password?: string;
2202
+ 'app:globalLang'?: string;
2203
+ };
2204
+ export type PostInstallerBody = {
2205
+ registerForm?: PostInstallerBodyRegisterForm;
2206
+ };
2207
+ export type PostInstaller200 = {
2208
+ message?: string;
2209
+ };
2210
+ export type PostInvitedBodyInvitedForm = {
2211
+ /** The username of the invited user. */
2212
+ username?: string;
2213
+ /** The name of the invited user. */
2214
+ name?: string;
2215
+ /** The password for the invited user. */
2216
+ password?: string;
2217
+ };
2218
+ export type PostInvitedBody = {
2219
+ invitedForm?: PostInvitedBodyInvitedForm;
2220
+ };
2221
+ export type PostInvited200 = {
2222
+ /** URL to redirect after successful activation. */
2223
+ redirectTo?: string;
2224
+ };
2225
+ export type GetMarkdownSetting200 = {
2226
+ /** markdown params */
2227
+ markdownParams?: MarkdownParams;
2228
+ };
2229
+ export type PutMarkdownSettingLineBreak200 = {
2230
+ lineBreaksParams?: LineBreakParams;
2231
+ };
2232
+ export type PutMarkdownSettingIndent200 = {
2233
+ /** indent params */
2234
+ indentParams?: IndentParams;
2235
+ };
2236
+ export type GetMongoCollections200 = {
2237
+ /** whether the request is succeeded */
2238
+ ok?: boolean;
2239
+ collections?: string[];
2240
+ };
2241
+ export type GetNotificationSetting200 = {
2242
+ /** notification params */
2243
+ notificationParams?: NotificationParams;
2244
+ };
2245
+ /**
2246
+ * response params
2247
+ */
2248
+ export type PostNotificationSettingUserNotification200ResponseParams = {
2249
+ /** user who set notification */
2250
+ createdUser?: User;
2251
+ userNotifications?: UserNotification[];
2252
+ };
2253
+ export type PostNotificationSettingUserNotification200 = {
2254
+ /** response params */
2255
+ responseParams?: PostNotificationSettingUserNotification200ResponseParams;
2256
+ };
2257
+ export type GetNotificationSettingGlobalNotificationId200 = {
2258
+ globalNotification?: GlobalNotification;
2259
+ };
2260
+ export type PutNotificationSettingGlobalNotificationId200 = {
2261
+ /** notification param updated */
2262
+ createdNotification?: GlobalNotification;
2263
+ };
2264
+ export type PostNotificationSettingGlobalNotification200 = {
2265
+ /** notification param created */
2266
+ createdNotification?: GlobalNotification;
2267
+ };
2268
+ export type PutNotificationSettingGlobalNotificationIdEnabledBody = {
2269
+ /** is notification enabled */
2270
+ isEnabled?: boolean;
2271
+ };
2272
+ export type PutNotificationSettingGlobalNotificationIdEnabled200 = {
2273
+ /** notification id */
2274
+ id?: string;
2275
+ };
2276
+ export type GetPageListingRoot200 = {
2277
+ rootPage?: Page;
2278
+ };
2279
+ export type GetPageListingAncestorsChildrenParams = {
2280
+ path: string;
2281
+ };
2282
+ export type GetPageListingAncestorsChildren200AncestorsChildren = {
2283
+ [key: string]: {
2284
+ /** Document ID */
2285
+ _id?: string;
2286
+ /** Number of descendants */
2287
+ descendantCount?: number;
2288
+ /** Indicates if the node is empty */
2289
+ isEmpty?: boolean;
2290
+ /** Access level */
2291
+ grant?: number;
2292
+ /** Path string */
2293
+ path?: string;
2294
+ /**
2295
+ * Revision ID (nullable)
2296
+ * @nullable
2297
+ */
2298
+ revision?: string | null;
2299
+ };
2300
+ };
2301
+ export type GetPageListingAncestorsChildren200 = {
2302
+ ancestorsChildren?: GetPageListingAncestorsChildren200AncestorsChildren;
2303
+ };
2304
+ export type GetPageListingChildrenParams = {
2305
+ id?: string;
2306
+ path?: string;
2307
+ };
2308
+ export type GetPageListingChildren200 = {
2309
+ children?: Page[];
2310
+ };
2311
+ export type GetPageListingInfoParams = {
2312
+ pageIds?: string[];
2313
+ path?: string;
2314
+ attachBookmarkCount?: boolean;
2315
+ attachShortBody?: boolean;
2316
+ };
2317
+ export type GetPageListingInfo200IdToPageInfoMap = {
2318
+ [key: string]: {
2319
+ commentCount?: number;
2320
+ contentAge?: number;
2321
+ descendantCount?: number;
2322
+ isAbleToDeleteCompletely?: boolean;
2323
+ isDeletable?: boolean;
2324
+ isEmpty?: boolean;
2325
+ isMovable?: boolean;
2326
+ isRevertible?: boolean;
2327
+ isV5Compatible?: boolean;
2328
+ likerIds?: string[];
2329
+ seenUserIds?: string[];
2330
+ sumOfLikers?: number;
2331
+ sumOfSeenUsers?: number;
2332
+ };
2333
+ };
2334
+ export type GetPageListingInfo200 = {
2335
+ idToPageInfoMap?: GetPageListingInfo200IdToPageInfoMap;
2336
+ };
2337
+ export type GetPageParams = {
2338
+ /**
2339
+ * page id
2340
+ */
2341
+ pageId?: ObjectId;
2342
+ /**
2343
+ * page path
2344
+ */
2345
+ path?: PagePath;
2346
+ };
2347
+ export type PostPageBody = {
2348
+ /** Text of page */
2349
+ body: string;
2350
+ path: PagePath;
2351
+ grant?: PageGrant;
2352
+ /** UserGroup ID */
2353
+ grantUserGroupIds?: string;
2354
+ pageTags?: string[];
2355
+ };
2356
+ export type PostPage201Data = {
2357
+ page?: Page;
2358
+ tags?: Tags[];
2359
+ revision?: Revision;
2360
+ };
2361
+ export type PostPage201 = {
2362
+ data?: PostPage201Data;
2363
+ };
2364
+ export type PutPageBody = {
2365
+ body: RevisionBody;
2366
+ pageId: ObjectId;
2367
+ revisionId: ObjectId;
2368
+ grant?: PageGrant;
2369
+ userRelatedGrantUserGroupIds?: string[];
2370
+ /** Determine whether the scopes of descendants should be overwritten */
2371
+ overwriteScopesOfDescendants?: boolean;
2372
+ /** Determine whether the page is enabled to be posted to Slack */
2373
+ isSlackEnabled?: boolean;
2374
+ /** Slack channel IDs */
2375
+ slackChannels?: string;
2376
+ /** Origin is "view" or "editor" */
2377
+ origin?: string;
2378
+ /** Determine whether the page is WIP */
2379
+ wip?: boolean;
2380
+ };
2381
+ export type PutPage200Data = {
2382
+ page?: Page;
2383
+ revision?: Revision;
2384
+ };
2385
+ export type PutPage200 = {
2386
+ data?: PutPage200Data;
2387
+ };
2388
+ export type GetPageExistParams = {
2389
+ /**
2390
+ * The path to check for existence
2391
+ */
2392
+ path: string;
2393
+ };
2394
+ export type GetPageExist200 = {
2395
+ isExist?: boolean;
2396
+ };
2397
+ export type GetPageGrantDataParams = {
2398
+ /**
2399
+ * page id
2400
+ */
2401
+ pageId?: ObjectId;
2402
+ };
2403
+ export type GetPageGrantData200 = {
2404
+ isGrantNormalized?: boolean;
2405
+ };
2406
+ export type GetPageNonUserRelatedGroupsGrantedParams = {
2407
+ /**
2408
+ * Path of the page
2409
+ */
2410
+ path: string;
2411
+ };
2412
+ export type GetPageNonUserRelatedGroupsGranted200 = {
2413
+ isNonUserRelatedGroupsGranted?: boolean;
2414
+ };
2415
+ export type GetPageApplicableGrantParams = {
2416
+ /**
2417
+ * ID of the page
2418
+ */
2419
+ pageId: string;
2420
+ };
2421
+ export type GetPageApplicableGrant200 = {
2422
+ grant?: number;
2423
+ grantedUsers?: string[];
2424
+ grantedGroups?: string[];
2425
+ };
2426
+ export type PutPageIdGrantBody = {
2427
+ /** Grant level */
2428
+ grant?: number;
2429
+ /** Array of user-related granted group IDs */
2430
+ userRelatedGrantedGroups?: string[];
2431
+ };
2432
+ export type GetPageExistPathsParams = {
2433
+ /**
2434
+ * old parent path
2435
+ */
2436
+ fromPath?: string;
2437
+ /**
2438
+ * new parent path
2439
+ */
2440
+ toPath?: string;
2441
+ };
2442
+ /**
2443
+ * Paths are already exist in DB
2444
+ */
2445
+ export type GetPageExistPaths200ExistPaths = {
2446
+ [key: string]: unknown;
2447
+ };
2448
+ export type GetPageExistPaths200 = {
2449
+ /** Paths are already exist in DB */
2450
+ existPaths?: GetPageExistPaths200ExistPaths;
2451
+ };
2452
+ export type PutPageSubscribeBody = {
2453
+ pageId?: ObjectId;
2454
+ };
2455
+ export type PutPageIdContentWidthBody = {
2456
+ /** Whether to expand the content width */
2457
+ expandContentWidth?: boolean;
2458
+ };
2459
+ export type PutPageIdContentWidth200 = {
2460
+ page?: Page;
2461
+ };
2462
+ /**
2463
+ * Yjs data
2464
+ */
2465
+ export type GetPageIdYjsData200YjsData = {
2466
+ /** Whether Yjs documents are newer than the latest revision */
2467
+ hasYdocsNewerThanLatestRevision?: boolean;
2468
+ /** Size of the awareness state */
2469
+ awarenessStateSize?: number;
2470
+ };
2471
+ export type GetPageIdYjsData200 = {
2472
+ /** Yjs data */
2473
+ yjsData?: GetPageIdYjsData200YjsData;
2474
+ };
2475
+ export type PutPageIdSyncLatestRevisionBodyToYjsDraftBody = {
2476
+ /** Length of the editing markdown */
2477
+ editingMarkdownLength?: number;
2478
+ };
2479
+ export type PutPageIdSyncLatestRevisionBodyToYjsDraft200 = {
2480
+ /** Whether the latest revision body is synced to the Yjs draft */
2481
+ synced?: boolean;
2482
+ /** Whether Yjs data is broken */
2483
+ isYjsDataBroken?: boolean;
2484
+ };
2485
+ export type GetPagesRecentParams = {
2486
+ /**
2487
+ * Limit of acquisitions
2488
+ */
2489
+ limit?: number;
2490
+ /**
2491
+ * Offset of acquisitions
2492
+ */
2493
+ offset?: number;
2494
+ /**
2495
+ * Whether to include WIP pages
2496
+ */
2497
+ includeWipPage?: string;
2498
+ };
2499
+ export type PostPagesRenameBody = {
2500
+ pageId: ObjectId;
2501
+ path?: PagePath;
2502
+ /** revision ID */
2503
+ revisionId: string;
2504
+ /** new path */
2505
+ newPagePath?: string;
2506
+ /** whether redirect page */
2507
+ isRenameRedirect?: boolean;
2508
+ /** whether update meta data */
2509
+ updateMetadata?: boolean;
2510
+ /** whether rename page with descendants */
2511
+ isRecursively?: boolean;
2512
+ };
2513
+ export type PostPagesRename200 = {
2514
+ page?: Page;
2515
+ };
2516
+ export type PostPagesResumeRenameBody = {
2517
+ pageId: ObjectId;
2518
+ };
2519
+ export type PostPagesResumeRename200 = {
2520
+ [key: string]: unknown;
2521
+ };
2522
+ export type DeletePagesEmptyTrash200 = {
2523
+ deletablePages?: Page[];
2524
+ };
2525
+ export type GetPagesListParams = {
2526
+ /**
2527
+ * Path to search
2528
+ */
2529
+ path?: string;
2530
+ /**
2531
+ * Limit of acquisitions
2532
+ */
2533
+ limit?: number;
2534
+ /**
2535
+ * Page number
2536
+ */
2537
+ page?: number;
2538
+ };
2539
+ export type GetPagesList200PagesItemAllOf = {
2540
+ lastUpdateUser?: User;
2541
+ };
2542
+ export type GetPagesList200PagesItem = Page & GetPagesList200PagesItemAllOf;
2543
+ export type GetPagesList200 = {
2544
+ /** Total count of pages */
2545
+ totalCount?: number;
2546
+ /** Offset of pages */
2547
+ offset?: number;
2548
+ /** Limit of pages */
2549
+ limit?: number;
2550
+ pages?: GetPagesList200PagesItem[];
2551
+ };
2552
+ export type PostPagesDuplicateBody = {
2553
+ pageId: ObjectId;
2554
+ pageNameInput?: PagePath;
2555
+ /** whether duplicate page with descendants */
2556
+ isRecursively?: boolean;
2557
+ /** whether duplicate only user related resources */
2558
+ onlyDuplicateUserRelatedResources?: boolean;
2559
+ };
2560
+ export type PostPagesDuplicate200 = {
2561
+ page?: Page;
2562
+ };
2563
+ export type GetPagesSubordinatedListParams = {
2564
+ /**
2565
+ * Parent path of search
2566
+ */
2567
+ path?: string;
2568
+ /**
2569
+ * Limit of acquisitions
2570
+ */
2571
+ limit?: number;
2572
+ };
2573
+ export type GetPagesSubordinatedList200 = {
2574
+ subordinatedPages?: Page[];
2575
+ };
2576
+ /**
2577
+ * Map of page IDs to revision IDs
2578
+ */
2579
+ export type PostPagesDeleteBodyPageIdToRevisionIdMap = {
2580
+ [key: string]: unknown;
2581
+ };
2582
+ export type PostPagesDeleteBody = {
2583
+ /** Map of page IDs to revision IDs */
2584
+ pageIdToRevisionIdMap?: PostPagesDeleteBodyPageIdToRevisionIdMap;
2585
+ /** Whether to delete pages completely */
2586
+ isCompletely?: boolean;
2587
+ /** Whether to delete pages recursively */
2588
+ isRecursively?: boolean;
2589
+ /** Whether the page is restricted to anyone with the link */
2590
+ isAnyoneWithTheLink?: boolean;
2591
+ };
2592
+ export type PostPagesDelete200 = {
2593
+ /** List of deleted page paths */
2594
+ paths?: string[];
2595
+ /** Whether pages were deleted recursively */
2596
+ isRecursively?: boolean;
2597
+ /** Whether pages were deleted completely */
2598
+ isCompletely?: boolean;
2599
+ };
2600
+ export type PostPagesConvertPagesByPathBody = {
2601
+ /** Path to convert */
2602
+ convertPath?: string;
2603
+ };
2604
+ /**
2605
+ * Empty object
2606
+ */
2607
+ export type PostPagesConvertPagesByPath200 = {
2608
+ [key: string]: unknown;
2609
+ };
2610
+ export type PostPagesLegacyPagesMigrationBody = {
2611
+ /** List of page IDs to migrate */
2612
+ pageIds?: string[];
2613
+ /** Whether to migrate pages recursively */
2614
+ isRecursively?: boolean;
2615
+ };
2616
+ /**
2617
+ * Empty object
2618
+ */
2619
+ export type PostPagesLegacyPagesMigration200 = {
2620
+ [key: string]: unknown;
2621
+ };
2622
+ export type GetPagesV5MigrationStatus200 = {
2623
+ /** Whether the app is V5 compatible */
2624
+ isV5Compatible?: boolean;
2625
+ /** Number of pages that can be migrated */
2626
+ migratablePagesCount?: number;
2627
+ };
2628
+ /**
2629
+ * personal params
2630
+ */
2631
+ export type GetPersonalSetting200CurrentUser = {
2632
+ [key: string]: unknown;
2633
+ };
2634
+ export type GetPersonalSetting200 = {
2635
+ /** personal params */
2636
+ currentUser?: GetPersonalSetting200CurrentUser;
2637
+ };
2638
+ /**
2639
+ * personal params
2640
+ */
2641
+ export type PutPersonalSetting200UpdatedUser = {
2642
+ [key: string]: unknown;
2643
+ };
2644
+ export type PutPersonalSetting200 = {
2645
+ /** personal params */
2646
+ updatedUser?: PutPersonalSetting200UpdatedUser;
2647
+ };
2648
+ export type GetPersonalSettingIsPasswordSet200 = {
2649
+ /** Whether a password has been set */
2650
+ isPasswordSet?: boolean;
2651
+ /** Minimum password length */
2652
+ minPasswordLength?: number;
2653
+ };
2654
+ export type PutPersonalSettingImageTypeBody = {
2655
+ isGravatarEnabled?: boolean;
2656
+ };
2657
+ /**
2658
+ * user data
2659
+ */
2660
+ export type PutPersonalSettingImageType200UserData = {
2661
+ [key: string]: unknown;
2662
+ };
2663
+ export type PutPersonalSettingImageType200 = {
2664
+ /** user data */
2665
+ userData?: PutPersonalSettingImageType200UserData;
2666
+ };
2667
+ /**
2668
+ * array of external accounts
2669
+ */
2670
+ export type GetPersonalSettingExternalAccounts200ExternalAccounts = {
2671
+ [key: string]: unknown;
2672
+ };
2673
+ export type GetPersonalSettingExternalAccounts200 = {
2674
+ /** array of external accounts */
2675
+ externalAccounts?: GetPersonalSettingExternalAccounts200ExternalAccounts;
2676
+ };
2677
+ export type PutPersonalSettingPasswordBody = {
2678
+ oldPassword?: string;
2679
+ newPassword?: string;
2680
+ };
2681
+ /**
2682
+ * user data updated
2683
+ */
2684
+ export type PutPersonalSettingPassword200UserData = {
2685
+ [key: string]: unknown;
2686
+ };
2687
+ export type PutPersonalSettingPassword200 = {
2688
+ /** user data updated */
2689
+ userData?: PutPersonalSettingPassword200UserData;
2690
+ };
2691
+ /**
2692
+ * user data
2693
+ */
2694
+ export type PutPersonalSettingApiToken200UserData = {
2695
+ [key: string]: unknown;
2696
+ };
2697
+ export type PutPersonalSettingApiToken200 = {
2698
+ /** user data */
2699
+ userData?: PutPersonalSettingApiToken200UserData;
2700
+ };
2701
+ export type PutPersonalSettingAssociateLdapBody = {
2702
+ username?: string;
2703
+ };
2704
+ /**
2705
+ * Ldap account associate to me
2706
+ */
2707
+ export type PutPersonalSettingAssociateLdap200AssociateUser = {
2708
+ [key: string]: unknown;
2709
+ };
2710
+ export type PutPersonalSettingAssociateLdap200 = {
2711
+ /** Ldap account associate to me */
2712
+ associateUser?: PutPersonalSettingAssociateLdap200AssociateUser;
2713
+ };
2714
+ /**
2715
+ * Ldap account disassociate to me
2716
+ */
2717
+ export type PutPersonalSettingDisassociateLdap200DisassociateUser = {
2718
+ [key: string]: unknown;
2719
+ };
2720
+ export type PutPersonalSettingDisassociateLdap200 = {
2721
+ /** Ldap account disassociate to me */
2722
+ disassociateUser?: PutPersonalSettingDisassociateLdap200DisassociateUser;
2723
+ };
2724
+ export type PutPersonalSettingEditorSettingsBody = {
2725
+ theme?: string;
2726
+ keymapMode?: string;
2727
+ styleActiveLine?: boolean;
2728
+ autoFormatMarkdownTable?: boolean;
2729
+ };
2730
+ /**
2731
+ * editor settings
2732
+ */
2733
+ export type PutPersonalSettingEditorSettings200 = {
2734
+ [key: string]: unknown;
2735
+ };
2736
+ /**
2737
+ * editor settings
2738
+ */
2739
+ export type GetPersonalSettingEditorSettings200 = {
2740
+ [key: string]: unknown;
2741
+ };
2742
+ export type PutPersonalSettingInAppNotificationSettingsBodySubscribeRulesItem = {
2743
+ name?: string;
2744
+ isEnabled?: boolean;
2745
+ };
2746
+ export type PutPersonalSettingInAppNotificationSettingsBody = {
2747
+ subscribeRules?: PutPersonalSettingInAppNotificationSettingsBodySubscribeRulesItem[];
2748
+ };
2749
+ export type PutPersonalSettingInAppNotificationSettings200 = {
2750
+ [key: string]: unknown;
2751
+ };
2752
+ /**
2753
+ * InAppNotificationSettings
2754
+ */
2755
+ export type GetPersonalSettingInAppNotificationSettings200CurrentUser = {
2756
+ [key: string]: unknown;
2757
+ };
2758
+ export type GetPersonalSettingInAppNotificationSettings200 = {
2759
+ /** InAppNotificationSettings */
2760
+ currentUser?: GetPersonalSettingInAppNotificationSettings200CurrentUser;
2761
+ };
2762
+ export type PutPersonalSettingQuestionnaireSettingsBody = {
2763
+ isQuestionnaireEnabled?: boolean;
2764
+ };
2765
+ export type PutPersonalSettingQuestionnaireSettings200 = {
2766
+ message?: string;
2767
+ isQuestionnaireEnabled?: boolean;
2768
+ };
2769
+ export type GetRevisionsListParams = {
2770
+ pageId?: string;
2771
+ /**
2772
+ * selected page number
2773
+ */
2774
+ page?: number;
2775
+ /**
2776
+ * page item limit
2777
+ */
2778
+ limit?: number;
2779
+ };
2780
+ export type GetRevisionsList200 = {
2781
+ revisions?: Revision[];
2782
+ /** total count of revisions */
2783
+ totalCount?: number;
2784
+ /** offset of the revisions */
2785
+ offset?: number;
2786
+ };
2787
+ export type GetRevisionsIdParams = {
2788
+ /**
2789
+ * page id
2790
+ */
2791
+ pageId: string;
2792
+ };
2793
+ export type GetRevisionsId200 = {
2794
+ revision?: Revision;
2795
+ };
2796
+ export type GetSearchIndices200 = {
2797
+ /** Status of indices */
2798
+ info?: Indices;
2799
+ };
2800
+ /**
2801
+ * Operation type against to indices > * `normalize` - Normalize indices * `rebuild` - Rebuild indices
2802
+ */
2803
+ export type PutSearchIndicesBodyOperation = (typeof PutSearchIndicesBodyOperation)[keyof typeof PutSearchIndicesBodyOperation];
2804
+ export declare const PutSearchIndicesBodyOperation: {
2805
+ readonly normalize: "normalize";
2806
+ readonly rebuild: "rebuild";
2807
+ };
2808
+ export type PutSearchIndicesBody = {
2809
+ /** Operation type against to indices > * `normalize` - Normalize indices * `rebuild` - Rebuild indices */
2810
+ operation?: PutSearchIndicesBodyOperation;
2811
+ };
2812
+ export type PutSearchIndices200 = {
2813
+ /** Operation is successfully processed, or requested */
2814
+ message?: string;
2815
+ };
2816
+ /**
2817
+ * security params
2818
+ */
2819
+ export type GetSecuritySetting200SecurityParams = {
2820
+ generalSetting?: GeneralSetting;
2821
+ shareLinkSetting?: ShareLinkSetting;
2822
+ localSetting?: LocalSetting;
2823
+ generalAuth?: GeneralAuthSetting;
2824
+ ldapAuth?: LdapAuthSetting;
2825
+ samlAuth?: SamlAuthSetting;
2826
+ oidcAuth?: OidcAuthSetting;
2827
+ googleOAuth?: GoogleOAuthSetting;
2828
+ githubOAuth?: GitHubOAuthSetting;
2829
+ };
2830
+ export type GetSecuritySetting200 = {
2831
+ /** security params */
2832
+ securityParams?: GetSecuritySetting200SecurityParams;
2833
+ };
2834
+ export type PutSecuritySettingAuthenticationEnabledBody = {
2835
+ isEnabled?: boolean;
2836
+ authId?: string;
2837
+ };
2838
+ /**
2839
+ * updated param
2840
+ */
2841
+ export type PutSecuritySettingAuthenticationEnabled200 = {
2842
+ [key: string]: unknown;
2843
+ };
2844
+ export type GetSecuritySettingAuthentication200 = {
2845
+ /** setup strategies list */
2846
+ setupStrategies?: string[];
2847
+ };
2848
+ export type PutSecuritySettingShareLinkSetting200 = {
2849
+ securitySettingParams?: ShareLinkSetting;
2850
+ };
2851
+ /**
2852
+ * suceed to get all share links
2853
+ */
2854
+ export type GetSecuritySettingAllShareLinks200SecurityParams = {
2855
+ [key: string]: unknown;
2856
+ };
2857
+ export type GetSecuritySettingAllShareLinks200 = {
2858
+ /** suceed to get all share links */
2859
+ securityParams?: GetSecuritySettingAllShareLinks200SecurityParams;
2860
+ };
2861
+ export type DeleteSecuritySettingAllShareLinks200 = {
2862
+ /** total number of removed share links */
2863
+ removeTotal?: number;
2864
+ };
2865
+ export type PutSecuritySettingLocalSetting200 = {
2866
+ localSettingParams?: LocalSetting;
2867
+ };
2868
+ export type PutSecuritySettingLdap200 = {
2869
+ securitySettingParams?: LdapAuthSetting;
2870
+ };
2871
+ export type PutSecuritySettingSaml200 = {
2872
+ securitySettingParams?: SamlAuthSetting;
2873
+ };
2874
+ export type PutSecuritySettingOidc200 = {
2875
+ securitySettingParams?: OidcAuthSetting;
2876
+ };
2877
+ export type PutSecuritySettingGoogleOauth200 = {
2878
+ securitySettingParams?: GoogleOAuthSetting;
2879
+ };
2880
+ export type PutSecuritySettingGithubOauth200 = {
2881
+ securitySettingParams?: GitHubOAuthSetting;
2882
+ };
2883
+ export type GetShareLinksParams = {
2884
+ /**
2885
+ * page id of share link
2886
+ */
2887
+ relatedPage: string;
2888
+ };
2889
+ export type GetShareLinks200 = {
2890
+ shareLinksResult?: ShareLink[];
2891
+ };
2892
+ export type PostShareLinksParams = {
2893
+ /**
2894
+ * page id of share link
2895
+ */
2896
+ relatedPage: string;
2897
+ /**
2898
+ * expiration date of share link
2899
+ */
2900
+ expiredAt?: string;
2901
+ /**
2902
+ * description of share link
2903
+ */
2904
+ description?: string;
2905
+ };
2906
+ export type DeleteShareLinksParams = {
2907
+ /**
2908
+ * page id of share link
2909
+ */
2910
+ relatedPage: string;
2911
+ };
2912
+ export type DeleteShareLinksAll200 = {
2913
+ /** The number of share links deleted */
2914
+ deletedCount?: number;
2915
+ };
2916
+ export type GetSlackIntegrationLegacySetting200SlackIntegrationParamsAllOf = {
2917
+ /** whether slackbot is configured */
2918
+ isSlackbotConfigured?: boolean;
2919
+ };
2920
+ export type GetSlackIntegrationLegacySetting200SlackIntegrationParams = SlackConfigurationParams & GetSlackIntegrationLegacySetting200SlackIntegrationParamsAllOf;
2921
+ export type GetSlackIntegrationLegacySetting200 = {
2922
+ slackIntegrationParams?: GetSlackIntegrationLegacySetting200SlackIntegrationParams;
2923
+ };
2924
+ export type PutSlackIntegrationLegacySettingBody = {
2925
+ /** incoming webhooks url */
2926
+ webhookUrl?: string;
2927
+ /** use incoming webhooks even if Slack App settings are enabled */
2928
+ isIncomingWebhookPrioritized?: boolean;
2929
+ /** OAuth access token */
2930
+ slackToken?: string;
2931
+ };
2932
+ export type PutSlackIntegrationLegacySetting200 = {
2933
+ responseParams?: SlackConfigurationParams;
2934
+ };
2935
+ export type GetSlackIntegrationSettings200SettingsCommandPermission = {
2936
+ [key: string]: unknown;
2937
+ };
2938
+ export type GetSlackIntegrationSettings200SettingsEventActionsPermission = {
2939
+ [key: string]: unknown;
2940
+ };
2941
+ export type GetSlackIntegrationSettings200Settings = {
2942
+ slackSigningSecretEnvVars?: string;
2943
+ slackBotTokenEnvVars?: string;
2944
+ slackSigningSecret?: string;
2945
+ slackBotToken?: string;
2946
+ commandPermission?: GetSlackIntegrationSettings200SettingsCommandPermission;
2947
+ eventActionsPermission?: GetSlackIntegrationSettings200SettingsEventActionsPermission;
2948
+ proxyServerUri?: string;
2949
+ };
2950
+ export type GetSlackIntegrationSettings200ConnectionStatuses = {
2951
+ [key: string]: unknown;
2952
+ };
2953
+ export type GetSlackIntegrationSettings200 = {
2954
+ currentBotType?: string;
2955
+ settings?: GetSlackIntegrationSettings200Settings;
2956
+ connectionStatuses?: GetSlackIntegrationSettings200ConnectionStatuses;
2957
+ errorMsg?: string;
2958
+ errorCode?: string;
2959
+ };
2960
+ export type PutSlackIntegrationSettingsWithoutProxyUpdateSettingsBody = {
2961
+ slackSigningSecret?: string;
2962
+ slackBotToken?: string;
2963
+ };
2964
+ export type PutSlackIntegrationSettingsWithoutProxyUpdatePermissionsBodyCommandPermission = {
2965
+ [key: string]: unknown;
2966
+ };
2967
+ export type PutSlackIntegrationSettingsWithoutProxyUpdatePermissionsBodyEventActionsPermission = {
2968
+ [key: string]: unknown;
2969
+ };
2970
+ export type PutSlackIntegrationSettingsWithoutProxyUpdatePermissionsBody = {
2971
+ commandPermission?: PutSlackIntegrationSettingsWithoutProxyUpdatePermissionsBodyCommandPermission;
2972
+ eventActionsPermission?: PutSlackIntegrationSettingsWithoutProxyUpdatePermissionsBodyEventActionsPermission;
2973
+ };
2974
+ export type PostSlackIntegrationSettingsSlackAppIntegrations200PermissionsForBroadcastUseCommands = {
2975
+ [key: string]: unknown;
2976
+ };
2977
+ export type PostSlackIntegrationSettingsSlackAppIntegrations200PermissionsForSingleUseCommands = {
2978
+ [key: string]: unknown;
2979
+ };
2980
+ export type PostSlackIntegrationSettingsSlackAppIntegrations200PermissionsForSlackEvents = {
2981
+ [key: string]: unknown;
2982
+ };
2983
+ export type PostSlackIntegrationSettingsSlackAppIntegrations200 = {
2984
+ tokenGtoP?: string;
2985
+ tokenPtoG?: string;
2986
+ permissionsForBroadcastUseCommands?: PostSlackIntegrationSettingsSlackAppIntegrations200PermissionsForBroadcastUseCommands;
2987
+ permissionsForSingleUseCommands?: PostSlackIntegrationSettingsSlackAppIntegrations200PermissionsForSingleUseCommands;
2988
+ permissionsForSlackEvents?: PostSlackIntegrationSettingsSlackAppIntegrations200PermissionsForSlackEvents;
2989
+ isPrimary?: boolean;
2990
+ };
2991
+ export type DeleteSlackIntegrationSettingsSlackAppIntegrationsId200Response = {
2992
+ [key: string]: unknown;
2993
+ };
2994
+ export type DeleteSlackIntegrationSettingsSlackAppIntegrationsId200 = {
2995
+ response?: DeleteSlackIntegrationSettingsSlackAppIntegrationsId200Response;
2996
+ };
2997
+ export type PutSlackIntegrationSettingsProxyUriBody = {
2998
+ proxyUri?: string;
2999
+ };
3000
+ export type PutSlackIntegrationSettingsProxyUri200 = {
3001
+ [key: string]: unknown;
3002
+ };
3003
+ export type PutSlackIntegrationSettingsSlackAppIntegrationsIdRegenerateTokens200 = {
3004
+ [key: string]: unknown;
3005
+ };
3006
+ export type PutSlackIntegrationSettingsSlackAppIntegrationsIdPermissionsBodyPermissionsForBroadcastUseCommands = {
3007
+ [key: string]: unknown;
3008
+ };
3009
+ export type PutSlackIntegrationSettingsSlackAppIntegrationsIdPermissionsBodyPermissionsForSingleUseCommands = {
3010
+ [key: string]: unknown;
3011
+ };
3012
+ export type PutSlackIntegrationSettingsSlackAppIntegrationsIdPermissionsBodyPermissionsForSlackEventActions = {
3013
+ [key: string]: unknown;
3014
+ };
3015
+ export type PutSlackIntegrationSettingsSlackAppIntegrationsIdPermissionsBody = {
3016
+ permissionsForBroadcastUseCommands?: PutSlackIntegrationSettingsSlackAppIntegrationsIdPermissionsBodyPermissionsForBroadcastUseCommands;
3017
+ permissionsForSingleUseCommands?: PutSlackIntegrationSettingsSlackAppIntegrationsIdPermissionsBodyPermissionsForSingleUseCommands;
3018
+ permissionsForSlackEventActions?: PutSlackIntegrationSettingsSlackAppIntegrationsIdPermissionsBodyPermissionsForSlackEventActions;
3019
+ };
3020
+ export type PutSlackIntegrationSettingsSlackAppIntegrationsIdPermissions200 = {
3021
+ [key: string]: unknown;
3022
+ };
3023
+ export type PostSlackIntegrationSettingsSlackAppIntegrationsIdRelationTestBody = {
3024
+ channel?: string;
3025
+ };
3026
+ export type PostSlackIntegrationSettingsWithoutProxyTestBody = {
3027
+ channel?: string;
3028
+ };
3029
+ export type PostSlackIntegrationCommandsBody = {
3030
+ [key: string]: unknown;
3031
+ };
3032
+ export type PostSlackIntegrationProxiedVerifyBody = {
3033
+ type?: string;
3034
+ challenge?: string;
3035
+ };
3036
+ export type PostSlackIntegrationProxiedVerify200 = {
3037
+ challenge?: string;
3038
+ };
3039
+ export type PostSlackIntegrationProxiedCommandsBody = {
3040
+ [key: string]: unknown;
3041
+ };
3042
+ export type PostSlackIntegrationInteractionsBody = {
3043
+ [key: string]: unknown;
3044
+ };
3045
+ export type PostSlackIntegrationProxiedInteractionsBody = {
3046
+ [key: string]: unknown;
3047
+ };
3048
+ export type GetSlackIntegrationSupportedCommands200PermissionsForBroadcastUseCommandsItem = {
3049
+ [key: string]: unknown;
3050
+ };
3051
+ export type GetSlackIntegrationSupportedCommands200PermissionsForSingleUseCommandsItem = {
3052
+ [key: string]: unknown;
3053
+ };
3054
+ export type GetSlackIntegrationSupportedCommands200 = {
3055
+ permissionsForBroadcastUseCommands?: GetSlackIntegrationSupportedCommands200PermissionsForBroadcastUseCommandsItem[];
3056
+ permissionsForSingleUseCommands?: GetSlackIntegrationSupportedCommands200PermissionsForSingleUseCommandsItem[];
3057
+ };
3058
+ export type PostSlackIntegrationEventsBodyEvent = {
3059
+ [key: string]: unknown;
3060
+ };
3061
+ export type PostSlackIntegrationEventsBody = {
3062
+ event?: PostSlackIntegrationEventsBodyEvent;
3063
+ };
3064
+ export type PostSlackIntegrationEvents200 = {
3065
+ [key: string]: unknown;
3066
+ };
3067
+ export type PostSlackIntegrationProxiedEventsBodyGrowiBotEvent = {
3068
+ [key: string]: unknown;
3069
+ };
3070
+ export type PostSlackIntegrationProxiedEventsBodyData = {
3071
+ [key: string]: unknown;
3072
+ };
3073
+ export type PostSlackIntegrationProxiedEventsBody = {
3074
+ growiBotEvent?: PostSlackIntegrationProxiedEventsBodyGrowiBotEvent;
3075
+ data?: PostSlackIntegrationProxiedEventsBodyData;
3076
+ };
3077
+ export type PostSlackIntegrationProxiedEvents200 = {
3078
+ [key: string]: unknown;
3079
+ };
3080
+ export type PostCompleteRegistrationBodyRegisterForm = {
3081
+ username?: string;
3082
+ name?: string;
3083
+ password?: string;
3084
+ token?: string;
3085
+ email?: string;
3086
+ };
3087
+ export type PostCompleteRegistrationBody = {
3088
+ registerForm?: PostCompleteRegistrationBodyRegisterForm;
3089
+ };
3090
+ export type PostCompleteRegistration200 = {
3091
+ redirectTo?: string;
3092
+ };
3093
+ export type GetUserGroupRelations200UserGroupRelationsUserGroupRelationsItem = {
3094
+ [key: string]: unknown;
3095
+ };
3096
+ export type GetUserGroupRelations200UserGroupRelationsRelationsOfChildGroupsItem = {
3097
+ [key: string]: unknown;
3098
+ };
3099
+ /**
3100
+ * contains arrays user objects related
3101
+ */
3102
+ export type GetUserGroupRelations200UserGroupRelations = {
3103
+ userGroupRelations?: GetUserGroupRelations200UserGroupRelationsUserGroupRelationsItem[];
3104
+ relationsOfChildGroups?: GetUserGroupRelations200UserGroupRelationsRelationsOfChildGroupsItem[];
3105
+ };
3106
+ export type GetUserGroupRelations200 = {
3107
+ /** contains arrays user objects related */
3108
+ userGroupRelations?: GetUserGroupRelations200UserGroupRelations;
3109
+ };
3110
+ export type GetUserGroupsParams = {
3111
+ /**
3112
+ * page number
3113
+ */
3114
+ page?: number;
3115
+ /**
3116
+ * number of items per page
3117
+ */
3118
+ limit?: number;
3119
+ /**
3120
+ * offset
3121
+ */
3122
+ offset?: number;
3123
+ /**
3124
+ * whether to paginate
3125
+ */
3126
+ pagination?: boolean;
3127
+ };
3128
+ /**
3129
+ * a result of `UserGroup.find`
3130
+ */
3131
+ export type GetUserGroups200UserGroups = {
3132
+ [key: string]: unknown;
3133
+ };
3134
+ export type GetUserGroups200 = {
3135
+ /** a result of `UserGroup.find` */
3136
+ userGroups?: GetUserGroups200UserGroups;
3137
+ /** the number of userGroups */
3138
+ totalUserGroups?: number;
3139
+ /** the number of items per page */
3140
+ pagingLimit?: number;
3141
+ };
3142
+ export type PostUserGroupsBody = {
3143
+ /** name of the userGroup trying to be added */
3144
+ name?: string;
3145
+ /** description of the userGroup trying to be added */
3146
+ description?: string;
3147
+ /** parentId of the userGroup trying to be added */
3148
+ parentId?: string;
3149
+ };
3150
+ /**
3151
+ * A result of `UserGroup.createGroupByName`
3152
+ */
3153
+ export type PostUserGroups200UserGroup = {
3154
+ [key: string]: unknown;
3155
+ };
3156
+ export type PostUserGroups200 = {
3157
+ /** A result of `UserGroup.createGroupByName` */
3158
+ userGroup?: PostUserGroups200UserGroup;
3159
+ };
3160
+ export type GetUserGroupsAncestorsParams = {
3161
+ /**
3162
+ * id of userGroup
3163
+ */
3164
+ groupId: string;
3165
+ };
3166
+ export type GetUserGroupsAncestors200AncestorUserGroupsItem = {
3167
+ [key: string]: unknown;
3168
+ };
3169
+ export type GetUserGroupsAncestors200 = {
3170
+ /** userGroup objects */
3171
+ ancestorUserGroups?: GetUserGroupsAncestors200AncestorUserGroupsItem[];
3172
+ };
3173
+ export type GetUserGroupsChildrenParams = {
3174
+ /**
3175
+ * IDs of parent user groups
3176
+ */
3177
+ parentIds?: string[];
3178
+ /**
3179
+ * Whether to include grandchild user groups
3180
+ */
3181
+ includeGrandChildren?: boolean;
3182
+ };
3183
+ export type GetUserGroupsChildren200ChildUserGroupsItem = {
3184
+ [key: string]: unknown;
3185
+ };
3186
+ export type GetUserGroupsChildren200GrandChildUserGroupsItem = {
3187
+ [key: string]: unknown;
3188
+ };
3189
+ export type GetUserGroupsChildren200 = {
3190
+ /** Child user group objects */
3191
+ childUserGroups?: GetUserGroupsChildren200ChildUserGroupsItem[];
3192
+ /** Grandchild user group objects */
3193
+ grandChildUserGroups?: GetUserGroupsChildren200GrandChildUserGroupsItem[];
3194
+ };
3195
+ export type GetSelectableParentGroupsParams = {
3196
+ /**
3197
+ * id of userGroup
3198
+ */
3199
+ groupId: string;
3200
+ };
3201
+ export type GetSelectableParentGroups200SelectableParentGroupsItem = {
3202
+ [key: string]: unknown;
3203
+ };
3204
+ export type GetSelectableParentGroups200 = {
3205
+ /** userGroup objects */
3206
+ selectableParentGroups?: GetSelectableParentGroups200SelectableParentGroupsItem[];
3207
+ };
3208
+ export type GetSelectableChildGroupsParams = {
3209
+ /**
3210
+ * id of userGroup
3211
+ */
3212
+ groupId: string;
3213
+ };
3214
+ export type GetSelectableChildGroups200SelectableChildGroupsItem = {
3215
+ [key: string]: unknown;
3216
+ };
3217
+ export type GetSelectableChildGroups200 = {
3218
+ /** userGroup objects */
3219
+ selectableChildGroups?: GetSelectableChildGroups200SelectableChildGroupsItem[];
3220
+ };
3221
+ /**
3222
+ * userGroup object
3223
+ */
3224
+ export type GetUserGroupsId200UserGroup = {
3225
+ [key: string]: unknown;
3226
+ };
3227
+ export type GetUserGroupsId200 = {
3228
+ /** userGroup object */
3229
+ userGroup?: GetUserGroupsId200UserGroup;
3230
+ };
3231
+ export type DeleteUserGroupsIdParams = {
3232
+ /**
3233
+ * name of action
3234
+ */
3235
+ actionName?: string;
3236
+ /**
3237
+ * userGroup id that will be transferred to
3238
+ */
3239
+ transferToUserGroupId?: string;
3240
+ /**
3241
+ * userGroup type that will be transferred to
3242
+ */
3243
+ transferToUserGroupType?: string;
3244
+ };
3245
+ /**
3246
+ * A result of `UserGroup.removeCompletelyById`
3247
+ */
3248
+ export type DeleteUserGroupsId200UserGroups = {
3249
+ [key: string]: unknown;
3250
+ };
3251
+ export type DeleteUserGroupsId200 = {
3252
+ /** A result of `UserGroup.removeCompletelyById` */
3253
+ userGroups?: DeleteUserGroupsId200UserGroups;
3254
+ };
3255
+ export type PutUserGroupsIdBody = {
3256
+ /** name of the userGroup trying to be updated */
3257
+ name?: string;
3258
+ /** description of the userGroup trying to be updated */
3259
+ description?: string;
3260
+ /** parentId of the userGroup trying to be updated */
3261
+ parentId?: string;
3262
+ /** whether to update parent groups */
3263
+ forceUpdateParents?: boolean;
3264
+ };
3265
+ /**
3266
+ * A result of `UserGroup.updateName`
3267
+ */
3268
+ export type PutUserGroupsId200UserGroup = {
3269
+ [key: string]: unknown;
3270
+ };
3271
+ export type PutUserGroupsId200 = {
3272
+ /** A result of `UserGroup.updateName` */
3273
+ userGroup?: PutUserGroupsId200UserGroup;
3274
+ };
3275
+ export type GetUserGroupsIdUsers200 = {
3276
+ /** user objects */
3277
+ users?: User[];
3278
+ };
3279
+ export type GetUserGroupsIdUnrelatedUsersParams = {
3280
+ /**
3281
+ * search word
3282
+ */
3283
+ searchWord?: string;
3284
+ /**
3285
+ * search type
3286
+ */
3287
+ searchType?: string;
3288
+ /**
3289
+ * whether name is also searched
3290
+ */
3291
+ isAlsoNameSearched?: boolean;
3292
+ /**
3293
+ * whether mail is also searched
3294
+ */
3295
+ isAlsoMailSearched?: boolean;
3296
+ };
3297
+ export type GetUserGroupsIdUnrelatedUsers200 = {
3298
+ /** user objects */
3299
+ users?: User[];
3300
+ };
3301
+ export type PostUserGroupsIdUsersUsername200 = {
3302
+ /** the user added to the group */
3303
+ user?: User;
3304
+ /** the number of relations created */
3305
+ createdRelationCount?: number;
3306
+ };
3307
+ export type DeleteUserGroupsIdUsersUsername200 = {
3308
+ /** the user removed from the group */
3309
+ user?: User;
3310
+ /** the number of groups from which the user was removed */
3311
+ deletedGroupsCount?: number;
3312
+ };
3313
+ export type GetUserGroupsIdUserGroupRelations200UserGroupRelationsItem = {
3314
+ [key: string]: unknown;
3315
+ };
3316
+ export type GetUserGroupsIdUserGroupRelations200 = {
3317
+ /** userGroupRelation objects */
3318
+ userGroupRelations?: GetUserGroupsIdUserGroupRelations200UserGroupRelationsItem[];
3319
+ };
3320
+ export type GetUserGroupsIdPages200PagesItem = {
3321
+ [key: string]: unknown;
3322
+ };
3323
+ export type GetUserGroupsIdPages200 = {
3324
+ /** page objects */
3325
+ pages?: GetUserGroupsIdPages200PagesItem[];
3326
+ };
3327
+ export type PutUserUiSettingsBodySettings = {
3328
+ currentSidebarContents?: string;
3329
+ currentProductNavWidth?: number;
3330
+ preferCollapsedModeByUser?: boolean;
3331
+ };
3332
+ export type PutUserUiSettingsBody = {
3333
+ settings?: PutUserUiSettingsBodySettings;
3334
+ };
3335
+ export type PutUserUiSettings200 = {
3336
+ _id?: string;
3337
+ user?: string;
3338
+ __v?: number;
3339
+ currentSidebarContents?: string;
3340
+ preferCollapsedModeByUser?: boolean;
3341
+ };
3342
+ export type GetUsersParams = {
3343
+ /**
3344
+ * page number
3345
+ */
3346
+ page?: number;
3347
+ /**
3348
+ * status list
3349
+ */
3350
+ selectedStatusList?: string;
3351
+ /**
3352
+ * For incremental search value from input box
3353
+ */
3354
+ searchText?: string;
3355
+ /**
3356
+ * asc or desc
3357
+ */
3358
+ sortOrder?: string;
3359
+ /**
3360
+ * sorting column
3361
+ */
3362
+ sort?: string;
3363
+ /**
3364
+ * force include attributes
3365
+ */
3366
+ forceIncludeAttributes?: string;
3367
+ };
3368
+ export type GetUsers200 = {
3369
+ paginateResult?: PaginateResult;
3370
+ };
3371
+ export type GetIdRecent200 = {
3372
+ paginateResult?: PaginateResult;
3373
+ };
3374
+ export type PostUsersInviteParams = {
3375
+ /**
3376
+ * Invitation emailList
3377
+ */
3378
+ shapedEmailList?: {
3379
+ [key: string]: unknown;
3380
+ };
3381
+ /**
3382
+ * Whether to send mail
3383
+ */
3384
+ sendEmail?: boolean;
3385
+ };
3386
+ /**
3387
+ * Users email that failed to create or send email
3388
+ */
3389
+ export type PostUsersInvite200FailedEmailList = {
3390
+ /** email address */
3391
+ email?: string;
3392
+ /** reason for failure */
3393
+ reason?: string;
3394
+ };
3395
+ export type PostUsersInvite200 = {
3396
+ /** Users successfully created */
3397
+ createdUserList?: User;
3398
+ /** Users email that already exists */
3399
+ existingEmailList?: string[];
3400
+ /** Users email that failed to create or send email */
3401
+ failedEmailList?: PostUsersInvite200FailedEmailList;
3402
+ };
3403
+ export type PutUsersIdGrantAdmin200 = {
3404
+ /** data of admin user */
3405
+ userData?: User;
3406
+ };
3407
+ /**
3408
+ * data of revoked admin user
3409
+ */
3410
+ export type PutUsersIdRevokeAdmin200UserData = {
3411
+ [key: string]: unknown;
3412
+ };
3413
+ export type PutUsersIdRevokeAdmin200 = {
3414
+ /** data of revoked admin user */
3415
+ userData?: PutUsersIdRevokeAdmin200UserData;
3416
+ };
3417
+ export type PutUsersIdGrantReadOnly200 = {
3418
+ /** data of grant read only */
3419
+ userData?: User;
3420
+ };
3421
+ export type PutUsersIdRevokeReadOnly200 = {
3422
+ /** data of revoke read only */
3423
+ userData?: User;
3424
+ };
3425
+ export type PutUsersIdActivate200 = {
3426
+ /** data of activate user */
3427
+ userData?: User;
3428
+ };
3429
+ export type PutUsersIdDeactivate200 = {
3430
+ /** data of deactivate user */
3431
+ userData?: User;
3432
+ };
3433
+ export type DeleteUsersIdRemove200 = {
3434
+ /** data of deleted user */
3435
+ user?: User;
3436
+ };
3437
+ export type GetUsersExternalAccountsParams = {
3438
+ /**
3439
+ * page number
3440
+ */
3441
+ page?: number;
3442
+ };
3443
+ export type GetUsersExternalAccounts200 = {
3444
+ paginateResult?: PaginateResult;
3445
+ };
3446
+ /**
3447
+ * A result of `ExtenralAccount.findByIdAndRemove`
3448
+ */
3449
+ export type DeleteUsersExternalAccountsIdRemove200ExternalAccount = {
3450
+ [key: string]: unknown;
3451
+ };
3452
+ export type DeleteUsersExternalAccountsIdRemove200 = {
3453
+ /** A result of `ExtenralAccount.findByIdAndRemove` */
3454
+ externalAccount?: DeleteUsersExternalAccountsIdRemove200ExternalAccount;
3455
+ };
3456
+ export type PutUsersUpdateImageUrlCacheBody = {
3457
+ /** user id list */
3458
+ userIds?: string[];
3459
+ };
3460
+ /**
3461
+ * success creating imageUrlCached
3462
+ */
3463
+ export type PutUsersUpdateImageUrlCache200 = {
3464
+ [key: string]: unknown;
3465
+ };
3466
+ export type PutUsersResetPasswordBody = {
3467
+ /** user id for reset password */
3468
+ id?: string;
3469
+ };
3470
+ export type PutUsersResetPassword200 = {
3471
+ /** new password */
3472
+ newPassword?: string;
3473
+ user?: User;
3474
+ };
3475
+ export type PutUsersResetPasswordEmailBody = {
3476
+ /** user id for send new password email */
3477
+ id?: string;
3478
+ newPassword?: string;
3479
+ };
3480
+ export type PutUsersSendInvitationEmailBody = {
3481
+ /** user id for send invitation email */
3482
+ id?: string;
3483
+ };
3484
+ /**
3485
+ * email and reasons for email sending failure
3486
+ */
3487
+ export type PutUsersSendInvitationEmail200FailedToSendEmail = {
3488
+ email?: string;
3489
+ reason?: string;
3490
+ };
3491
+ export type PutUsersSendInvitationEmail200 = {
3492
+ /** email and reasons for email sending failure */
3493
+ failedToSendEmail?: PutUsersSendInvitationEmail200FailedToSendEmail;
3494
+ };
3495
+ export type GetUsersListParams = {
3496
+ userIds?: string;
3497
+ };
3498
+ export type GetUsersList200 = {
3499
+ /** user list */
3500
+ users?: User[];
3501
+ };
3502
+ export type GetUsersUsernamesParams = {
3503
+ q?: string;
3504
+ offset?: number;
3505
+ limit?: number;
3506
+ options?: string;
3507
+ };
3508
+ export type GetUsersUsernames200ActiveUser = {
3509
+ usernames?: string[];
3510
+ totalCount?: number;
3511
+ };
3512
+ export type GetUsersUsernames200InactiveUser = {
3513
+ usernames?: string[];
3514
+ totalCount?: number;
3515
+ };
3516
+ export type GetUsersUsernames200ActivitySnapshotUser = {
3517
+ usernames?: string[];
3518
+ totalCount?: number;
3519
+ };
3520
+ export type GetUsersUsernames200 = {
3521
+ activeUser?: GetUsersUsernames200ActiveUser;
3522
+ inactiveUser?: GetUsersUsernames200InactiveUser;
3523
+ activitySnapshotUser?: GetUsersUsernames200ActivitySnapshotUser;
3524
+ mixedUsernames?: string[];
3525
+ };
3526
+ export type PostLoginBodyLoginForm = {
3527
+ username?: string;
3528
+ password?: string;
3529
+ };
3530
+ export type PostLoginBody = {
3531
+ loginForm?: PostLoginBodyLoginForm;
3532
+ };
3533
+ export type PostLogin200 = {
3534
+ redirectTo?: string;
3535
+ };
3536
+ export type PostRegisterBodyRegisterForm = {
3537
+ name?: string;
3538
+ username?: string;
3539
+ email?: string;
3540
+ password?: string;
3541
+ };
3542
+ export type PostRegisterBody = {
3543
+ registerForm?: PostRegisterBodyRegisterForm;
3544
+ };
3545
+ export type PostRegister200 = {
3546
+ redirectTo?: string;
3547
+ };
3548
+ //# sourceMappingURL=index.schemas.d.ts.map