@fusebase/fusebase-gate-sdk 1.0.2-sdk.0

package/dist/apis/DashboardsApi.d.ts

@@ -0,0 +1,405 @@
+/**
+ * Dashboards API
+ *
+ * Generated from contract introspection
+ * Domain: dashboards
+ */
+import type { Client } from "../runtime/transport";
+import type { AliasContract, aliasInQueryOptional, aliasInQueryRequired, AssignRepresentationToViewRequestContract, CopyDashboardFromDashboardRequestContract, copyDataInQueryRequired, copyRelationsInQueryRequired, copyViewsInQueryRequired, CreateDashboardFromFormRequestContract, CreateDashboardFromTemplateRequestContract, CreateDashboardIntentRequestContract, CreateDashboardRequestContract, CreateDashboardViewRepresentationTemplateRequestContract, CreateDashboardViewRepresentationTemplateResponseContract, CreateDashboardViewRequestContract, createDefaultRowsInQuery, CreateViewIntentRequestContract, DashboardAllowedSchemaItemsResponseContract, DashboardDescribeResponseContract, dashboardIdInPathRequired, DashboardListResponseContract, DashboardResponseContract, DashboardViewRepresentationTemplateListResponseContract, DashboardViewResponseContract, databaseIdInQueryRequired, DeleteDashboardSchemaItem200ResponseContract, ExportDashboardAsJson200ResponseContract, GetChildTableLinkDashboardRequestContract, GetChildTableLinkDashboardResponseContract, GetOrCreateDashboardRequestContract, GetOrCreateDashboardResponseContract, ImportDashboardRequestContract, mappingInQueryRequiredContract, nameInQueryOptional, PortalFormInfoListResponseContract, rootEntitiesInQueryOptional, rootEntityInQueryOptional, scopeIdInQueryRequired, scopeTypeInQueryRequired, scopeTypeOrgInQueryRequired, StandardApiResponseContract, UpdateDashboardRequestContract, UpdateDashboardViewFiltersRequestContract, UpdateDashboardViewRequestContract, UpdateSchemaIntentRequestContract, viewIdInPathRequired, viewIdInQueryOptional } from "../types";
+export declare class DashboardsApi {
+    private client;
+    constructor(client: Client);
+    /**
+     * Assign or update representation for a view
+     * Create or update a representation instance for a dashboard view. If this is the first representation for the view, it will automatically be set as default.
+     */
+    assignRepresentationToView(params: {
+        path: {
+            representationTemplateId: string;
+            dashboardId: dashboardIdInPathRequired;
+            viewId: viewIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body?: AssignRepresentationToViewRequestContract;
+    }): Promise<StandardApiResponseContract>;
+    /**
+     * Copy dashboard from another dashboard
+     * Create a new dashboard by copying an existing dashboard with all its views, representations, rows, and optionally data
+     */
+    copyDashboardFromDashboard(params: {
+        query?: {
+            copy_views: copyViewsInQueryRequired;
+            copy_data: copyDataInQueryRequired;
+            copy_relations: copyRelationsInQueryRequired;
+            create_default_rows?: createDefaultRowsInQuery;
+        };
+        headers?: Record<string, string>;
+        body: CopyDashboardFromDashboardRequestContract;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Create dashboard
+     * Create a new dashboard
+     */
+    createDashboard(params: {
+        headers?: Record<string, string>;
+        body: CreateDashboardRequestContract;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Create dashboard from form
+     * Create a new dashboard based on an existing form
+     */
+    createDashboardFromForm(params: {
+        headers?: Record<string, string>;
+        body: CreateDashboardFromFormRequestContract;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Create dashboard from template
+     * Create a new dashboard based on an existing template
+     */
+    createDashboardFromTemplate(params: {
+        headers?: Record<string, string>;
+        body: CreateDashboardFromTemplateRequestContract;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Create dashboard via Intent
+     * Create a new dashboard using a simplified Intent payload.
+     * The Intent payload is enriched into a canonical full schema using allowed-items templates.
+     * Keys and aliases are auto-generated if not provided.
+     *
+     */
+    createDashboardIntent(params: {
+        headers?: Record<string, string>;
+        body: CreateDashboardIntentRequestContract;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Create dashboard view
+     * Create a new dashboard view
+     */
+    createDashboardView(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: CreateDashboardViewRequestContract;
+    }): Promise<DashboardViewResponseContract>;
+    /**
+     * Create a dashboard view representation template (system endpoint)
+     * Create a new dashboard view representation template with its scope.
+     * This is a system endpoint used for internal operations.
+     *
+     */
+    createDashboardViewRepresentationTemplate(params: {
+        headers?: Record<string, string>;
+        body: CreateDashboardViewRepresentationTemplateRequestContract;
+    }): Promise<CreateDashboardViewRepresentationTemplateResponseContract>;
+    /**
+     * Create dashboard view via Intent
+     * Create a new dashboard view using a simplified Intent payload.
+     * Specify which columns from the dashboard schema to include in the view.
+     * Schema items must already exist in the dashboard before they can be included in a view.
+     * Does NOT modify the dashboard schema.
+     *
+     */
+    createViewIntent(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: CreateViewIntentRequestContract;
+    }): Promise<DashboardViewResponseContract>;
+    /**
+     * Delete dashboard by UUID
+     * Delete a dashboard (soft delete) by UUID
+     */
+    deleteDashboard(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<StandardApiResponseContract>;
+    /**
+     * Permanently delete dashboard schema item
+     * Permanently delete a schema item from a dashboard and all views by its key by dashboard UUID
+     */
+    deleteDashboardSchemaItem(params: {
+        path: {
+            itemKey: string;
+            dashboardId: dashboardIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DeleteDashboardSchemaItem200ResponseContract>;
+    /**
+     * Delete dashboard view
+     * Delete a dashboard view (soft delete)
+     */
+    deleteDashboardView(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+            viewId: viewIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<StandardApiResponseContract>;
+    /**
+     * Describe dashboard by UUID
+     * Describe a specific dashboard by UUID
+     */
+    describeDashboard(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DashboardDescribeResponseContract>;
+    /**
+     * Export dashboard data as CSV
+     * Export dashboard data as CSV format
+     */
+    exportDashboardAsCsv(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+        };
+        query?: {
+            view_id?: string;
+            delimiter?: string;
+            include_root_index_value?: boolean;
+        };
+        headers?: Record<string, string>;
+    }): Promise<string>;
+    /**
+     * Export dashboard as JSON
+     * Export dashboard structure and optionally data as JSON
+     */
+    exportDashboardAsJson(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+            viewId: viewIdInPathRequired;
+        };
+        query?: {
+            structure?: boolean;
+            data?: boolean;
+        };
+        headers?: Record<string, string>;
+    }): Promise<ExportDashboardAsJson200ResponseContract>;
+    /**
+     * Get or create child table link dashboard
+     * Get or create dashboard for a child-table-link cell.
+     * If childTableId in cell is null, creates new dashboard using template from schema item.
+     * If childTableId exists, returns the existing dashboard.
+     * Automatically updates the cell with the created dashboard ID.
+     *
+     */
+    getChildTableLinkDashboard(params: {
+        headers?: Record<string, string>;
+        body: GetChildTableLinkDashboardRequestContract;
+    }): Promise<GetChildTableLinkDashboardResponseContract>;
+    /**
+     * Get dashboard
+     * Get a specific dashboard by UUID
+     */
+    getDashboard(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Get available fields and related dashboards
+     * Returns the list of allowed SchemaItem fields for the specified dashboard, along with names and IDs of related dashboards.
+     */
+    getDashboardAllowedItems(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+        };
+        query?: {
+            source_view_ids?: unknown[];
+            include_possible_lookup_items?: boolean;
+            viewId?: viewIdInQueryOptional;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DashboardAllowedSchemaItemsResponseContract>;
+    /**
+     * Get allowed fields by root entity without related dashboards
+     * Returns the list of allowed SchemaItem fields without related dashboards. Returns only common fields that are allowed to be used in the dashboard specified by the root entity.
+     */
+    getDashboardAllowedItemsByRootEntity(params: {
+        query?: {
+            root_entity?: rootEntityInQueryOptional;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DashboardAllowedSchemaItemsResponseContract>;
+    /**
+     * Get fields types supported for CSV columns mapping
+     * Returns a list of SchemaItem fields that are supported for mapping to CSV columns
+     */
+    getDashboardCsvImportAllowedItems(params: {
+        query?: {
+            sort_by_detection_priority?: boolean;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DashboardAllowedSchemaItemsResponseContract>;
+    /**
+     * List dashboards
+     * Get a list of dashboards with optional filtering
+     */
+    getDashboards(params: {
+        query?: {
+            template_id?: string;
+            database_id?: string;
+            root_entities?: rootEntitiesInQueryOptional;
+            name?: nameInQueryOptional;
+            alias?: aliasInQueryOptional;
+            scope_type: scopeTypeInQueryRequired;
+            scope_id: scopeIdInQueryRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DashboardListResponseContract>;
+    /**
+     * Get dashboard view
+     * Get a specific dashboard view by ID
+     */
+    getDashboardView(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+            viewId: viewIdInPathRequired;
+        };
+        query?: {
+            fetch_filters?: boolean;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DashboardViewResponseContract>;
+    /**
+     * Get dashboard view templates for an organization
+     * Fetch dashboard view templates for a specific organization.
+     * Returns all managed templates and custom templates that have the provided scope ID in their scopes.
+     *
+     */
+    getDashboardViewRepresentationTemplates(params: {
+        query?: {
+            scope_type: scopeTypeOrgInQueryRequired;
+            scope_id: scopeIdInQueryRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DashboardViewRepresentationTemplateListResponseContract>;
+    /**
+     * Get or create dashboard
+     * Find dashboard by alias and scope, or create new one if not found.
+     * If creating from template, searches for template in template_scope first,
+     * then org scope from scopes array, then system org (from SYSTEM_ORG_SCOPE_ID env var).
+     *
+     */
+    getOrCreateDashboard(params: {
+        query?: {
+            database_id?: string;
+            database_alias?: AliasContract;
+            copy_with_content?: boolean;
+            alias: aliasInQueryRequired;
+            scope_type: scopeTypeOrgInQueryRequired;
+            scope_id: scopeIdInQueryRequired;
+        };
+        headers?: Record<string, string>;
+        body: GetOrCreateDashboardRequestContract;
+    }): Promise<GetOrCreateDashboardResponseContract>;
+    /**
+     * Get a list of forms
+     * Get a list of forms for a given org
+     */
+    getPortalFormsList(params: {
+        query?: {
+            scope_type: scopeTypeOrgInQueryRequired;
+            scope_id: scopeIdInQueryRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<PortalFormInfoListResponseContract>;
+    /**
+     * Import dashboard from JSON
+     * Import a dashboard from exported JSON structure
+     */
+    importDashboard(params: {
+        headers?: Record<string, string>;
+        body: ImportDashboardRequestContract;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Import dashboard data from CSV
+     * The mapping parameter uses OpenAPI's deepObject style with bracket notation
+     * for type-safe serialization in the generated client.
+     * Example query string:
+     * ?database_id=8b7c5d9d-f178-4b2a-99fb-bc3d5c363a6f&mapping[columns][0][index]=0&mapping[columns][0][type]=string&mapping[columns][0][edit_type]=string-single-line&mapping[columns][1][index]=1&mapping[columns][1][type]=number&mapping[columns][1][edit_type]=number
+     *
+     */
+    importDashboardFromCsv(params: {
+        query?: {
+            delimiter?: string;
+            dashboard_id?: string;
+            view_id?: string;
+            dashboard_name?: string;
+            database_id: databaseIdInQueryRequired;
+            mapping?: mappingInQueryRequiredContract;
+        };
+        headers?: Record<string, string>;
+        body: FormData;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Update dashboard
+     * Update an existing dashboard by UUID
+     */
+    updateDashboard(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: UpdateDashboardRequestContract;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Update dashboard schema via Intent patch
+     * Update dashboard schema items using a simplified Intent patch payload.
+     * Supports add, update, and remove operations on schema items.
+     * Only specified items are modified; others remain unchanged.
+     * The Intent payload is enriched into canonical full schema items using allowed-items templates.
+     *
+     */
+    updateDashboardSchemaIntent(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: UpdateSchemaIntentRequestContract;
+    }): Promise<DashboardResponseContract>;
+    /**
+     * Update dashboard view
+     * Update an existing dashboard view
+     */
+    updateDashboardView(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+            viewId: viewIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: UpdateDashboardViewRequestContract;
+    }): Promise<DashboardViewResponseContract>;
+    /**
+     * Update dashboard view filters
+     * Update only the filters configuration of a dashboard view
+     */
+    updateDashboardViewFilters(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+            viewId: viewIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: UpdateDashboardViewFiltersRequestContract;
+    }): Promise<StandardApiResponseContract>;
+    /**
+     * Update view schema via Intent patch
+     * Update view schema using the same Intent patch payload as dashboard schema updates.
+     * Supports add, update, and remove operations on schema items for this view.
+     * Uses UpdateSchemaIntentRequest (schema_patch) — same payload as PATCH /dashboards/{id}/schema/intent.
+     *
+     */
+    updateViewIntent(params: {
+        path: {
+            dashboardId: dashboardIdInPathRequired;
+            viewId: viewIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: UpdateSchemaIntentRequestContract;
+    }): Promise<DashboardViewResponseContract>;
+}