@inneropen/marvin-sdk 3.0.0 → 3.1.0-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3336 +1,5 @@
1
1
  import { H as HttpClient } from './HttpClient-CdF3IHM1.js';
2
- import { AuthToken } from './types/index.js';
3
-
4
- interface components {
5
- schemas: {
6
- /**
7
- * APIClientCreate
8
- * @description Schema for creating a new API client.
9
- */
10
- APIClientCreate: {
11
- /** Name */
12
- name: string;
13
- /** Slug */
14
- slug?: string | null;
15
- /** Description */
16
- description?: string | null;
17
- /** Permissions */
18
- permissions?: {
19
- [key: string]: unknown;
20
- } | null;
21
- };
22
- /**
23
- * APIClientRead
24
- * @description Full schema for reading an API client.
25
- */
26
- APIClientRead: {
27
- /**
28
- * Id
29
- * Format: uuid4
30
- */
31
- id: string;
32
- /** Name */
33
- name: string;
34
- /** Slug */
35
- slug: string;
36
- /** Description */
37
- description?: string | null;
38
- /** Enabled */
39
- enabled: boolean;
40
- /**
41
- * Groupid
42
- * Format: uuid4
43
- */
44
- groupId: string;
45
- /** Permissions */
46
- permissions: {
47
- [key: string]: unknown;
48
- };
49
- /** Lastusedat */
50
- lastUsedAt?: string | null;
51
- /** Createdat */
52
- createdAt?: string | null;
53
- /** Updateat */
54
- updateAt?: string | null;
55
- /** Revokedat */
56
- revokedAt?: string | null;
57
- };
58
- /**
59
- * APIClientUpdate
60
- * @description Schema for updating an API client.
61
- */
62
- APIClientUpdate: {
63
- /** Name */
64
- name?: string | null;
65
- /** Description */
66
- description?: string | null;
67
- /** Permissions */
68
- permissions?: {
69
- [key: string]: unknown;
70
- } | null;
71
- /** Enabled */
72
- enabled?: boolean | null;
73
- };
74
- /**
75
- * APIClientWithToken
76
- * @description Response when creating or rotating an API client token - includes plaintext token ONCE.
77
- */
78
- APIClientWithToken: {
79
- /**
80
- * Id
81
- * Format: uuid4
82
- */
83
- id: string;
84
- /**
85
- * Groupid
86
- * Format: uuid4
87
- */
88
- groupId: string;
89
- /** Name */
90
- name: string;
91
- /** Slug */
92
- slug: string;
93
- /** Description */
94
- description?: string | null;
95
- /** Permissions */
96
- permissions: {
97
- [key: string]: unknown;
98
- };
99
- /** Token */
100
- token: string;
101
- /** Enabled */
102
- enabled: boolean;
103
- /** Createdat */
104
- createdAt?: string | null;
105
- };
106
- /**
107
- * AdminAboutInfo
108
- * @description Schema for detailed application information, extending `AppInfo` with
109
- * additional details relevant for administrators.
110
- */
111
- AdminAboutInfo: {
112
- /** Production */
113
- production: boolean;
114
- /** Version */
115
- version: string;
116
- /** Demostatus */
117
- demoStatus: boolean;
118
- /** Allowsignup */
119
- allowSignup: boolean;
120
- /** Defaultgroupslug */
121
- defaultGroupSlug?: string | null;
122
- /** Defaulthouseholdslug */
123
- defaultHouseholdSlug?: string | null;
124
- /** Enableoidc */
125
- enableOidc: boolean;
126
- /** Oidcredirect */
127
- oidcRedirect: boolean;
128
- /** Oidcprovidername */
129
- oidcProviderName: string;
130
- /** Enableopenai */
131
- enableOpenai: boolean;
132
- /** Enableopenaiimageservices */
133
- enableOpenaiImageServices: boolean;
134
- /** Versionlatest */
135
- versionLatest: string;
136
- /** Apiport */
137
- apiPort: number;
138
- /** Apidocs */
139
- apiDocs: boolean;
140
- /** Dbtype */
141
- dbType: string;
142
- /** Dburl */
143
- dbUrl?: string | null;
144
- /** Defaultgroup */
145
- defaultGroup: string;
146
- /** Buildid */
147
- buildId: string;
148
- };
149
- /**
150
- * AppInfo
151
- * @description Schema for general, publicly accessible application information.
152
- */
153
- AppInfo: {
154
- /** Production */
155
- production: boolean;
156
- /** Version */
157
- version: string;
158
- };
159
- /**
160
- * AppStatistics
161
- * @description Schema for comprehensive application statistics.
162
- */
163
- AppStatistics: {
164
- /** Totalusers */
165
- totalUsers: number;
166
- /** Totalgroups */
167
- totalGroups: number;
168
- /** Totalentries */
169
- totalEntries: number;
170
- /** Totalcollections */
171
- totalCollections: number;
172
- /** Totalentrytypes */
173
- totalEntryTypes: number;
174
- /** Totalassets */
175
- totalAssets: number;
176
- /** Totalresources */
177
- totalResources: number;
178
- /** Totalapitokens */
179
- totalApiTokens: number;
180
- /** Totalapiclients */
181
- totalApiClients: number;
182
- /** Totalwebhooks */
183
- totalWebhooks: number;
184
- };
185
- /**
186
- * AppTheme
187
- * @description Schema defining the complete color system for the application's light and dark themes.
188
- * Includes background, surface, text, border, and accent colors.
189
- * Actual color values are defined in core/settings/theme.py
190
- */
191
- AppTheme: {
192
- /** Lightbg */
193
- lightBg: string;
194
- /** Lightpanel */
195
- lightPanel: string;
196
- /** Lightpanelsecondary */
197
- lightPanelSecondary: string;
198
- /** Lighttext */
199
- lightText: string;
200
- /** Lighttextmuted */
201
- lightTextMuted: string;
202
- /** Lightborder */
203
- lightBorder: string;
204
- /** Lightprimary */
205
- lightPrimary: string;
206
- /** Lightaccent */
207
- lightAccent: string;
208
- /** Lightsecondary */
209
- lightSecondary: string;
210
- /** Lightsuccess */
211
- lightSuccess: string;
212
- /** Lightinfo */
213
- lightInfo: string;
214
- /** Lightwarning */
215
- lightWarning: string;
216
- /** Lighterror */
217
- lightError: string;
218
- /** Darkbg */
219
- darkBg: string;
220
- /** Darkpanel */
221
- darkPanel: string;
222
- /** Darkpanelsecondary */
223
- darkPanelSecondary: string;
224
- /** Darktext */
225
- darkText: string;
226
- /** Darktextmuted */
227
- darkTextMuted: string;
228
- /** Darkborder */
229
- darkBorder: string;
230
- /** Darkprimary */
231
- darkPrimary: string;
232
- /** Darkaccent */
233
- darkAccent: string;
234
- /** Darksecondary */
235
- darkSecondary: string;
236
- /** Darksuccess */
237
- darkSuccess: string;
238
- /** Darkinfo */
239
- darkInfo: string;
240
- /** Darkwarning */
241
- darkWarning: string;
242
- /** Darkerror */
243
- darkError: string;
244
- };
245
- /**
246
- * AssetRead
247
- * @description Full schema for reading an asset.
248
- */
249
- AssetRead: {
250
- /**
251
- * Id
252
- * Format: uuid4
253
- */
254
- id: string;
255
- /** Slug */
256
- slug: string;
257
- /** Name */
258
- name: string;
259
- /** Mimetype */
260
- mimeType: string;
261
- /** Alttext */
262
- altText?: string | null;
263
- /** Originalfilename */
264
- originalFilename: string;
265
- /** Filename */
266
- filename: string;
267
- /** Extension */
268
- extension: string;
269
- /** Filesize */
270
- fileSize: number;
271
- /**
272
- * Assettype
273
- * @enum {string}
274
- */
275
- assetType: "image" | "document" | "video" | "audio" | "archive" | "svg" | "other";
276
- /** Checksum */
277
- checksum: string;
278
- /** Width */
279
- width?: number | null;
280
- /** Height */
281
- height?: number | null;
282
- /** Orientation */
283
- orientation?: number | null;
284
- /** Storageprovider */
285
- storageProvider: string;
286
- /** Storagekey */
287
- storageKey: string;
288
- /** Publicurl */
289
- publicUrl?: string | null;
290
- /** Description */
291
- description?: string | null;
292
- /** Metadata */
293
- metadata_?: {
294
- [key: string]: unknown;
295
- } | null;
296
- /**
297
- * Uploadedby
298
- * Format: uuid4
299
- */
300
- uploadedBy: string;
301
- };
302
- /**
303
- * AssetUpdate
304
- * @description Schema for updating editable asset fields.
305
- */
306
- AssetUpdate: {
307
- /** Slug */
308
- slug?: string | null;
309
- /** Name */
310
- name?: string | null;
311
- /** Alt Text */
312
- alt_text?: string | null;
313
- /** Description */
314
- description?: string | null;
315
- /** Metadata */
316
- metadata?: {
317
- [key: string]: unknown;
318
- } | null;
319
- };
320
- /**
321
- * AuthMethod
322
- * @description Enumeration for the authentication methods a user can be associated with.
323
- * @enum {string}
324
- */
325
- AuthMethod: "MARVIN" | "LDAP" | "OIDC";
326
- /** Body_get_token_api_auth_token_post */
327
- Body_get_token_api_auth_token_post: {
328
- /**
329
- * Username
330
- * @default
331
- */
332
- username: string;
333
- /**
334
- * Password
335
- * @default
336
- */
337
- password: string;
338
- /**
339
- * Remember Me
340
- * @default false
341
- */
342
- remember_me: boolean;
343
- };
344
- /** Body_upload_asset_api_platform_assets_upload_post */
345
- Body_upload_asset_api_platform_assets_upload_post: {
346
- /**
347
- * File
348
- * Format: binary
349
- */
350
- file: string;
351
- /** Slug */
352
- slug: string;
353
- /** Name */
354
- name: string;
355
- /** Alt Text */
356
- alt_text?: string | null;
357
- /** Description */
358
- description?: string | null;
359
- /** Metadata */
360
- metadata?: string | null;
361
- };
362
- /**
363
- * ChangePassword
364
- * @description Schema for a password change request.
365
- * Requires the user's current password and the new password (min length 8).
366
- */
367
- ChangePassword: {
368
- /**
369
- * Currentpassword
370
- * @default
371
- */
372
- currentPassword: string;
373
- /** Newpassword */
374
- newPassword: string;
375
- };
376
- /**
377
- * CheckAppConfig
378
- * @description Schema representing the status of various critical application configurations.
379
- * Used to quickly assess if key features are configured and ready for use.
380
- */
381
- CheckAppConfig: {
382
- /** Emailready */
383
- emailReady: boolean;
384
- /** Ldapready */
385
- ldapReady: boolean;
386
- /** Oidcready */
387
- oidcReady: boolean;
388
- /** Enableopenai */
389
- enableOpenai: boolean;
390
- /** Appriseready */
391
- appriseReady: boolean;
392
- /** Baseurlset */
393
- baseUrlSet: boolean;
394
- /** Isuptodate */
395
- isUpToDate: boolean;
396
- };
397
- /**
398
- * CollectionCreate
399
- * @description Schema for creating a new collection.
400
- */
401
- CollectionCreate: {
402
- /** Name */
403
- name: string;
404
- /** Slug */
405
- slug?: string | null;
406
- /** Description */
407
- description?: string | null;
408
- /**
409
- * Sortorder
410
- * @default 0
411
- */
412
- sortOrder: number;
413
- /** Icon */
414
- icon?: string | null;
415
- /** Color */
416
- color?: string | null;
417
- /**
418
- * Issmart
419
- * @default false
420
- */
421
- isSmart: boolean;
422
- /** Smartrules */
423
- smartRules?: {
424
- [key: string]: unknown;
425
- } | null;
426
- /** Metadatajson */
427
- metadataJson?: {
428
- [key: string]: unknown;
429
- } | null;
430
- /** Entryids */
431
- entryIds?: string[] | null;
432
- };
433
- /**
434
- * CollectionRead
435
- * @description Full schema for reading a collection.
436
- */
437
- CollectionRead: {
438
- /**
439
- * Id
440
- * Format: uuid4
441
- */
442
- id: string;
443
- /** Name */
444
- name: string;
445
- /** Slug */
446
- slug: string;
447
- /** Description */
448
- description?: string | null;
449
- /** Sortorder */
450
- sortOrder: number;
451
- /** Icon */
452
- icon?: string | null;
453
- /** Color */
454
- color?: string | null;
455
- /** Issmart */
456
- isSmart: boolean;
457
- /** Createdat */
458
- createdAt?: string | null;
459
- /** Updateat */
460
- updateAt?: string | null;
461
- /**
462
- * Groupid
463
- * Format: uuid4
464
- */
465
- groupId: string;
466
- /** Smartrules */
467
- smartRules?: {
468
- [key: string]: unknown;
469
- } | null;
470
- /** Metadatajson */
471
- metadataJson?: {
472
- [key: string]: unknown;
473
- } | null;
474
- };
475
- /**
476
- * CollectionUpdate
477
- * @description Schema for updating a collection.
478
- */
479
- CollectionUpdate: {
480
- /** Name */
481
- name?: string | null;
482
- /** Slug */
483
- slug?: string | null;
484
- /** Description */
485
- description?: string | null;
486
- /** Sortorder */
487
- sortOrder?: number | null;
488
- /** Icon */
489
- icon?: string | null;
490
- /** Color */
491
- color?: string | null;
492
- /** Issmart */
493
- isSmart?: boolean | null;
494
- /** Smartrules */
495
- smartRules?: {
496
- [key: string]: unknown;
497
- } | null;
498
- /** Metadatajson */
499
- metadataJson?: {
500
- [key: string]: unknown;
501
- } | null;
502
- /** Entryids */
503
- entryIds?: string[] | null;
504
- };
505
- /**
506
- * EmailInitationResponse
507
- * @description Schema for the response after attempting to send an email invitation.
508
- * Indicates success or failure and provides an error message if applicable.
509
- */
510
- EmailInitationResponse: {
511
- /** Success */
512
- success: boolean;
513
- /** Error */
514
- error?: string | null;
515
- };
516
- /**
517
- * EmailInvitation
518
- * @description Schema for the request body when sending an email invitation.
519
- * Contains the recipient's email and the invitation token string.
520
- */
521
- EmailInvitation: {
522
- /** Email */
523
- email: string;
524
- /** Token */
525
- token: string;
526
- };
527
- /**
528
- * EmailReady
529
- * @description Schema indicating the readiness of the email (SMTP) service.
530
- */
531
- EmailReady: {
532
- /** Ready */
533
- ready: boolean;
534
- };
535
- /**
536
- * EmailSuccess
537
- * @description Schema for the response when an email operation (like sending a test email) is attempted.
538
- * Indicates success or failure and provides an error message if applicable.
539
- */
540
- EmailSuccess: {
541
- /** Success */
542
- success: boolean;
543
- /** Error */
544
- error?: string | null;
545
- };
546
- /**
547
- * EmailTemplateCreate
548
- * @description Schema for creating a new email template.
549
- */
550
- EmailTemplateCreate: {
551
- /**
552
- * Templatetype
553
- * @description Type of email (invitation, password_reset, notification, test)
554
- */
555
- templateType: string;
556
- /**
557
- * Groupid
558
- * @description Workspace ID - null for system-wide templates
559
- */
560
- groupId?: string | null;
561
- /**
562
- * Name
563
- * @description Human-readable template name
564
- */
565
- name: string;
566
- /**
567
- * Description
568
- * @description Description of when this template is used
569
- */
570
- description?: string | null;
571
- /**
572
- * Subject
573
- * @description Email subject line - supports Jinja2 variables
574
- */
575
- subject: string;
576
- /**
577
- * Headertext
578
- * @description Header text (structured mode with default.html)
579
- */
580
- headerText?: string | null;
581
- /**
582
- * Messagetop
583
- * @description Top message (structured mode with default.html)
584
- */
585
- messageTop?: string | null;
586
- /**
587
- * Messagebottom
588
- * @description Bottom message (structured mode with default.html)
589
- */
590
- messageBottom?: string | null;
591
- /**
592
- * Buttontext
593
- * @description Button text (structured mode with default.html)
594
- */
595
- buttonText?: string | null;
596
- /**
597
- * Customhtml
598
- * @description Full custom HTML - if set, overrides structured fields
599
- */
600
- customHtml?: string | null;
601
- /**
602
- * Availablevariables
603
- * @description Documentation of available variables
604
- */
605
- availableVariables?: {
606
- [key: string]: unknown;
607
- } | null;
608
- /**
609
- * Enabled
610
- * @description Whether this template is active
611
- * @default true
612
- */
613
- enabled: boolean;
614
- };
615
- /**
616
- * EmailTemplateRead
617
- * @description Schema for reading an email template.
618
- */
619
- EmailTemplateRead: {
620
- /**
621
- * Id
622
- * Format: uuid4
623
- */
624
- id: string;
625
- /** Templatetype */
626
- templateType: string;
627
- /** Groupid */
628
- groupId: string | null;
629
- /** Name */
630
- name: string;
631
- /** Description */
632
- description: string | null;
633
- /** Subject */
634
- subject: string;
635
- /** Headertext */
636
- headerText: string | null;
637
- /** Messagetop */
638
- messageTop: string | null;
639
- /** Messagebottom */
640
- messageBottom: string | null;
641
- /** Buttontext */
642
- buttonText: string | null;
643
- /** Customhtml */
644
- customHtml: string | null;
645
- /** Availablevariables */
646
- availableVariables: {
647
- [key: string]: unknown;
648
- } | null;
649
- /** Enabled */
650
- enabled: boolean;
651
- /**
652
- * Createdat
653
- * Format: date-time
654
- */
655
- createdAt: string;
656
- /**
657
- * Updateat
658
- * Format: date-time
659
- */
660
- updateAt: string;
661
- };
662
- /**
663
- * EmailTemplateSummary
664
- * @description Summary schema for listing email templates.
665
- */
666
- EmailTemplateSummary: {
667
- /**
668
- * Id
669
- * Format: uuid4
670
- */
671
- id: string;
672
- /** Templatetype */
673
- templateType: string;
674
- /** Name */
675
- name: string;
676
- /** Description */
677
- description: string | null;
678
- /** Enabled */
679
- enabled: boolean;
680
- };
681
- /**
682
- * EmailTemplateUpdate
683
- * @description Schema for updating an email template.
684
- */
685
- EmailTemplateUpdate: {
686
- /** Name */
687
- name?: string | null;
688
- /** Description */
689
- description?: string | null;
690
- /** Subject */
691
- subject?: string | null;
692
- /** Headertext */
693
- headerText?: string | null;
694
- /** Messagetop */
695
- messageTop?: string | null;
696
- /** Messagebottom */
697
- messageBottom?: string | null;
698
- /** Buttontext */
699
- buttonText?: string | null;
700
- /** Customhtml */
701
- customHtml?: string | null;
702
- /** Availablevariables */
703
- availableVariables?: {
704
- [key: string]: unknown;
705
- } | null;
706
- /** Enabled */
707
- enabled?: boolean | null;
708
- };
709
- /**
710
- * EmailTest
711
- * @description Schema for the request body when sending a test email.
712
- * Specifies the recipient email address.
713
- */
714
- EmailTest: {
715
- /** Email */
716
- email: string;
717
- };
718
- /**
719
- * EntryAssetRead
720
- * @description Asset metadata plus entry-specific placement details.
721
- */
722
- EntryAssetRead: {
723
- /** Role */
724
- role?: string | null;
725
- /** Usage */
726
- usage?: string | null;
727
- /**
728
- * Position
729
- * @default 0
730
- */
731
- position: number;
732
- /** Focalpoint */
733
- focalPoint?: string | null;
734
- /** Caption */
735
- caption?: string | null;
736
- /** Placementmetadata */
737
- placementMetadata?: {
738
- [key: string]: unknown;
739
- } | null;
740
- /**
741
- * Id
742
- * Format: uuid4
743
- */
744
- id: string;
745
- /** Slug */
746
- slug: string;
747
- /** Name */
748
- name: string;
749
- /** Mimetype */
750
- mimeType: string;
751
- /** Alttext */
752
- altText?: string | null;
753
- /** Originalfilename */
754
- originalFilename: string;
755
- /** Filename */
756
- filename: string;
757
- /** Extension */
758
- extension: string;
759
- /** Filesize */
760
- fileSize: number;
761
- /**
762
- * Assettype
763
- * @enum {string}
764
- */
765
- assetType: "image" | "document" | "video" | "audio" | "archive" | "svg" | "other";
766
- /** Checksum */
767
- checksum: string;
768
- /** Width */
769
- width?: number | null;
770
- /** Height */
771
- height?: number | null;
772
- /** Orientation */
773
- orientation?: number | null;
774
- /** Storageprovider */
775
- storageProvider: string;
776
- /** Storagekey */
777
- storageKey: string;
778
- /** Publicurl */
779
- publicUrl?: string | null;
780
- /** Description */
781
- description?: string | null;
782
- /** Metadata */
783
- metadata_?: {
784
- [key: string]: unknown;
785
- } | null;
786
- /**
787
- * Uploadedby
788
- * Format: uuid4
789
- */
790
- uploadedBy: string;
791
- };
792
- /**
793
- * EntryCreate
794
- * @description Schema for creating an entry.
795
- *
796
- * BREAKING CHANGE: content_markdown removed, replaced with data_json.
797
- * Entry content is now schema-driven based on entry_type.schema_json.
798
- */
799
- EntryCreate: {
800
- /**
801
- * Entrytypeid
802
- * Format: uuid4
803
- */
804
- entryTypeId: string;
805
- /** Title */
806
- title: string;
807
- /** Slug */
808
- slug?: string | null;
809
- /** Summary */
810
- summary?: string | null;
811
- /** Description */
812
- description?: string | null;
813
- /**
814
- * Datajson
815
- * @description Schema-driven content data (validated against entry_type.schema_json)
816
- */
817
- dataJson?: {
818
- [key: string]: unknown;
819
- };
820
- /**
821
- * Status
822
- * @default inbox
823
- */
824
- status: string;
825
- /** Publishedat */
826
- publishedAt?: string | null;
827
- /** Publishat */
828
- publishAt?: string | null;
829
- /** Expireat */
830
- expireAt?: string | null;
831
- /**
832
- * Metadatajson
833
- * @description Custom non-schema metadata (API keys, external IDs, etc.)
834
- */
835
- metadataJson?: {
836
- [key: string]: unknown;
837
- } | null;
838
- /** Collectionids */
839
- collectionIds?: string[] | null;
840
- /** Assetids */
841
- assetIds?: string[] | null;
842
- /** Resourceids */
843
- resourceIds?: string[] | null;
844
- };
845
- /**
846
- * EntryOrderItem
847
- * @description Schema for a single entry order update.
848
- */
849
- EntryOrderItem: {
850
- /**
851
- * Entryid
852
- * Format: uuid4
853
- */
854
- entryId: string;
855
- /** Sortorder */
856
- sortOrder: number;
857
- };
858
- /**
859
- * EntryRead
860
- * @description Schema for reading an entry.
861
- *
862
- * BREAKING CHANGE: content_markdown removed, replaced with data_json.
863
- * Entry content is now schema-driven based on entry_type.schema_json.
864
- */
865
- EntryRead: {
866
- /**
867
- * Id
868
- * Format: uuid4
869
- */
870
- id: string;
871
- /**
872
- * Groupid
873
- * Format: uuid4
874
- */
875
- groupId: string;
876
- /**
877
- * Entrytypeid
878
- * Format: uuid4
879
- */
880
- entryTypeId: string;
881
- /** Title */
882
- title: string;
883
- /** Slug */
884
- slug: string;
885
- /** Summary */
886
- summary?: string | null;
887
- /** Description */
888
- description?: string | null;
889
- /**
890
- * Datajson
891
- * @description Schema-driven content data
892
- */
893
- dataJson?: {
894
- [key: string]: unknown;
895
- };
896
- /** Status */
897
- status: string;
898
- /** Publishedat */
899
- publishedAt?: string | null;
900
- /** Publishat */
901
- publishAt?: string | null;
902
- /** Expireat */
903
- expireAt?: string | null;
904
- /**
905
- * Metadatajson
906
- * @description Custom non-schema metadata
907
- */
908
- metadataJson?: {
909
- [key: string]: unknown;
910
- } | null;
911
- /** Createdby */
912
- createdBy?: string | null;
913
- /** Createdat */
914
- createdAt?: string | null;
915
- /** Updateat */
916
- updateAt?: string | null;
917
- /**
918
- * Resources
919
- * @default []
920
- */
921
- resources: components["schemas"]["ResourceSummary"][];
922
- /**
923
- * Assets
924
- * @default []
925
- */
926
- assets: components["schemas"]["EntryAssetRead"][];
927
- /**
928
- * Collections
929
- * @default []
930
- */
931
- collections: string[];
932
- /** Order */
933
- order?: number | null;
934
- };
935
- /**
936
- * EntryTypeCapabilities
937
- * @description Capabilities for a published entry type.
938
- */
939
- EntryTypeCapabilities: {
940
- /**
941
- * Publishable
942
- * @default true
943
- */
944
- publishable: boolean;
945
- /**
946
- * Submittable
947
- * @default false
948
- */
949
- submittable: boolean;
950
- /**
951
- * Routable
952
- * @default true
953
- */
954
- routable: boolean;
955
- };
956
- /**
957
- * EntryTypeCreate
958
- * @description Schema for creating an entry type.
959
- */
960
- EntryTypeCreate: {
961
- /** Name */
962
- name: string;
963
- /** Slug */
964
- slug?: string | null;
965
- /** Icon */
966
- icon?: string | null;
967
- /** Color */
968
- color?: string | null;
969
- /** Description */
970
- description?: string | null;
971
- /**
972
- * Sortorder
973
- * @default 0
974
- */
975
- sortOrder: number;
976
- /**
977
- * Issystem
978
- * @default false
979
- */
980
- isSystem: boolean;
981
- /**
982
- * Isrendered
983
- * @default false
984
- */
985
- isRendered: boolean;
986
- /**
987
- * Schema Json
988
- * @description Entry type schema definition (EntryTypeSchemaDefinition)
989
- */
990
- schema_json?: {
991
- [key: string]: unknown;
992
- } | null;
993
- /**
994
- * Rendering Json
995
- * @description Rendering configuration (RenderingDefinition)
996
- */
997
- rendering_json?: {
998
- [key: string]: unknown;
999
- } | null;
1000
- /**
1001
- * Capabilities Json
1002
- * @description Behavioral capabilities (CapabilitiesDefinition)
1003
- */
1004
- capabilities_json?: {
1005
- [key: string]: unknown;
1006
- } | null;
1007
- };
1008
- /**
1009
- * EntryTypeRead
1010
- * @description Schema for reading an entry type.
1011
- *
1012
- * System entry types have group_id=None and are globally available to all workspaces.
1013
- * Workspace-scoped entry types have a specific group_id.
1014
- */
1015
- EntryTypeRead: {
1016
- /**
1017
- * Id
1018
- * Format: uuid4
1019
- */
1020
- id: string;
1021
- /** Groupid */
1022
- groupId: string | null;
1023
- /** Name */
1024
- name: string;
1025
- /** Slug */
1026
- slug: string;
1027
- /** Icon */
1028
- icon?: string | null;
1029
- /** Color */
1030
- color?: string | null;
1031
- /** Description */
1032
- description?: string | null;
1033
- /** Sortorder */
1034
- sortOrder: number;
1035
- /** Issystem */
1036
- isSystem: boolean;
1037
- /**
1038
- * Isrendered
1039
- * @default false
1040
- */
1041
- isRendered: boolean;
1042
- /**
1043
- * Schemajson
1044
- * @description Entry type schema definition (EntryTypeSchemaDefinition)
1045
- */
1046
- schemaJson?: {
1047
- [key: string]: unknown;
1048
- } | null;
1049
- /**
1050
- * Renderingjson
1051
- * @description Rendering configuration (RenderingDefinition)
1052
- */
1053
- renderingJson?: {
1054
- [key: string]: unknown;
1055
- } | null;
1056
- /**
1057
- * Capabilitiesjson
1058
- * @description Behavioral capabilities (CapabilitiesDefinition)
1059
- */
1060
- capabilitiesJson?: {
1061
- [key: string]: unknown;
1062
- } | null;
1063
- /** Createdat */
1064
- createdAt?: string | null;
1065
- /** Updateat */
1066
- updateAt?: string | null;
1067
- /** Warnings */
1068
- warnings?: string[] | null;
1069
- };
1070
- /**
1071
- * EntryTypeRendering
1072
- * @description Rendering configuration for a published entry type.
1073
- */
1074
- EntryTypeRendering: {
1075
- /** Renderer */
1076
- renderer?: string | null;
1077
- /** Package */
1078
- package?: string | null;
1079
- /** Version */
1080
- version?: string | null;
1081
- /** Config */
1082
- config?: {
1083
- [key: string]: unknown;
1084
- } | null;
1085
- };
1086
- /**
1087
- * EntryTypeUpdate
1088
- * @description Schema for patching an entry type.
1089
- */
1090
- EntryTypeUpdate: {
1091
- /** Name */
1092
- name?: string | null;
1093
- /** Slug */
1094
- slug?: string | null;
1095
- /** Icon */
1096
- icon?: string | null;
1097
- /** Color */
1098
- color?: string | null;
1099
- /** Description */
1100
- description?: string | null;
1101
- /** Sortorder */
1102
- sortOrder?: number | null;
1103
- /** Issystem */
1104
- isSystem?: boolean | null;
1105
- /** Isrendered */
1106
- isRendered?: boolean | null;
1107
- /**
1108
- * Schema Json
1109
- * @description Entry type schema definition (EntryTypeSchemaDefinition)
1110
- */
1111
- schema_json?: {
1112
- [key: string]: unknown;
1113
- } | null;
1114
- /**
1115
- * Rendering Json
1116
- * @description Rendering configuration (RenderingDefinition)
1117
- */
1118
- rendering_json?: {
1119
- [key: string]: unknown;
1120
- } | null;
1121
- /**
1122
- * Capabilities Json
1123
- * @description Behavioral capabilities (CapabilitiesDefinition)
1124
- */
1125
- capabilities_json?: {
1126
- [key: string]: unknown;
1127
- } | null;
1128
- };
1129
- /**
1130
- * EntryUpdate
1131
- * @description Schema for patching an entry.
1132
- *
1133
- * BREAKING CHANGE: content_markdown removed, replaced with data_json.
1134
- * Entry content is now schema-driven based on entry_type.schema_json.
1135
- */
1136
- EntryUpdate: {
1137
- /** Entry Type Id */
1138
- entry_type_id?: string | null;
1139
- /** Title */
1140
- title?: string | null;
1141
- /** Slug */
1142
- slug?: string | null;
1143
- /** Summary */
1144
- summary?: string | null;
1145
- /** Description */
1146
- description?: string | null;
1147
- /**
1148
- * Datajson
1149
- * @description Schema-driven content data (validated against entry_type.schema_json)
1150
- */
1151
- dataJson?: {
1152
- [key: string]: unknown;
1153
- } | null;
1154
- /** Status */
1155
- status?: string | null;
1156
- /** Publishedat */
1157
- publishedAt?: string | null;
1158
- /** Publishat */
1159
- publishAt?: string | null;
1160
- /** Expireat */
1161
- expireAt?: string | null;
1162
- /**
1163
- * Metadatajson
1164
- * @description Custom non-schema metadata (API keys, external IDs, etc.)
1165
- */
1166
- metadataJson?: {
1167
- [key: string]: unknown;
1168
- } | null;
1169
- /** Collection Ids */
1170
- collection_ids?: string[] | null;
1171
- /** Asset Ids */
1172
- asset_ids?: string[] | null;
1173
- /** Resource Ids */
1174
- resource_ids?: string[] | null;
1175
- };
1176
- /**
1177
- * EventDocumentType
1178
- * @description Enumeration for the type of document or data payload associated with an event.
1179
- * Helps listeners understand the nature of `EventDocumentDataBase` content.
1180
- * @enum {string}
1181
- */
1182
- EventDocumentType: "generic" | "user" | "workspace" | "entry" | "form" | "form_submission" | "collection" | "asset" | "webhook" | "member" | "invitation" | "api_token" | "api_client" | "entry_type" | "resource" | "deployment";
1183
- /**
1184
- * EventLogRead
1185
- * @description Schema for reading an event log entry.
1186
- */
1187
- EventLogRead: {
1188
- /**
1189
- * Id
1190
- * Format: uuid4
1191
- */
1192
- id: string;
1193
- /**
1194
- * Eventid
1195
- * Format: uuid4
1196
- */
1197
- eventId: string;
1198
- /** Eventtype */
1199
- eventType: string;
1200
- /**
1201
- * Occurredat
1202
- * Format: date-time
1203
- */
1204
- occurredAt: string;
1205
- /**
1206
- * Workspaceid
1207
- * Format: uuid4
1208
- */
1209
- workspaceId: string;
1210
- /** Userid */
1211
- userId?: string | null;
1212
- /** Entityid */
1213
- entityId?: string | null;
1214
- /** Entitytype */
1215
- entityType?: string | null;
1216
- /** Integrationid */
1217
- integrationId: string;
1218
- /** Operation */
1219
- operation?: string | null;
1220
- /** Eventdata */
1221
- eventData: {
1222
- [key: string]: unknown;
1223
- };
1224
- /** Messagetitle */
1225
- messageTitle: string;
1226
- /** Messagebody */
1227
- messageBody?: string | null;
1228
- /** Createdat */
1229
- createdAt?: string | null;
1230
- /** Updateat */
1231
- updateAt?: string | null;
1232
- };
1233
- /**
1234
- * EventLogSummary
1235
- * @description Summary schema for an event log entry (lighter payload).
1236
- */
1237
- EventLogSummary: {
1238
- /**
1239
- * Id
1240
- * Format: uuid4
1241
- */
1242
- id: string;
1243
- /**
1244
- * Eventid
1245
- * Format: uuid4
1246
- */
1247
- eventId: string;
1248
- /** Eventtype */
1249
- eventType: string;
1250
- /**
1251
- * Occurredat
1252
- * Format: date-time
1253
- */
1254
- occurredAt: string;
1255
- /**
1256
- * Workspaceid
1257
- * Format: uuid4
1258
- */
1259
- workspaceId: string;
1260
- /** Userid */
1261
- userId?: string | null;
1262
- /** Entityid */
1263
- entityId?: string | null;
1264
- /** Entitytype */
1265
- entityType?: string | null;
1266
- /** Messagetitle */
1267
- messageTitle: string;
1268
- /** Messagebody */
1269
- messageBody?: string | null;
1270
- };
1271
- /**
1272
- * EventNotifierOptionsPagination
1273
- * @description Schema for paginated responses containing a list of event notifier option summaries.
1274
- */
1275
- EventNotifierOptionsPagination: {
1276
- /**
1277
- * Page
1278
- * @default 1
1279
- */
1280
- page: number;
1281
- /**
1282
- * Per Page
1283
- * @default 10
1284
- */
1285
- per_page: number;
1286
- /**
1287
- * Total
1288
- * @default 0
1289
- */
1290
- total: number;
1291
- /**
1292
- * Total Pages
1293
- * @default 0
1294
- */
1295
- total_pages: number;
1296
- /** Items */
1297
- items: components["schemas"]["EventNotifierOptionsSummary"][];
1298
- /** Next */
1299
- next?: string | null;
1300
- /** Previous */
1301
- previous?: string | null;
1302
- };
1303
- /**
1304
- * EventNotifierOptionsSummary
1305
- * @description Schema for a summary representation of an event notifier option.
1306
- * Extends `EventNotifierOptionsRead` with a combined `option` field (namespace.slug).
1307
- */
1308
- EventNotifierOptionsSummary: {
1309
- /** Name */
1310
- name: string;
1311
- /** Description */
1312
- description: string | null;
1313
- /**
1314
- * Enabled
1315
- * @default false
1316
- */
1317
- enabled: boolean | null;
1318
- /** Slug */
1319
- slug: string | null;
1320
- /** Option */
1321
- option: string;
1322
- };
1323
- /**
1324
- * ForgotPassword
1325
- * @description Schema for the "forgot password" request.
1326
- * Requires the user's email address to initiate the password reset process.
1327
- */
1328
- ForgotPassword: {
1329
- /** Email */
1330
- email: string;
1331
- };
1332
- /**
1333
- * FormCreate
1334
- * @description Schema for creating a form.
1335
- */
1336
- FormCreate: {
1337
- /** Name */
1338
- name: string;
1339
- /** Slug */
1340
- slug?: string | null;
1341
- /** Description */
1342
- description?: string | null;
1343
- /**
1344
- * Status
1345
- * @default draft
1346
- */
1347
- status: string;
1348
- /** Formschema */
1349
- formSchema?: {
1350
- [key: string]: unknown;
1351
- };
1352
- /** Settingsjson */
1353
- settingsJson?: {
1354
- [key: string]: unknown;
1355
- } | null;
1356
- /** Metadatajson */
1357
- metadataJson?: {
1358
- [key: string]: unknown;
1359
- } | null;
1360
- };
1361
- /**
1362
- * FormRead
1363
- * @description Schema for reading a form.
1364
- */
1365
- FormRead: {
1366
- /**
1367
- * Id
1368
- * Format: uuid4
1369
- */
1370
- id: string;
1371
- /**
1372
- * Groupid
1373
- * Format: uuid4
1374
- */
1375
- groupId: string;
1376
- /** Slug */
1377
- slug: string;
1378
- /** Name */
1379
- name: string;
1380
- /** Description */
1381
- description: string | null;
1382
- /** Schemajson */
1383
- schemaJson: {
1384
- [key: string]: unknown;
1385
- };
1386
- /** Settingsjson */
1387
- settingsJson: {
1388
- [key: string]: unknown;
1389
- } | null;
1390
- /** Metadatajson */
1391
- metadataJson: {
1392
- [key: string]: unknown;
1393
- } | null;
1394
- /** Status */
1395
- status: string;
1396
- /** Submissionscount */
1397
- submissionsCount: number;
1398
- /** Lastsubmissionat */
1399
- lastSubmissionAt: string | null;
1400
- /** Createdat */
1401
- createdAt: string | null;
1402
- /** Updateat */
1403
- updateAt: string | null;
1404
- };
1405
- /**
1406
- * FormSubmissionRead
1407
- * @description Schema for reading a form submission.
1408
- */
1409
- FormSubmissionRead: {
1410
- /**
1411
- * Id
1412
- * Format: uuid4
1413
- */
1414
- id: string;
1415
- /**
1416
- * Formid
1417
- * Format: uuid4
1418
- */
1419
- formId: string;
1420
- /**
1421
- * Groupid
1422
- * Format: uuid4
1423
- */
1424
- groupId: string;
1425
- /** Datajson */
1426
- dataJson: {
1427
- [key: string]: unknown;
1428
- };
1429
- /** Metadatajson */
1430
- metadataJson: {
1431
- [key: string]: unknown;
1432
- } | null;
1433
- /** Status */
1434
- status: string;
1435
- /** Ipaddress */
1436
- ipAddress: string | null;
1437
- /** Useragent */
1438
- userAgent: string | null;
1439
- /** Referrer */
1440
- referrer: string | null;
1441
- /**
1442
- * Submittedat
1443
- * Format: date-time
1444
- */
1445
- submittedAt: string;
1446
- /** Processedat */
1447
- processedAt: string | null;
1448
- };
1449
- /**
1450
- * FormSubmissionResponse
1451
- * @description Response after form submission.
1452
- *
1453
- * Indicates success/failure and optionally provides redirect URL.
1454
- */
1455
- FormSubmissionResponse: {
1456
- /** Success */
1457
- success: boolean;
1458
- /** Message */
1459
- message: string;
1460
- /** Submissionid */
1461
- submissionId?: string | null;
1462
- /** Redirecturl */
1463
- redirectUrl?: string | null;
1464
- };
1465
- /**
1466
- * FormUpdate
1467
- * @description Schema for updating a form.
1468
- */
1469
- FormUpdate: {
1470
- /** Name */
1471
- name?: string | null;
1472
- /** Slug */
1473
- slug?: string | null;
1474
- /** Description */
1475
- description?: string | null;
1476
- /** Status */
1477
- status?: string | null;
1478
- /** Formschema */
1479
- formSchema?: {
1480
- [key: string]: unknown;
1481
- } | null;
1482
- /** Settingsjson */
1483
- settingsJson?: {
1484
- [key: string]: unknown;
1485
- } | null;
1486
- /** Metadatajson */
1487
- metadataJson?: {
1488
- [key: string]: unknown;
1489
- } | null;
1490
- };
1491
- /**
1492
- * GroupAdminUpdate
1493
- * @description Schema for administrators to update a group.
1494
- * Allows updating the name and group preferences. Inherits `name` from `GroupCreate`.
1495
- */
1496
- GroupAdminUpdate: {
1497
- /** Name */
1498
- name: string;
1499
- /**
1500
- * Id
1501
- * Format: uuid4
1502
- */
1503
- id: string;
1504
- preferences?: components["schemas"]["GroupPreferencesUpdate"] | null;
1505
- };
1506
- /**
1507
- * GroupCreate
1508
- * @description Schema for creating a new group. Requires only a name.
1509
- * The name will be stripped of whitespace and must have a minimum length of 1.
1510
- */
1511
- GroupCreate: {
1512
- /** Name */
1513
- name: string;
1514
- };
1515
- /**
1516
- * GroupEventNotifierCreate
1517
- * @description Schema for creating a new group event notifier.
1518
- * A notifier typically involves a service URL (e.g., Apprise) and a set of
1519
- * event options it should react to.
1520
- * @example {
1521
- * "apprise_url": "json://some-service-url/for/notifications",
1522
- * "name": "My Project Updates Notifier",
1523
- * "options": [
1524
- * "core.test-message",
1525
- * "project.task_completed"
1526
- * ]
1527
- * }
1528
- */
1529
- GroupEventNotifierCreate: {
1530
- /** Name */
1531
- name: string;
1532
- /** Appriseurl */
1533
- appriseUrl?: string | null;
1534
- /**
1535
- * Options
1536
- * @default []
1537
- */
1538
- options: string[];
1539
- };
1540
- /**
1541
- * GroupEventNotifierOptionsSummary
1542
- * @description Schema for a summary representation of a group event notifier option.
1543
- * Provides a combined `option` string (namespace.slug).
1544
- */
1545
- GroupEventNotifierOptionsSummary: {
1546
- /** Option */
1547
- option: string;
1548
- };
1549
- /**
1550
- * GroupEventNotifierPagination
1551
- * @description Schema for paginated responses containing a list of group event notifiers.
1552
- */
1553
- GroupEventNotifierPagination: {
1554
- /**
1555
- * Page
1556
- * @default 1
1557
- */
1558
- page: number;
1559
- /**
1560
- * Per Page
1561
- * @default 10
1562
- */
1563
- per_page: number;
1564
- /**
1565
- * Total
1566
- * @default 0
1567
- */
1568
- total: number;
1569
- /**
1570
- * Total Pages
1571
- * @default 0
1572
- */
1573
- total_pages: number;
1574
- /** Items */
1575
- items: components["schemas"]["GroupEventNotifierRead"][];
1576
- /** Next */
1577
- next?: string | null;
1578
- /** Previous */
1579
- previous?: string | null;
1580
- };
1581
- /**
1582
- * GroupEventNotifierRead
1583
- * @description Schema for representing a group event notifier when read from the system.
1584
- * Includes its configuration and the list of event options it's subscribed to.
1585
- */
1586
- GroupEventNotifierRead: {
1587
- /**
1588
- * Id
1589
- * Format: uuid4
1590
- */
1591
- id: string;
1592
- /** Name */
1593
- name: string;
1594
- /** Enabled */
1595
- enabled: boolean;
1596
- /**
1597
- * Groupid
1598
- * Format: uuid4
1599
- */
1600
- groupId: string;
1601
- /**
1602
- * Options
1603
- * @default []
1604
- */
1605
- options: components["schemas"]["GroupEventNotifierOptionsSummary"][];
1606
- };
1607
- /**
1608
- * GroupEventNotifierUpdate
1609
- * @description Schema for updating an existing group event notifier.
1610
- * Extends `GroupEventNotifierSave`, implying all fields can be updated,
1611
- * and adds an `enabled` flag.
1612
- *
1613
- * For partial updates (PATCH), individual fields should be `Optional`.
1614
- * This schema implies a PUT-style update where all fields are provided.
1615
- * @example {
1616
- * "apprise_url": "json://some-service-url/for/notifications",
1617
- * "name": "My Project Updates Notifier",
1618
- * "options": [
1619
- * "core.test-message",
1620
- * "project.task_completed"
1621
- * ]
1622
- * }
1623
- */
1624
- GroupEventNotifierUpdate: {
1625
- /** Name */
1626
- name: string;
1627
- /** Appriseurl */
1628
- appriseUrl?: string | null;
1629
- /**
1630
- * Options
1631
- * @default []
1632
- */
1633
- options: string[];
1634
- /**
1635
- * Groupid
1636
- * Format: uuid4
1637
- */
1638
- groupId: string;
1639
- /**
1640
- * Enabled
1641
- * @default true
1642
- */
1643
- enabled: boolean;
1644
- };
1645
- /**
1646
- * GroupPagination
1647
- * @description Schema for paginated responses containing a list of groups.
1648
- * The items in the list are expected to conform to the `GroupRead` schema.
1649
- */
1650
- GroupPagination: {
1651
- /**
1652
- * Page
1653
- * @default 1
1654
- */
1655
- page: number;
1656
- /**
1657
- * Per Page
1658
- * @default 10
1659
- */
1660
- per_page: number;
1661
- /**
1662
- * Total
1663
- * @default 0
1664
- */
1665
- total: number;
1666
- /**
1667
- * Total Pages
1668
- * @default 0
1669
- */
1670
- total_pages: number;
1671
- /** Items */
1672
- items: components["schemas"]["GroupRead"][];
1673
- /** Next */
1674
- next?: string | null;
1675
- /** Previous */
1676
- previous?: string | null;
1677
- };
1678
- /**
1679
- * GroupPreferencesRead
1680
- * @description Schema for representing group preferences when read from the system.
1681
- * Includes all preference fields.
1682
- */
1683
- GroupPreferencesRead: {
1684
- /**
1685
- * Groupid
1686
- * Format: uuid4
1687
- */
1688
- groupId: string;
1689
- /**
1690
- * Privategroup
1691
- * @default true
1692
- */
1693
- privateGroup: boolean;
1694
- /**
1695
- * Firstdayofweek
1696
- * @default 0
1697
- */
1698
- firstDayOfWeek: number;
1699
- /** Sitetitle */
1700
- siteTitle?: string | null;
1701
- /** Sitetagline */
1702
- siteTagline?: string | null;
1703
- /** Sitedescription */
1704
- siteDescription?: string | null;
1705
- /** Sitecanonicalurl */
1706
- siteCanonicalUrl?: string | null;
1707
- /** Sitelogo */
1708
- siteLogo?: string | null;
1709
- /** Sitefavicon */
1710
- siteFavicon?: string | null;
1711
- /**
1712
- * Sitelocale
1713
- * @default en-US
1714
- */
1715
- siteLocale: string | null;
1716
- /**
1717
- * Sitetimezone
1718
- * @default America/New_York
1719
- */
1720
- siteTimezone: string | null;
1721
- /** Sitecontactemail */
1722
- siteContactEmail?: string | null;
1723
- /** Sitesocialjson */
1724
- siteSocialJson?: {
1725
- [key: string]: unknown;
1726
- } | null;
1727
- /** Sitemetadatajson */
1728
- siteMetadataJson?: {
1729
- [key: string]: unknown;
1730
- } | null;
1731
- };
1732
- /**
1733
- * GroupPreferencesUpdate
1734
- * @description Schema for updating existing group preferences and workspace settings.
1735
- * All fields are optional for partial updates.
1736
- * The id and group_id are set by the controller based on the URL path.
1737
- */
1738
- GroupPreferencesUpdate: {
1739
- /** Id */
1740
- id?: string | null;
1741
- /** Groupid */
1742
- groupId?: string | null;
1743
- /** Name */
1744
- name?: string | null;
1745
- /** Privategroup */
1746
- privateGroup?: boolean | null;
1747
- /** Firstdayofweek */
1748
- firstDayOfWeek?: number | null;
1749
- /** Sitetitle */
1750
- siteTitle?: string | null;
1751
- /** Sitetagline */
1752
- siteTagline?: string | null;
1753
- /** Sitedescription */
1754
- siteDescription?: string | null;
1755
- /** Sitecanonicalurl */
1756
- siteCanonicalUrl?: string | null;
1757
- /** Sitelogo */
1758
- siteLogo?: string | null;
1759
- /** Sitefavicon */
1760
- siteFavicon?: string | null;
1761
- /** Sitelocale */
1762
- siteLocale?: string | null;
1763
- /** Sitetimezone */
1764
- siteTimezone?: string | null;
1765
- /** Sitecontactemail */
1766
- siteContactEmail?: string | null;
1767
- /** Sitesocialjson */
1768
- siteSocialJson?: {
1769
- [key: string]: unknown;
1770
- } | null;
1771
- /** Sitemetadatajson */
1772
- siteMetadataJson?: {
1773
- [key: string]: unknown;
1774
- } | null;
1775
- };
1776
- /**
1777
- * GroupRead
1778
- * @description Schema for representing a group when read from the system, including detailed information.
1779
- * This typically serves as a response model for GET requests.
1780
- * Inherits `id`, `name`, and `webhooks` (as `WebhookRead`) from `GroupUpdate`.
1781
- */
1782
- GroupRead: {
1783
- /** Name */
1784
- name: string;
1785
- /**
1786
- * Id
1787
- * Format: uuid4
1788
- */
1789
- id: string;
1790
- /**
1791
- * Webhooks
1792
- * @default []
1793
- */
1794
- webhooks: components["schemas"]["WebhookRead"][];
1795
- /** Slug */
1796
- slug?: string | null;
1797
- /** Users */
1798
- users?: components["schemas"]["UserSummary"][] | null;
1799
- preferences?: components["schemas"]["GroupPreferencesRead"] | null;
1800
- };
1801
- /** HTTPValidationError */
1802
- HTTPValidationError: {
1803
- /** Detail */
1804
- detail?: components["schemas"]["ValidationError"][];
1805
- };
1806
- /**
1807
- * HealthCheck
1808
- * @description Response model for the health check endpoint.
1809
- * Indicates the operational status of the application.
1810
- */
1811
- HealthCheck: {
1812
- /**
1813
- * Status
1814
- * @default OK
1815
- */
1816
- status: string;
1817
- };
1818
- /**
1819
- * InviteTokenCreate
1820
- * @description Schema for creating a new group invitation token.
1821
- * Specifies the initial number of uses, role, and the group it belongs to.
1822
- */
1823
- InviteTokenCreate: {
1824
- /** Usesleft */
1825
- usesLeft: number;
1826
- /** @default EDITOR */
1827
- workspaceRole: components["schemas"]["WorkspaceRole"];
1828
- };
1829
- /**
1830
- * InviteTokenPagination
1831
- * @description Schema for paginated responses containing a list of invite token summaries.
1832
- */
1833
- InviteTokenPagination: {
1834
- /**
1835
- * Page
1836
- * @default 1
1837
- */
1838
- page: number;
1839
- /**
1840
- * Per Page
1841
- * @default 10
1842
- */
1843
- per_page: number;
1844
- /**
1845
- * Total
1846
- * @default 0
1847
- */
1848
- total: number;
1849
- /**
1850
- * Total Pages
1851
- * @default 0
1852
- */
1853
- total_pages: number;
1854
- /** Items */
1855
- items: components["schemas"]["InviteTokenSummary"][];
1856
- /** Next */
1857
- next?: string | null;
1858
- /** Previous */
1859
- previous?: string | null;
1860
- };
1861
- /**
1862
- * InviteTokenSummary
1863
- * @description Schema for a summary representation of a invite token.
1864
- */
1865
- InviteTokenSummary: {
1866
- /** Usesleft */
1867
- usesLeft: number;
1868
- workspaceRole: components["schemas"]["WorkspaceRole"];
1869
- /**
1870
- * Id
1871
- * Format: uuid4
1872
- */
1873
- id: string;
1874
- /** Token */
1875
- token: string;
1876
- /** Createdat */
1877
- createdAt?: string | null;
1878
- };
1879
- /**
1880
- * LongLiveTokenCreate
1881
- * @description Schema for creating a new long-lived API token (Personal Access Token).
1882
- */
1883
- LongLiveTokenCreate: {
1884
- /** Name */
1885
- name: string;
1886
- /** Description */
1887
- description?: string | null;
1888
- /**
1889
- * Integrationid
1890
- * @default generic
1891
- */
1892
- integrationId: string;
1893
- };
1894
- /**
1895
- * LongLiveTokenRead
1896
- * @description Schema for representing a long-lived API token when read from the system.
1897
- * Excludes the sensitive token string itself (never return token_hash).
1898
- * Includes security fields: enabled, last_used_at, revoked_at.
1899
- */
1900
- LongLiveTokenRead: {
1901
- /**
1902
- * Id
1903
- * Format: uuid4
1904
- */
1905
- id: string;
1906
- /**
1907
- * Userid
1908
- * Format: uuid4
1909
- */
1910
- userId: string;
1911
- /** Name */
1912
- name: string;
1913
- /** Description */
1914
- description?: string | null;
1915
- /** Enabled */
1916
- enabled: boolean;
1917
- /** Lastusedat */
1918
- lastUsedAt?: string | null;
1919
- /** Revokedat */
1920
- revokedAt?: string | null;
1921
- /** Createdat */
1922
- createdAt?: string | null;
1923
- /** Updateat */
1924
- updateAt?: string | null;
1925
- /**
1926
- * Integrationid
1927
- * @default generic
1928
- */
1929
- integrationId: string;
1930
- };
1931
- /**
1932
- * LongLiveTokenUpdate
1933
- * @description Schema for updating an existing long-lived API token.
1934
- * All fields are optional.
1935
- */
1936
- LongLiveTokenUpdate: {
1937
- /** Name */
1938
- name?: string | null;
1939
- /** Description */
1940
- description?: string | null;
1941
- /** Enabled */
1942
- enabled?: boolean | null;
1943
- };
1944
- /**
1945
- * LongLiveTokenWithToken
1946
- * @description Schema for the response when a new token is created or rotated.
1947
- * Includes the actual `token` string, which is shown ONLY ONCE.
1948
- *
1949
- * IMPORTANT: The plaintext token is never stored in the database.
1950
- * Only the bcrypt hash is stored.
1951
- */
1952
- LongLiveTokenWithToken: {
1953
- /**
1954
- * Id
1955
- * Format: uuid4
1956
- */
1957
- id: string;
1958
- /**
1959
- * Userid
1960
- * Format: uuid4
1961
- */
1962
- userId: string;
1963
- /** Name */
1964
- name: string;
1965
- /** Description */
1966
- description?: string | null;
1967
- /** Enabled */
1968
- enabled: boolean;
1969
- /** Token */
1970
- token: string;
1971
- /** Createdat */
1972
- createdAt?: string | null;
1973
- };
1974
- /**
1975
- * MaintenanceStorageDetails
1976
- * @description Schema providing detailed storage usage for various key application directories.
1977
- * All sizes are presented as human-readable strings.
1978
- */
1979
- MaintenanceStorageDetails: {
1980
- /** Tempdirsize */
1981
- tempDirSize: string;
1982
- /** Backupsdirsize */
1983
- backupsDirSize: string;
1984
- /** Seedsdirsize */
1985
- seedsDirSize: string;
1986
- /** Plugindirsize */
1987
- pluginDirSize: string;
1988
- };
1989
- /**
1990
- * MaintenanceSummary
1991
- * @description Schema for a summary of maintenance information, currently focused on data directory size.
1992
- */
1993
- MaintenanceSummary: {
1994
- /** Datadirsize */
1995
- dataDirSize: string;
1996
- };
1997
- /**
1998
- * MarvinAuthToken
1999
- * @description Pydantic response model for authentication tokens.
2000
- */
2001
- MarvinAuthToken: {
2002
- /** Access Token */
2003
- access_token: string;
2004
- /**
2005
- * Token Type
2006
- * @default bearer
2007
- */
2008
- token_type: string;
2009
- };
2010
- /**
2011
- * OrderByNullPosition
2012
- * @description Enumeration for specifying how NULL values should be positioned in ordered results.
2013
- * @enum {string}
2014
- */
2015
- OrderByNullPosition: "first" | "last";
2016
- /**
2017
- * OrderDirection
2018
- * @description Enumeration for specifying the direction of ordering in queries.
2019
- * @enum {string}
2020
- */
2021
- OrderDirection: "asc" | "desc";
2022
- /**
2023
- * PaginationMeta
2024
- * @description Pagination metadata.
2025
- */
2026
- PaginationMeta: {
2027
- /** Total */
2028
- total: number;
2029
- /** Page */
2030
- page: number;
2031
- /** Limit */
2032
- limit: number;
2033
- /** Offset */
2034
- offset: number;
2035
- };
2036
- /**
2037
- * PasswordResetToken
2038
- * @description Schema representing a password reset token along with the associated email.
2039
- * This might be used when returning token information or in contexts where
2040
- * both email and token are relevant.
2041
- */
2042
- PasswordResetToken: {
2043
- /** Email */
2044
- email: string;
2045
- /** Token */
2046
- token: string;
2047
- };
2048
- /**
2049
- * PlatformRole
2050
- * @description Platform-level roles for Marvin.
2051
- *
2052
- * A user has ONE platform role that determines their platform-level access.
2053
- * Platform roles are independent of workspace membership.
2054
- * @enum {string}
2055
- */
2056
- PlatformRole: "NONE" | "SUPER_ADMIN";
2057
- /**
2058
- * PublishedAssetRead
2059
- * @description Schema for published assets in the publishing API.
2060
- *
2061
- * Provides asset metadata for external sites to build proper media tags.
2062
- * Read-only, does not expose internal fields like storage_key or uploaded_by.
2063
- */
2064
- PublishedAssetRead: {
2065
- /** Slug */
2066
- slug: string;
2067
- /** Name */
2068
- name: string;
2069
- /** Mimetype */
2070
- mimeType: string;
2071
- /** Assettype */
2072
- assetType: string;
2073
- /** Filesize */
2074
- fileSize: number;
2075
- /** Width */
2076
- width?: number | null;
2077
- /** Height */
2078
- height?: number | null;
2079
- /** Alttext */
2080
- altText?: string | null;
2081
- /** Description */
2082
- description?: string | null;
2083
- /** Publicurl */
2084
- publicUrl: string;
2085
- /** Metadatajson */
2086
- metadataJson?: {
2087
- [key: string]: unknown;
2088
- } | null;
2089
- };
2090
- /**
2091
- * PublishedAssetsResponse
2092
- * @description Paginated response for listing published assets.
2093
- */
2094
- PublishedAssetsResponse: {
2095
- /** Data */
2096
- data: components["schemas"]["PublishedAssetRead"][];
2097
- meta: components["schemas"]["PaginationMeta"];
2098
- };
2099
- /**
2100
- * PublishedCollectionRead
2101
- * @description Schema for published collections in the publishing API.
2102
- *
2103
- * Includes collection metadata and its published entries.
2104
- */
2105
- PublishedCollectionRead: {
2106
- /** Slug */
2107
- slug: string;
2108
- /** Name */
2109
- name: string;
2110
- /** Description */
2111
- description?: string | null;
2112
- /**
2113
- * Issmart
2114
- * @default false
2115
- */
2116
- isSmart: boolean;
2117
- /** Smartrules */
2118
- smartRules?: {
2119
- [key: string]: unknown;
2120
- } | null;
2121
- /** Metadatajson */
2122
- metadataJson?: {
2123
- [key: string]: unknown;
2124
- } | null;
2125
- /** Entrycount */
2126
- entryCount: number;
2127
- /** Entries */
2128
- entries: components["schemas"]["PublishedEntryListItem"][];
2129
- };
2130
- /**
2131
- * PublishedCollectionSummary
2132
- * @description Summary schema for published collections (for listing).
2133
- *
2134
- * Minimal collection info for entry contexts - only includes
2135
- * essential fields for display and ordering.
2136
- */
2137
- PublishedCollectionSummary: {
2138
- /** Slug */
2139
- slug: string;
2140
- /** Name */
2141
- name: string;
2142
- /** Metadatajson */
2143
- metadataJson?: {
2144
- [key: string]: unknown;
2145
- } | null;
2146
- /** Sortorder */
2147
- sortOrder: number;
2148
- };
2149
- /**
2150
- * PublishedCollectionsResponse
2151
- * @description Paginated response for listing published collections.
2152
- */
2153
- PublishedCollectionsResponse: {
2154
- /** Data */
2155
- data: components["schemas"]["PublishedCollectionSummary"][];
2156
- meta: components["schemas"]["PaginationMeta"];
2157
- };
2158
- /**
2159
- * PublishedEntriesResponse
2160
- * @description Paginated response for listing published entries.
2161
- */
2162
- PublishedEntriesResponse: {
2163
- /** Data */
2164
- data: components["schemas"]["PublishedEntryListItem"][];
2165
- meta: components["schemas"]["PaginationMeta"];
2166
- };
2167
- /**
2168
- * PublishedEntryListItem
2169
- * @description Minimal entry schema for list responses.
2170
- *
2171
- * Used when listing multiple entries - returns only essential fields
2172
- * without full content.
2173
- */
2174
- PublishedEntryListItem: {
2175
- /** Slug */
2176
- slug: string;
2177
- /** Title */
2178
- title: string;
2179
- /** Entrytype */
2180
- entryType: string;
2181
- entryTypeInfo?: components["schemas"]["PublishedEntryTypeInfo"] | null;
2182
- /** Summary */
2183
- summary?: string | null;
2184
- /** Publishedat */
2185
- publishedAt?: string | null;
2186
- /** Status */
2187
- status: string;
2188
- /**
2189
- * Collections
2190
- * @default []
2191
- */
2192
- collections: string[];
2193
- /**
2194
- * Assetslugs
2195
- * @default []
2196
- */
2197
- assetSlugs: string[];
2198
- /**
2199
- * Resourceslugs
2200
- * @default []
2201
- */
2202
- resourceSlugs: string[];
2203
- /** Order */
2204
- order?: number | null;
2205
- };
2206
- /**
2207
- * PublishedEntryRead
2208
- * @description Schema for published entries in the publishing API.
2209
- *
2210
- * Only includes public-facing fields. Excludes all admin metadata,
2211
- * internal fields, and user information.
2212
- *
2213
- * BREAKING CHANGE: content_markdown removed, replaced with data.
2214
- * Entry content is now schema-driven based on entry_type.schema_json.
2215
- */
2216
- PublishedEntryRead: {
2217
- /** Slug */
2218
- slug: string;
2219
- /** Title */
2220
- title: string;
2221
- /** Entrytype */
2222
- entryType: string;
2223
- entryTypeInfo?: components["schemas"]["PublishedEntryTypeInfo"] | null;
2224
- /** Summary */
2225
- summary?: string | null;
2226
- /** Data */
2227
- data: {
2228
- [key: string]: unknown;
2229
- };
2230
- /** Publishedat */
2231
- publishedAt?: string | null;
2232
- /** Metadatajson */
2233
- metadataJson?: {
2234
- [key: string]: unknown;
2235
- } | null;
2236
- /**
2237
- * Collections
2238
- * @default []
2239
- */
2240
- collections: components["schemas"]["PublishedCollectionSummary"][];
2241
- /**
2242
- * Resources
2243
- * @default []
2244
- */
2245
- resources: components["schemas"]["PublishedResourceRead"][];
2246
- /**
2247
- * Assets
2248
- * @default []
2249
- */
2250
- assets: components["schemas"]["PublishedAssetRead"][];
2251
- /** Order */
2252
- order?: number | null;
2253
- };
2254
- /**
2255
- * PublishedEntryTypeInfo
2256
- * @description Flattened entry type rendering and capabilities info for published entries.
2257
- */
2258
- PublishedEntryTypeInfo: {
2259
- /** Slug */
2260
- slug: string;
2261
- /** Renderer */
2262
- renderer?: string | null;
2263
- /** Package */
2264
- package?: string | null;
2265
- /** Version */
2266
- version?: string | null;
2267
- /** Config */
2268
- config?: {
2269
- [key: string]: unknown;
2270
- } | null;
2271
- /**
2272
- * Publishable
2273
- * @default true
2274
- */
2275
- publishable: boolean;
2276
- /**
2277
- * Submittable
2278
- * @default false
2279
- */
2280
- submittable: boolean;
2281
- /**
2282
- * Routable
2283
- * @default true
2284
- */
2285
- routable: boolean;
2286
- };
2287
- /**
2288
- * PublishedEntryTypeRead
2289
- * @description Schema for entry types in the publishing API.
2290
- */
2291
- PublishedEntryTypeRead: {
2292
- /** Slug */
2293
- slug: string;
2294
- /** Name */
2295
- name: string;
2296
- /**
2297
- * Isrendered
2298
- * @default false
2299
- */
2300
- isRendered: boolean;
2301
- rendering?: components["schemas"]["EntryTypeRendering"] | null;
2302
- capabilities?: components["schemas"]["EntryTypeCapabilities"] | null;
2303
- };
2304
- /**
2305
- * PublishedFormRead
2306
- * @description Schema for published forms in the publishing API.
2307
- *
2308
- * Provides form definition for frontend to render the form.
2309
- * Does not expose internal fields like submissions_count.
2310
- */
2311
- PublishedFormRead: {
2312
- /** Slug */
2313
- slug: string;
2314
- /** Name */
2315
- name: string;
2316
- /** Description */
2317
- description?: string | null;
2318
- /** Formschema */
2319
- formSchema: {
2320
- [key: string]: unknown;
2321
- };
2322
- /** Metadata */
2323
- metadata?: {
2324
- [key: string]: unknown;
2325
- } | null;
2326
- };
2327
- /**
2328
- * PublishedResourceRead
2329
- * @description Schema for published resources in entry context.
2330
- *
2331
- * Combines resource metadata with entry-specific placement info.
2332
- */
2333
- PublishedResourceRead: {
2334
- /** Slug */
2335
- slug: string;
2336
- /** Name */
2337
- name: string;
2338
- /** Resourcetype */
2339
- resourceType: string;
2340
- /** Description */
2341
- description?: string | null;
2342
- /** Url */
2343
- url?: string | null;
2344
- /** Externalid */
2345
- externalId?: string | null;
2346
- /** Metadatajson */
2347
- metadataJson?: {
2348
- [key: string]: unknown;
2349
- } | null;
2350
- /** Role */
2351
- role?: string | null;
2352
- /** Quantity */
2353
- quantity?: string | null;
2354
- /** Unit */
2355
- unit?: string | null;
2356
- /**
2357
- * Position
2358
- * @default 0
2359
- */
2360
- position: number;
2361
- };
2362
- /**
2363
- * PublishedResourceSummary
2364
- * @description Schema for published resources in standalone context.
2365
- *
2366
- * Provides resource metadata without entry-specific placement info.
2367
- * Used for listing resources and getting individual resource details.
2368
- */
2369
- PublishedResourceSummary: {
2370
- /** Slug */
2371
- slug: string;
2372
- /** Name */
2373
- name: string;
2374
- /** Resourcetype */
2375
- resourceType: string;
2376
- /** Description */
2377
- description?: string | null;
2378
- /** Url */
2379
- url?: string | null;
2380
- /** Externalid */
2381
- externalId?: string | null;
2382
- /** Metadatajson */
2383
- metadataJson?: {
2384
- [key: string]: unknown;
2385
- } | null;
2386
- /**
2387
- * Entries
2388
- * @default []
2389
- */
2390
- entries: string[];
2391
- };
2392
- /**
2393
- * PublishedResourcesResponse
2394
- * @description Paginated response for listing published resources.
2395
- */
2396
- PublishedResourcesResponse: {
2397
- /** Data */
2398
- data: components["schemas"]["PublishedResourceSummary"][];
2399
- meta: components["schemas"]["PaginationMeta"];
2400
- };
2401
- /**
2402
- * ReorderEntriesRequest
2403
- * @description Schema for bulk reordering entries in a collection.
2404
- */
2405
- ReorderEntriesRequest: {
2406
- /** Entries */
2407
- entries: components["schemas"]["EntryOrderItem"][];
2408
- };
2409
- /**
2410
- * ResetPassword
2411
- * @description Schema for the actual password reset operation.
2412
- * Requires the reset token, the user's email (for verification, though token
2413
- * should be sufficient if unique and mapped to user), and the new password
2414
- * with confirmation.
2415
- */
2416
- ResetPassword: {
2417
- /** Token */
2418
- token: string;
2419
- /** Email */
2420
- email: string;
2421
- /** Password */
2422
- password: string;
2423
- /** Passwordconfirm */
2424
- passwordConfirm: string;
2425
- };
2426
- /**
2427
- * ResourceCreate
2428
- * @description Schema for creating a new resource.
2429
- */
2430
- ResourceCreate: {
2431
- /** Slug */
2432
- slug: string;
2433
- /** Name */
2434
- name: string;
2435
- /** Resourcetype */
2436
- resourceType: string;
2437
- /** Description */
2438
- description?: string | null;
2439
- /** Url */
2440
- url?: string | null;
2441
- /** Externalid */
2442
- externalId?: string | null;
2443
- /** Metadata */
2444
- metadata?: {
2445
- [key: string]: unknown;
2446
- } | null;
2447
- };
2448
- /**
2449
- * ResourceRead
2450
- * @description Full schema for reading a resource.
2451
- */
2452
- ResourceRead: {
2453
- /**
2454
- * Id
2455
- * Format: uuid4
2456
- */
2457
- id: string;
2458
- /** Slug */
2459
- slug: string;
2460
- /** Name */
2461
- name: string;
2462
- /** Resourcetype */
2463
- resourceType: string;
2464
- /** Description */
2465
- description?: string | null;
2466
- /** Url */
2467
- url?: string | null;
2468
- /** Externalid */
2469
- externalId?: string | null;
2470
- /** Metadata */
2471
- metadata?: {
2472
- [key: string]: unknown;
2473
- } | null;
2474
- /**
2475
- * Createdby
2476
- * Format: uuid4
2477
- */
2478
- createdBy: string;
2479
- };
2480
- /**
2481
- * ResourceSummary
2482
- * @description Summary schema for a resource.
2483
- */
2484
- ResourceSummary: {
2485
- /**
2486
- * Id
2487
- * Format: uuid4
2488
- */
2489
- id: string;
2490
- /** Slug */
2491
- slug: string;
2492
- /** Name */
2493
- name: string;
2494
- /** Resourcetype */
2495
- resourceType: string;
2496
- /** Description */
2497
- description?: string | null;
2498
- /** Url */
2499
- url?: string | null;
2500
- /** Externalid */
2501
- externalId?: string | null;
2502
- };
2503
- /**
2504
- * ResourceUpdate
2505
- * @description Schema for updating a resource.
2506
- */
2507
- ResourceUpdate: {
2508
- /** Slug */
2509
- slug?: string | null;
2510
- /** Name */
2511
- name?: string | null;
2512
- /** Resourcetype */
2513
- resourceType?: string | null;
2514
- /** Description */
2515
- description?: string | null;
2516
- /** Url */
2517
- url?: string | null;
2518
- /** Externalid */
2519
- externalId?: string | null;
2520
- /** Metadata */
2521
- metadata?: {
2522
- [key: string]: unknown;
2523
- } | null;
2524
- };
2525
- /**
2526
- * ScheduledTaskCreate
2527
- * @description Schema for creating a new scheduled task.
2528
- */
2529
- ScheduledTaskCreate: {
2530
- /** Name */
2531
- name: string;
2532
- /** Slug */
2533
- slug?: string | null;
2534
- /** Description */
2535
- description?: string | null;
2536
- /**
2537
- * Enabled
2538
- * @default true
2539
- */
2540
- enabled: boolean;
2541
- /**
2542
- * Scheduletype
2543
- * @enum {string}
2544
- */
2545
- scheduleType: "cron" | "interval" | "once";
2546
- /** Scheduleconfig */
2547
- scheduleConfig: {
2548
- [key: string]: unknown;
2549
- };
2550
- /** Tasktype */
2551
- taskType: string;
2552
- /** Taskconfig */
2553
- taskConfig?: {
2554
- [key: string]: unknown;
2555
- };
2556
- /** Retrypolicy */
2557
- retryPolicy?: {
2558
- [key: string]: unknown;
2559
- } | null;
2560
- };
2561
- /**
2562
- * ScheduledTaskExecutionLogRead
2563
- * @description Schema for reading a scheduled task execution log entry.
2564
- */
2565
- ScheduledTaskExecutionLogRead: {
2566
- /**
2567
- * Id
2568
- * Format: uuid4
2569
- */
2570
- id: string;
2571
- /**
2572
- * Taskid
2573
- * Format: uuid4
2574
- */
2575
- taskId: string;
2576
- /** Groupid */
2577
- groupId?: string | null;
2578
- /**
2579
- * Executedat
2580
- * Format: date-time
2581
- */
2582
- executedAt: string;
2583
- /** Status */
2584
- status: string;
2585
- /** Durationms */
2586
- durationMs?: number | null;
2587
- /** Errormessage */
2588
- errorMessage?: string | null;
2589
- /** Errortraceback */
2590
- errorTraceback?: string | null;
2591
- /** Retryattempt */
2592
- retryAttempt: number;
2593
- };
2594
- /**
2595
- * ScheduledTaskRead
2596
- * @description Full schema for reading a scheduled task.
2597
- */
2598
- ScheduledTaskRead: {
2599
- /**
2600
- * Id
2601
- * Format: uuid4
2602
- */
2603
- id: string;
2604
- /** Name */
2605
- name: string;
2606
- /** Slug */
2607
- slug: string;
2608
- /** Description */
2609
- description?: string | null;
2610
- /** Enabled */
2611
- enabled: boolean;
2612
- /** Scheduletype */
2613
- scheduleType: string;
2614
- /** Tasktype */
2615
- taskType: string;
2616
- /** Lastrunat */
2617
- lastRunAt?: string | null;
2618
- /** Nextrunat */
2619
- nextRunAt?: string | null;
2620
- /** Laststatus */
2621
- lastStatus?: string | null;
2622
- /** Failurecount */
2623
- failureCount: number;
2624
- /** Createdat */
2625
- createdAt?: string | null;
2626
- /** Updateat */
2627
- updateAt?: string | null;
2628
- /** Groupid */
2629
- groupId?: string | null;
2630
- /** Scheduleconfig */
2631
- scheduleConfig: {
2632
- [key: string]: unknown;
2633
- };
2634
- /** Taskconfig */
2635
- taskConfig: {
2636
- [key: string]: unknown;
2637
- };
2638
- /** Retrypolicy */
2639
- retryPolicy?: {
2640
- [key: string]: unknown;
2641
- } | null;
2642
- /** Lastdurationms */
2643
- lastDurationMs?: number | null;
2644
- };
2645
- /**
2646
- * ScheduledTaskUpdate
2647
- * @description Schema for updating a scheduled task.
2648
- */
2649
- ScheduledTaskUpdate: {
2650
- /** Name */
2651
- name?: string | null;
2652
- /** Description */
2653
- description?: string | null;
2654
- /** Enabled */
2655
- enabled?: boolean | null;
2656
- /** Scheduletype */
2657
- scheduleType?: ("cron" | "interval" | "once") | null;
2658
- /** Scheduleconfig */
2659
- scheduleConfig?: {
2660
- [key: string]: unknown;
2661
- } | null;
2662
- /** Tasktype */
2663
- taskType?: string | null;
2664
- /** Taskconfig */
2665
- taskConfig?: {
2666
- [key: string]: unknown;
2667
- } | null;
2668
- /** Retrypolicy */
2669
- retryPolicy?: {
2670
- [key: string]: unknown;
2671
- } | null;
2672
- };
2673
- /**
2674
- * SiteConfiguration
2675
- * @description Site configuration for publishing API.
2676
- *
2677
- * Provides the public identity and settings for a workspace's published site.
2678
- * This replaces hardcoded site.ts files in Astro projects.
2679
- */
2680
- SiteConfiguration: {
2681
- /** Title */
2682
- title?: string | null;
2683
- /** Tagline */
2684
- tagline?: string | null;
2685
- /** Description */
2686
- description?: string | null;
2687
- /** Canonicalurl */
2688
- canonicalUrl?: string | null;
2689
- /** Logo */
2690
- logo?: string | null;
2691
- /** Favicon */
2692
- favicon?: string | null;
2693
- /**
2694
- * Locale
2695
- * @default en-US
2696
- */
2697
- locale: string;
2698
- /**
2699
- * Timezone
2700
- * @default America/New_York
2701
- */
2702
- timezone: string;
2703
- /** Contactemail */
2704
- contactEmail?: string | null;
2705
- /** Social */
2706
- social?: {
2707
- [key: string]: unknown;
2708
- } | null;
2709
- /** Metadatajson */
2710
- metadataJson?: {
2711
- [key: string]: unknown;
2712
- } | null;
2713
- };
2714
- /**
2715
- * SuccessResponse
2716
- * @description Standardized schema for generic API success responses.
2717
- * Provides a success message and an error flag set to False.
2718
- */
2719
- SuccessResponse: {
2720
- /** Message */
2721
- message: string;
2722
- /**
2723
- * Error
2724
- * @default false
2725
- */
2726
- error: boolean;
2727
- };
2728
- /**
2729
- * SystemStats
2730
- * @description System statistics response model.
2731
- */
2732
- SystemStats: {
2733
- /** Users Count */
2734
- users_count: number;
2735
- /** Groups Count */
2736
- groups_count: number;
2737
- /** Entries Count */
2738
- entries_count: number;
2739
- /** Assets Count */
2740
- assets_count: number;
2741
- /** Api Tokens Count */
2742
- api_tokens_count: number;
2743
- /** Webhooks Count */
2744
- webhooks_count: number;
2745
- /** Database Size */
2746
- database_size: string;
2747
- /** Database Path */
2748
- database_path: string;
2749
- /** Assets Size */
2750
- assets_size: string;
2751
- /** Assets Path */
2752
- assets_path: string;
2753
- /** Backups Size */
2754
- backups_size: string;
2755
- /** Backups Path */
2756
- backups_path: string;
2757
- /** Total Size */
2758
- total_size: string;
2759
- /** Data Dir Path */
2760
- data_dir_path: string;
2761
- };
2762
- /**
2763
- * TestEmailRequest
2764
- * @description Request to send a test email.
2765
- */
2766
- TestEmailRequest: {
2767
- /**
2768
- * Recipient Email
2769
- * Format: email
2770
- */
2771
- recipient_email: string;
2772
- };
2773
- /**
2774
- * TokenResponseDelete
2775
- * @description Schema for the response after successfully deleting an API token.
2776
- * Confirms which token was deleted by its name.
2777
- */
2778
- TokenResponseDelete: {
2779
- /** Tokendelete */
2780
- tokenDelete: string;
2781
- };
2782
- /**
2783
- * UnlockResults
2784
- * @description Schema for the response when an operation to unlock user accounts is performed.
2785
- * Indicates how many user accounts were successfully unlocked.
2786
- */
2787
- UnlockResults: {
2788
- /**
2789
- * Unlocked
2790
- * @default 0
2791
- */
2792
- unlocked: number;
2793
- };
2794
- /**
2795
- * UserCreate
2796
- * @description Schema for creating a new user.
2797
- * Includes essential user details, authentication method, admin status,
2798
- * group assignment, permissions, and password.
2799
- * @example {
2800
- * "admin": false,
2801
- * "email": "newuser@example.com",
2802
- * "fullName": "New User Name",
2803
- * "group": "Default",
2804
- * "password": "aSecurePassword123",
2805
- * "username": "NewUser"
2806
- * }
2807
- */
2808
- UserCreate: {
2809
- /** Id */
2810
- id?: string | null;
2811
- /** Username */
2812
- username?: string | null;
2813
- /** Fullname */
2814
- fullName?: string | null;
2815
- /** Email */
2816
- email: string;
2817
- /** @default MARVIN */
2818
- authMethod: components["schemas"]["AuthMethod"];
2819
- /** @default NONE */
2820
- platformRole: components["schemas"]["PlatformRole"];
2821
- /**
2822
- * Admin
2823
- * @default false
2824
- */
2825
- admin: boolean;
2826
- /**
2827
- * Issuperuser
2828
- * @default false
2829
- */
2830
- isSuperuser: boolean;
2831
- /** Group */
2832
- group?: string | null;
2833
- /**
2834
- * Advanced
2835
- * @default false
2836
- */
2837
- advanced: boolean;
2838
- /** Password */
2839
- password: string;
2840
- /**
2841
- * Caninvite
2842
- * @default false
2843
- */
2844
- canInvite: boolean;
2845
- /**
2846
- * Canmanage
2847
- * @default false
2848
- */
2849
- canManage: boolean;
2850
- /**
2851
- * Canorganize
2852
- * @default false
2853
- */
2854
- canOrganize: boolean;
2855
- };
2856
- /**
2857
- * UserPagination
2858
- * @description Schema for paginated responses containing a list of users.
2859
- * Items are expected to conform to the `UserRead` schema.
2860
- */
2861
- UserPagination: {
2862
- /**
2863
- * Page
2864
- * @default 1
2865
- */
2866
- page: number;
2867
- /**
2868
- * Per Page
2869
- * @default 10
2870
- */
2871
- per_page: number;
2872
- /**
2873
- * Total
2874
- * @default 0
2875
- */
2876
- total: number;
2877
- /**
2878
- * Total Pages
2879
- * @default 0
2880
- */
2881
- total_pages: number;
2882
- /** Items */
2883
- items: components["schemas"]["UserRead"][];
2884
- /** Next */
2885
- next?: string | null;
2886
- /** Previous */
2887
- previous?: string | null;
2888
- };
2889
- /**
2890
- * UserProfileUpdate
2891
- * @description Schema for updating a user's profile information (without password).
2892
- * All fields are optional for partial updates.
2893
- * Used by the /api/self endpoint for users updating their own profile.
2894
- */
2895
- UserProfileUpdate: {
2896
- /** Username */
2897
- username?: string | null;
2898
- /** Email */
2899
- email?: string | null;
2900
- /** Fullname */
2901
- fullName?: string | null;
2902
- };
2903
- /**
2904
- * UserRead
2905
- * @description Schema for representing a user when read from the system.
2906
- * Extends `UserCreate` (which includes password), and adds system-generated fields
2907
- * like `id`, group details, and `cache_key`.
2908
- *
2909
- * NOTE: Inheriting from `UserCreate` means this schema will include `password`.
2910
- * For public user representations, `password` should typically be excluded.
2911
- * Consider having a different base or explicitly excluding password here if this
2912
- * is for general-purpose reading. `PrivateUser` below handles sensitive data.
2913
- * @example {
2914
- * "admin": false,
2915
- * "email": "newuser@example.com",
2916
- * "fullName": "New User Name",
2917
- * "group": "Default",
2918
- * "password": "aSecurePassword123",
2919
- * "username": "NewUser"
2920
- * }
2921
- */
2922
- UserRead: {
2923
- /**
2924
- * Id
2925
- * Format: uuid4
2926
- */
2927
- id: string;
2928
- /** Username */
2929
- username?: string | null;
2930
- /** Fullname */
2931
- fullName?: string | null;
2932
- /** Email */
2933
- email: string;
2934
- /** @default MARVIN */
2935
- authMethod: components["schemas"]["AuthMethod"];
2936
- platformRole: components["schemas"]["PlatformRole"];
2937
- /**
2938
- * Admin
2939
- * @default false
2940
- */
2941
- admin: boolean;
2942
- /**
2943
- * Issuperuser
2944
- * @default false
2945
- */
2946
- isSuperuser: boolean;
2947
- /** Group */
2948
- group: string;
2949
- /**
2950
- * Advanced
2951
- * @default false
2952
- */
2953
- advanced: boolean;
2954
- /** Password */
2955
- password: string;
2956
- /**
2957
- * Caninvite
2958
- * @default false
2959
- */
2960
- canInvite: boolean;
2961
- /**
2962
- * Canmanage
2963
- * @default false
2964
- */
2965
- canManage: boolean;
2966
- /**
2967
- * Canorganize
2968
- * @default false
2969
- */
2970
- canOrganize: boolean;
2971
- /**
2972
- * Groupid
2973
- * Format: uuid4
2974
- */
2975
- groupId: string;
2976
- /** Groupslug */
2977
- groupSlug: string;
2978
- /** Activegroupid */
2979
- activeGroupId?: string | null;
2980
- /**
2981
- * Workspacememberships
2982
- * @default []
2983
- */
2984
- workspaceMemberships: components["schemas"]["WorkspaceMembershipSummary"][];
2985
- /** Cachekey */
2986
- cacheKey: string | null;
2987
- };
2988
- /** UserRegistrationCreate */
2989
- UserRegistrationCreate: {
2990
- /** Group */
2991
- group?: string | null;
2992
- /** Grouptoken */
2993
- groupToken?: string | null;
2994
- /** Email */
2995
- email: string;
2996
- /** Username */
2997
- username: string;
2998
- /** Fullname */
2999
- fullName: string;
3000
- /** Password */
3001
- password: string;
3002
- /** Passwordconfirm */
3003
- passwordConfirm: string;
3004
- /**
3005
- * Advanced
3006
- * @default false
3007
- */
3008
- advanced: boolean;
3009
- /**
3010
- * Private
3011
- * @default false
3012
- */
3013
- private: boolean;
3014
- /**
3015
- * Seeddata
3016
- * @default false
3017
- */
3018
- seedData: boolean;
3019
- };
3020
- /**
3021
- * UserSummary
3022
- * @description Schema for a summary representation of a user.
3023
- * Provides key identifying information, suitable for lists or brief displays.
3024
- */
3025
- UserSummary: {
3026
- /**
3027
- * Id
3028
- * Format: uuid4
3029
- */
3030
- id: string;
3031
- /**
3032
- * Groupid
3033
- * Format: uuid4
3034
- */
3035
- groupId: string;
3036
- /** Username */
3037
- username: string;
3038
- /** Email */
3039
- email?: string | null;
3040
- /** Fullname */
3041
- fullName?: string | null;
3042
- };
3043
- /**
3044
- * UserUpdate
3045
- * @description Schema likely used internally for saving a user to the database,
3046
- * ensuring required fields like `username`, `full_name`, and `password` are present.
3047
- * Extends `UserCreate`.
3048
- * @example {
3049
- * "admin": false,
3050
- * "email": "newuser@example.com",
3051
- * "fullName": "New User Name",
3052
- * "group": "Default",
3053
- * "password": "aSecurePassword123",
3054
- * "username": "NewUser"
3055
- * }
3056
- */
3057
- UserUpdate: {
3058
- /** Id */
3059
- id?: string | null;
3060
- /** Username */
3061
- username: string;
3062
- /** Fullname */
3063
- fullName: string;
3064
- /** Email */
3065
- email: string;
3066
- /** @default MARVIN */
3067
- authMethod: components["schemas"]["AuthMethod"];
3068
- /** @default NONE */
3069
- platformRole: components["schemas"]["PlatformRole"];
3070
- /**
3071
- * Admin
3072
- * @default false
3073
- */
3074
- admin: boolean;
3075
- /**
3076
- * Issuperuser
3077
- * @default false
3078
- */
3079
- isSuperuser: boolean;
3080
- /** Group */
3081
- group?: string | null;
3082
- /**
3083
- * Advanced
3084
- * @default false
3085
- */
3086
- advanced: boolean;
3087
- /** Password */
3088
- password: string;
3089
- /**
3090
- * Caninvite
3091
- * @default false
3092
- */
3093
- canInvite: boolean;
3094
- /**
3095
- * Canmanage
3096
- * @default false
3097
- */
3098
- canManage: boolean;
3099
- /**
3100
- * Canorganize
3101
- * @default false
3102
- */
3103
- canOrganize: boolean;
3104
- };
3105
- /** ValidationError */
3106
- ValidationError: {
3107
- /** Location */
3108
- loc: (string | number)[];
3109
- /** Message */
3110
- msg: string;
3111
- /** Error Type */
3112
- type: string;
3113
- };
3114
- /**
3115
- * WebhookCreate
3116
- * @description Schema for creating a new webhook configuration.
3117
- * Includes fields for enabling the webhook, naming it, specifying the target URL,
3118
- * HTTP method, type, and an optional scheduled time for execution.
3119
- */
3120
- WebhookCreate: {
3121
- /**
3122
- * Enabled
3123
- * @default true
3124
- */
3125
- enabled: boolean;
3126
- /** Name */
3127
- name: string;
3128
- /**
3129
- * Url
3130
- * Format: uri
3131
- */
3132
- url: string;
3133
- /** @default POST */
3134
- method: components["schemas"]["WebhookMethod"];
3135
- /** @default generic */
3136
- webhookType: components["schemas"]["EventDocumentType"];
3137
- /**
3138
- * Scheduledtime
3139
- * Format: date-time
3140
- */
3141
- scheduledTime: string;
3142
- };
3143
- /**
3144
- * WebhookMethod
3145
- * @description Enumeration for HTTP methods supported by webhooks.
3146
- * @enum {string}
3147
- */
3148
- WebhookMethod: "GET" | "POST";
3149
- /**
3150
- * WebhookPagination
3151
- * @description Schema for paginated responses containing a list of webhook configurations.
3152
- */
3153
- WebhookPagination: {
3154
- /**
3155
- * Page
3156
- * @default 1
3157
- */
3158
- page: number;
3159
- /**
3160
- * Per Page
3161
- * @default 10
3162
- */
3163
- per_page: number;
3164
- /**
3165
- * Total
3166
- * @default 0
3167
- */
3168
- total: number;
3169
- /**
3170
- * Total Pages
3171
- * @default 0
3172
- */
3173
- total_pages: number;
3174
- /** Items */
3175
- items: components["schemas"]["WebhookRead"][];
3176
- /** Next */
3177
- next?: string | null;
3178
- /** Previous */
3179
- previous?: string | null;
3180
- };
3181
- /**
3182
- * WebhookRead
3183
- * @description Schema for representing a webhook configuration when read from the system.
3184
- * Extends `WebhookUpdate` by adding the unique `id` of the webhook.
3185
- */
3186
- WebhookRead: {
3187
- /**
3188
- * Enabled
3189
- * @default true
3190
- */
3191
- enabled: boolean;
3192
- /** Name */
3193
- name: string;
3194
- /**
3195
- * Url
3196
- * Format: uri
3197
- */
3198
- url: string;
3199
- /** @default POST */
3200
- method: components["schemas"]["WebhookMethod"];
3201
- /** @default generic */
3202
- webhookType: components["schemas"]["EventDocumentType"];
3203
- /**
3204
- * Scheduledtime
3205
- * Format: date-time
3206
- */
3207
- scheduledTime: string;
3208
- /**
3209
- * Groupid
3210
- * Format: uuid4
3211
- */
3212
- groupId: string;
3213
- /**
3214
- * Id
3215
- * Format: uuid4
3216
- */
3217
- id: string;
3218
- };
3219
- /**
3220
- * WorkspaceActivationRequest
3221
- * @description Request to change active workspace.
3222
- */
3223
- WorkspaceActivationRequest: {
3224
- /** Workspace */
3225
- workspace: string;
3226
- };
3227
- /**
3228
- * WorkspaceInfo
3229
- * @description Public workspace information for publishing API.
3230
- */
3231
- WorkspaceInfo: {
3232
- /** Slug */
3233
- slug: string;
3234
- /** Name */
3235
- name: string;
3236
- };
3237
- /**
3238
- * WorkspaceMemberCreate
3239
- * @description Schema for adding a user to a workspace.
3240
- *
3241
- * Used when a workspace admin wants to invite a user to their workspace.
3242
- */
3243
- WorkspaceMemberCreate: {
3244
- /**
3245
- * Userid
3246
- * Format: uuid4
3247
- */
3248
- userId: string;
3249
- workspaceRole: components["schemas"]["WorkspaceRole"];
3250
- };
3251
- /**
3252
- * WorkspaceMemberUpdate
3253
- * @description Schema for updating a workspace member's role.
3254
- *
3255
- * Used when changing a user's permissions within a workspace.
3256
- */
3257
- WorkspaceMemberUpdate: {
3258
- workspaceRole: components["schemas"]["WorkspaceRole"];
3259
- };
3260
- /**
3261
- * WorkspaceMembershipRead
3262
- * @description Schema for reading a user's workspace membership with role.
3263
- * Represents the relationship between a user and a workspace.
3264
- * Includes user details when loaded with joinedload.
3265
- */
3266
- WorkspaceMembershipRead: {
3267
- /**
3268
- * Id
3269
- * Format: uuid4
3270
- */
3271
- id: string;
3272
- /**
3273
- * Userid
3274
- * Format: uuid4
3275
- */
3276
- userId: string;
3277
- /**
3278
- * Groupid
3279
- * Format: uuid4
3280
- */
3281
- groupId: string;
3282
- workspaceRole: components["schemas"]["WorkspaceRole"];
3283
- user?: components["schemas"]["UserSummary"] | null;
3284
- };
3285
- /**
3286
- * WorkspaceMembershipSummary
3287
- * @description Schema for summarized workspace membership information.
3288
- * Used in user profiles to show which workspaces they belong to.
3289
- */
3290
- WorkspaceMembershipSummary: {
3291
- /**
3292
- * Groupid
3293
- * Format: uuid4
3294
- */
3295
- groupId: string;
3296
- workspaceRole: components["schemas"]["WorkspaceRole"];
3297
- };
3298
- /**
3299
- * WorkspaceRole
3300
- * @description Workspace-level roles for workspace members.
3301
- *
3302
- * Each user-workspace membership has ONE workspace role that determines
3303
- * what they can do within that specific workspace.
3304
- * @enum {string}
3305
- */
3306
- WorkspaceRole: "OWNER" | "ADMIN" | "EDITOR" | "AUTHOR" | "VIEWER";
3307
- /**
3308
- * WorkspaceSiteInfo
3309
- * @description Combined workspace and site configuration response.
3310
- *
3311
- * Returns everything an external site needs to initialize itself.
3312
- */
3313
- WorkspaceSiteInfo: {
3314
- workspace: components["schemas"]["WorkspaceInfo"];
3315
- site: components["schemas"]["SiteConfiguration"];
3316
- };
3317
- /**
3318
- * WorkspaceWithMembership
3319
- * @description Workspace with user's role and active status.
3320
- */
3321
- WorkspaceWithMembership: {
3322
- workspace: components["schemas"]["GroupRead"];
3323
- role: components["schemas"]["WorkspaceRole"];
3324
- /** Isactive */
3325
- isActive: boolean;
3326
- };
3327
- };
3328
- responses: never;
3329
- parameters: never;
3330
- requestBodies: never;
3331
- headers: never;
3332
- pathItems: never;
3333
- }
2
+ import { n as components, A as AuthToken } from './index-BLIrbIHf.js';
3334
3
 
3335
4
  /**
3336
5
  * Platform API Types
@@ -3630,30 +299,8 @@ declare class APIClientsModule {
3630
299
  * Entry Types Module - Platform API
3631
300
  */
3632
301
 
3633
- interface EntryTypeCreate {
3634
- name: string;
3635
- slug?: string;
3636
- description?: string;
3637
- icon?: string;
3638
- color?: string;
3639
- sortOrder?: number;
3640
- isRendered?: boolean;
3641
- schemaJson?: Record<string, unknown>;
3642
- renderingJson?: Record<string, unknown>;
3643
- capabilitiesJson?: Record<string, unknown>;
3644
- }
3645
- interface EntryTypeUpdate {
3646
- name?: string;
3647
- slug?: string;
3648
- description?: string;
3649
- icon?: string;
3650
- color?: string;
3651
- sortOrder?: number;
3652
- isRendered?: boolean;
3653
- schemaJson?: Record<string, unknown>;
3654
- renderingJson?: Record<string, unknown>;
3655
- capabilitiesJson?: Record<string, unknown>;
3656
- }
302
+ type EntryTypeCreate = components['schemas']['EntryTypeCreate'];
303
+ type EntryTypeUpdate = components['schemas']['EntryTypeUpdate'];
3657
304
  declare class EntryTypesModule {
3658
305
  private http;
3659
306
  constructor(http: HttpClient);
@@ -3716,45 +363,15 @@ declare class WorkspaceMembersModule {
3716
363
  * Workspace activation and listing operations
3717
364
  */
3718
365
 
3719
- interface Workspace {
3720
- id: string;
3721
- slug: string;
3722
- name: string;
3723
- description?: string | null;
3724
- }
3725
- interface WorkspaceWithMembership {
3726
- workspace: Workspace;
3727
- role: string;
3728
- isActive: boolean;
3729
- }
366
+ type Workspace = components['schemas']['GroupRead'];
367
+ type WorkspaceCreate = components['schemas']['GroupCreate'];
368
+ type WorkspaceUpdate = components['schemas']['GroupAdminUpdate'];
369
+ type WorkspacePreferences = components['schemas']['GroupPreferencesRead'];
370
+ type WorkspacePreferencesUpdate = components['schemas']['GroupPreferencesUpdate'];
371
+ type WorkspaceWithMembership = components['schemas']['WorkspaceWithMembership'];
3730
372
  interface WorkspaceActivationRequest {
3731
373
  workspace: string;
3732
374
  }
3733
- interface WorkspaceCreate {
3734
- name: string;
3735
- slug?: string;
3736
- description?: string | null;
3737
- }
3738
- interface WorkspaceUpdate {
3739
- name?: string;
3740
- description?: string | null;
3741
- }
3742
- /**
3743
- * Workspace preferences - dynamic key-value store
3744
- * Common keys include: theme, locale, notifications, etc.
3745
- */
3746
- interface WorkspacePreferences {
3747
- theme?: string;
3748
- locale?: string;
3749
- notifications?: boolean;
3750
- [key: string]: unknown;
3751
- }
3752
- interface WorkspacePreferencesUpdate {
3753
- theme?: string;
3754
- locale?: string;
3755
- notifications?: boolean;
3756
- [key: string]: unknown;
3757
- }
3758
375
  declare class WorkspacesModule {
3759
376
  private http;
3760
377
  constructor(http: HttpClient);
@@ -3865,28 +482,9 @@ declare class InvitesModule {
3865
482
  * Manage workspace notifications
3866
483
  */
3867
484
 
3868
- interface Notification {
3869
- id: string;
3870
- name: string;
3871
- enabled: boolean;
3872
- eventType: string;
3873
- url?: string;
3874
- config?: Record<string, any>;
3875
- }
3876
- interface NotificationCreate {
3877
- name: string;
3878
- eventType: string;
3879
- url?: string;
3880
- enabled?: boolean;
3881
- config?: Record<string, any>;
3882
- }
3883
- interface NotificationUpdate {
3884
- name?: string;
3885
- eventType?: string;
3886
- url?: string;
3887
- enabled?: boolean;
3888
- config?: Record<string, any>;
3889
- }
485
+ type Notification = components['schemas']['GroupEventNotifierRead'];
486
+ type NotificationCreate = components['schemas']['GroupEventNotifierCreate'];
487
+ type NotificationUpdate = components['schemas']['GroupEventNotifierUpdate'];
3890
488
  declare class NotificationsModule {
3891
489
  private http;
3892
490
  constructor(http: HttpClient);
@@ -3929,14 +527,7 @@ type Webhook = components['schemas']['WebhookRead'];
3929
527
  type WebhookCreate = components['schemas']['WebhookCreate'];
3930
528
  type WebhookPagination = components['schemas']['WebhookPagination'];
3931
529
  type WebhookMethod = components['schemas']['WebhookMethod'];
3932
- interface WebhookUpdate {
3933
- name?: string;
3934
- url?: string;
3935
- enabled?: boolean;
3936
- eventTypes?: string[];
3937
- method?: WebhookMethod;
3938
- headers?: Record<string, string>;
3939
- }
530
+ type WebhookUpdate = components['schemas']['WebhookCreate'];
3940
531
  declare class WebhooksModule {
3941
532
  private http;
3942
533
  constructor(http: HttpClient);
@@ -4173,38 +764,12 @@ declare class AdminMaintenanceModule {
4173
764
  * User profile and personal API token management
4174
765
  */
4175
766
 
4176
- interface UserProfile {
4177
- id: string;
4178
- username: string;
4179
- email: string;
4180
- fullName?: string | null;
4181
- admin: boolean;
4182
- }
4183
- interface ApiToken {
4184
- id: string;
4185
- name: string;
4186
- description?: string | null;
4187
- lastUsedAt?: string | null;
4188
- createdAt: string;
4189
- expiresAt?: string | null;
4190
- }
4191
- interface ApiTokenCreate {
4192
- name: string;
4193
- description?: string | null;
4194
- expiresAt?: string | null;
4195
- }
4196
- interface ApiTokenWithToken extends ApiToken {
4197
- token: string;
4198
- }
4199
- interface PasswordChange {
4200
- currentPassword: string;
4201
- newPassword: string;
4202
- }
4203
- interface UserProfileUpdate {
4204
- username?: string;
4205
- email?: string;
4206
- fullName?: string | null;
4207
- }
767
+ type UserProfile = components['schemas']['UserRead'];
768
+ type UserProfileUpdate = components['schemas']['UserUpdate'];
769
+ type ApiToken = components['schemas']['LongLiveTokenRead'];
770
+ type ApiTokenCreate = components['schemas']['LongLiveTokenCreate'];
771
+ type ApiTokenWithToken = components['schemas']['LongLiveTokenWithToken'];
772
+ type PasswordChange = components['schemas']['ChangePassword'];
4208
773
  declare class UserModule {
4209
774
  private http;
4210
775
  constructor(http: HttpClient);
@@ -4431,57 +996,11 @@ declare class ThemeModule {
4431
996
  * Manage workspace email templates
4432
997
  */
4433
998
 
4434
- interface EmailTemplateSummary {
4435
- id: string;
4436
- template_type: string;
4437
- group_id: string | null;
4438
- name: string;
4439
- description?: string;
4440
- enabled: boolean;
4441
- created_at: string;
4442
- updated_at: string;
4443
- }
4444
- interface EmailTemplateRead extends EmailTemplateSummary {
4445
- subject: string;
4446
- header_text?: string;
4447
- message_top?: string;
4448
- message_bottom?: string;
4449
- button_text?: string;
4450
- custom_html?: string;
4451
- available_variables?: Record<string, string>;
4452
- }
4453
- interface EmailTemplateCreate {
4454
- template_type: string;
4455
- group_id?: string;
4456
- name: string;
4457
- description?: string;
4458
- subject: string;
4459
- header_text?: string;
4460
- message_top?: string;
4461
- message_bottom?: string;
4462
- button_text?: string;
4463
- custom_html?: string;
4464
- available_variables?: Record<string, string>;
4465
- enabled?: boolean;
4466
- }
4467
- interface EmailTemplateUpdate {
4468
- name?: string;
4469
- description?: string;
4470
- subject?: string;
4471
- header_text?: string;
4472
- message_top?: string;
4473
- message_bottom?: string;
4474
- button_text?: string;
4475
- custom_html?: string;
4476
- available_variables?: Record<string, string>;
4477
- enabled?: boolean;
4478
- }
4479
- interface TestEmailRequest {
4480
- recipient_email: string;
4481
- }
4482
- interface TestEmailResponse {
4483
- message: string;
4484
- }
999
+ type EmailTemplateSummary = components['schemas']['EmailTemplateSummary'];
1000
+ type EmailTemplateRead = components['schemas']['EmailTemplateRead'];
1001
+ type EmailTemplateCreate = components['schemas']['EmailTemplateCreate'];
1002
+ type EmailTemplateUpdate = components['schemas']['EmailTemplateUpdate'];
1003
+ type TestEmailRequest = components['schemas']['EmailTest'];
4485
1004
  /**
4486
1005
  * Email Templates API client for workspace-scoped templates
4487
1006
  */
@@ -4490,41 +1009,30 @@ declare class EmailTemplatesClient {
4490
1009
  constructor(http: HttpClient);
4491
1010
  /**
4492
1011
  * List all email templates for the workspace
4493
- * @param groupId - Workspace ID
4494
1012
  */
4495
1013
  list(groupId: string): Promise<EmailTemplateSummary[]>;
4496
1014
  /**
4497
1015
  * Get a specific email template
4498
- * @param groupId - Workspace ID
4499
- * @param templateId - Template ID
4500
1016
  */
4501
1017
  get(groupId: string, templateId: string): Promise<EmailTemplateRead>;
4502
1018
  /**
4503
1019
  * Create a new email template
4504
- * @param groupId - Workspace ID
4505
- * @param data - Template data
4506
1020
  */
4507
1021
  create(groupId: string, data: EmailTemplateCreate): Promise<EmailTemplateRead>;
4508
1022
  /**
4509
1023
  * Update an email template
4510
- * @param groupId - Workspace ID
4511
- * @param templateId - Template ID
4512
- * @param data - Updated template data
4513
1024
  */
4514
1025
  update(groupId: string, templateId: string, data: EmailTemplateUpdate): Promise<EmailTemplateRead>;
4515
1026
  /**
4516
1027
  * Delete an email template
4517
- * @param groupId - Workspace ID
4518
- * @param templateId - Template ID
4519
1028
  */
4520
1029
  delete(groupId: string, templateId: string): Promise<void>;
4521
1030
  /**
4522
1031
  * Send a test email using a template
4523
- * @param groupId - Workspace ID
4524
- * @param templateId - Template ID
4525
- * @param recipientEmail - Test recipient email address
4526
1032
  */
4527
- sendTest(groupId: string, templateId: string, recipientEmail: string): Promise<TestEmailResponse>;
1033
+ sendTest(groupId: string, templateId: string, recipientEmail: string): Promise<{
1034
+ message: string;
1035
+ }>;
4528
1036
  }
4529
1037
 
4530
1038
  /**
@@ -4693,4 +1201,4 @@ declare class PlatformClient extends HttpClient {
4693
1201
  */
4694
1202
  declare function createPlatformClient(config?: Partial<PlatformClientConfig>): PlatformClient;
4695
1203
 
4696
- export { APIClientsModule, type AdminAboutInfo, AdminMaintenanceModule, AdminSystemModule, AdminUsersModule, type ApiToken, type ApiTokenCreate, type ApiTokenWithToken, type AppTheme, AssetsModule, AuthModule, CollectionsModule, type EmailInvitationRequest, type EmailSettings, type EmailSettingsUpdate, type EmailTemplateCreate, type EmailTemplateRead, type EmailTemplateSummary, type EmailTemplateUpdate, EmailTemplatesClient, EntriesModule, EntryTypesModule, type EventLogEntry, EventLogModule, type EventLogQueryParams, type EventLogSummary, type EventOption, EventsModule, FormsModule, type InviteTokenCreate, type InviteTokenPagination, type InviteTokenSummary, InvitesModule, type MaintenanceStorageDetails, type MaintenanceSummary, type Notification, type NotificationCreate, type NotificationUpdate, NotificationsModule, type PasswordChange, type PasswordResetTokenRequest, type PasswordResetTokenResponse, type PlatformAPIClient, type PlatformAPIClientCreate, type PlatformAPIClientUpdate, type PlatformAPIClientWithToken, type PlatformAsset, type PlatformAssetUpdate, PlatformClient, type PlatformClientConfig, type PlatformCollection, type PlatformCollectionCreate, type PlatformCollectionUpdate, type PlatformEntry, type PlatformEntryCreate, type PlatformEntryType, type PlatformEntryUpdate, type PlatformForm, type PlatformFormCreate, type PlatformFormSubmission, type PlatformFormUpdate, type PlatformResource, type PlatformResourceCreate, type PlatformResourceUpdate, type PlatformWorkspaceMember, type PlatformWorkspaceMemberCreate, type PlatformWorkspaceMemberUpdate, ResourcesModule, type ScheduledTask, type ScheduledTaskCreate, type ScheduledTaskExecutionLog, type ScheduledTaskUpdate, ScheduledTasksModule, type StartupInfo, type SystemStatistics, type TaskTypeInfo, type TestEmailRequest, type TestEmailResponse, ThemeModule, type UnlockUserRequest, type User, type UserCreate, UserModule, type UserPagination, type UserProfile, type UserProfileUpdate, type UserSummary, type UserUpdate, type Webhook, type WebhookCreate, type WebhookMethod, type WebhookPagination, type WebhookUpdate, WebhooksModule, type Workspace, type WorkspaceActivationRequest, type WorkspaceCreate, WorkspaceMembersModule, type WorkspacePreferences, type WorkspacePreferencesUpdate, type WorkspaceUpdate, type WorkspaceWithMembership, WorkspacesModule, createPlatformClient, createPlatformConfigFromEnv };
1204
+ export { APIClientsModule, type AdminAboutInfo, AdminMaintenanceModule, AdminSystemModule, AdminUsersModule, type ApiToken, type ApiTokenCreate, type ApiTokenWithToken, type AppTheme, AssetsModule, AuthModule, CollectionsModule, type EmailInvitationRequest, type EmailSettings, type EmailSettingsUpdate, type EmailTemplateCreate, type EmailTemplateRead, type EmailTemplateSummary, type EmailTemplateUpdate, EmailTemplatesClient, EntriesModule, EntryTypesModule, type EventLogEntry, EventLogModule, type EventLogQueryParams, type EventLogSummary, type EventOption, EventsModule, FormsModule, type InviteTokenCreate, type InviteTokenPagination, type InviteTokenSummary, InvitesModule, type MaintenanceStorageDetails, type MaintenanceSummary, type Notification, type NotificationCreate, type NotificationUpdate, NotificationsModule, type PasswordChange, type PasswordResetTokenRequest, type PasswordResetTokenResponse, type PlatformAPIClient, type PlatformAPIClientCreate, type PlatformAPIClientUpdate, type PlatformAPIClientWithToken, type PlatformAsset, type PlatformAssetUpdate, PlatformClient, type PlatformClientConfig, type PlatformCollection, type PlatformCollectionCreate, type PlatformCollectionUpdate, type PlatformEntry, type PlatformEntryCreate, type PlatformEntryType, type PlatformEntryUpdate, type PlatformForm, type PlatformFormCreate, type PlatformFormSubmission, type PlatformFormUpdate, type PlatformResource, type PlatformResourceCreate, type PlatformResourceUpdate, type PlatformWorkspaceMember, type PlatformWorkspaceMemberCreate, type PlatformWorkspaceMemberUpdate, ResourcesModule, type ScheduledTask, type ScheduledTaskCreate, type ScheduledTaskExecutionLog, type ScheduledTaskUpdate, ScheduledTasksModule, type StartupInfo, type SystemStatistics, type TaskTypeInfo, type TestEmailRequest, ThemeModule, type UnlockUserRequest, type User, type UserCreate, UserModule, type UserPagination, type UserProfile, type UserProfileUpdate, type UserSummary, type UserUpdate, type Webhook, type WebhookCreate, type WebhookMethod, type WebhookPagination, type WebhookUpdate, WebhooksModule, type Workspace, type WorkspaceActivationRequest, type WorkspaceCreate, WorkspaceMembersModule, type WorkspacePreferences, type WorkspacePreferencesUpdate, type WorkspaceUpdate, type WorkspaceWithMembership, WorkspacesModule, createPlatformClient, createPlatformConfigFromEnv };