@inneropen/marvin-sdk 2.0.0-next.6 → 2.0.0-next.8

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.
@@ -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.
@@ -940,7 +1097,7 @@ interface components {
940
1097
  * Helps listeners understand the nature of `EventDocumentDataBase` content.
941
1098
  * @enum {string}
942
1099
  */
943
- 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";
944
1101
  /**
945
1102
  * EventLogRead
946
1103
  * @description Schema for reading an event log entry.
@@ -1090,6 +1247,165 @@ interface components {
1090
1247
  /** Email */
1091
1248
  email: string;
1092
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
+ };
1093
1409
  /**
1094
1410
  * GroupAdminUpdate
1095
1411
  * @description Schema for administrators to update a group.
@@ -1851,6 +2167,29 @@ interface components {
1851
2167
  /** Order */
1852
2168
  order?: number | null;
1853
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;
2192
+ };
1854
2193
  /**
1855
2194
  * PublishedResourceRead
1856
2195
  * @description Schema for published resources in entry context.
@@ -2286,6 +2625,17 @@ interface components {
2286
2625
  /** Data Dir Path */
2287
2626
  data_dir_path: string;
2288
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
+ };
2289
2639
  /**
2290
2640
  * TokenResponseDelete
2291
2641
  * @description Schema for the response after successfully deleting an API token.
@@ -2907,6 +3257,16 @@ type PlatformWorkspaceMemberUpdate = components['schemas']['WorkspaceMemberUpdat
2907
3257
  */
2908
3258
  type EventLogEntry = components['schemas']['EventLogRead'];
2909
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'];
2910
3270
 
2911
3271
  /**
2912
3272
  * Entries Module - Platform API
@@ -3940,6 +4300,106 @@ declare class EmailTemplatesClient {
3940
4300
  sendTest(groupId: string, templateId: string, recipientEmail: string): Promise<TestEmailResponse>;
3941
4301
  }
3942
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
+
3943
4403
  /**
3944
4404
  * Platform API Client
3945
4405
  *
@@ -3969,6 +4429,8 @@ declare class PlatformClient extends HttpClient {
3969
4429
  session: AuthModule;
3970
4430
  theme: ThemeModule;
3971
4431
  emailTemplates: EmailTemplatesClient;
4432
+ scheduledTasks: ScheduledTasksModule;
4433
+ forms: FormsModule;
3972
4434
  adminUsers: AdminUsersModule;
3973
4435
  adminSystem: AdminSystemModule;
3974
4436
  adminMaintenance: AdminMaintenanceModule;
@@ -3979,4 +4441,4 @@ declare class PlatformClient extends HttpClient {
3979
4441
  */
3980
4442
  declare function createPlatformClient(config: PlatformClientConfig): PlatformClient;
3981
4443
 
3982
- 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, 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, 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 };
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 };