@inneropen/marvin-sdk 1.6.0 → 1.8.0

package/dist/platform.d.cts

@@ -2703,6 +2703,12 @@ interface WorkspaceUpdate {
     name?: string;
     description?: string | null;
 }
+interface WorkspacePreferences {
+    [key: string]: any;
+}
+interface WorkspacePreferencesUpdate {
+    [key: string]: any;
+}
 declare class WorkspacesModule {
     private http;
     constructor(http: HttpClient);
@@ -2735,6 +2741,14 @@ declare class WorkspacesModule {
      * Delete a workspace (requires SUPER_ADMIN)
      */
     delete(id: string, force?: boolean): Promise<void>;
+    /**
+     * Get workspace preferences
+     */
+    getPreferences(workspaceId: string): Promise<WorkspacePreferences>;
+    /**
+     * Update workspace preferences
+     */
+    updatePreferences(workspaceId: string, data: WorkspacePreferencesUpdate): Promise<WorkspacePreferences>;
 }
 
 /**
@@ -2767,6 +2781,366 @@ declare class InvitesModule {
     sendEmail(data: EmailInvitationRequest): Promise<void>;
 }
 
+/**
+ * Notifications Module - Platform API
+ *
+ * Manage workspace notifications
+ */
+
+interface Notification {
+    id: string;
+    name: string;
+    enabled: boolean;
+    eventType: string;
+    url?: string;
+    config?: Record<string, any>;
+}
+interface NotificationCreate {
+    name: string;
+    eventType: string;
+    url?: string;
+    enabled?: boolean;
+    config?: Record<string, any>;
+}
+interface NotificationUpdate {
+    name?: string;
+    eventType?: string;
+    url?: string;
+    enabled?: boolean;
+    config?: Record<string, any>;
+}
+declare class NotificationsModule {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * List all notifications for the current workspace
+     */
+    list(): Promise<Notification[]>;
+    /**
+     * Get a notification by ID
+     */
+    get(id: string): Promise<Notification>;
+    /**
+     * Create a new notification
+     */
+    create(data: NotificationCreate): Promise<Notification>;
+    /**
+     * Update a notification
+     */
+    update(id: string, data: NotificationUpdate): Promise<Notification>;
+    /**
+     * Delete a notification
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Test a notification
+     */
+    test(id: string): Promise<{
+        success: boolean;
+        message?: string;
+    }>;
+}
+
+/**
+ * Webhooks Module - Platform API
+ *
+ * Manage workspace webhooks
+ */
+
+type Webhook = components['schemas']['WebhookRead'];
+type WebhookCreate = components['schemas']['WebhookCreate'];
+type WebhookPagination = components['schemas']['WebhookPagination'];
+type WebhookMethod = components['schemas']['WebhookMethod'];
+interface WebhookUpdate {
+    name?: string;
+    url?: string;
+    enabled?: boolean;
+    eventTypes?: string[];
+    method?: WebhookMethod;
+    headers?: Record<string, string>;
+}
+declare class WebhooksModule {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * List all webhooks for the current workspace
+     */
+    list(): Promise<Webhook[]>;
+    /**
+     * Get a webhook by ID
+     */
+    get(id: string): Promise<Webhook>;
+    /**
+     * Create a new webhook
+     */
+    create(data: WebhookCreate): Promise<Webhook>;
+    /**
+     * Update a webhook
+     */
+    update(id: string, data: WebhookUpdate): Promise<Webhook>;
+    /**
+     * Delete a webhook
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Test a webhook
+     */
+    test(id: string): Promise<{
+        success: boolean;
+        message?: string;
+        statusCode?: number;
+    }>;
+    /**
+     * Rerun failed webhooks
+     */
+    rerun(): Promise<{
+        message: string;
+        requeued: number;
+    }>;
+}
+
+/**
+ * Admin Users Module - Platform API
+ *
+ * User management for administrators
+ */
+
+type User = components['schemas']['UserRead'];
+type UserCreate = components['schemas']['UserCreate'];
+type UserUpdate = components['schemas']['UserUpdate'];
+type UserPagination = components['schemas']['UserPagination'];
+type UserSummary = components['schemas']['UserSummary'];
+interface PasswordResetTokenRequest {
+    userId: string;
+}
+interface PasswordResetTokenResponse {
+    token: string;
+}
+interface UnlockUserRequest {
+    userId: string;
+}
+declare class AdminUsersModule {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * List all users (paginated)
+     */
+    list(page?: number, perPage?: number): Promise<UserPagination>;
+    /**
+     * Get a user by ID
+     */
+    get(id: string): Promise<User>;
+    /**
+     * Update a user
+     */
+    update(id: string, data: UserUpdate): Promise<User>;
+    /**
+     * Delete a user
+     */
+    delete(id: string): Promise<void>;
+    /**
+     * Generate a password reset token for a user
+     */
+    generatePasswordResetToken(userId: string): Promise<PasswordResetTokenResponse>;
+    /**
+     * Unlock a locked user account
+     */
+    unlock(userId: string): Promise<void>;
+}
+
+/**
+ * Admin System Module - Platform API
+ *
+ * System information and settings for administrators
+ */
+
+type AdminAboutInfo = components['schemas']['AdminAboutInfo'];
+interface EmailSettings {
+    host?: string;
+    port?: number;
+    username?: string;
+    password?: string;
+    from?: string;
+    useTls?: boolean;
+}
+interface SystemStatistics {
+    users?: number;
+    workspaces?: number;
+    entries?: number;
+    collections?: number;
+    resources?: number;
+    assets?: number;
+}
+declare class AdminSystemModule {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Get system information
+     */
+    getAbout(): Promise<AdminAboutInfo>;
+    /**
+     * Check system health
+     */
+    check(): Promise<{
+        status: string;
+    }>;
+    /**
+     * Get startup information
+     */
+    getStartupInfo(): Promise<any>;
+    /**
+     * Get system statistics
+     */
+    getStatistics(): Promise<SystemStatistics>;
+    /**
+     * Get email settings
+     */
+    getEmailSettings(): Promise<EmailSettings>;
+    /**
+     * Update email settings
+     */
+    updateEmailSettings(data: EmailSettings): Promise<EmailSettings>;
+}
+
+/**
+ * Admin Maintenance Module - Platform API
+ *
+ * System maintenance operations for administrators
+ */
+
+type MaintenanceSummary = components['schemas']['MaintenanceSummary'];
+type MaintenanceStorageDetails = components['schemas']['MaintenanceStorageDetails'];
+declare class AdminMaintenanceModule {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Clean temporary files
+     */
+    cleanTemp(): Promise<{
+        message: string;
+    }>;
+    /**
+     * Clean up old events
+     */
+    cleanupEvents(): Promise<{
+        message: string;
+        deleted: number;
+    }>;
+    /**
+     * Clean up expired tokens
+     */
+    cleanupTokens(): Promise<{
+        message: string;
+        deleted: number;
+    }>;
+    /**
+     * Clear application cache
+     */
+    clearCache(): Promise<{
+        message: string;
+    }>;
+    /**
+     * Optimize database
+     */
+    optimizeDatabase(): Promise<{
+        message: string;
+    }>;
+    /**
+     * Get maintenance statistics
+     */
+    getStats(): Promise<MaintenanceSummary>;
+    /**
+     * Get storage information
+     */
+    getStorage(): Promise<MaintenanceStorageDetails>;
+}
+
+/**
+ * User Self-Service Module - Platform API
+ *
+ * User profile and personal API token management
+ */
+
+interface UserProfile {
+    id: string;
+    username: string;
+    email: string;
+    fullName?: string | null;
+    admin: boolean;
+}
+interface ApiToken {
+    id: string;
+    name: string;
+    description?: string | null;
+    lastUsedAt?: string | null;
+    createdAt: string;
+    expiresAt?: string | null;
+}
+interface ApiTokenCreate {
+    name: string;
+    description?: string | null;
+    expiresAt?: string | null;
+}
+interface ApiTokenWithToken extends ApiToken {
+    token: string;
+}
+interface PasswordChange {
+    currentPassword: string;
+    newPassword: string;
+}
+declare class UserModule {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Get current user profile
+     */
+    getProfile(): Promise<UserProfile>;
+    /**
+     * List personal API tokens
+     */
+    listApiTokens(): Promise<ApiToken[]>;
+    /**
+     * Create a new personal API token
+     */
+    createApiToken(data: ApiTokenCreate): Promise<ApiTokenWithToken>;
+    /**
+     * Revoke an API token
+     */
+    revokeApiToken(tokenId: string): Promise<void>;
+    /**
+     * Rotate an API token (revoke old, create new)
+     */
+    rotateApiToken(tokenId: string): Promise<ApiTokenWithToken>;
+    /**
+     * Delete an API token
+     */
+    deleteApiToken(tokenId: string): Promise<void>;
+    /**
+     * Change password
+     */
+    changePassword(data: PasswordChange): Promise<void>;
+}
+
+/**
+ * Events Module - Platform API
+ *
+ * Event type information for webhooks and notifications
+ */
+
+interface EventOption {
+    value: string;
+    label: string;
+    description?: string;
+}
+declare class EventsModule {
+    private http;
+    constructor(http: HttpClient);
+    /**
+     * Get available event types for webhooks and notifications
+     */
+    getOptions(): Promise<EventOption[]>;
+}
+
 /**
  * Platform API Client
  *
@@ -2788,6 +3162,13 @@ declare class PlatformClient extends HttpClient {
     workspaceMembers: WorkspaceMembersModule;
     workspaces: WorkspacesModule;
     invites: InvitesModule;
+    notifications: NotificationsModule;
+    webhooks: WebhooksModule;
+    user: UserModule;
+    events: EventsModule;
+    adminUsers: AdminUsersModule;
+    adminSystem: AdminSystemModule;
+    adminMaintenance: AdminMaintenanceModule;
     constructor(config: PlatformClientConfig);
 }
 /**
@@ -2795,4 +3176,4 @@ declare class PlatformClient extends HttpClient {
  */
 declare function createPlatformClient(config: PlatformClientConfig): PlatformClient;
 
-export { APIClientsModule, AssetsModule, CollectionsModule, type EmailInvitationRequest, EntriesModule, EntryTypesModule, type InviteTokenCreate, type InviteTokenPagination, type InviteTokenSummary, InvitesModule, type PlatformAPIClient, type PlatformAPIClientCreate, type PlatformAPIClientUpdate, type PlatformAPIClientWithToken, type PlatformAsset, type PlatformAssetCreate, 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 Workspace, type WorkspaceActivationRequest, type WorkspaceCreate, WorkspaceMembersModule, type WorkspaceUpdate, type WorkspaceWithMembership, WorkspacesModule, createPlatformClient };
+export { APIClientsModule, type AdminAboutInfo, AdminMaintenanceModule, AdminSystemModule, AdminUsersModule, type ApiToken, type ApiTokenCreate, type ApiTokenWithToken, AssetsModule, CollectionsModule, type EmailInvitationRequest, type EmailSettings, EntriesModule, EntryTypesModule, 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 PlatformAssetCreate, 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 UnlockUserRequest, type User, type UserCreate, UserModule, type UserPagination, type UserProfile, 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 };