@inneropen/marvin-sdk 1.11.0-next.3 → 2.0.0-next.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +36 -0
- package/dist/index.d.cts +30 -0
- package/dist/index.d.ts +30 -0
- package/dist/index.js +36 -0
- package/dist/platform.cjs +197 -0
- package/dist/platform.d.cts +871 -61
- package/dist/platform.d.ts +871 -61
- package/dist/platform.js +194 -0
- package/dist/types/index.d.cts +19 -0
- package/dist/types/index.d.ts +19 -0
- package/package.json +8 -2
package/dist/platform.d.ts
CHANGED
|
@@ -560,6 +560,163 @@ interface components {
|
|
|
560
560
|
/** Error */
|
|
561
561
|
error?: string | null;
|
|
562
562
|
};
|
|
563
|
+
/**
|
|
564
|
+
* EmailTemplateCreate
|
|
565
|
+
* @description Schema for creating a new email template.
|
|
566
|
+
*/
|
|
567
|
+
EmailTemplateCreate: {
|
|
568
|
+
/**
|
|
569
|
+
* Templatetype
|
|
570
|
+
* @description Type of email (invitation, password_reset, notification, test)
|
|
571
|
+
*/
|
|
572
|
+
templateType: string;
|
|
573
|
+
/**
|
|
574
|
+
* Groupid
|
|
575
|
+
* @description Workspace ID - null for system-wide templates
|
|
576
|
+
*/
|
|
577
|
+
groupId?: string | null;
|
|
578
|
+
/**
|
|
579
|
+
* Name
|
|
580
|
+
* @description Human-readable template name
|
|
581
|
+
*/
|
|
582
|
+
name: string;
|
|
583
|
+
/**
|
|
584
|
+
* Description
|
|
585
|
+
* @description Description of when this template is used
|
|
586
|
+
*/
|
|
587
|
+
description?: string | null;
|
|
588
|
+
/**
|
|
589
|
+
* Subject
|
|
590
|
+
* @description Email subject line - supports Jinja2 variables
|
|
591
|
+
*/
|
|
592
|
+
subject: string;
|
|
593
|
+
/**
|
|
594
|
+
* Headertext
|
|
595
|
+
* @description Header text (structured mode with default.html)
|
|
596
|
+
*/
|
|
597
|
+
headerText?: string | null;
|
|
598
|
+
/**
|
|
599
|
+
* Messagetop
|
|
600
|
+
* @description Top message (structured mode with default.html)
|
|
601
|
+
*/
|
|
602
|
+
messageTop?: string | null;
|
|
603
|
+
/**
|
|
604
|
+
* Messagebottom
|
|
605
|
+
* @description Bottom message (structured mode with default.html)
|
|
606
|
+
*/
|
|
607
|
+
messageBottom?: string | null;
|
|
608
|
+
/**
|
|
609
|
+
* Buttontext
|
|
610
|
+
* @description Button text (structured mode with default.html)
|
|
611
|
+
*/
|
|
612
|
+
buttonText?: string | null;
|
|
613
|
+
/**
|
|
614
|
+
* Customhtml
|
|
615
|
+
* @description Full custom HTML - if set, overrides structured fields
|
|
616
|
+
*/
|
|
617
|
+
customHtml?: string | null;
|
|
618
|
+
/**
|
|
619
|
+
* Availablevariables
|
|
620
|
+
* @description Documentation of available variables
|
|
621
|
+
*/
|
|
622
|
+
availableVariables?: {
|
|
623
|
+
[key: string]: unknown;
|
|
624
|
+
} | null;
|
|
625
|
+
/**
|
|
626
|
+
* Enabled
|
|
627
|
+
* @description Whether this template is active
|
|
628
|
+
* @default true
|
|
629
|
+
*/
|
|
630
|
+
enabled: boolean;
|
|
631
|
+
};
|
|
632
|
+
/**
|
|
633
|
+
* EmailTemplateRead
|
|
634
|
+
* @description Schema for reading an email template.
|
|
635
|
+
*/
|
|
636
|
+
EmailTemplateRead: {
|
|
637
|
+
/**
|
|
638
|
+
* Id
|
|
639
|
+
* Format: uuid4
|
|
640
|
+
*/
|
|
641
|
+
id: string;
|
|
642
|
+
/** Templatetype */
|
|
643
|
+
templateType: string;
|
|
644
|
+
/** Groupid */
|
|
645
|
+
groupId: string | null;
|
|
646
|
+
/** Name */
|
|
647
|
+
name: string;
|
|
648
|
+
/** Description */
|
|
649
|
+
description: string | null;
|
|
650
|
+
/** Subject */
|
|
651
|
+
subject: string;
|
|
652
|
+
/** Headertext */
|
|
653
|
+
headerText: string | null;
|
|
654
|
+
/** Messagetop */
|
|
655
|
+
messageTop: string | null;
|
|
656
|
+
/** Messagebottom */
|
|
657
|
+
messageBottom: string | null;
|
|
658
|
+
/** Buttontext */
|
|
659
|
+
buttonText: string | null;
|
|
660
|
+
/** Customhtml */
|
|
661
|
+
customHtml: string | null;
|
|
662
|
+
/** Availablevariables */
|
|
663
|
+
availableVariables: {
|
|
664
|
+
[key: string]: unknown;
|
|
665
|
+
} | null;
|
|
666
|
+
/** Enabled */
|
|
667
|
+
enabled: boolean;
|
|
668
|
+
/** Createdat */
|
|
669
|
+
createdAt: string;
|
|
670
|
+
/** Updateat */
|
|
671
|
+
updateAt: string;
|
|
672
|
+
};
|
|
673
|
+
/**
|
|
674
|
+
* EmailTemplateSummary
|
|
675
|
+
* @description Summary schema for listing email templates.
|
|
676
|
+
*/
|
|
677
|
+
EmailTemplateSummary: {
|
|
678
|
+
/**
|
|
679
|
+
* Id
|
|
680
|
+
* Format: uuid4
|
|
681
|
+
*/
|
|
682
|
+
id: string;
|
|
683
|
+
/** Templatetype */
|
|
684
|
+
templateType: string;
|
|
685
|
+
/** Name */
|
|
686
|
+
name: string;
|
|
687
|
+
/** Description */
|
|
688
|
+
description: string | null;
|
|
689
|
+
/** Enabled */
|
|
690
|
+
enabled: boolean;
|
|
691
|
+
};
|
|
692
|
+
/**
|
|
693
|
+
* EmailTemplateUpdate
|
|
694
|
+
* @description Schema for updating an email template.
|
|
695
|
+
*/
|
|
696
|
+
EmailTemplateUpdate: {
|
|
697
|
+
/** Name */
|
|
698
|
+
name?: string | null;
|
|
699
|
+
/** Description */
|
|
700
|
+
description?: string | null;
|
|
701
|
+
/** Subject */
|
|
702
|
+
subject?: string | null;
|
|
703
|
+
/** Headertext */
|
|
704
|
+
headerText?: string | null;
|
|
705
|
+
/** Messagetop */
|
|
706
|
+
messageTop?: string | null;
|
|
707
|
+
/** Messagebottom */
|
|
708
|
+
messageBottom?: string | null;
|
|
709
|
+
/** Buttontext */
|
|
710
|
+
buttonText?: string | null;
|
|
711
|
+
/** Customhtml */
|
|
712
|
+
customHtml?: string | null;
|
|
713
|
+
/** Availablevariables */
|
|
714
|
+
availableVariables?: {
|
|
715
|
+
[key: string]: unknown;
|
|
716
|
+
} | null;
|
|
717
|
+
/** Enabled */
|
|
718
|
+
enabled?: boolean | null;
|
|
719
|
+
};
|
|
563
720
|
/**
|
|
564
721
|
* EmailTest
|
|
565
722
|
* @description Schema for the request body when sending a test email.
|
|
@@ -646,6 +803,9 @@ interface components {
|
|
|
646
803
|
/**
|
|
647
804
|
* EntryCreate
|
|
648
805
|
* @description Schema for creating an entry.
|
|
806
|
+
*
|
|
807
|
+
* BREAKING CHANGE: content_markdown removed, replaced with data_json.
|
|
808
|
+
* Entry content is now schema-driven based on entry_type.schema_json.
|
|
649
809
|
*/
|
|
650
810
|
EntryCreate: {
|
|
651
811
|
/**
|
|
@@ -661,8 +821,13 @@ interface components {
|
|
|
661
821
|
summary?: string | null;
|
|
662
822
|
/** Description */
|
|
663
823
|
description?: string | null;
|
|
664
|
-
/**
|
|
665
|
-
|
|
824
|
+
/**
|
|
825
|
+
* Datajson
|
|
826
|
+
* @description Schema-driven content data (validated against entry_type.schema_json)
|
|
827
|
+
*/
|
|
828
|
+
dataJson?: {
|
|
829
|
+
[key: string]: unknown;
|
|
830
|
+
};
|
|
666
831
|
/**
|
|
667
832
|
* Status
|
|
668
833
|
* @default inbox
|
|
@@ -670,7 +835,14 @@ interface components {
|
|
|
670
835
|
status: string;
|
|
671
836
|
/** Publishedat */
|
|
672
837
|
publishedAt?: string | null;
|
|
673
|
-
/**
|
|
838
|
+
/** Publishat */
|
|
839
|
+
publishAt?: string | null;
|
|
840
|
+
/** Expireat */
|
|
841
|
+
expireAt?: string | null;
|
|
842
|
+
/**
|
|
843
|
+
* Metadatajson
|
|
844
|
+
* @description Custom non-schema metadata (API keys, external IDs, etc.)
|
|
845
|
+
*/
|
|
674
846
|
metadataJson?: {
|
|
675
847
|
[key: string]: unknown;
|
|
676
848
|
} | null;
|
|
@@ -681,9 +853,25 @@ interface components {
|
|
|
681
853
|
/** Resourceids */
|
|
682
854
|
resourceIds?: string[] | null;
|
|
683
855
|
};
|
|
856
|
+
/**
|
|
857
|
+
* EntryOrderItem
|
|
858
|
+
* @description Schema for a single entry order update.
|
|
859
|
+
*/
|
|
860
|
+
EntryOrderItem: {
|
|
861
|
+
/**
|
|
862
|
+
* Entryid
|
|
863
|
+
* Format: uuid4
|
|
864
|
+
*/
|
|
865
|
+
entryId: string;
|
|
866
|
+
/** Sortorder */
|
|
867
|
+
sortOrder: number;
|
|
868
|
+
};
|
|
684
869
|
/**
|
|
685
870
|
* EntryRead
|
|
686
871
|
* @description Schema for reading an entry.
|
|
872
|
+
*
|
|
873
|
+
* BREAKING CHANGE: content_markdown removed, replaced with data_json.
|
|
874
|
+
* Entry content is now schema-driven based on entry_type.schema_json.
|
|
687
875
|
*/
|
|
688
876
|
EntryRead: {
|
|
689
877
|
/**
|
|
@@ -709,13 +897,25 @@ interface components {
|
|
|
709
897
|
summary?: string | null;
|
|
710
898
|
/** Description */
|
|
711
899
|
description?: string | null;
|
|
712
|
-
/**
|
|
713
|
-
|
|
900
|
+
/**
|
|
901
|
+
* Datajson
|
|
902
|
+
* @description Schema-driven content data
|
|
903
|
+
*/
|
|
904
|
+
dataJson?: {
|
|
905
|
+
[key: string]: unknown;
|
|
906
|
+
};
|
|
714
907
|
/** Status */
|
|
715
908
|
status: string;
|
|
716
909
|
/** Publishedat */
|
|
717
910
|
publishedAt?: string | null;
|
|
718
|
-
/**
|
|
911
|
+
/** Publishat */
|
|
912
|
+
publishAt?: string | null;
|
|
913
|
+
/** Expireat */
|
|
914
|
+
expireAt?: string | null;
|
|
915
|
+
/**
|
|
916
|
+
* Metadatajson
|
|
917
|
+
* @description Custom non-schema metadata
|
|
918
|
+
*/
|
|
719
919
|
metadataJson?: {
|
|
720
920
|
[key: string]: unknown;
|
|
721
921
|
} | null;
|
|
@@ -740,6 +940,8 @@ interface components {
|
|
|
740
940
|
* @default []
|
|
741
941
|
*/
|
|
742
942
|
collections: string[];
|
|
943
|
+
/** Order */
|
|
944
|
+
order?: number | null;
|
|
743
945
|
};
|
|
744
946
|
/**
|
|
745
947
|
* EntryTypeCreate
|
|
@@ -766,10 +968,20 @@ interface components {
|
|
|
766
968
|
* @default false
|
|
767
969
|
*/
|
|
768
970
|
isSystem: boolean;
|
|
971
|
+
/**
|
|
972
|
+
* Schema Json
|
|
973
|
+
* @description Entry type schema definition (EntryTypeSchemaDefinition)
|
|
974
|
+
*/
|
|
975
|
+
schema_json?: {
|
|
976
|
+
[key: string]: unknown;
|
|
977
|
+
} | null;
|
|
769
978
|
};
|
|
770
979
|
/**
|
|
771
980
|
* EntryTypeRead
|
|
772
981
|
* @description Schema for reading an entry type.
|
|
982
|
+
*
|
|
983
|
+
* System entry types have group_id=None and are globally available to all workspaces.
|
|
984
|
+
* Workspace-scoped entry types have a specific group_id.
|
|
773
985
|
*/
|
|
774
986
|
EntryTypeRead: {
|
|
775
987
|
/**
|
|
@@ -777,11 +989,8 @@ interface components {
|
|
|
777
989
|
* Format: uuid4
|
|
778
990
|
*/
|
|
779
991
|
id: string;
|
|
780
|
-
/**
|
|
781
|
-
|
|
782
|
-
* Format: uuid4
|
|
783
|
-
*/
|
|
784
|
-
groupId: string;
|
|
992
|
+
/** Groupid */
|
|
993
|
+
groupId: string | null;
|
|
785
994
|
/** Name */
|
|
786
995
|
name: string;
|
|
787
996
|
/** Slug */
|
|
@@ -796,6 +1005,13 @@ interface components {
|
|
|
796
1005
|
sortOrder: number;
|
|
797
1006
|
/** Issystem */
|
|
798
1007
|
isSystem: boolean;
|
|
1008
|
+
/**
|
|
1009
|
+
* Schemajson
|
|
1010
|
+
* @description Entry type schema definition (EntryTypeSchemaDefinition)
|
|
1011
|
+
*/
|
|
1012
|
+
schemaJson?: {
|
|
1013
|
+
[key: string]: unknown;
|
|
1014
|
+
} | null;
|
|
799
1015
|
/** Createdat */
|
|
800
1016
|
createdAt?: string | null;
|
|
801
1017
|
/** Updateat */
|
|
@@ -820,10 +1036,20 @@ interface components {
|
|
|
820
1036
|
sortOrder?: number | null;
|
|
821
1037
|
/** Issystem */
|
|
822
1038
|
isSystem?: boolean | null;
|
|
1039
|
+
/**
|
|
1040
|
+
* Schema Json
|
|
1041
|
+
* @description Entry type schema definition (EntryTypeSchemaDefinition)
|
|
1042
|
+
*/
|
|
1043
|
+
schema_json?: {
|
|
1044
|
+
[key: string]: unknown;
|
|
1045
|
+
} | null;
|
|
823
1046
|
};
|
|
824
1047
|
/**
|
|
825
1048
|
* EntryUpdate
|
|
826
1049
|
* @description Schema for patching an entry.
|
|
1050
|
+
*
|
|
1051
|
+
* BREAKING CHANGE: content_markdown removed, replaced with data_json.
|
|
1052
|
+
* Entry content is now schema-driven based on entry_type.schema_json.
|
|
827
1053
|
*/
|
|
828
1054
|
EntryUpdate: {
|
|
829
1055
|
/** Entry Type Id */
|
|
@@ -836,14 +1062,26 @@ interface components {
|
|
|
836
1062
|
summary?: string | null;
|
|
837
1063
|
/** Description */
|
|
838
1064
|
description?: string | null;
|
|
839
|
-
/**
|
|
840
|
-
|
|
1065
|
+
/**
|
|
1066
|
+
* Datajson
|
|
1067
|
+
* @description Schema-driven content data (validated against entry_type.schema_json)
|
|
1068
|
+
*/
|
|
1069
|
+
dataJson?: {
|
|
1070
|
+
[key: string]: unknown;
|
|
1071
|
+
} | null;
|
|
841
1072
|
/** Status */
|
|
842
1073
|
status?: string | null;
|
|
843
|
-
/**
|
|
844
|
-
|
|
845
|
-
/**
|
|
846
|
-
|
|
1074
|
+
/** Publishedat */
|
|
1075
|
+
publishedAt?: string | null;
|
|
1076
|
+
/** Publishat */
|
|
1077
|
+
publishAt?: string | null;
|
|
1078
|
+
/** Expireat */
|
|
1079
|
+
expireAt?: string | null;
|
|
1080
|
+
/**
|
|
1081
|
+
* Metadatajson
|
|
1082
|
+
* @description Custom non-schema metadata (API keys, external IDs, etc.)
|
|
1083
|
+
*/
|
|
1084
|
+
metadataJson?: {
|
|
847
1085
|
[key: string]: unknown;
|
|
848
1086
|
} | null;
|
|
849
1087
|
/** Collection Ids */
|
|
@@ -859,7 +1097,7 @@ interface components {
|
|
|
859
1097
|
* Helps listeners understand the nature of `EventDocumentDataBase` content.
|
|
860
1098
|
* @enum {string}
|
|
861
1099
|
*/
|
|
862
|
-
EventDocumentType: "generic" | "user" | "workspace" | "entry" | "collection" | "asset" | "webhook" | "member" | "invitation" | "api_token" | "api_client" | "entry_type" | "resource" | "deployment";
|
|
1100
|
+
EventDocumentType: "generic" | "user" | "workspace" | "entry" | "form" | "form_submission" | "collection" | "asset" | "webhook" | "member" | "invitation" | "api_token" | "api_client" | "entry_type" | "resource" | "deployment";
|
|
863
1101
|
/**
|
|
864
1102
|
* EventLogRead
|
|
865
1103
|
* @description Schema for reading an event log entry.
|
|
@@ -1009,6 +1247,165 @@ interface components {
|
|
|
1009
1247
|
/** Email */
|
|
1010
1248
|
email: string;
|
|
1011
1249
|
};
|
|
1250
|
+
/**
|
|
1251
|
+
* FormCreate
|
|
1252
|
+
* @description Schema for creating a form.
|
|
1253
|
+
*/
|
|
1254
|
+
FormCreate: {
|
|
1255
|
+
/** Name */
|
|
1256
|
+
name: string;
|
|
1257
|
+
/** Slug */
|
|
1258
|
+
slug?: string | null;
|
|
1259
|
+
/** Description */
|
|
1260
|
+
description?: string | null;
|
|
1261
|
+
/**
|
|
1262
|
+
* Status
|
|
1263
|
+
* @default draft
|
|
1264
|
+
*/
|
|
1265
|
+
status: string;
|
|
1266
|
+
/** Formschema */
|
|
1267
|
+
formSchema?: {
|
|
1268
|
+
[key: string]: unknown;
|
|
1269
|
+
};
|
|
1270
|
+
/** Settingsjson */
|
|
1271
|
+
settingsJson?: {
|
|
1272
|
+
[key: string]: unknown;
|
|
1273
|
+
} | null;
|
|
1274
|
+
/** Metadatajson */
|
|
1275
|
+
metadataJson?: {
|
|
1276
|
+
[key: string]: unknown;
|
|
1277
|
+
} | null;
|
|
1278
|
+
};
|
|
1279
|
+
/**
|
|
1280
|
+
* FormRead
|
|
1281
|
+
* @description Schema for reading a form.
|
|
1282
|
+
*/
|
|
1283
|
+
FormRead: {
|
|
1284
|
+
/**
|
|
1285
|
+
* Id
|
|
1286
|
+
* Format: uuid4
|
|
1287
|
+
*/
|
|
1288
|
+
id: string;
|
|
1289
|
+
/**
|
|
1290
|
+
* Groupid
|
|
1291
|
+
* Format: uuid4
|
|
1292
|
+
*/
|
|
1293
|
+
groupId: string;
|
|
1294
|
+
/** Slug */
|
|
1295
|
+
slug: string;
|
|
1296
|
+
/** Name */
|
|
1297
|
+
name: string;
|
|
1298
|
+
/** Description */
|
|
1299
|
+
description: string | null;
|
|
1300
|
+
/** Schemajson */
|
|
1301
|
+
schemaJson: {
|
|
1302
|
+
[key: string]: unknown;
|
|
1303
|
+
};
|
|
1304
|
+
/** Settingsjson */
|
|
1305
|
+
settingsJson: {
|
|
1306
|
+
[key: string]: unknown;
|
|
1307
|
+
} | null;
|
|
1308
|
+
/** Metadatajson */
|
|
1309
|
+
metadataJson: {
|
|
1310
|
+
[key: string]: unknown;
|
|
1311
|
+
} | null;
|
|
1312
|
+
/** Status */
|
|
1313
|
+
status: string;
|
|
1314
|
+
/** Submissionscount */
|
|
1315
|
+
submissionsCount: number;
|
|
1316
|
+
/** Lastsubmissionat */
|
|
1317
|
+
lastSubmissionAt: string | null;
|
|
1318
|
+
/** Createdat */
|
|
1319
|
+
createdAt: string | null;
|
|
1320
|
+
/** Updateat */
|
|
1321
|
+
updateAt: string | null;
|
|
1322
|
+
};
|
|
1323
|
+
/**
|
|
1324
|
+
* FormSubmissionRead
|
|
1325
|
+
* @description Schema for reading a form submission.
|
|
1326
|
+
*/
|
|
1327
|
+
FormSubmissionRead: {
|
|
1328
|
+
/**
|
|
1329
|
+
* Id
|
|
1330
|
+
* Format: uuid4
|
|
1331
|
+
*/
|
|
1332
|
+
id: string;
|
|
1333
|
+
/**
|
|
1334
|
+
* Formid
|
|
1335
|
+
* Format: uuid4
|
|
1336
|
+
*/
|
|
1337
|
+
formId: string;
|
|
1338
|
+
/**
|
|
1339
|
+
* Groupid
|
|
1340
|
+
* Format: uuid4
|
|
1341
|
+
*/
|
|
1342
|
+
groupId: string;
|
|
1343
|
+
/** Datajson */
|
|
1344
|
+
dataJson: {
|
|
1345
|
+
[key: string]: unknown;
|
|
1346
|
+
};
|
|
1347
|
+
/** Metadatajson */
|
|
1348
|
+
metadataJson: {
|
|
1349
|
+
[key: string]: unknown;
|
|
1350
|
+
} | null;
|
|
1351
|
+
/** Status */
|
|
1352
|
+
status: string;
|
|
1353
|
+
/** Ipaddress */
|
|
1354
|
+
ipAddress: string | null;
|
|
1355
|
+
/** Useragent */
|
|
1356
|
+
userAgent: string | null;
|
|
1357
|
+
/** Referrer */
|
|
1358
|
+
referrer: string | null;
|
|
1359
|
+
/**
|
|
1360
|
+
* Submittedat
|
|
1361
|
+
* Format: date-time
|
|
1362
|
+
*/
|
|
1363
|
+
submittedAt: string;
|
|
1364
|
+
/** Processedat */
|
|
1365
|
+
processedAt: string | null;
|
|
1366
|
+
};
|
|
1367
|
+
/**
|
|
1368
|
+
* FormSubmissionResponse
|
|
1369
|
+
* @description Response after form submission.
|
|
1370
|
+
*
|
|
1371
|
+
* Indicates success/failure and optionally provides redirect URL.
|
|
1372
|
+
*/
|
|
1373
|
+
FormSubmissionResponse: {
|
|
1374
|
+
/** Success */
|
|
1375
|
+
success: boolean;
|
|
1376
|
+
/** Message */
|
|
1377
|
+
message: string;
|
|
1378
|
+
/** Submissionid */
|
|
1379
|
+
submissionId?: string | null;
|
|
1380
|
+
/** Redirecturl */
|
|
1381
|
+
redirectUrl?: string | null;
|
|
1382
|
+
};
|
|
1383
|
+
/**
|
|
1384
|
+
* FormUpdate
|
|
1385
|
+
* @description Schema for updating a form.
|
|
1386
|
+
*/
|
|
1387
|
+
FormUpdate: {
|
|
1388
|
+
/** Name */
|
|
1389
|
+
name?: string | null;
|
|
1390
|
+
/** Slug */
|
|
1391
|
+
slug?: string | null;
|
|
1392
|
+
/** Description */
|
|
1393
|
+
description?: string | null;
|
|
1394
|
+
/** Status */
|
|
1395
|
+
status?: string | null;
|
|
1396
|
+
/** Formschema */
|
|
1397
|
+
formSchema?: {
|
|
1398
|
+
[key: string]: unknown;
|
|
1399
|
+
} | null;
|
|
1400
|
+
/** Settingsjson */
|
|
1401
|
+
settingsJson?: {
|
|
1402
|
+
[key: string]: unknown;
|
|
1403
|
+
} | null;
|
|
1404
|
+
/** Metadatajson */
|
|
1405
|
+
metadataJson?: {
|
|
1406
|
+
[key: string]: unknown;
|
|
1407
|
+
} | null;
|
|
1408
|
+
};
|
|
1012
1409
|
/**
|
|
1013
1410
|
* GroupAdminUpdate
|
|
1014
1411
|
* @description Schema for administrators to update a group.
|
|
@@ -1603,15 +2000,10 @@ interface components {
|
|
|
1603
2000
|
description?: string | null;
|
|
1604
2001
|
/** Publicurl */
|
|
1605
2002
|
publicUrl: string;
|
|
1606
|
-
/**
|
|
1607
|
-
|
|
2003
|
+
/** Metadatajson */
|
|
2004
|
+
metadataJson?: {
|
|
1608
2005
|
[key: string]: unknown;
|
|
1609
2006
|
} | null;
|
|
1610
|
-
/**
|
|
1611
|
-
* Entries
|
|
1612
|
-
* @default []
|
|
1613
|
-
*/
|
|
1614
|
-
entries: string[];
|
|
1615
2007
|
};
|
|
1616
2008
|
/**
|
|
1617
2009
|
* PublishedAssetsResponse
|
|
@@ -1644,8 +2036,8 @@ interface components {
|
|
|
1644
2036
|
smartRules?: {
|
|
1645
2037
|
[key: string]: unknown;
|
|
1646
2038
|
} | null;
|
|
1647
|
-
/**
|
|
1648
|
-
|
|
2039
|
+
/** Metadatajson */
|
|
2040
|
+
metadataJson?: {
|
|
1649
2041
|
[key: string]: unknown;
|
|
1650
2042
|
} | null;
|
|
1651
2043
|
/** Entrycount */
|
|
@@ -1656,35 +2048,21 @@ interface components {
|
|
|
1656
2048
|
/**
|
|
1657
2049
|
* PublishedCollectionSummary
|
|
1658
2050
|
* @description Summary schema for published collections (for listing).
|
|
2051
|
+
*
|
|
2052
|
+
* Minimal collection info for entry contexts - only includes
|
|
2053
|
+
* essential fields for display and ordering.
|
|
1659
2054
|
*/
|
|
1660
2055
|
PublishedCollectionSummary: {
|
|
1661
2056
|
/** Slug */
|
|
1662
2057
|
slug: string;
|
|
1663
2058
|
/** Name */
|
|
1664
2059
|
name: string;
|
|
1665
|
-
/**
|
|
1666
|
-
|
|
1667
|
-
/**
|
|
1668
|
-
* Issmart
|
|
1669
|
-
* @default false
|
|
1670
|
-
*/
|
|
1671
|
-
isSmart: boolean;
|
|
1672
|
-
/** Smartrules */
|
|
1673
|
-
smartRules?: {
|
|
1674
|
-
[key: string]: unknown;
|
|
1675
|
-
} | null;
|
|
1676
|
-
/** Metadata */
|
|
1677
|
-
metadata?: {
|
|
2060
|
+
/** Metadatajson */
|
|
2061
|
+
metadataJson?: {
|
|
1678
2062
|
[key: string]: unknown;
|
|
1679
2063
|
} | null;
|
|
1680
|
-
/** Entrycount */
|
|
1681
|
-
entryCount: number;
|
|
1682
2064
|
/** Sortorder */
|
|
1683
2065
|
sortOrder: number;
|
|
1684
|
-
/** Icon */
|
|
1685
|
-
icon?: string | null;
|
|
1686
|
-
/** Color */
|
|
1687
|
-
color?: string | null;
|
|
1688
2066
|
};
|
|
1689
2067
|
/**
|
|
1690
2068
|
* PublishedCollectionsResponse
|
|
@@ -1722,21 +2100,25 @@ interface components {
|
|
|
1722
2100
|
summary?: string | null;
|
|
1723
2101
|
/** Publishedat */
|
|
1724
2102
|
publishedAt?: string | null;
|
|
2103
|
+
/** Status */
|
|
2104
|
+
status: string;
|
|
1725
2105
|
/**
|
|
1726
2106
|
* Collections
|
|
1727
2107
|
* @default []
|
|
1728
2108
|
*/
|
|
1729
2109
|
collections: string[];
|
|
1730
2110
|
/**
|
|
1731
|
-
*
|
|
2111
|
+
* Assetslugs
|
|
1732
2112
|
* @default []
|
|
1733
2113
|
*/
|
|
1734
|
-
|
|
2114
|
+
assetSlugs: string[];
|
|
1735
2115
|
/**
|
|
1736
|
-
*
|
|
2116
|
+
* Resourceslugs
|
|
1737
2117
|
* @default []
|
|
1738
2118
|
*/
|
|
1739
|
-
|
|
2119
|
+
resourceSlugs: string[];
|
|
2120
|
+
/** Order */
|
|
2121
|
+
order?: number | null;
|
|
1740
2122
|
};
|
|
1741
2123
|
/**
|
|
1742
2124
|
* PublishedEntryRead
|
|
@@ -1744,6 +2126,9 @@ interface components {
|
|
|
1744
2126
|
*
|
|
1745
2127
|
* Only includes public-facing fields. Excludes all admin metadata,
|
|
1746
2128
|
* internal fields, and user information.
|
|
2129
|
+
*
|
|
2130
|
+
* BREAKING CHANGE: content_markdown removed, replaced with data.
|
|
2131
|
+
* Entry content is now schema-driven based on entry_type.schema_json.
|
|
1747
2132
|
*/
|
|
1748
2133
|
PublishedEntryRead: {
|
|
1749
2134
|
/** Slug */
|
|
@@ -1754,12 +2139,14 @@ interface components {
|
|
|
1754
2139
|
entryType: string;
|
|
1755
2140
|
/** Summary */
|
|
1756
2141
|
summary?: string | null;
|
|
1757
|
-
/**
|
|
1758
|
-
|
|
2142
|
+
/** Data */
|
|
2143
|
+
data: {
|
|
2144
|
+
[key: string]: unknown;
|
|
2145
|
+
};
|
|
1759
2146
|
/** Publishedat */
|
|
1760
2147
|
publishedAt?: string | null;
|
|
1761
|
-
/**
|
|
1762
|
-
|
|
2148
|
+
/** Metadatajson */
|
|
2149
|
+
metadataJson?: {
|
|
1763
2150
|
[key: string]: unknown;
|
|
1764
2151
|
} | null;
|
|
1765
2152
|
/**
|
|
@@ -1777,6 +2164,31 @@ interface components {
|
|
|
1777
2164
|
* @default []
|
|
1778
2165
|
*/
|
|
1779
2166
|
assets: components["schemas"]["PublishedAssetRead"][];
|
|
2167
|
+
/** Order */
|
|
2168
|
+
order?: number | null;
|
|
2169
|
+
};
|
|
2170
|
+
/**
|
|
2171
|
+
* PublishedFormRead
|
|
2172
|
+
* @description Schema for published forms in the publishing API.
|
|
2173
|
+
*
|
|
2174
|
+
* Provides form definition for frontend to render the form.
|
|
2175
|
+
* Does not expose internal fields like submissions_count.
|
|
2176
|
+
*/
|
|
2177
|
+
PublishedFormRead: {
|
|
2178
|
+
/** Slug */
|
|
2179
|
+
slug: string;
|
|
2180
|
+
/** Name */
|
|
2181
|
+
name: string;
|
|
2182
|
+
/** Description */
|
|
2183
|
+
description?: string | null;
|
|
2184
|
+
/** Formschema */
|
|
2185
|
+
formSchema: {
|
|
2186
|
+
[key: string]: unknown;
|
|
2187
|
+
};
|
|
2188
|
+
/** Metadata */
|
|
2189
|
+
metadata?: {
|
|
2190
|
+
[key: string]: unknown;
|
|
2191
|
+
} | null;
|
|
1780
2192
|
};
|
|
1781
2193
|
/**
|
|
1782
2194
|
* PublishedResourceRead
|
|
@@ -1797,8 +2209,8 @@ interface components {
|
|
|
1797
2209
|
url?: string | null;
|
|
1798
2210
|
/** Externalid */
|
|
1799
2211
|
externalId?: string | null;
|
|
1800
|
-
/**
|
|
1801
|
-
|
|
2212
|
+
/** Metadatajson */
|
|
2213
|
+
metadataJson?: {
|
|
1802
2214
|
[key: string]: unknown;
|
|
1803
2215
|
} | null;
|
|
1804
2216
|
/** Role */
|
|
@@ -1833,8 +2245,8 @@ interface components {
|
|
|
1833
2245
|
url?: string | null;
|
|
1834
2246
|
/** Externalid */
|
|
1835
2247
|
externalId?: string | null;
|
|
1836
|
-
/**
|
|
1837
|
-
|
|
2248
|
+
/** Metadatajson */
|
|
2249
|
+
metadataJson?: {
|
|
1838
2250
|
[key: string]: unknown;
|
|
1839
2251
|
} | null;
|
|
1840
2252
|
/**
|
|
@@ -1852,6 +2264,14 @@ interface components {
|
|
|
1852
2264
|
data: components["schemas"]["PublishedResourceSummary"][];
|
|
1853
2265
|
meta: components["schemas"]["PaginationMeta"];
|
|
1854
2266
|
};
|
|
2267
|
+
/**
|
|
2268
|
+
* ReorderEntriesRequest
|
|
2269
|
+
* @description Schema for bulk reordering entries in a collection.
|
|
2270
|
+
*/
|
|
2271
|
+
ReorderEntriesRequest: {
|
|
2272
|
+
/** Entries */
|
|
2273
|
+
entries: components["schemas"]["EntryOrderItem"][];
|
|
2274
|
+
};
|
|
1855
2275
|
/**
|
|
1856
2276
|
* ResetPassword
|
|
1857
2277
|
* @description Schema for the actual password reset operation.
|
|
@@ -1968,6 +2388,154 @@ interface components {
|
|
|
1968
2388
|
[key: string]: unknown;
|
|
1969
2389
|
} | null;
|
|
1970
2390
|
};
|
|
2391
|
+
/**
|
|
2392
|
+
* ScheduledTaskCreate
|
|
2393
|
+
* @description Schema for creating a new scheduled task.
|
|
2394
|
+
*/
|
|
2395
|
+
ScheduledTaskCreate: {
|
|
2396
|
+
/** Name */
|
|
2397
|
+
name: string;
|
|
2398
|
+
/** Slug */
|
|
2399
|
+
slug?: string | null;
|
|
2400
|
+
/** Description */
|
|
2401
|
+
description?: string | null;
|
|
2402
|
+
/**
|
|
2403
|
+
* Enabled
|
|
2404
|
+
* @default true
|
|
2405
|
+
*/
|
|
2406
|
+
enabled: boolean;
|
|
2407
|
+
/**
|
|
2408
|
+
* Scheduletype
|
|
2409
|
+
* @enum {string}
|
|
2410
|
+
*/
|
|
2411
|
+
scheduleType: "cron" | "interval" | "once";
|
|
2412
|
+
/** Scheduleconfig */
|
|
2413
|
+
scheduleConfig: {
|
|
2414
|
+
[key: string]: unknown;
|
|
2415
|
+
};
|
|
2416
|
+
/** Tasktype */
|
|
2417
|
+
taskType: string;
|
|
2418
|
+
/** Taskconfig */
|
|
2419
|
+
taskConfig?: {
|
|
2420
|
+
[key: string]: unknown;
|
|
2421
|
+
};
|
|
2422
|
+
/** Retrypolicy */
|
|
2423
|
+
retryPolicy?: {
|
|
2424
|
+
[key: string]: unknown;
|
|
2425
|
+
} | null;
|
|
2426
|
+
};
|
|
2427
|
+
/**
|
|
2428
|
+
* ScheduledTaskExecutionLogRead
|
|
2429
|
+
* @description Schema for reading a scheduled task execution log entry.
|
|
2430
|
+
*/
|
|
2431
|
+
ScheduledTaskExecutionLogRead: {
|
|
2432
|
+
/**
|
|
2433
|
+
* Id
|
|
2434
|
+
* Format: uuid4
|
|
2435
|
+
*/
|
|
2436
|
+
id: string;
|
|
2437
|
+
/**
|
|
2438
|
+
* Taskid
|
|
2439
|
+
* Format: uuid4
|
|
2440
|
+
*/
|
|
2441
|
+
taskId: string;
|
|
2442
|
+
/** Groupid */
|
|
2443
|
+
groupId?: string | null;
|
|
2444
|
+
/**
|
|
2445
|
+
* Executedat
|
|
2446
|
+
* Format: date-time
|
|
2447
|
+
*/
|
|
2448
|
+
executedAt: string;
|
|
2449
|
+
/** Status */
|
|
2450
|
+
status: string;
|
|
2451
|
+
/** Durationms */
|
|
2452
|
+
durationMs?: number | null;
|
|
2453
|
+
/** Errormessage */
|
|
2454
|
+
errorMessage?: string | null;
|
|
2455
|
+
/** Errortraceback */
|
|
2456
|
+
errorTraceback?: string | null;
|
|
2457
|
+
/** Retryattempt */
|
|
2458
|
+
retryAttempt: number;
|
|
2459
|
+
};
|
|
2460
|
+
/**
|
|
2461
|
+
* ScheduledTaskRead
|
|
2462
|
+
* @description Full schema for reading a scheduled task.
|
|
2463
|
+
*/
|
|
2464
|
+
ScheduledTaskRead: {
|
|
2465
|
+
/**
|
|
2466
|
+
* Id
|
|
2467
|
+
* Format: uuid4
|
|
2468
|
+
*/
|
|
2469
|
+
id: string;
|
|
2470
|
+
/** Name */
|
|
2471
|
+
name: string;
|
|
2472
|
+
/** Slug */
|
|
2473
|
+
slug: string;
|
|
2474
|
+
/** Description */
|
|
2475
|
+
description?: string | null;
|
|
2476
|
+
/** Enabled */
|
|
2477
|
+
enabled: boolean;
|
|
2478
|
+
/** Scheduletype */
|
|
2479
|
+
scheduleType: string;
|
|
2480
|
+
/** Tasktype */
|
|
2481
|
+
taskType: string;
|
|
2482
|
+
/** Lastrunat */
|
|
2483
|
+
lastRunAt?: string | null;
|
|
2484
|
+
/** Nextrunat */
|
|
2485
|
+
nextRunAt?: string | null;
|
|
2486
|
+
/** Laststatus */
|
|
2487
|
+
lastStatus?: string | null;
|
|
2488
|
+
/** Failurecount */
|
|
2489
|
+
failureCount: number;
|
|
2490
|
+
/** Createdat */
|
|
2491
|
+
createdAt?: string | null;
|
|
2492
|
+
/** Updateat */
|
|
2493
|
+
updateAt?: string | null;
|
|
2494
|
+
/** Groupid */
|
|
2495
|
+
groupId?: string | null;
|
|
2496
|
+
/** Scheduleconfig */
|
|
2497
|
+
scheduleConfig: {
|
|
2498
|
+
[key: string]: unknown;
|
|
2499
|
+
};
|
|
2500
|
+
/** Taskconfig */
|
|
2501
|
+
taskConfig: {
|
|
2502
|
+
[key: string]: unknown;
|
|
2503
|
+
};
|
|
2504
|
+
/** Retrypolicy */
|
|
2505
|
+
retryPolicy?: {
|
|
2506
|
+
[key: string]: unknown;
|
|
2507
|
+
} | null;
|
|
2508
|
+
/** Lastdurationms */
|
|
2509
|
+
lastDurationMs?: number | null;
|
|
2510
|
+
};
|
|
2511
|
+
/**
|
|
2512
|
+
* ScheduledTaskUpdate
|
|
2513
|
+
* @description Schema for updating a scheduled task.
|
|
2514
|
+
*/
|
|
2515
|
+
ScheduledTaskUpdate: {
|
|
2516
|
+
/** Name */
|
|
2517
|
+
name?: string | null;
|
|
2518
|
+
/** Description */
|
|
2519
|
+
description?: string | null;
|
|
2520
|
+
/** Enabled */
|
|
2521
|
+
enabled?: boolean | null;
|
|
2522
|
+
/** Scheduletype */
|
|
2523
|
+
scheduleType?: ("cron" | "interval" | "once") | null;
|
|
2524
|
+
/** Scheduleconfig */
|
|
2525
|
+
scheduleConfig?: {
|
|
2526
|
+
[key: string]: unknown;
|
|
2527
|
+
} | null;
|
|
2528
|
+
/** Tasktype */
|
|
2529
|
+
taskType?: string | null;
|
|
2530
|
+
/** Taskconfig */
|
|
2531
|
+
taskConfig?: {
|
|
2532
|
+
[key: string]: unknown;
|
|
2533
|
+
} | null;
|
|
2534
|
+
/** Retrypolicy */
|
|
2535
|
+
retryPolicy?: {
|
|
2536
|
+
[key: string]: unknown;
|
|
2537
|
+
} | null;
|
|
2538
|
+
};
|
|
1971
2539
|
/**
|
|
1972
2540
|
* SiteConfiguration
|
|
1973
2541
|
* @description Site configuration for publishing API.
|
|
@@ -2004,8 +2572,8 @@ interface components {
|
|
|
2004
2572
|
social?: {
|
|
2005
2573
|
[key: string]: unknown;
|
|
2006
2574
|
} | null;
|
|
2007
|
-
/**
|
|
2008
|
-
|
|
2575
|
+
/** Metadatajson */
|
|
2576
|
+
metadataJson?: {
|
|
2009
2577
|
[key: string]: unknown;
|
|
2010
2578
|
} | null;
|
|
2011
2579
|
};
|
|
@@ -2057,6 +2625,17 @@ interface components {
|
|
|
2057
2625
|
/** Data Dir Path */
|
|
2058
2626
|
data_dir_path: string;
|
|
2059
2627
|
};
|
|
2628
|
+
/**
|
|
2629
|
+
* TestEmailRequest
|
|
2630
|
+
* @description Request to send a test email.
|
|
2631
|
+
*/
|
|
2632
|
+
TestEmailRequest: {
|
|
2633
|
+
/**
|
|
2634
|
+
* Recipient Email
|
|
2635
|
+
* Format: email
|
|
2636
|
+
*/
|
|
2637
|
+
recipient_email: string;
|
|
2638
|
+
};
|
|
2060
2639
|
/**
|
|
2061
2640
|
* TokenResponseDelete
|
|
2062
2641
|
* @description Schema for the response after successfully deleting an API token.
|
|
@@ -2173,6 +2752,20 @@ interface components {
|
|
|
2173
2752
|
/** Previous */
|
|
2174
2753
|
previous?: string | null;
|
|
2175
2754
|
};
|
|
2755
|
+
/**
|
|
2756
|
+
* UserProfileUpdate
|
|
2757
|
+
* @description Schema for updating a user's profile information (without password).
|
|
2758
|
+
* All fields are optional for partial updates.
|
|
2759
|
+
* Used by the /api/self endpoint for users updating their own profile.
|
|
2760
|
+
*/
|
|
2761
|
+
UserProfileUpdate: {
|
|
2762
|
+
/** Username */
|
|
2763
|
+
username?: string | null;
|
|
2764
|
+
/** Email */
|
|
2765
|
+
email?: string | null;
|
|
2766
|
+
/** Fullname */
|
|
2767
|
+
fullName?: string | null;
|
|
2768
|
+
};
|
|
2176
2769
|
/**
|
|
2177
2770
|
* UserRead
|
|
2178
2771
|
* @description Schema for representing a user when read from the system.
|
|
@@ -2664,6 +3257,16 @@ type PlatformWorkspaceMemberUpdate = components['schemas']['WorkspaceMemberUpdat
|
|
|
2664
3257
|
*/
|
|
2665
3258
|
type EventLogEntry = components['schemas']['EventLogRead'];
|
|
2666
3259
|
type EventLogSummary = components['schemas']['EventLogSummary'];
|
|
3260
|
+
/**
|
|
3261
|
+
* Forms (Platform API - full CRUD)
|
|
3262
|
+
*/
|
|
3263
|
+
type PlatformForm = components['schemas']['FormRead'];
|
|
3264
|
+
type PlatformFormCreate = components['schemas']['FormCreate'];
|
|
3265
|
+
type PlatformFormUpdate = components['schemas']['FormUpdate'];
|
|
3266
|
+
/**
|
|
3267
|
+
* Form Submissions (Platform API - read access)
|
|
3268
|
+
*/
|
|
3269
|
+
type PlatformFormSubmission = components['schemas']['FormSubmissionRead'];
|
|
2667
3270
|
|
|
2668
3271
|
/**
|
|
2669
3272
|
* Entries Module - Platform API
|
|
@@ -2872,6 +3475,7 @@ interface EntryTypeCreate {
|
|
|
2872
3475
|
icon?: string;
|
|
2873
3476
|
color?: string;
|
|
2874
3477
|
sortOrder?: number;
|
|
3478
|
+
schemaJson?: Record<string, unknown>;
|
|
2875
3479
|
}
|
|
2876
3480
|
interface EntryTypeUpdate {
|
|
2877
3481
|
name?: string;
|
|
@@ -2880,6 +3484,7 @@ interface EntryTypeUpdate {
|
|
|
2880
3484
|
icon?: string;
|
|
2881
3485
|
color?: string;
|
|
2882
3486
|
sortOrder?: number;
|
|
3487
|
+
schemaJson?: Record<string, unknown>;
|
|
2883
3488
|
}
|
|
2884
3489
|
declare class EntryTypesModule {
|
|
2885
3490
|
private http;
|
|
@@ -3593,6 +4198,208 @@ declare class ThemeModule {
|
|
|
3593
4198
|
getTheme(): Promise<AppTheme>;
|
|
3594
4199
|
}
|
|
3595
4200
|
|
|
4201
|
+
/**
|
|
4202
|
+
* Email Templates Module - Platform API
|
|
4203
|
+
*
|
|
4204
|
+
* Manage workspace email templates
|
|
4205
|
+
*/
|
|
4206
|
+
|
|
4207
|
+
interface EmailTemplateSummary {
|
|
4208
|
+
id: string;
|
|
4209
|
+
template_type: string;
|
|
4210
|
+
group_id: string | null;
|
|
4211
|
+
name: string;
|
|
4212
|
+
description?: string;
|
|
4213
|
+
enabled: boolean;
|
|
4214
|
+
created_at: string;
|
|
4215
|
+
update_at: string;
|
|
4216
|
+
}
|
|
4217
|
+
interface EmailTemplateRead extends EmailTemplateSummary {
|
|
4218
|
+
subject: string;
|
|
4219
|
+
header_text?: string;
|
|
4220
|
+
message_top?: string;
|
|
4221
|
+
message_bottom?: string;
|
|
4222
|
+
button_text?: string;
|
|
4223
|
+
custom_html?: string;
|
|
4224
|
+
available_variables?: Record<string, string>;
|
|
4225
|
+
}
|
|
4226
|
+
interface EmailTemplateCreate {
|
|
4227
|
+
template_type: string;
|
|
4228
|
+
group_id?: string;
|
|
4229
|
+
name: string;
|
|
4230
|
+
description?: string;
|
|
4231
|
+
subject: string;
|
|
4232
|
+
header_text?: string;
|
|
4233
|
+
message_top?: string;
|
|
4234
|
+
message_bottom?: string;
|
|
4235
|
+
button_text?: string;
|
|
4236
|
+
custom_html?: string;
|
|
4237
|
+
available_variables?: Record<string, string>;
|
|
4238
|
+
enabled?: boolean;
|
|
4239
|
+
}
|
|
4240
|
+
interface EmailTemplateUpdate {
|
|
4241
|
+
name?: string;
|
|
4242
|
+
description?: string;
|
|
4243
|
+
subject?: string;
|
|
4244
|
+
header_text?: string;
|
|
4245
|
+
message_top?: string;
|
|
4246
|
+
message_bottom?: string;
|
|
4247
|
+
button_text?: string;
|
|
4248
|
+
custom_html?: string;
|
|
4249
|
+
available_variables?: Record<string, string>;
|
|
4250
|
+
enabled?: boolean;
|
|
4251
|
+
}
|
|
4252
|
+
interface TestEmailRequest {
|
|
4253
|
+
recipient_email: string;
|
|
4254
|
+
}
|
|
4255
|
+
interface TestEmailResponse {
|
|
4256
|
+
message: string;
|
|
4257
|
+
}
|
|
4258
|
+
/**
|
|
4259
|
+
* Email Templates API client for workspace-scoped templates
|
|
4260
|
+
*/
|
|
4261
|
+
declare class EmailTemplatesClient {
|
|
4262
|
+
private readonly http;
|
|
4263
|
+
constructor(http: HttpClient);
|
|
4264
|
+
/**
|
|
4265
|
+
* List all email templates for the workspace
|
|
4266
|
+
* @param groupId - Workspace ID
|
|
4267
|
+
*/
|
|
4268
|
+
list(groupId: string): Promise<EmailTemplateSummary[]>;
|
|
4269
|
+
/**
|
|
4270
|
+
* Get a specific email template
|
|
4271
|
+
* @param groupId - Workspace ID
|
|
4272
|
+
* @param templateId - Template ID
|
|
4273
|
+
*/
|
|
4274
|
+
get(groupId: string, templateId: string): Promise<EmailTemplateRead>;
|
|
4275
|
+
/**
|
|
4276
|
+
* Create a new email template
|
|
4277
|
+
* @param groupId - Workspace ID
|
|
4278
|
+
* @param data - Template data
|
|
4279
|
+
*/
|
|
4280
|
+
create(groupId: string, data: EmailTemplateCreate): Promise<EmailTemplateRead>;
|
|
4281
|
+
/**
|
|
4282
|
+
* Update an email template
|
|
4283
|
+
* @param groupId - Workspace ID
|
|
4284
|
+
* @param templateId - Template ID
|
|
4285
|
+
* @param data - Updated template data
|
|
4286
|
+
*/
|
|
4287
|
+
update(groupId: string, templateId: string, data: EmailTemplateUpdate): Promise<EmailTemplateRead>;
|
|
4288
|
+
/**
|
|
4289
|
+
* Delete an email template
|
|
4290
|
+
* @param groupId - Workspace ID
|
|
4291
|
+
* @param templateId - Template ID
|
|
4292
|
+
*/
|
|
4293
|
+
delete(groupId: string, templateId: string): Promise<void>;
|
|
4294
|
+
/**
|
|
4295
|
+
* Send a test email using a template
|
|
4296
|
+
* @param groupId - Workspace ID
|
|
4297
|
+
* @param templateId - Template ID
|
|
4298
|
+
* @param recipientEmail - Test recipient email address
|
|
4299
|
+
*/
|
|
4300
|
+
sendTest(groupId: string, templateId: string, recipientEmail: string): Promise<TestEmailResponse>;
|
|
4301
|
+
}
|
|
4302
|
+
|
|
4303
|
+
/**
|
|
4304
|
+
* Scheduled Tasks Module - Platform API
|
|
4305
|
+
*
|
|
4306
|
+
* Manage workspace scheduled task automation
|
|
4307
|
+
*/
|
|
4308
|
+
|
|
4309
|
+
type ScheduledTask = components['schemas']['ScheduledTaskRead'];
|
|
4310
|
+
type ScheduledTaskCreate = components['schemas']['ScheduledTaskCreate'];
|
|
4311
|
+
type ScheduledTaskUpdate = components['schemas']['ScheduledTaskUpdate'];
|
|
4312
|
+
type ScheduledTaskExecutionLog = components['schemas']['ScheduledTaskExecutionLogRead'];
|
|
4313
|
+
interface TaskTypeInfo {
|
|
4314
|
+
task_type: string;
|
|
4315
|
+
name: string;
|
|
4316
|
+
description: string;
|
|
4317
|
+
config_schema?: any;
|
|
4318
|
+
}
|
|
4319
|
+
declare class ScheduledTasksModule {
|
|
4320
|
+
private http;
|
|
4321
|
+
constructor(http: HttpClient);
|
|
4322
|
+
/**
|
|
4323
|
+
* List all scheduled tasks for the current workspace
|
|
4324
|
+
*/
|
|
4325
|
+
list(): Promise<ScheduledTask[]>;
|
|
4326
|
+
/**
|
|
4327
|
+
* Get a scheduled task by ID or slug
|
|
4328
|
+
*/
|
|
4329
|
+
get(idOrSlug: string): Promise<ScheduledTask>;
|
|
4330
|
+
/**
|
|
4331
|
+
* Create a new scheduled task
|
|
4332
|
+
*/
|
|
4333
|
+
create(data: ScheduledTaskCreate): Promise<ScheduledTask>;
|
|
4334
|
+
/**
|
|
4335
|
+
* Update a scheduled task
|
|
4336
|
+
*/
|
|
4337
|
+
update(idOrSlug: string, data: ScheduledTaskUpdate): Promise<ScheduledTask>;
|
|
4338
|
+
/**
|
|
4339
|
+
* Delete a scheduled task
|
|
4340
|
+
*/
|
|
4341
|
+
delete(idOrSlug: string): Promise<void>;
|
|
4342
|
+
/**
|
|
4343
|
+
* Manually trigger task execution (bypass schedule)
|
|
4344
|
+
*/
|
|
4345
|
+
execute(idOrSlug: string): Promise<void>;
|
|
4346
|
+
/**
|
|
4347
|
+
* Get task execution history
|
|
4348
|
+
*/
|
|
4349
|
+
history(idOrSlug: string, options?: {
|
|
4350
|
+
limit?: number;
|
|
4351
|
+
}): Promise<ScheduledTaskExecutionLog[]>;
|
|
4352
|
+
/**
|
|
4353
|
+
* Get available task types
|
|
4354
|
+
*/
|
|
4355
|
+
taskTypes(options?: {
|
|
4356
|
+
detailed?: boolean;
|
|
4357
|
+
}): Promise<string[] | TaskTypeInfo[]>;
|
|
4358
|
+
}
|
|
4359
|
+
|
|
4360
|
+
/**
|
|
4361
|
+
* Forms Module - Platform API
|
|
4362
|
+
*
|
|
4363
|
+
* CRUD operations for forms and submissions
|
|
4364
|
+
*/
|
|
4365
|
+
|
|
4366
|
+
declare class FormsModule {
|
|
4367
|
+
private http;
|
|
4368
|
+
constructor(http: HttpClient);
|
|
4369
|
+
/**
|
|
4370
|
+
* List all forms
|
|
4371
|
+
*/
|
|
4372
|
+
list(): Promise<PlatformForm[]>;
|
|
4373
|
+
/**
|
|
4374
|
+
* Get a single form by ID
|
|
4375
|
+
*/
|
|
4376
|
+
get(id: string): Promise<PlatformForm>;
|
|
4377
|
+
/**
|
|
4378
|
+
* Create a new form
|
|
4379
|
+
*/
|
|
4380
|
+
create(data: PlatformFormCreate): Promise<PlatformForm>;
|
|
4381
|
+
/**
|
|
4382
|
+
* Update a form
|
|
4383
|
+
*/
|
|
4384
|
+
update(id: string, data: PlatformFormUpdate): Promise<PlatformForm>;
|
|
4385
|
+
/**
|
|
4386
|
+
* Delete a form
|
|
4387
|
+
*/
|
|
4388
|
+
delete(id: string): Promise<void>;
|
|
4389
|
+
/**
|
|
4390
|
+
* Get submissions for a form
|
|
4391
|
+
*/
|
|
4392
|
+
getSubmissions(formId: string): Promise<PlatformFormSubmission[]>;
|
|
4393
|
+
/**
|
|
4394
|
+
* Get a published form by slug (Publishing API - public access)
|
|
4395
|
+
*/
|
|
4396
|
+
getPublishedForm(slug: string): Promise<PlatformForm>;
|
|
4397
|
+
/**
|
|
4398
|
+
* Submit data to a published form (Publishing API - public access)
|
|
4399
|
+
*/
|
|
4400
|
+
submitForm(slug: string, data: Record<string, unknown>): Promise<PlatformFormSubmission>;
|
|
4401
|
+
}
|
|
4402
|
+
|
|
3596
4403
|
/**
|
|
3597
4404
|
* Platform API Client
|
|
3598
4405
|
*
|
|
@@ -3621,6 +4428,9 @@ declare class PlatformClient extends HttpClient {
|
|
|
3621
4428
|
eventLog: EventLogModule;
|
|
3622
4429
|
session: AuthModule;
|
|
3623
4430
|
theme: ThemeModule;
|
|
4431
|
+
emailTemplates: EmailTemplatesClient;
|
|
4432
|
+
scheduledTasks: ScheduledTasksModule;
|
|
4433
|
+
forms: FormsModule;
|
|
3624
4434
|
adminUsers: AdminUsersModule;
|
|
3625
4435
|
adminSystem: AdminSystemModule;
|
|
3626
4436
|
adminMaintenance: AdminMaintenanceModule;
|
|
@@ -3631,4 +4441,4 @@ declare class PlatformClient extends HttpClient {
|
|
|
3631
4441
|
*/
|
|
3632
4442
|
declare function createPlatformClient(config: PlatformClientConfig): PlatformClient;
|
|
3633
4443
|
|
|
3634
|
-
export { APIClientsModule, type AdminAboutInfo, AdminMaintenanceModule, AdminSystemModule, AdminUsersModule, type ApiToken, type ApiTokenCreate, type ApiTokenWithToken, type AppTheme, AssetsModule, AuthModule, type AuthToken, CollectionsModule, type EmailInvitationRequest, type EmailSettings, EntriesModule, EntryTypesModule, type EventLogEntry, EventLogModule, type EventLogQueryParams, type EventLogSummary, type EventOption, EventsModule, 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 PlatformResource, type PlatformResourceCreate, type PlatformResourceUpdate, type PlatformWorkspaceMember, type PlatformWorkspaceMemberCreate, type PlatformWorkspaceMemberUpdate, ResourcesModule, type SystemStatistics, 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 };
|
|
4444
|
+
export { APIClientsModule, type AdminAboutInfo, AdminMaintenanceModule, AdminSystemModule, AdminUsersModule, type ApiToken, type ApiTokenCreate, type ApiTokenWithToken, type AppTheme, AssetsModule, AuthModule, type AuthToken, CollectionsModule, type EmailInvitationRequest, type EmailSettings, 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 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 };
|