@inneropen/marvin-sdk 2.0.0-next.18 → 2.0.0-next.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -136
- package/dist/{HttpClient-CdF3IHM1.d.cts → HttpClient-CLtgQGXH.d.cts} +2 -49
- package/dist/{HttpClient-CdF3IHM1.d.ts → HttpClient-CLtgQGXH.d.ts} +2 -49
- package/dist/chunk-25F3IF6S.js +396 -0
- package/dist/index.cjs +25 -536
- package/dist/index.d.cts +544 -20
- package/dist/index.d.ts +544 -20
- package/dist/index.js +791 -27
- package/dist/platform.cjs +42 -681
- package/dist/platform.d.cts +80 -803
- package/dist/platform.d.ts +80 -803
- package/dist/platform.js +32 -449
- package/dist/types/index.d.cts +1 -9
- package/dist/types/index.d.ts +1 -9
- package/package.json +7 -18
- package/dist/chunk-GJNOYXUQ.js +0 -980
- package/dist/chunk-WJC4X7TB.js +0 -738
- package/dist/marvin-Bx5k6tsF.d.cts +0 -654
- package/dist/marvin-g7dayc83.d.ts +0 -654
- package/dist/publish.cjs +0 -1487
- package/dist/publish.d.cts +0 -49
- package/dist/publish.d.ts +0 -49
- package/dist/publish.js +0 -75
package/dist/platform.d.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import { H as HttpClient } from './HttpClient-
|
|
2
|
-
import { AuthToken } from './types/index.js';
|
|
1
|
+
import { H as HttpClient } from './HttpClient-CLtgQGXH.js';
|
|
3
2
|
|
|
4
3
|
interface components {
|
|
5
4
|
schemas: {
|
|
@@ -561,163 +560,6 @@ interface components {
|
|
|
561
560
|
/** Error */
|
|
562
561
|
error?: string | null;
|
|
563
562
|
};
|
|
564
|
-
/**
|
|
565
|
-
* EmailTemplateCreate
|
|
566
|
-
* @description Schema for creating a new email template.
|
|
567
|
-
*/
|
|
568
|
-
EmailTemplateCreate: {
|
|
569
|
-
/**
|
|
570
|
-
* Templatetype
|
|
571
|
-
* @description Type of email (invitation, password_reset, notification, test)
|
|
572
|
-
*/
|
|
573
|
-
templateType: string;
|
|
574
|
-
/**
|
|
575
|
-
* Groupid
|
|
576
|
-
* @description Workspace ID - null for system-wide templates
|
|
577
|
-
*/
|
|
578
|
-
groupId?: string | null;
|
|
579
|
-
/**
|
|
580
|
-
* Name
|
|
581
|
-
* @description Human-readable template name
|
|
582
|
-
*/
|
|
583
|
-
name: string;
|
|
584
|
-
/**
|
|
585
|
-
* Description
|
|
586
|
-
* @description Description of when this template is used
|
|
587
|
-
*/
|
|
588
|
-
description?: string | null;
|
|
589
|
-
/**
|
|
590
|
-
* Subject
|
|
591
|
-
* @description Email subject line - supports Jinja2 variables
|
|
592
|
-
*/
|
|
593
|
-
subject: string;
|
|
594
|
-
/**
|
|
595
|
-
* Headertext
|
|
596
|
-
* @description Header text (structured mode with default.html)
|
|
597
|
-
*/
|
|
598
|
-
headerText?: string | null;
|
|
599
|
-
/**
|
|
600
|
-
* Messagetop
|
|
601
|
-
* @description Top message (structured mode with default.html)
|
|
602
|
-
*/
|
|
603
|
-
messageTop?: string | null;
|
|
604
|
-
/**
|
|
605
|
-
* Messagebottom
|
|
606
|
-
* @description Bottom message (structured mode with default.html)
|
|
607
|
-
*/
|
|
608
|
-
messageBottom?: string | null;
|
|
609
|
-
/**
|
|
610
|
-
* Buttontext
|
|
611
|
-
* @description Button text (structured mode with default.html)
|
|
612
|
-
*/
|
|
613
|
-
buttonText?: string | null;
|
|
614
|
-
/**
|
|
615
|
-
* Customhtml
|
|
616
|
-
* @description Full custom HTML - if set, overrides structured fields
|
|
617
|
-
*/
|
|
618
|
-
customHtml?: string | null;
|
|
619
|
-
/**
|
|
620
|
-
* Availablevariables
|
|
621
|
-
* @description Documentation of available variables
|
|
622
|
-
*/
|
|
623
|
-
availableVariables?: {
|
|
624
|
-
[key: string]: unknown;
|
|
625
|
-
} | null;
|
|
626
|
-
/**
|
|
627
|
-
* Enabled
|
|
628
|
-
* @description Whether this template is active
|
|
629
|
-
* @default true
|
|
630
|
-
*/
|
|
631
|
-
enabled: boolean;
|
|
632
|
-
};
|
|
633
|
-
/**
|
|
634
|
-
* EmailTemplateRead
|
|
635
|
-
* @description Schema for reading an email template.
|
|
636
|
-
*/
|
|
637
|
-
EmailTemplateRead: {
|
|
638
|
-
/**
|
|
639
|
-
* Id
|
|
640
|
-
* Format: uuid4
|
|
641
|
-
*/
|
|
642
|
-
id: string;
|
|
643
|
-
/** Templatetype */
|
|
644
|
-
templateType: string;
|
|
645
|
-
/** Groupid */
|
|
646
|
-
groupId: string | null;
|
|
647
|
-
/** Name */
|
|
648
|
-
name: string;
|
|
649
|
-
/** Description */
|
|
650
|
-
description: string | null;
|
|
651
|
-
/** Subject */
|
|
652
|
-
subject: string;
|
|
653
|
-
/** Headertext */
|
|
654
|
-
headerText: string | null;
|
|
655
|
-
/** Messagetop */
|
|
656
|
-
messageTop: string | null;
|
|
657
|
-
/** Messagebottom */
|
|
658
|
-
messageBottom: string | null;
|
|
659
|
-
/** Buttontext */
|
|
660
|
-
buttonText: string | null;
|
|
661
|
-
/** Customhtml */
|
|
662
|
-
customHtml: string | null;
|
|
663
|
-
/** Availablevariables */
|
|
664
|
-
availableVariables: {
|
|
665
|
-
[key: string]: unknown;
|
|
666
|
-
} | null;
|
|
667
|
-
/** Enabled */
|
|
668
|
-
enabled: boolean;
|
|
669
|
-
/** Createdat */
|
|
670
|
-
createdAt: string;
|
|
671
|
-
/** Updateat */
|
|
672
|
-
updateAt: string;
|
|
673
|
-
};
|
|
674
|
-
/**
|
|
675
|
-
* EmailTemplateSummary
|
|
676
|
-
* @description Summary schema for listing email templates.
|
|
677
|
-
*/
|
|
678
|
-
EmailTemplateSummary: {
|
|
679
|
-
/**
|
|
680
|
-
* Id
|
|
681
|
-
* Format: uuid4
|
|
682
|
-
*/
|
|
683
|
-
id: string;
|
|
684
|
-
/** Templatetype */
|
|
685
|
-
templateType: string;
|
|
686
|
-
/** Name */
|
|
687
|
-
name: string;
|
|
688
|
-
/** Description */
|
|
689
|
-
description: string | null;
|
|
690
|
-
/** Enabled */
|
|
691
|
-
enabled: boolean;
|
|
692
|
-
};
|
|
693
|
-
/**
|
|
694
|
-
* EmailTemplateUpdate
|
|
695
|
-
* @description Schema for updating an email template.
|
|
696
|
-
*/
|
|
697
|
-
EmailTemplateUpdate: {
|
|
698
|
-
/** Name */
|
|
699
|
-
name?: string | null;
|
|
700
|
-
/** Description */
|
|
701
|
-
description?: string | null;
|
|
702
|
-
/** Subject */
|
|
703
|
-
subject?: string | null;
|
|
704
|
-
/** Headertext */
|
|
705
|
-
headerText?: string | null;
|
|
706
|
-
/** Messagetop */
|
|
707
|
-
messageTop?: string | null;
|
|
708
|
-
/** Messagebottom */
|
|
709
|
-
messageBottom?: string | null;
|
|
710
|
-
/** Buttontext */
|
|
711
|
-
buttonText?: string | null;
|
|
712
|
-
/** Customhtml */
|
|
713
|
-
customHtml?: string | null;
|
|
714
|
-
/** Availablevariables */
|
|
715
|
-
availableVariables?: {
|
|
716
|
-
[key: string]: unknown;
|
|
717
|
-
} | null;
|
|
718
|
-
/** Enabled */
|
|
719
|
-
enabled?: boolean | null;
|
|
720
|
-
};
|
|
721
563
|
/**
|
|
722
564
|
* EmailTest
|
|
723
565
|
* @description Schema for the request body when sending a test email.
|
|
@@ -804,9 +646,6 @@ interface components {
|
|
|
804
646
|
/**
|
|
805
647
|
* EntryCreate
|
|
806
648
|
* @description Schema for creating an entry.
|
|
807
|
-
*
|
|
808
|
-
* BREAKING CHANGE: content_markdown removed, replaced with data_json.
|
|
809
|
-
* Entry content is now schema-driven based on entry_type.schema_json.
|
|
810
649
|
*/
|
|
811
650
|
EntryCreate: {
|
|
812
651
|
/**
|
|
@@ -822,13 +661,8 @@ interface components {
|
|
|
822
661
|
summary?: string | null;
|
|
823
662
|
/** Description */
|
|
824
663
|
description?: string | null;
|
|
825
|
-
/**
|
|
826
|
-
|
|
827
|
-
* @description Schema-driven content data (validated against entry_type.schema_json)
|
|
828
|
-
*/
|
|
829
|
-
dataJson?: {
|
|
830
|
-
[key: string]: unknown;
|
|
831
|
-
};
|
|
664
|
+
/** Contentmarkdown */
|
|
665
|
+
contentMarkdown?: string | null;
|
|
832
666
|
/**
|
|
833
667
|
* Status
|
|
834
668
|
* @default inbox
|
|
@@ -840,10 +674,7 @@ interface components {
|
|
|
840
674
|
publishAt?: string | null;
|
|
841
675
|
/** Expireat */
|
|
842
676
|
expireAt?: string | null;
|
|
843
|
-
/**
|
|
844
|
-
* Metadatajson
|
|
845
|
-
* @description Custom non-schema metadata (API keys, external IDs, etc.)
|
|
846
|
-
*/
|
|
677
|
+
/** Metadatajson */
|
|
847
678
|
metadataJson?: {
|
|
848
679
|
[key: string]: unknown;
|
|
849
680
|
} | null;
|
|
@@ -870,9 +701,6 @@ interface components {
|
|
|
870
701
|
/**
|
|
871
702
|
* EntryRead
|
|
872
703
|
* @description Schema for reading an entry.
|
|
873
|
-
*
|
|
874
|
-
* BREAKING CHANGE: content_markdown removed, replaced with data_json.
|
|
875
|
-
* Entry content is now schema-driven based on entry_type.schema_json.
|
|
876
704
|
*/
|
|
877
705
|
EntryRead: {
|
|
878
706
|
/**
|
|
@@ -898,13 +726,8 @@ interface components {
|
|
|
898
726
|
summary?: string | null;
|
|
899
727
|
/** Description */
|
|
900
728
|
description?: string | null;
|
|
901
|
-
/**
|
|
902
|
-
|
|
903
|
-
* @description Schema-driven content data
|
|
904
|
-
*/
|
|
905
|
-
dataJson?: {
|
|
906
|
-
[key: string]: unknown;
|
|
907
|
-
};
|
|
729
|
+
/** Contentmarkdown */
|
|
730
|
+
contentMarkdown?: string | null;
|
|
908
731
|
/** Status */
|
|
909
732
|
status: string;
|
|
910
733
|
/** Publishedat */
|
|
@@ -913,10 +736,7 @@ interface components {
|
|
|
913
736
|
publishAt?: string | null;
|
|
914
737
|
/** Expireat */
|
|
915
738
|
expireAt?: string | null;
|
|
916
|
-
/**
|
|
917
|
-
* Metadatajson
|
|
918
|
-
* @description Custom non-schema metadata
|
|
919
|
-
*/
|
|
739
|
+
/** Metadatajson */
|
|
920
740
|
metadataJson?: {
|
|
921
741
|
[key: string]: unknown;
|
|
922
742
|
} | null;
|
|
@@ -969,20 +789,10 @@ interface components {
|
|
|
969
789
|
* @default false
|
|
970
790
|
*/
|
|
971
791
|
isSystem: boolean;
|
|
972
|
-
/**
|
|
973
|
-
* Schema Json
|
|
974
|
-
* @description Entry type schema definition (EntryTypeSchemaDefinition)
|
|
975
|
-
*/
|
|
976
|
-
schema_json?: {
|
|
977
|
-
[key: string]: unknown;
|
|
978
|
-
} | null;
|
|
979
792
|
};
|
|
980
793
|
/**
|
|
981
794
|
* EntryTypeRead
|
|
982
795
|
* @description Schema for reading an entry type.
|
|
983
|
-
*
|
|
984
|
-
* System entry types have group_id=None and are globally available to all workspaces.
|
|
985
|
-
* Workspace-scoped entry types have a specific group_id.
|
|
986
796
|
*/
|
|
987
797
|
EntryTypeRead: {
|
|
988
798
|
/**
|
|
@@ -990,8 +800,11 @@ interface components {
|
|
|
990
800
|
* Format: uuid4
|
|
991
801
|
*/
|
|
992
802
|
id: string;
|
|
993
|
-
/**
|
|
994
|
-
|
|
803
|
+
/**
|
|
804
|
+
* Groupid
|
|
805
|
+
* Format: uuid4
|
|
806
|
+
*/
|
|
807
|
+
groupId: string;
|
|
995
808
|
/** Name */
|
|
996
809
|
name: string;
|
|
997
810
|
/** Slug */
|
|
@@ -1006,13 +819,6 @@ interface components {
|
|
|
1006
819
|
sortOrder: number;
|
|
1007
820
|
/** Issystem */
|
|
1008
821
|
isSystem: boolean;
|
|
1009
|
-
/**
|
|
1010
|
-
* Schemajson
|
|
1011
|
-
* @description Entry type schema definition (EntryTypeSchemaDefinition)
|
|
1012
|
-
*/
|
|
1013
|
-
schemaJson?: {
|
|
1014
|
-
[key: string]: unknown;
|
|
1015
|
-
} | null;
|
|
1016
822
|
/** Createdat */
|
|
1017
823
|
createdAt?: string | null;
|
|
1018
824
|
/** Updateat */
|
|
@@ -1037,20 +843,10 @@ interface components {
|
|
|
1037
843
|
sortOrder?: number | null;
|
|
1038
844
|
/** Issystem */
|
|
1039
845
|
isSystem?: boolean | null;
|
|
1040
|
-
/**
|
|
1041
|
-
* Schema Json
|
|
1042
|
-
* @description Entry type schema definition (EntryTypeSchemaDefinition)
|
|
1043
|
-
*/
|
|
1044
|
-
schema_json?: {
|
|
1045
|
-
[key: string]: unknown;
|
|
1046
|
-
} | null;
|
|
1047
846
|
};
|
|
1048
847
|
/**
|
|
1049
848
|
* EntryUpdate
|
|
1050
849
|
* @description Schema for patching an entry.
|
|
1051
|
-
*
|
|
1052
|
-
* BREAKING CHANGE: content_markdown removed, replaced with data_json.
|
|
1053
|
-
* Entry content is now schema-driven based on entry_type.schema_json.
|
|
1054
850
|
*/
|
|
1055
851
|
EntryUpdate: {
|
|
1056
852
|
/** Entry Type Id */
|
|
@@ -1063,26 +859,18 @@ interface components {
|
|
|
1063
859
|
summary?: string | null;
|
|
1064
860
|
/** Description */
|
|
1065
861
|
description?: string | null;
|
|
1066
|
-
/**
|
|
1067
|
-
|
|
1068
|
-
* @description Schema-driven content data (validated against entry_type.schema_json)
|
|
1069
|
-
*/
|
|
1070
|
-
dataJson?: {
|
|
1071
|
-
[key: string]: unknown;
|
|
1072
|
-
} | null;
|
|
862
|
+
/** Content Markdown */
|
|
863
|
+
content_markdown?: string | null;
|
|
1073
864
|
/** Status */
|
|
1074
865
|
status?: string | null;
|
|
1075
|
-
/**
|
|
1076
|
-
|
|
1077
|
-
/**
|
|
1078
|
-
|
|
1079
|
-
/**
|
|
1080
|
-
|
|
1081
|
-
/**
|
|
1082
|
-
|
|
1083
|
-
* @description Custom non-schema metadata (API keys, external IDs, etc.)
|
|
1084
|
-
*/
|
|
1085
|
-
metadataJson?: {
|
|
866
|
+
/** Published At */
|
|
867
|
+
published_at?: string | null;
|
|
868
|
+
/** Publish At */
|
|
869
|
+
publish_at?: string | null;
|
|
870
|
+
/** Expire At */
|
|
871
|
+
expire_at?: string | null;
|
|
872
|
+
/** Metadata Json */
|
|
873
|
+
metadata_json?: {
|
|
1086
874
|
[key: string]: unknown;
|
|
1087
875
|
} | null;
|
|
1088
876
|
/** Collection Ids */
|
|
@@ -1098,7 +886,7 @@ interface components {
|
|
|
1098
886
|
* Helps listeners understand the nature of `EventDocumentDataBase` content.
|
|
1099
887
|
* @enum {string}
|
|
1100
888
|
*/
|
|
1101
|
-
EventDocumentType: "generic" | "user" | "workspace" | "entry" | "
|
|
889
|
+
EventDocumentType: "generic" | "user" | "workspace" | "entry" | "collection" | "asset" | "webhook" | "member" | "invitation" | "api_token" | "api_client" | "entry_type" | "resource" | "deployment";
|
|
1102
890
|
/**
|
|
1103
891
|
* EventLogRead
|
|
1104
892
|
* @description Schema for reading an event log entry.
|
|
@@ -1248,165 +1036,6 @@ interface components {
|
|
|
1248
1036
|
/** Email */
|
|
1249
1037
|
email: string;
|
|
1250
1038
|
};
|
|
1251
|
-
/**
|
|
1252
|
-
* FormCreate
|
|
1253
|
-
* @description Schema for creating a form.
|
|
1254
|
-
*/
|
|
1255
|
-
FormCreate: {
|
|
1256
|
-
/** Name */
|
|
1257
|
-
name: string;
|
|
1258
|
-
/** Slug */
|
|
1259
|
-
slug?: string | null;
|
|
1260
|
-
/** Description */
|
|
1261
|
-
description?: string | null;
|
|
1262
|
-
/**
|
|
1263
|
-
* Status
|
|
1264
|
-
* @default draft
|
|
1265
|
-
*/
|
|
1266
|
-
status: string;
|
|
1267
|
-
/** Formschema */
|
|
1268
|
-
formSchema?: {
|
|
1269
|
-
[key: string]: unknown;
|
|
1270
|
-
};
|
|
1271
|
-
/** Settingsjson */
|
|
1272
|
-
settingsJson?: {
|
|
1273
|
-
[key: string]: unknown;
|
|
1274
|
-
} | null;
|
|
1275
|
-
/** Metadatajson */
|
|
1276
|
-
metadataJson?: {
|
|
1277
|
-
[key: string]: unknown;
|
|
1278
|
-
} | null;
|
|
1279
|
-
};
|
|
1280
|
-
/**
|
|
1281
|
-
* FormRead
|
|
1282
|
-
* @description Schema for reading a form.
|
|
1283
|
-
*/
|
|
1284
|
-
FormRead: {
|
|
1285
|
-
/**
|
|
1286
|
-
* Id
|
|
1287
|
-
* Format: uuid4
|
|
1288
|
-
*/
|
|
1289
|
-
id: string;
|
|
1290
|
-
/**
|
|
1291
|
-
* Groupid
|
|
1292
|
-
* Format: uuid4
|
|
1293
|
-
*/
|
|
1294
|
-
groupId: string;
|
|
1295
|
-
/** Slug */
|
|
1296
|
-
slug: string;
|
|
1297
|
-
/** Name */
|
|
1298
|
-
name: string;
|
|
1299
|
-
/** Description */
|
|
1300
|
-
description: string | null;
|
|
1301
|
-
/** Schemajson */
|
|
1302
|
-
schemaJson: {
|
|
1303
|
-
[key: string]: unknown;
|
|
1304
|
-
};
|
|
1305
|
-
/** Settingsjson */
|
|
1306
|
-
settingsJson: {
|
|
1307
|
-
[key: string]: unknown;
|
|
1308
|
-
} | null;
|
|
1309
|
-
/** Metadatajson */
|
|
1310
|
-
metadataJson: {
|
|
1311
|
-
[key: string]: unknown;
|
|
1312
|
-
} | null;
|
|
1313
|
-
/** Status */
|
|
1314
|
-
status: string;
|
|
1315
|
-
/** Submissionscount */
|
|
1316
|
-
submissionsCount: number;
|
|
1317
|
-
/** Lastsubmissionat */
|
|
1318
|
-
lastSubmissionAt: string | null;
|
|
1319
|
-
/** Createdat */
|
|
1320
|
-
createdAt: string | null;
|
|
1321
|
-
/** Updateat */
|
|
1322
|
-
updateAt: string | null;
|
|
1323
|
-
};
|
|
1324
|
-
/**
|
|
1325
|
-
* FormSubmissionRead
|
|
1326
|
-
* @description Schema for reading a form submission.
|
|
1327
|
-
*/
|
|
1328
|
-
FormSubmissionRead: {
|
|
1329
|
-
/**
|
|
1330
|
-
* Id
|
|
1331
|
-
* Format: uuid4
|
|
1332
|
-
*/
|
|
1333
|
-
id: string;
|
|
1334
|
-
/**
|
|
1335
|
-
* Formid
|
|
1336
|
-
* Format: uuid4
|
|
1337
|
-
*/
|
|
1338
|
-
formId: string;
|
|
1339
|
-
/**
|
|
1340
|
-
* Groupid
|
|
1341
|
-
* Format: uuid4
|
|
1342
|
-
*/
|
|
1343
|
-
groupId: string;
|
|
1344
|
-
/** Datajson */
|
|
1345
|
-
dataJson: {
|
|
1346
|
-
[key: string]: unknown;
|
|
1347
|
-
};
|
|
1348
|
-
/** Metadatajson */
|
|
1349
|
-
metadataJson: {
|
|
1350
|
-
[key: string]: unknown;
|
|
1351
|
-
} | null;
|
|
1352
|
-
/** Status */
|
|
1353
|
-
status: string;
|
|
1354
|
-
/** Ipaddress */
|
|
1355
|
-
ipAddress: string | null;
|
|
1356
|
-
/** Useragent */
|
|
1357
|
-
userAgent: string | null;
|
|
1358
|
-
/** Referrer */
|
|
1359
|
-
referrer: string | null;
|
|
1360
|
-
/**
|
|
1361
|
-
* Submittedat
|
|
1362
|
-
* Format: date-time
|
|
1363
|
-
*/
|
|
1364
|
-
submittedAt: string;
|
|
1365
|
-
/** Processedat */
|
|
1366
|
-
processedAt: string | null;
|
|
1367
|
-
};
|
|
1368
|
-
/**
|
|
1369
|
-
* FormSubmissionResponse
|
|
1370
|
-
* @description Response after form submission.
|
|
1371
|
-
*
|
|
1372
|
-
* Indicates success/failure and optionally provides redirect URL.
|
|
1373
|
-
*/
|
|
1374
|
-
FormSubmissionResponse: {
|
|
1375
|
-
/** Success */
|
|
1376
|
-
success: boolean;
|
|
1377
|
-
/** Message */
|
|
1378
|
-
message: string;
|
|
1379
|
-
/** Submissionid */
|
|
1380
|
-
submissionId?: string | null;
|
|
1381
|
-
/** Redirecturl */
|
|
1382
|
-
redirectUrl?: string | null;
|
|
1383
|
-
};
|
|
1384
|
-
/**
|
|
1385
|
-
* FormUpdate
|
|
1386
|
-
* @description Schema for updating a form.
|
|
1387
|
-
*/
|
|
1388
|
-
FormUpdate: {
|
|
1389
|
-
/** Name */
|
|
1390
|
-
name?: string | null;
|
|
1391
|
-
/** Slug */
|
|
1392
|
-
slug?: string | null;
|
|
1393
|
-
/** Description */
|
|
1394
|
-
description?: string | null;
|
|
1395
|
-
/** Status */
|
|
1396
|
-
status?: string | null;
|
|
1397
|
-
/** Formschema */
|
|
1398
|
-
formSchema?: {
|
|
1399
|
-
[key: string]: unknown;
|
|
1400
|
-
} | null;
|
|
1401
|
-
/** Settingsjson */
|
|
1402
|
-
settingsJson?: {
|
|
1403
|
-
[key: string]: unknown;
|
|
1404
|
-
} | null;
|
|
1405
|
-
/** Metadatajson */
|
|
1406
|
-
metadataJson?: {
|
|
1407
|
-
[key: string]: unknown;
|
|
1408
|
-
} | null;
|
|
1409
|
-
};
|
|
1410
1039
|
/**
|
|
1411
1040
|
* GroupAdminUpdate
|
|
1412
1041
|
* @description Schema for administrators to update a group.
|
|
@@ -2001,10 +1630,15 @@ interface components {
|
|
|
2001
1630
|
description?: string | null;
|
|
2002
1631
|
/** Publicurl */
|
|
2003
1632
|
publicUrl: string;
|
|
2004
|
-
/**
|
|
2005
|
-
|
|
1633
|
+
/** Metadata */
|
|
1634
|
+
metadata?: {
|
|
2006
1635
|
[key: string]: unknown;
|
|
2007
1636
|
} | null;
|
|
1637
|
+
/**
|
|
1638
|
+
* Entries
|
|
1639
|
+
* @default []
|
|
1640
|
+
*/
|
|
1641
|
+
entries: string[];
|
|
2008
1642
|
};
|
|
2009
1643
|
/**
|
|
2010
1644
|
* PublishedAssetsResponse
|
|
@@ -2037,8 +1671,8 @@ interface components {
|
|
|
2037
1671
|
smartRules?: {
|
|
2038
1672
|
[key: string]: unknown;
|
|
2039
1673
|
} | null;
|
|
2040
|
-
/**
|
|
2041
|
-
|
|
1674
|
+
/** Metadata */
|
|
1675
|
+
metadata?: {
|
|
2042
1676
|
[key: string]: unknown;
|
|
2043
1677
|
} | null;
|
|
2044
1678
|
/** Entrycount */
|
|
@@ -2049,21 +1683,35 @@ interface components {
|
|
|
2049
1683
|
/**
|
|
2050
1684
|
* PublishedCollectionSummary
|
|
2051
1685
|
* @description Summary schema for published collections (for listing).
|
|
2052
|
-
*
|
|
2053
|
-
* Minimal collection info for entry contexts - only includes
|
|
2054
|
-
* essential fields for display and ordering.
|
|
2055
1686
|
*/
|
|
2056
1687
|
PublishedCollectionSummary: {
|
|
2057
1688
|
/** Slug */
|
|
2058
1689
|
slug: string;
|
|
2059
1690
|
/** Name */
|
|
2060
1691
|
name: string;
|
|
2061
|
-
/**
|
|
2062
|
-
|
|
1692
|
+
/** Description */
|
|
1693
|
+
description?: string | null;
|
|
1694
|
+
/**
|
|
1695
|
+
* Issmart
|
|
1696
|
+
* @default false
|
|
1697
|
+
*/
|
|
1698
|
+
isSmart: boolean;
|
|
1699
|
+
/** Smartrules */
|
|
1700
|
+
smartRules?: {
|
|
1701
|
+
[key: string]: unknown;
|
|
1702
|
+
} | null;
|
|
1703
|
+
/** Metadata */
|
|
1704
|
+
metadata?: {
|
|
2063
1705
|
[key: string]: unknown;
|
|
2064
1706
|
} | null;
|
|
1707
|
+
/** Entrycount */
|
|
1708
|
+
entryCount: number;
|
|
2065
1709
|
/** Sortorder */
|
|
2066
1710
|
sortOrder: number;
|
|
1711
|
+
/** Icon */
|
|
1712
|
+
icon?: string | null;
|
|
1713
|
+
/** Color */
|
|
1714
|
+
color?: string | null;
|
|
2067
1715
|
};
|
|
2068
1716
|
/**
|
|
2069
1717
|
* PublishedCollectionsResponse
|
|
@@ -2101,25 +1749,23 @@ interface components {
|
|
|
2101
1749
|
summary?: string | null;
|
|
2102
1750
|
/** Publishedat */
|
|
2103
1751
|
publishedAt?: string | null;
|
|
2104
|
-
/** Status */
|
|
2105
|
-
status: string;
|
|
2106
1752
|
/**
|
|
2107
1753
|
* Collections
|
|
2108
1754
|
* @default []
|
|
2109
1755
|
*/
|
|
2110
1756
|
collections: string[];
|
|
2111
1757
|
/**
|
|
2112
|
-
*
|
|
1758
|
+
* Assets
|
|
2113
1759
|
* @default []
|
|
2114
1760
|
*/
|
|
2115
|
-
|
|
1761
|
+
assets: string[];
|
|
1762
|
+
/** Order */
|
|
1763
|
+
order?: number | null;
|
|
2116
1764
|
/**
|
|
2117
|
-
*
|
|
1765
|
+
* Resources
|
|
2118
1766
|
* @default []
|
|
2119
1767
|
*/
|
|
2120
|
-
|
|
2121
|
-
/** Order */
|
|
2122
|
-
order?: number | null;
|
|
1768
|
+
resources: string[];
|
|
2123
1769
|
};
|
|
2124
1770
|
/**
|
|
2125
1771
|
* PublishedEntryRead
|
|
@@ -2127,9 +1773,6 @@ interface components {
|
|
|
2127
1773
|
*
|
|
2128
1774
|
* Only includes public-facing fields. Excludes all admin metadata,
|
|
2129
1775
|
* internal fields, and user information.
|
|
2130
|
-
*
|
|
2131
|
-
* BREAKING CHANGE: content_markdown removed, replaced with data.
|
|
2132
|
-
* Entry content is now schema-driven based on entry_type.schema_json.
|
|
2133
1776
|
*/
|
|
2134
1777
|
PublishedEntryRead: {
|
|
2135
1778
|
/** Slug */
|
|
@@ -2140,14 +1783,12 @@ interface components {
|
|
|
2140
1783
|
entryType: string;
|
|
2141
1784
|
/** Summary */
|
|
2142
1785
|
summary?: string | null;
|
|
2143
|
-
/**
|
|
2144
|
-
|
|
2145
|
-
[key: string]: unknown;
|
|
2146
|
-
};
|
|
1786
|
+
/** Contentmarkdown */
|
|
1787
|
+
contentMarkdown?: string | null;
|
|
2147
1788
|
/** Publishedat */
|
|
2148
1789
|
publishedAt?: string | null;
|
|
2149
|
-
/**
|
|
2150
|
-
|
|
1790
|
+
/** Metadata */
|
|
1791
|
+
metadata?: {
|
|
2151
1792
|
[key: string]: unknown;
|
|
2152
1793
|
} | null;
|
|
2153
1794
|
/**
|
|
@@ -2168,29 +1809,6 @@ interface components {
|
|
|
2168
1809
|
/** Order */
|
|
2169
1810
|
order?: number | null;
|
|
2170
1811
|
};
|
|
2171
|
-
/**
|
|
2172
|
-
* PublishedFormRead
|
|
2173
|
-
* @description Schema for published forms in the publishing API.
|
|
2174
|
-
*
|
|
2175
|
-
* Provides form definition for frontend to render the form.
|
|
2176
|
-
* Does not expose internal fields like submissions_count.
|
|
2177
|
-
*/
|
|
2178
|
-
PublishedFormRead: {
|
|
2179
|
-
/** Slug */
|
|
2180
|
-
slug: string;
|
|
2181
|
-
/** Name */
|
|
2182
|
-
name: string;
|
|
2183
|
-
/** Description */
|
|
2184
|
-
description?: string | null;
|
|
2185
|
-
/** Formschema */
|
|
2186
|
-
formSchema: {
|
|
2187
|
-
[key: string]: unknown;
|
|
2188
|
-
};
|
|
2189
|
-
/** Metadata */
|
|
2190
|
-
metadata?: {
|
|
2191
|
-
[key: string]: unknown;
|
|
2192
|
-
} | null;
|
|
2193
|
-
};
|
|
2194
1812
|
/**
|
|
2195
1813
|
* PublishedResourceRead
|
|
2196
1814
|
* @description Schema for published resources in entry context.
|
|
@@ -2210,8 +1828,8 @@ interface components {
|
|
|
2210
1828
|
url?: string | null;
|
|
2211
1829
|
/** Externalid */
|
|
2212
1830
|
externalId?: string | null;
|
|
2213
|
-
/**
|
|
2214
|
-
|
|
1831
|
+
/** Metadata */
|
|
1832
|
+
metadata?: {
|
|
2215
1833
|
[key: string]: unknown;
|
|
2216
1834
|
} | null;
|
|
2217
1835
|
/** Role */
|
|
@@ -2246,8 +1864,8 @@ interface components {
|
|
|
2246
1864
|
url?: string | null;
|
|
2247
1865
|
/** Externalid */
|
|
2248
1866
|
externalId?: string | null;
|
|
2249
|
-
/**
|
|
2250
|
-
|
|
1867
|
+
/** Metadata */
|
|
1868
|
+
metadata?: {
|
|
2251
1869
|
[key: string]: unknown;
|
|
2252
1870
|
} | null;
|
|
2253
1871
|
/**
|
|
@@ -2573,8 +2191,8 @@ interface components {
|
|
|
2573
2191
|
social?: {
|
|
2574
2192
|
[key: string]: unknown;
|
|
2575
2193
|
} | null;
|
|
2576
|
-
/**
|
|
2577
|
-
|
|
2194
|
+
/** Metadata */
|
|
2195
|
+
metadata?: {
|
|
2578
2196
|
[key: string]: unknown;
|
|
2579
2197
|
} | null;
|
|
2580
2198
|
};
|
|
@@ -2626,17 +2244,6 @@ interface components {
|
|
|
2626
2244
|
/** Data Dir Path */
|
|
2627
2245
|
data_dir_path: string;
|
|
2628
2246
|
};
|
|
2629
|
-
/**
|
|
2630
|
-
* TestEmailRequest
|
|
2631
|
-
* @description Request to send a test email.
|
|
2632
|
-
*/
|
|
2633
|
-
TestEmailRequest: {
|
|
2634
|
-
/**
|
|
2635
|
-
* Recipient Email
|
|
2636
|
-
* Format: email
|
|
2637
|
-
*/
|
|
2638
|
-
recipient_email: string;
|
|
2639
|
-
};
|
|
2640
2247
|
/**
|
|
2641
2248
|
* TokenResponseDelete
|
|
2642
2249
|
* @description Schema for the response after successfully deleting an API token.
|
|
@@ -3258,16 +2865,6 @@ type PlatformWorkspaceMemberUpdate = components['schemas']['WorkspaceMemberUpdat
|
|
|
3258
2865
|
*/
|
|
3259
2866
|
type EventLogEntry = components['schemas']['EventLogRead'];
|
|
3260
2867
|
type EventLogSummary = components['schemas']['EventLogSummary'];
|
|
3261
|
-
/**
|
|
3262
|
-
* Forms (Platform API - full CRUD)
|
|
3263
|
-
*/
|
|
3264
|
-
type PlatformForm = components['schemas']['FormRead'];
|
|
3265
|
-
type PlatformFormCreate = components['schemas']['FormCreate'];
|
|
3266
|
-
type PlatformFormUpdate = components['schemas']['FormUpdate'];
|
|
3267
|
-
/**
|
|
3268
|
-
* Form Submissions (Platform API - read access)
|
|
3269
|
-
*/
|
|
3270
|
-
type PlatformFormSubmission = components['schemas']['FormSubmissionRead'];
|
|
3271
2868
|
|
|
3272
2869
|
/**
|
|
3273
2870
|
* Entries Module - Platform API
|
|
@@ -3397,19 +2994,9 @@ declare class ResourcesModule {
|
|
|
3397
2994
|
* CRUD operations and file upload for assets
|
|
3398
2995
|
*/
|
|
3399
2996
|
|
|
3400
|
-
interface FileUploadOptions {
|
|
3401
|
-
/** Maximum file size in bytes (default: 100MB) */
|
|
3402
|
-
maxFileSize?: number;
|
|
3403
|
-
/** Allowed MIME types (if not provided, all types allowed) */
|
|
3404
|
-
allowedMimeTypes?: string[];
|
|
3405
|
-
}
|
|
3406
2997
|
declare class AssetsModule {
|
|
3407
2998
|
private http;
|
|
3408
2999
|
constructor(http: HttpClient);
|
|
3409
|
-
/**
|
|
3410
|
-
* Validate file before upload
|
|
3411
|
-
*/
|
|
3412
|
-
private validateFile;
|
|
3413
3000
|
/**
|
|
3414
3001
|
* List all assets
|
|
3415
3002
|
*/
|
|
@@ -3423,22 +3010,9 @@ declare class AssetsModule {
|
|
|
3423
3010
|
*
|
|
3424
3011
|
* @param file - The file to upload (File or Blob)
|
|
3425
3012
|
* @param metadata - Asset metadata (slug, name, altText, description, metadata)
|
|
3426
|
-
* @param options - Upload options (file size limits, allowed types)
|
|
3427
3013
|
* @returns The created asset with extracted metadata
|
|
3428
|
-
*
|
|
3429
|
-
* @example
|
|
3430
|
-
* ```typescript
|
|
3431
|
-
* // Upload with default limits (100MB, all types)
|
|
3432
|
-
* const asset = await assets.upload(file, { slug: 'my-image', name: 'My Image' });
|
|
3433
|
-
*
|
|
3434
|
-
* // Upload with restrictions
|
|
3435
|
-
* const asset = await assets.upload(file,
|
|
3436
|
-
* { slug: 'avatar', name: 'Avatar' },
|
|
3437
|
-
* { maxFileSize: 5 * 1024 * 1024, allowedMimeTypes: ['image/*'] }
|
|
3438
|
-
* );
|
|
3439
|
-
* ```
|
|
3440
3014
|
*/
|
|
3441
|
-
upload(file: File | Blob, metadata: PlatformAssetUpload
|
|
3015
|
+
upload(file: File | Blob, metadata: PlatformAssetUpload): Promise<PlatformAsset>;
|
|
3442
3016
|
/**
|
|
3443
3017
|
* Update an asset (editable fields only: slug, name, altText, description, metadata)
|
|
3444
3018
|
*/
|
|
@@ -3447,11 +3021,6 @@ declare class AssetsModule {
|
|
|
3447
3021
|
* Delete an asset (removes file from storage and database)
|
|
3448
3022
|
*/
|
|
3449
3023
|
delete(id: string): Promise<void>;
|
|
3450
|
-
/**
|
|
3451
|
-
* Get download URL for an asset file
|
|
3452
|
-
* Use this to create download links or fetch the file directly
|
|
3453
|
-
*/
|
|
3454
|
-
getDownloadUrl(id: string, baseUrl?: string): string;
|
|
3455
3024
|
}
|
|
3456
3025
|
|
|
3457
3026
|
/**
|
|
@@ -3600,21 +3169,11 @@ interface WorkspaceUpdate {
|
|
|
3600
3169
|
name?: string;
|
|
3601
3170
|
description?: string | null;
|
|
3602
3171
|
}
|
|
3603
|
-
/**
|
|
3604
|
-
* Workspace preferences - dynamic key-value store
|
|
3605
|
-
* Common keys include: theme, locale, notifications, etc.
|
|
3606
|
-
*/
|
|
3607
3172
|
interface WorkspacePreferences {
|
|
3608
|
-
|
|
3609
|
-
locale?: string;
|
|
3610
|
-
notifications?: boolean;
|
|
3611
|
-
[key: string]: unknown;
|
|
3173
|
+
[key: string]: any;
|
|
3612
3174
|
}
|
|
3613
3175
|
interface WorkspacePreferencesUpdate {
|
|
3614
|
-
|
|
3615
|
-
locale?: string;
|
|
3616
|
-
notifications?: boolean;
|
|
3617
|
-
[key: string]: unknown;
|
|
3176
|
+
[key: string]: any;
|
|
3618
3177
|
}
|
|
3619
3178
|
declare class WorkspacesModule {
|
|
3620
3179
|
private http;
|
|
@@ -3648,13 +3207,6 @@ declare class WorkspacesModule {
|
|
|
3648
3207
|
* Delete a workspace (requires SUPER_ADMIN)
|
|
3649
3208
|
*/
|
|
3650
3209
|
delete(id: string, force?: boolean): Promise<void>;
|
|
3651
|
-
/**
|
|
3652
|
-
* Export workspace data as JSON (collections, entry types, entries, site config)
|
|
3653
|
-
*/
|
|
3654
|
-
export(options?: {
|
|
3655
|
-
includeSystemTypes?: boolean;
|
|
3656
|
-
pretty?: boolean;
|
|
3657
|
-
}): Promise<Record<string, unknown>>;
|
|
3658
3210
|
/**
|
|
3659
3211
|
* Get workspace preferences
|
|
3660
3212
|
*/
|
|
@@ -3703,19 +3255,7 @@ declare class InvitesModule {
|
|
|
3703
3255
|
delete(tokenId: string): Promise<void>;
|
|
3704
3256
|
/**
|
|
3705
3257
|
* Generate invitation URL from a token
|
|
3706
|
-
*
|
|
3707
|
-
* @param token - Invitation token
|
|
3708
|
-
* @param baseUrl - Base URL for the frontend (required in browser environments)
|
|
3709
|
-
* @returns Full invitation URL
|
|
3710
|
-
*
|
|
3711
|
-
* @example
|
|
3712
|
-
* ```typescript
|
|
3713
|
-
* // Node.js (can use env vars)
|
|
3714
|
-
* const url = invites.getInvitationUrl(token);
|
|
3715
|
-
*
|
|
3716
|
-
* // Browser (must provide baseUrl)
|
|
3717
|
-
* const url = invites.getInvitationUrl(token, 'https://app.example.com');
|
|
3718
|
-
* ```
|
|
3258
|
+
* Uses MARVIN_FRONTEND_URL for the base URL, falls back to MARVIN_API_URL with common port mappings
|
|
3719
3259
|
*/
|
|
3720
3260
|
getInvitationUrl(token: string, baseUrl?: string): string;
|
|
3721
3261
|
}
|
|
@@ -3801,10 +3341,6 @@ interface WebhookUpdate {
|
|
|
3801
3341
|
declare class WebhooksModule {
|
|
3802
3342
|
private http;
|
|
3803
3343
|
constructor(http: HttpClient);
|
|
3804
|
-
/**
|
|
3805
|
-
* Validate webhook URL to prevent SSRF attacks
|
|
3806
|
-
*/
|
|
3807
|
-
private validateWebhookUrl;
|
|
3808
3344
|
/**
|
|
3809
3345
|
* List all webhooks for the current workspace
|
|
3810
3346
|
*/
|
|
@@ -3815,12 +3351,10 @@ declare class WebhooksModule {
|
|
|
3815
3351
|
get(id: string): Promise<Webhook>;
|
|
3816
3352
|
/**
|
|
3817
3353
|
* Create a new webhook
|
|
3818
|
-
* Validates URL to prevent SSRF attacks
|
|
3819
3354
|
*/
|
|
3820
3355
|
create(data: WebhookCreate): Promise<Webhook>;
|
|
3821
3356
|
/**
|
|
3822
3357
|
* Update a webhook
|
|
3823
|
-
* Validates URL if provided to prevent SSRF attacks
|
|
3824
3358
|
*/
|
|
3825
3359
|
update(id: string, data: WebhookUpdate): Promise<Webhook>;
|
|
3826
3360
|
/**
|
|
@@ -3900,22 +3434,7 @@ declare class AdminUsersModule {
|
|
|
3900
3434
|
*/
|
|
3901
3435
|
|
|
3902
3436
|
type AdminAboutInfo = components['schemas']['AdminAboutInfo'];
|
|
3903
|
-
/**
|
|
3904
|
-
* Email settings returned from API (read-only)
|
|
3905
|
-
* Password is never returned for security reasons
|
|
3906
|
-
*/
|
|
3907
3437
|
interface EmailSettings {
|
|
3908
|
-
host?: string;
|
|
3909
|
-
port?: number;
|
|
3910
|
-
username?: string;
|
|
3911
|
-
from?: string;
|
|
3912
|
-
useTls?: boolean;
|
|
3913
|
-
}
|
|
3914
|
-
/**
|
|
3915
|
-
* Email settings for updates (write-only)
|
|
3916
|
-
* Password can be provided to update settings
|
|
3917
|
-
*/
|
|
3918
|
-
interface EmailSettingsUpdate {
|
|
3919
3438
|
host?: string;
|
|
3920
3439
|
port?: number;
|
|
3921
3440
|
username?: string;
|
|
@@ -3931,18 +3450,6 @@ interface SystemStatistics {
|
|
|
3931
3450
|
resources?: number;
|
|
3932
3451
|
assets?: number;
|
|
3933
3452
|
}
|
|
3934
|
-
interface StartupInfo {
|
|
3935
|
-
version: string;
|
|
3936
|
-
api_port: number;
|
|
3937
|
-
api_docs: boolean;
|
|
3938
|
-
database_url: string;
|
|
3939
|
-
database_provider: string;
|
|
3940
|
-
default_group?: string;
|
|
3941
|
-
allow_signup: boolean;
|
|
3942
|
-
theme?: string;
|
|
3943
|
-
custom_middleware?: string[];
|
|
3944
|
-
[key: string]: unknown;
|
|
3945
|
-
}
|
|
3946
3453
|
declare class AdminSystemModule {
|
|
3947
3454
|
private http;
|
|
3948
3455
|
constructor(http: HttpClient);
|
|
@@ -3959,7 +3466,7 @@ declare class AdminSystemModule {
|
|
|
3959
3466
|
/**
|
|
3960
3467
|
* Get startup information
|
|
3961
3468
|
*/
|
|
3962
|
-
getStartupInfo(): Promise<
|
|
3469
|
+
getStartupInfo(): Promise<any>;
|
|
3963
3470
|
/**
|
|
3964
3471
|
* Get system statistics
|
|
3965
3472
|
*/
|
|
@@ -3970,9 +3477,8 @@ declare class AdminSystemModule {
|
|
|
3970
3477
|
getEmailSettings(): Promise<EmailSettings>;
|
|
3971
3478
|
/**
|
|
3972
3479
|
* Update email settings
|
|
3973
|
-
* Note: Password field is write-only and will not be returned in response
|
|
3974
3480
|
*/
|
|
3975
|
-
updateEmailSettings(data:
|
|
3481
|
+
updateEmailSettings(data: EmailSettings): Promise<EmailSettings>;
|
|
3976
3482
|
}
|
|
3977
3483
|
|
|
3978
3484
|
/**
|
|
@@ -4230,6 +3736,10 @@ declare class EventLogModule {
|
|
|
4230
3736
|
* Authenticated session management (logout, refresh)
|
|
4231
3737
|
*/
|
|
4232
3738
|
|
|
3739
|
+
interface AuthToken {
|
|
3740
|
+
accessToken: string;
|
|
3741
|
+
tokenType: string;
|
|
3742
|
+
}
|
|
4233
3743
|
declare class AuthModule {
|
|
4234
3744
|
private http;
|
|
4235
3745
|
constructor(http: HttpClient);
|
|
@@ -4286,216 +3796,6 @@ declare class ThemeModule {
|
|
|
4286
3796
|
getTheme(): Promise<AppTheme>;
|
|
4287
3797
|
}
|
|
4288
3798
|
|
|
4289
|
-
/**
|
|
4290
|
-
* Email Templates Module - Platform API
|
|
4291
|
-
*
|
|
4292
|
-
* Manage workspace email templates
|
|
4293
|
-
*/
|
|
4294
|
-
|
|
4295
|
-
interface EmailTemplateSummary {
|
|
4296
|
-
id: string;
|
|
4297
|
-
template_type: string;
|
|
4298
|
-
group_id: string | null;
|
|
4299
|
-
name: string;
|
|
4300
|
-
description?: string;
|
|
4301
|
-
enabled: boolean;
|
|
4302
|
-
created_at: string;
|
|
4303
|
-
updated_at: string;
|
|
4304
|
-
}
|
|
4305
|
-
interface EmailTemplateRead extends EmailTemplateSummary {
|
|
4306
|
-
subject: string;
|
|
4307
|
-
header_text?: string;
|
|
4308
|
-
message_top?: string;
|
|
4309
|
-
message_bottom?: string;
|
|
4310
|
-
button_text?: string;
|
|
4311
|
-
custom_html?: string;
|
|
4312
|
-
available_variables?: Record<string, string>;
|
|
4313
|
-
}
|
|
4314
|
-
interface EmailTemplateCreate {
|
|
4315
|
-
template_type: string;
|
|
4316
|
-
group_id?: string;
|
|
4317
|
-
name: string;
|
|
4318
|
-
description?: string;
|
|
4319
|
-
subject: string;
|
|
4320
|
-
header_text?: string;
|
|
4321
|
-
message_top?: string;
|
|
4322
|
-
message_bottom?: string;
|
|
4323
|
-
button_text?: string;
|
|
4324
|
-
custom_html?: string;
|
|
4325
|
-
available_variables?: Record<string, string>;
|
|
4326
|
-
enabled?: boolean;
|
|
4327
|
-
}
|
|
4328
|
-
interface EmailTemplateUpdate {
|
|
4329
|
-
name?: string;
|
|
4330
|
-
description?: string;
|
|
4331
|
-
subject?: string;
|
|
4332
|
-
header_text?: string;
|
|
4333
|
-
message_top?: string;
|
|
4334
|
-
message_bottom?: string;
|
|
4335
|
-
button_text?: string;
|
|
4336
|
-
custom_html?: string;
|
|
4337
|
-
available_variables?: Record<string, string>;
|
|
4338
|
-
enabled?: boolean;
|
|
4339
|
-
}
|
|
4340
|
-
interface TestEmailRequest {
|
|
4341
|
-
recipient_email: string;
|
|
4342
|
-
}
|
|
4343
|
-
interface TestEmailResponse {
|
|
4344
|
-
message: string;
|
|
4345
|
-
}
|
|
4346
|
-
/**
|
|
4347
|
-
* Email Templates API client for workspace-scoped templates
|
|
4348
|
-
*/
|
|
4349
|
-
declare class EmailTemplatesClient {
|
|
4350
|
-
private readonly http;
|
|
4351
|
-
constructor(http: HttpClient);
|
|
4352
|
-
/**
|
|
4353
|
-
* List all email templates for the workspace
|
|
4354
|
-
* @param groupId - Workspace ID
|
|
4355
|
-
*/
|
|
4356
|
-
list(groupId: string): Promise<EmailTemplateSummary[]>;
|
|
4357
|
-
/**
|
|
4358
|
-
* Get a specific email template
|
|
4359
|
-
* @param groupId - Workspace ID
|
|
4360
|
-
* @param templateId - Template ID
|
|
4361
|
-
*/
|
|
4362
|
-
get(groupId: string, templateId: string): Promise<EmailTemplateRead>;
|
|
4363
|
-
/**
|
|
4364
|
-
* Create a new email template
|
|
4365
|
-
* @param groupId - Workspace ID
|
|
4366
|
-
* @param data - Template data
|
|
4367
|
-
*/
|
|
4368
|
-
create(groupId: string, data: EmailTemplateCreate): Promise<EmailTemplateRead>;
|
|
4369
|
-
/**
|
|
4370
|
-
* Update an email template
|
|
4371
|
-
* @param groupId - Workspace ID
|
|
4372
|
-
* @param templateId - Template ID
|
|
4373
|
-
* @param data - Updated template data
|
|
4374
|
-
*/
|
|
4375
|
-
update(groupId: string, templateId: string, data: EmailTemplateUpdate): Promise<EmailTemplateRead>;
|
|
4376
|
-
/**
|
|
4377
|
-
* Delete an email template
|
|
4378
|
-
* @param groupId - Workspace ID
|
|
4379
|
-
* @param templateId - Template ID
|
|
4380
|
-
*/
|
|
4381
|
-
delete(groupId: string, templateId: string): Promise<void>;
|
|
4382
|
-
/**
|
|
4383
|
-
* Send a test email using a template
|
|
4384
|
-
* @param groupId - Workspace ID
|
|
4385
|
-
* @param templateId - Template ID
|
|
4386
|
-
* @param recipientEmail - Test recipient email address
|
|
4387
|
-
*/
|
|
4388
|
-
sendTest(groupId: string, templateId: string, recipientEmail: string): Promise<TestEmailResponse>;
|
|
4389
|
-
}
|
|
4390
|
-
|
|
4391
|
-
/**
|
|
4392
|
-
* Scheduled Tasks Module - Platform API
|
|
4393
|
-
*
|
|
4394
|
-
* Manage workspace scheduled task automation
|
|
4395
|
-
*/
|
|
4396
|
-
|
|
4397
|
-
type ScheduledTask = components['schemas']['ScheduledTaskRead'];
|
|
4398
|
-
type ScheduledTaskCreate = components['schemas']['ScheduledTaskCreate'];
|
|
4399
|
-
type ScheduledTaskUpdate = components['schemas']['ScheduledTaskUpdate'];
|
|
4400
|
-
type ScheduledTaskExecutionLog = components['schemas']['ScheduledTaskExecutionLogRead'];
|
|
4401
|
-
interface TaskTypeInfo {
|
|
4402
|
-
task_type: string;
|
|
4403
|
-
name: string;
|
|
4404
|
-
description: string;
|
|
4405
|
-
config_schema?: any;
|
|
4406
|
-
}
|
|
4407
|
-
declare class ScheduledTasksModule {
|
|
4408
|
-
private http;
|
|
4409
|
-
constructor(http: HttpClient);
|
|
4410
|
-
/**
|
|
4411
|
-
* List all scheduled tasks for the current workspace
|
|
4412
|
-
*/
|
|
4413
|
-
list(): Promise<ScheduledTask[]>;
|
|
4414
|
-
/**
|
|
4415
|
-
* Get a scheduled task by ID or slug
|
|
4416
|
-
*/
|
|
4417
|
-
get(idOrSlug: string): Promise<ScheduledTask>;
|
|
4418
|
-
/**
|
|
4419
|
-
* Create a new scheduled task
|
|
4420
|
-
*/
|
|
4421
|
-
create(data: ScheduledTaskCreate): Promise<ScheduledTask>;
|
|
4422
|
-
/**
|
|
4423
|
-
* Update a scheduled task
|
|
4424
|
-
*/
|
|
4425
|
-
update(idOrSlug: string, data: ScheduledTaskUpdate): Promise<ScheduledTask>;
|
|
4426
|
-
/**
|
|
4427
|
-
* Delete a scheduled task
|
|
4428
|
-
*/
|
|
4429
|
-
delete(idOrSlug: string): Promise<void>;
|
|
4430
|
-
/**
|
|
4431
|
-
* Manually trigger task execution (bypass schedule)
|
|
4432
|
-
*/
|
|
4433
|
-
execute(idOrSlug: string): Promise<void>;
|
|
4434
|
-
/**
|
|
4435
|
-
* Get task execution history
|
|
4436
|
-
*/
|
|
4437
|
-
history(idOrSlug: string, options?: {
|
|
4438
|
-
limit?: number;
|
|
4439
|
-
}): Promise<ScheduledTaskExecutionLog[]>;
|
|
4440
|
-
/**
|
|
4441
|
-
* Get available task types
|
|
4442
|
-
*/
|
|
4443
|
-
taskTypes(options?: {
|
|
4444
|
-
detailed?: boolean;
|
|
4445
|
-
}): Promise<string[] | TaskTypeInfo[]>;
|
|
4446
|
-
}
|
|
4447
|
-
|
|
4448
|
-
/**
|
|
4449
|
-
* Forms Module - Platform API
|
|
4450
|
-
*
|
|
4451
|
-
* CRUD operations for forms and submissions
|
|
4452
|
-
*/
|
|
4453
|
-
|
|
4454
|
-
declare class FormsModule {
|
|
4455
|
-
private http;
|
|
4456
|
-
constructor(http: HttpClient);
|
|
4457
|
-
/**
|
|
4458
|
-
* Validate form submission data
|
|
4459
|
-
* - Prevents XSS by checking for script tags
|
|
4460
|
-
* - Validates data is a proper object
|
|
4461
|
-
* - Checks for reasonable size limits
|
|
4462
|
-
*/
|
|
4463
|
-
private validateFormData;
|
|
4464
|
-
/**
|
|
4465
|
-
* List all forms
|
|
4466
|
-
*/
|
|
4467
|
-
list(): Promise<PlatformForm[]>;
|
|
4468
|
-
/**
|
|
4469
|
-
* Get a single form by ID
|
|
4470
|
-
*/
|
|
4471
|
-
get(id: string): Promise<PlatformForm>;
|
|
4472
|
-
/**
|
|
4473
|
-
* Create a new form
|
|
4474
|
-
*/
|
|
4475
|
-
create(data: PlatformFormCreate): Promise<PlatformForm>;
|
|
4476
|
-
/**
|
|
4477
|
-
* Update a form
|
|
4478
|
-
*/
|
|
4479
|
-
update(id: string, data: PlatformFormUpdate): Promise<PlatformForm>;
|
|
4480
|
-
/**
|
|
4481
|
-
* Delete a form
|
|
4482
|
-
*/
|
|
4483
|
-
delete(id: string): Promise<void>;
|
|
4484
|
-
/**
|
|
4485
|
-
* Get submissions for a form
|
|
4486
|
-
*/
|
|
4487
|
-
getSubmissions(formId: string): Promise<PlatformFormSubmission[]>;
|
|
4488
|
-
/**
|
|
4489
|
-
* Get a published form by slug (Publishing API - public access)
|
|
4490
|
-
*/
|
|
4491
|
-
getPublishedForm(slug: string): Promise<PlatformForm>;
|
|
4492
|
-
/**
|
|
4493
|
-
* Submit data to a published form (Publishing API - public access)
|
|
4494
|
-
* Validates data before submission to prevent XSS and malicious content
|
|
4495
|
-
*/
|
|
4496
|
-
submitForm(slug: string, data: Record<string, unknown>): Promise<PlatformFormSubmission>;
|
|
4497
|
-
}
|
|
4498
|
-
|
|
4499
3799
|
/**
|
|
4500
3800
|
* Platform API Client
|
|
4501
3801
|
*
|
|
@@ -4503,14 +3803,10 @@ declare class FormsModule {
|
|
|
4503
3803
|
*/
|
|
4504
3804
|
|
|
4505
3805
|
interface PlatformClientConfig {
|
|
4506
|
-
apiUrl
|
|
3806
|
+
apiUrl: string;
|
|
4507
3807
|
userToken?: string;
|
|
4508
3808
|
credentials?: RequestCredentials;
|
|
4509
3809
|
}
|
|
4510
|
-
/**
|
|
4511
|
-
* Create Platform API config from environment
|
|
4512
|
-
*/
|
|
4513
|
-
declare function createPlatformConfigFromEnv(overrides?: Partial<PlatformClientConfig>): PlatformClientConfig;
|
|
4514
3810
|
declare class PlatformClient extends HttpClient {
|
|
4515
3811
|
entries: EntriesModule;
|
|
4516
3812
|
collections: CollectionsModule;
|
|
@@ -4528,9 +3824,6 @@ declare class PlatformClient extends HttpClient {
|
|
|
4528
3824
|
eventLog: EventLogModule;
|
|
4529
3825
|
session: AuthModule;
|
|
4530
3826
|
theme: ThemeModule;
|
|
4531
|
-
emailTemplates: EmailTemplatesClient;
|
|
4532
|
-
scheduledTasks: ScheduledTasksModule;
|
|
4533
|
-
forms: FormsModule;
|
|
4534
3827
|
adminUsers: AdminUsersModule;
|
|
4535
3828
|
adminSystem: AdminSystemModule;
|
|
4536
3829
|
adminMaintenance: AdminMaintenanceModule;
|
|
@@ -4538,23 +3831,7 @@ declare class PlatformClient extends HttpClient {
|
|
|
4538
3831
|
}
|
|
4539
3832
|
/**
|
|
4540
3833
|
* Create a Platform API client
|
|
4541
|
-
*
|
|
4542
|
-
* @example
|
|
4543
|
-
* ```ts
|
|
4544
|
-
* // From environment (MARVIN_API_URL, MARVIN_USER_TOKEN)
|
|
4545
|
-
* const platform = createPlatformClient();
|
|
4546
|
-
*
|
|
4547
|
-
* // With explicit user token (for programmatic admin)
|
|
4548
|
-
* const platform = createPlatformClient({
|
|
4549
|
-
* userToken: 'user-token-here'
|
|
4550
|
-
* });
|
|
4551
|
-
*
|
|
4552
|
-
* // Browser with session cookies (admin UI)
|
|
4553
|
-
* const platform = createPlatformClient({
|
|
4554
|
-
* credentials: 'include'
|
|
4555
|
-
* });
|
|
4556
|
-
* ```
|
|
4557
3834
|
*/
|
|
4558
|
-
declare function createPlatformClient(config
|
|
3835
|
+
declare function createPlatformClient(config: PlatformClientConfig): PlatformClient;
|
|
4559
3836
|
|
|
4560
|
-
export { APIClientsModule, type AdminAboutInfo, AdminMaintenanceModule, AdminSystemModule, AdminUsersModule, type ApiToken, type ApiTokenCreate, type ApiTokenWithToken, type AppTheme, AssetsModule, AuthModule,
|
|
3837
|
+
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 };
|