@cube-dev/platform-client 0.8.0 → 0.9.0
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/CHANGELOG.md +15 -1
- package/dist/schema.d.ts +498 -1
- package/dist/schema.d.ts.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -9,11 +9,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
9
9
|
|
|
10
10
|
<!-- Curate public-facing entries here before the next release. -->
|
|
11
11
|
|
|
12
|
+
## [0.9.0] - 2026-09-12
|
|
13
|
+
|
|
14
|
+
### Added
|
|
15
|
+
|
|
16
|
+
- New public REST API for managing Databricks Metric View publication settings (CUB-4443): `GET /api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}` (`DatabricksMetricViewIntegrationPublicController.getIntegration`) reads the current configuration and requires `SchemaRead` or `SchemaUpdate` access; `PUT` (`saveIntegration`) creates or updates it using optimistic `configurationVersion`-based concurrency (pass `expectedConfigurationVersion: 0` to create) and requires `SchemaUpdate` access. Both require a Databricks datasource; this is currently in preview — reach out to the Cube support team to activate it for your account. New schemas: `DatabricksMetricViewIntegrationResponse`, `DatabricksMetricViewIntegrationConfigurationResponse`, `SaveDatabricksMetricViewIntegrationInput`.
|
|
17
|
+
- New public REST API for listing the workbooks an embed tenant can access (CUB-4509): `GET /api/v1/deployments/{deploymentId}/embed-tenants/{embedTenantName}/workbooks` (`DashboardEmbedAccessPublicController.listEmbedTenantWorkbooks`) returns the tenant's effective access — direct tenant shares, all-embed-user shares, and access inherited from shared folders — with optional `accessSource` (`tenant` | `allEmbedUsers` | `folder`) filtering and cursor pagination. Requires administrator privileges. New schema: `EmbedTenantWorkbooksListResponse`.
|
|
18
|
+
- New public REST API for commenting on embeddable dashboards (CUB-3637): `GET /api/v1/embed/dashboard/{publicId}/comments` (`EmbedPublicController.listDashboardComments`) lists comment threads; `POST` (`createDashboardComment`) starts a thread or replies to one; `PATCH .../comments/{commentId}` (`updateDashboardComment`) and `DELETE .../comments/{commentId}` (`removeDashboardComment`) edit or soft-delete a comment (author only); `POST .../comments/{commentId}/resolve` (`setDashboardCommentResolved`) resolves or re-opens a thread (author only); `GET .../comments/mentionable-users` (`listMentionableEmbedUsers`) lists the caller's fellow embed users for a mention autocomplete. Requires a signed embed session scoped to an embed tenant. New schemas: `EmbedDashboardCommentDto`, `EmbedDashboardCommentThreadDto`, `EmbedDashboardCommentThreadsListResponse`, `CreateEmbedDashboardCommentBody`, `UpdateEmbedDashboardCommentBody`, `SetEmbedDashboardCommentResolvedBody`, `EmbedMentionableUserDto`, `EmbedMentionableUsersListResponse`.
|
|
19
|
+
- `EmbedSessionSettings` gained `locale` and `timezone` (CUB-4604) — a session's own language and time zone, resolved host message → launch param → session → account → built-in default; and four per-session Creator Mode opt-outs (CUB-4147): `showWorkbookShare`, `showDashboardSettings`, `showMemberNames`, `showGroupByCube`.
|
|
20
|
+
- `AppConfigResponse` gained `sheetsAgentChatEnabled` (CUB-4574) — whether the Sheets add-in's chat can act on the spreadsheet (run a query into cells, read a range) rather than only describe changes it cannot make.
|
|
21
|
+
|
|
22
|
+
### Fixed
|
|
23
|
+
|
|
24
|
+
- `DatabricksMetricViewPublicationPublicController.startPreview` and the new Databricks Metric View integration endpoints no longer name the internal `useDatabricksMetricViewsPush` feature flag (or an internal codename) in their descriptions — both now point readers at the Cube support team to activate the preview feature, matching every other preview-gated endpoint.
|
|
25
|
+
|
|
12
26
|
## [0.8.0] - 2026-09-11
|
|
13
27
|
|
|
14
28
|
### Added
|
|
15
29
|
|
|
16
|
-
- New public REST API for previewing a Databricks Metric View publication (CUB-4442): `POST /api/v1/deployments/{deploymentId}/databricks-metric-view-previews` (`DatabricksMetricViewPublicationPublicController.startPreview`) queues an offline conversion of the deployment's latest successful build and returns `202` with polling URLs; `GET .../databricks-metric-view-previews/{previewId}` (`previewStatus`) polls progress; `GET .../databricks-metric-view-previews/{previewId}/result` (`previewResult`) returns the completed result (`409` while still running or if it ended without one); `DELETE .../databricks-metric-view-previews/{previewId}` (`cancelPreview`) requests cancellation. Requires `SchemaRead` or `SchemaUpdate` access
|
|
30
|
+
- New public REST API for previewing a Databricks Metric View publication (CUB-4442): `POST /api/v1/deployments/{deploymentId}/databricks-metric-view-previews` (`DatabricksMetricViewPublicationPublicController.startPreview`) queues an offline conversion of the deployment's latest successful build and returns `202` with polling URLs; `GET .../databricks-metric-view-previews/{previewId}` (`previewStatus`) polls progress; `GET .../databricks-metric-view-previews/{previewId}/result` (`previewResult`) returns the completed result (`409` while still running or if it ended without one); `DELETE .../databricks-metric-view-previews/{previewId}` (`cancelPreview`) requests cancellation. Requires `SchemaRead` or `SchemaUpdate` access; this is currently in preview — reach out to the Cube support team to activate it for your account. Preview payloads and results are retained for at most seven days. New schemas: `DatabricksMetricViewPublicationPreviewInput`, `DatabricksMetricViewPublicationPreviewStartResponse`, `DatabricksMetricViewPublicationPreviewStatusResponse`, `DatabricksMetricViewPublicationPreviewResultResponse`, `DatabricksMetricViewPublicationViewResult`, `DatabricksMetricViewPublicationIssue`, `DatabricksMetricViewPublicationCounts`, `DatabricksMetricViewPublicationDatasetSource`, `DatabricksMetricViewPublicationRuntime`, `DatabricksMetricViewPublicationProgress`.
|
|
17
31
|
- `StartDbtSyncInput` gained `source` (`"git"` | `"manifest"`) and `manifest` — pass an uploaded `manifest.json` directly instead of having Cube clone the dbt repository and run dbt itself (CUB-4492). The corresponding `DbtSyncRun` response gained `source` (which pull path a run used), and `DbtSyncRunStats` gained `dbtVersion` and `manifestGeneratedAt`, populated for manifest-sourced runs.
|
|
18
32
|
- `EmbedSessionSettings` / `EmbedSettings` gained `allowAi`, `showAiWidgets`, and `showWorkbookChat` (CUB-2615) — per-session AI opt-outs for embeds. `allowAi` disables every AI surface, including the standalone embed chat, and is enforced server-side so a client holding the token can't work around it; the `show*` keys (alongside the existing `showDashboardChat`) only hide specific entry points — the dashboard agent, workspace chat, and AI-summary widget generation, respectively.
|
|
19
33
|
|
package/dist/schema.d.ts
CHANGED
|
@@ -381,6 +381,30 @@ export interface paths {
|
|
|
381
381
|
patch?: never;
|
|
382
382
|
trace?: never;
|
|
383
383
|
};
|
|
384
|
+
"/api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}": {
|
|
385
|
+
parameters: {
|
|
386
|
+
query?: never;
|
|
387
|
+
header?: never;
|
|
388
|
+
path?: never;
|
|
389
|
+
cookie?: never;
|
|
390
|
+
};
|
|
391
|
+
/**
|
|
392
|
+
* Get Databricks Metric View publication settings
|
|
393
|
+
* @description Requires a Databricks datasource. This is currently in preview — reach out to the Cube support team to activate it for your account.
|
|
394
|
+
*/
|
|
395
|
+
get: operations["DatabricksMetricViewIntegrationPublicController.getIntegration"];
|
|
396
|
+
/**
|
|
397
|
+
* Create or update Databricks Metric View publication settings
|
|
398
|
+
* @description Uses optimistic configuration versioning. Pass `expectedConfigurationVersion` 0 to create. Requires a Databricks datasource. This is currently in preview — reach out to the Cube support team to activate it for your account.
|
|
399
|
+
*/
|
|
400
|
+
put: operations["DatabricksMetricViewIntegrationPublicController.saveIntegration"];
|
|
401
|
+
post?: never;
|
|
402
|
+
delete?: never;
|
|
403
|
+
options?: never;
|
|
404
|
+
head?: never;
|
|
405
|
+
patch?: never;
|
|
406
|
+
trace?: never;
|
|
407
|
+
};
|
|
384
408
|
"/api/v1/deployments/{deploymentId}/databricks-metric-view-previews": {
|
|
385
409
|
parameters: {
|
|
386
410
|
query?: never;
|
|
@@ -392,7 +416,7 @@ export interface paths {
|
|
|
392
416
|
put?: never;
|
|
393
417
|
/**
|
|
394
418
|
* Start a Databricks Metric View publication preview
|
|
395
|
-
* @description Queues an offline conversion of static YAML from the deployment's latest successful build and returns polling URLs immediately. Exact retries while the same content-addressed preview is running reuse that work; a later submission starts a fresh execution. Preview payloads and results are retained for at most seven days. The conversion supports scalar dimensions, common and calculated measures, and acyclic many-to-one equi-joins from one Databricks datasource. Access policies, templating, extends, unsafe fanout, unsupported expressions, multiple datasources, and converter loss are blocked per view. Two-part schema.table sources are qualified with CUBEJS_DB_DATABRICKS_CATALOG for the selected datasource; without that setting they fail closed with an actionable issue. Requires SchemaRead or SchemaUpdate access
|
|
419
|
+
* @description Queues an offline conversion of static YAML from the deployment's latest successful build and returns polling URLs immediately. Exact retries while the same content-addressed preview is running reuse that work; a later submission starts a fresh execution. Preview payloads and results are retained for at most seven days. The conversion supports scalar dimensions, common and calculated measures, and acyclic many-to-one equi-joins from one Databricks datasource. Access policies, templating, extends, unsafe fanout, unsupported expressions, multiple datasources, and converter loss are blocked per view. Two-part schema.table sources are qualified with `CUBEJS_DB_DATABRICKS_CATALOG` for the selected datasource; without that setting they fail closed with an actionable issue. Requires `SchemaRead` or `SchemaUpdate` access. This is currently in preview — reach out to the Cube support team to activate it for your account.
|
|
396
420
|
*/
|
|
397
421
|
post: operations["DatabricksMetricViewPublicationPublicController.startPreview"];
|
|
398
422
|
delete?: never;
|
|
@@ -509,6 +533,36 @@ export interface paths {
|
|
|
509
533
|
patch?: never;
|
|
510
534
|
trace?: never;
|
|
511
535
|
};
|
|
536
|
+
"/api/v1/deployments/{deploymentId}/embed-tenants/{embedTenantName}/workbooks": {
|
|
537
|
+
parameters: {
|
|
538
|
+
query?: never;
|
|
539
|
+
header?: never;
|
|
540
|
+
path?: never;
|
|
541
|
+
cookie?: never;
|
|
542
|
+
};
|
|
543
|
+
/**
|
|
544
|
+
* List workbooks accessible to an embed tenant
|
|
545
|
+
* @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
|
|
546
|
+
*
|
|
547
|
+
* Return every workbook the named embed tenant can access in this deployment. Effective access includes workbooks shared directly with the tenant, workbooks shared with all embed users, and workbooks inherited from shared folders. Supports `first`/`after` cursor pagination.
|
|
548
|
+
*
|
|
549
|
+
* Filter workbooks by how access is granted:
|
|
550
|
+
*
|
|
551
|
+
* - `tenant`: the workbook itself is explicitly shared with the named embed tenant. Excludes workbooks available only through the all-embed-users group or a shared folder.
|
|
552
|
+
* - `allEmbedUsers`: the workbook itself is explicitly shared with the built-in all-embed-users group, making it available to every embed tenant. Excludes tenant-specific direct shares and folder-inherited access.
|
|
553
|
+
* - `folder`: access is inherited because the workbook is inside a shared folder or any of its descendant folders. The folder may be shared specifically with the named tenant or with all embed users.
|
|
554
|
+
*
|
|
555
|
+
* Omit this parameter to return the union of all three access sources. A workbook can match more than one source.
|
|
556
|
+
*/
|
|
557
|
+
get: operations["DashboardEmbedAccessPublicController.listEmbedTenantWorkbooks"];
|
|
558
|
+
put?: never;
|
|
559
|
+
post?: never;
|
|
560
|
+
delete?: never;
|
|
561
|
+
options?: never;
|
|
562
|
+
head?: never;
|
|
563
|
+
patch?: never;
|
|
564
|
+
trace?: never;
|
|
565
|
+
};
|
|
512
566
|
"/api/v1/deployments/{deploymentId}/env-vars": {
|
|
513
567
|
parameters: {
|
|
514
568
|
query?: never;
|
|
@@ -1623,6 +1677,112 @@ export interface paths {
|
|
|
1623
1677
|
patch: operations["EmbedPublicController.updateDashboardEmbedding"];
|
|
1624
1678
|
trace?: never;
|
|
1625
1679
|
};
|
|
1680
|
+
"/api/v1/embed/dashboard/{publicId}/comments": {
|
|
1681
|
+
parameters: {
|
|
1682
|
+
query?: never;
|
|
1683
|
+
header?: never;
|
|
1684
|
+
path?: never;
|
|
1685
|
+
cookie?: never;
|
|
1686
|
+
};
|
|
1687
|
+
/**
|
|
1688
|
+
* List comment threads on an embeddable dashboard
|
|
1689
|
+
* @description Returns one page of comment threads — each a root comment plus its replies, oldest first — for the dashboard identified by its `publicId`, scoped to the caller's embed tenant.
|
|
1690
|
+
*
|
|
1691
|
+
* Threads are ordered newest-first by when they started, so a thread holds its place while it is being replied to. Open threads are returned by default; pass `includeResolved` to widen the page to resolved ones too, or `resolvedOnly` to replace the set with just those.
|
|
1692
|
+
*
|
|
1693
|
+
* A comment whose author deleted it is returned with an empty `body` and `removedAt` set, so a thread keeps its shape and the surviving replies stay readable.
|
|
1694
|
+
*
|
|
1695
|
+
* Requires a signed embed session scoped to an embed tenant. Every comment endpoint does: a conversation lives inside one embed tenant's partition, so a credential that names no tenant — an API key, a console session — has no conversation to be served and receives `403`.
|
|
1696
|
+
*/
|
|
1697
|
+
get: operations["EmbedPublicController.listDashboardComments"];
|
|
1698
|
+
put?: never;
|
|
1699
|
+
/**
|
|
1700
|
+
* Post a comment on an embeddable dashboard
|
|
1701
|
+
* @description Starts a thread, or replies to one when `parentId` names a thread root.
|
|
1702
|
+
*
|
|
1703
|
+
* The comment is attributed to the calling embed user — the author is taken from the signed session, never from the request body. Nesting is one level deep: replying to a reply returns `400`, and `404` covers a `parentId` that names a comment on another dashboard, a deleted thread, or nothing at all.
|
|
1704
|
+
*/
|
|
1705
|
+
post: operations["EmbedPublicController.createDashboardComment"];
|
|
1706
|
+
delete?: never;
|
|
1707
|
+
options?: never;
|
|
1708
|
+
head?: never;
|
|
1709
|
+
patch?: never;
|
|
1710
|
+
trace?: never;
|
|
1711
|
+
};
|
|
1712
|
+
"/api/v1/embed/dashboard/{publicId}/comments/mentionable-users": {
|
|
1713
|
+
parameters: {
|
|
1714
|
+
query?: never;
|
|
1715
|
+
header?: never;
|
|
1716
|
+
path?: never;
|
|
1717
|
+
cookie?: never;
|
|
1718
|
+
};
|
|
1719
|
+
/**
|
|
1720
|
+
* List embed users mentionable in a dashboard comment
|
|
1721
|
+
* @description Returns one page of the caller's fellow embed users, for a mention autocomplete, ordered by username.
|
|
1722
|
+
*
|
|
1723
|
+
* Scoped to the caller's own embed tenant and to embed users only — console users of the host tenant are never returned. Pass `search` to filter by username or email. `email` may be `null`: `username` is the only identity field an embed user is guaranteed to have.
|
|
1724
|
+
*/
|
|
1725
|
+
get: operations["EmbedPublicController.listMentionableEmbedUsers"];
|
|
1726
|
+
put?: never;
|
|
1727
|
+
post?: never;
|
|
1728
|
+
delete?: never;
|
|
1729
|
+
options?: never;
|
|
1730
|
+
head?: never;
|
|
1731
|
+
patch?: never;
|
|
1732
|
+
trace?: never;
|
|
1733
|
+
};
|
|
1734
|
+
"/api/v1/embed/dashboard/{publicId}/comments/{commentId}": {
|
|
1735
|
+
parameters: {
|
|
1736
|
+
query?: never;
|
|
1737
|
+
header?: never;
|
|
1738
|
+
path?: never;
|
|
1739
|
+
cookie?: never;
|
|
1740
|
+
};
|
|
1741
|
+
get?: never;
|
|
1742
|
+
put?: never;
|
|
1743
|
+
post?: never;
|
|
1744
|
+
/**
|
|
1745
|
+
* Delete a comment on an embeddable dashboard
|
|
1746
|
+
* @description Soft-deletes a comment. Author only.
|
|
1747
|
+
*
|
|
1748
|
+
* Deleting a thread root takes its replies with it, so a deleted thread leaves nothing behind. Deleting a reply re-derives its thread's last-activity marker, so the thread does not keep its position on the strength of a message that is gone.
|
|
1749
|
+
*/
|
|
1750
|
+
delete: operations["EmbedPublicController.removeDashboardComment"];
|
|
1751
|
+
options?: never;
|
|
1752
|
+
head?: never;
|
|
1753
|
+
/**
|
|
1754
|
+
* Edit a comment on an embeddable dashboard
|
|
1755
|
+
* @description Replaces a comment's body and stamps `editedAt`.
|
|
1756
|
+
*
|
|
1757
|
+
* Author only: another embed user's comment returns `403`, and a comment that is not on this dashboard returns `404` rather than revealing that it exists elsewhere.
|
|
1758
|
+
*/
|
|
1759
|
+
patch: operations["EmbedPublicController.updateDashboardComment"];
|
|
1760
|
+
trace?: never;
|
|
1761
|
+
};
|
|
1762
|
+
"/api/v1/embed/dashboard/{publicId}/comments/{commentId}/resolve": {
|
|
1763
|
+
parameters: {
|
|
1764
|
+
query?: never;
|
|
1765
|
+
header?: never;
|
|
1766
|
+
path?: never;
|
|
1767
|
+
cookie?: never;
|
|
1768
|
+
};
|
|
1769
|
+
get?: never;
|
|
1770
|
+
put?: never;
|
|
1771
|
+
/**
|
|
1772
|
+
* Resolve or re-open a comment thread
|
|
1773
|
+
* @description Marks a thread resolved, or re-opens it. Author only — the embed user who started the thread.
|
|
1774
|
+
*
|
|
1775
|
+
* The console surface is wider: there, a workbook editor may also resolve someone else's thread. That branch has no analogue here, because an embed viewer holds no workbook rights at all, so authorship is the whole rule.
|
|
1776
|
+
*
|
|
1777
|
+
* Threads only — a reply has no resolve state of its own, and one carrying it would put two answers on the same thread, so `400` is returned for a reply's id. A thread whose root was deleted while replies survive is still resolvable, or it would sit in the unresolved list forever.
|
|
1778
|
+
*/
|
|
1779
|
+
post: operations["EmbedPublicController.setDashboardCommentResolved"];
|
|
1780
|
+
delete?: never;
|
|
1781
|
+
options?: never;
|
|
1782
|
+
head?: never;
|
|
1783
|
+
patch?: never;
|
|
1784
|
+
trace?: never;
|
|
1785
|
+
};
|
|
1626
1786
|
"/api/v1/embed/dashboard/{publicId}/python-run": {
|
|
1627
1787
|
parameters: {
|
|
1628
1788
|
query?: never;
|
|
@@ -2876,6 +3036,7 @@ export interface components {
|
|
|
2876
3036
|
applyThemeGlobally: boolean;
|
|
2877
3037
|
creatorMode?: components["schemas"]["CreatorMode"] | null;
|
|
2878
3038
|
embedding?: components["schemas"]["EmbedSettings"] | null;
|
|
3039
|
+
sheetsAgentChatEnabled: boolean;
|
|
2879
3040
|
sheetsUi?: components["schemas"]["SheetsUiSettings"] | null;
|
|
2880
3041
|
timezoneSettings?: components["schemas"]["TimezoneSettings"] | null;
|
|
2881
3042
|
};
|
|
@@ -3108,6 +3269,10 @@ export interface components {
|
|
|
3108
3269
|
CreateDeploymentTokenInput: {
|
|
3109
3270
|
expiresIn?: number | null;
|
|
3110
3271
|
};
|
|
3272
|
+
CreateEmbedDashboardCommentBody: {
|
|
3273
|
+
body: string;
|
|
3274
|
+
parentId?: number | null;
|
|
3275
|
+
};
|
|
3111
3276
|
CreateEmbedGroupInput: {
|
|
3112
3277
|
description?: string | null;
|
|
3113
3278
|
/** @description Group name, unique within the embed tenant. The `system:` prefix is reserved and rejected. */
|
|
@@ -3544,6 +3709,39 @@ export interface components {
|
|
|
3544
3709
|
DataModelWriteResponse: {
|
|
3545
3710
|
success: boolean;
|
|
3546
3711
|
};
|
|
3712
|
+
DatabricksMetricViewIntegrationConfigurationResponse: {
|
|
3713
|
+
deletionPolicy: components["schemas"]["DatabricksMetricViewIntegrationConfigurationResponseDeletionPolicy"];
|
|
3714
|
+
enabled: boolean;
|
|
3715
|
+
selectionMode: components["schemas"]["DatabricksMetricViewIntegrationConfigurationResponseSelectionMode"];
|
|
3716
|
+
sourceOverrides?: {
|
|
3717
|
+
[key: string]: string;
|
|
3718
|
+
} | null;
|
|
3719
|
+
targetCatalog: string;
|
|
3720
|
+
targetNamePrefix?: string | null;
|
|
3721
|
+
targetNames?: {
|
|
3722
|
+
[key: string]: string;
|
|
3723
|
+
} | null;
|
|
3724
|
+
targetSchema: string;
|
|
3725
|
+
version: components["schemas"]["DatabricksMetricViewIntegrationConfigurationResponseVersion"];
|
|
3726
|
+
viewNameRegex?: string | null;
|
|
3727
|
+
viewNames?: string[] | null;
|
|
3728
|
+
};
|
|
3729
|
+
/** @enum {string} */
|
|
3730
|
+
DatabricksMetricViewIntegrationConfigurationResponseDeletionPolicy: "retain" | "delete-managed";
|
|
3731
|
+
/** @enum {string} */
|
|
3732
|
+
DatabricksMetricViewIntegrationConfigurationResponseSelectionMode: "all" | "selected" | "pattern";
|
|
3733
|
+
/** @enum {number} */
|
|
3734
|
+
DatabricksMetricViewIntegrationConfigurationResponseVersion: 1;
|
|
3735
|
+
DatabricksMetricViewIntegrationResponse: {
|
|
3736
|
+
accessTest?: Record<string, never> | null;
|
|
3737
|
+
configuration: components["schemas"]["DatabricksMetricViewIntegrationConfigurationResponse"];
|
|
3738
|
+
configurationVersion: number;
|
|
3739
|
+
createdAt: string;
|
|
3740
|
+
dataSourceName: string;
|
|
3741
|
+
deploymentId: number;
|
|
3742
|
+
publicId: string;
|
|
3743
|
+
updatedAt: string;
|
|
3744
|
+
};
|
|
3547
3745
|
DatabricksMetricViewPublicationCounts: {
|
|
3548
3746
|
dimensions: number;
|
|
3549
3747
|
errors: number;
|
|
@@ -3976,6 +4174,26 @@ export interface components {
|
|
|
3976
4174
|
};
|
|
3977
4175
|
/** @enum {string} */
|
|
3978
4176
|
EmbedAccessTenantEntryAction: "read" | "none";
|
|
4177
|
+
EmbedDashboardCommentDto: {
|
|
4178
|
+
body: string;
|
|
4179
|
+
createdAt: string;
|
|
4180
|
+
dashboardId: string;
|
|
4181
|
+
editedAt?: (string) | null;
|
|
4182
|
+
id: number;
|
|
4183
|
+
isOwn: boolean;
|
|
4184
|
+
removedAt?: (string) | null;
|
|
4185
|
+
userId?: number | null;
|
|
4186
|
+
};
|
|
4187
|
+
EmbedDashboardCommentThreadDto: {
|
|
4188
|
+
replies: components["schemas"]["EmbedDashboardCommentDto"][];
|
|
4189
|
+
resolvedAt?: (string) | null;
|
|
4190
|
+
resolvedBy?: number | null;
|
|
4191
|
+
root: components["schemas"]["EmbedDashboardCommentDto"];
|
|
4192
|
+
};
|
|
4193
|
+
EmbedDashboardCommentThreadsListResponse: {
|
|
4194
|
+
items: components["schemas"]["EmbedDashboardCommentThreadDto"][];
|
|
4195
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
4196
|
+
};
|
|
3979
4197
|
EmbedGroupMemberInput: {
|
|
3980
4198
|
embedUserId?: number | null;
|
|
3981
4199
|
externalId?: string | null;
|
|
@@ -3988,6 +4206,16 @@ export interface components {
|
|
|
3988
4206
|
addedMembers: components["schemas"]["EmbedUser"][];
|
|
3989
4207
|
unchangedMembers: components["schemas"]["EmbedUser"][];
|
|
3990
4208
|
};
|
|
4209
|
+
EmbedMentionableUserDto: {
|
|
4210
|
+
email?: string | null;
|
|
4211
|
+
firstName?: string | null;
|
|
4212
|
+
id: number;
|
|
4213
|
+
username: string;
|
|
4214
|
+
};
|
|
4215
|
+
EmbedMentionableUsersListResponse: {
|
|
4216
|
+
items: components["schemas"]["EmbedMentionableUserDto"][];
|
|
4217
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
4218
|
+
};
|
|
3991
4219
|
EmbedPythonFilteredRunInput: {
|
|
3992
4220
|
reportId: number;
|
|
3993
4221
|
reportVersionId: number;
|
|
@@ -3996,9 +4224,15 @@ export interface components {
|
|
|
3996
4224
|
EmbedSessionSettings: {
|
|
3997
4225
|
allowAi?: boolean | null;
|
|
3998
4226
|
allowChatWorkspaceAuthoring?: boolean | null;
|
|
4227
|
+
locale?: string | null;
|
|
3999
4228
|
showAiWidgets?: boolean | null;
|
|
4000
4229
|
showDashboardChat?: boolean | null;
|
|
4230
|
+
showDashboardSettings?: boolean | null;
|
|
4231
|
+
showGroupByCube?: boolean | null;
|
|
4232
|
+
showMemberNames?: boolean | null;
|
|
4001
4233
|
showWorkbookChat?: boolean | null;
|
|
4234
|
+
showWorkbookShare?: boolean | null;
|
|
4235
|
+
timezone?: string | null;
|
|
4002
4236
|
};
|
|
4003
4237
|
EmbedSettings: {
|
|
4004
4238
|
allowAi?: boolean | null;
|
|
@@ -4019,6 +4253,12 @@ export interface components {
|
|
|
4019
4253
|
EmbedTenantProfile: {
|
|
4020
4254
|
displayName?: string | null;
|
|
4021
4255
|
};
|
|
4256
|
+
/** @enum {string} */
|
|
4257
|
+
EmbedTenantWorkbooksListQueryAccessSource: "tenant" | "allEmbedUsers" | "folder";
|
|
4258
|
+
EmbedTenantWorkbooksListResponse: {
|
|
4259
|
+
items: components["schemas"]["Workbook"][];
|
|
4260
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
4261
|
+
};
|
|
4022
4262
|
EmbedTenantsPublicResponse: {
|
|
4023
4263
|
items: components["schemas"]["EmbedTenant"][];
|
|
4024
4264
|
pageInfo: components["schemas"]["PageInfo"];
|
|
@@ -4785,6 +5025,28 @@ export interface components {
|
|
|
4785
5025
|
id: number;
|
|
4786
5026
|
name: string;
|
|
4787
5027
|
};
|
|
5028
|
+
SaveDatabricksMetricViewIntegrationInput: {
|
|
5029
|
+
deletionPolicy?: components["schemas"]["SaveDatabricksMetricViewIntegrationInputDeletionPolicy"];
|
|
5030
|
+
enabled: boolean;
|
|
5031
|
+
/** @description Use 0 to create; otherwise pass the configurationVersion returned by GET. */
|
|
5032
|
+
expectedConfigurationVersion: number;
|
|
5033
|
+
selectionMode: components["schemas"]["SaveDatabricksMetricViewIntegrationInputSelectionMode"];
|
|
5034
|
+
sourceOverrides?: {
|
|
5035
|
+
[key: string]: string;
|
|
5036
|
+
};
|
|
5037
|
+
targetCatalog: string;
|
|
5038
|
+
targetNamePrefix?: string;
|
|
5039
|
+
targetNames?: {
|
|
5040
|
+
[key: string]: string;
|
|
5041
|
+
};
|
|
5042
|
+
targetSchema: string;
|
|
5043
|
+
viewNameRegex?: string;
|
|
5044
|
+
viewNames?: string[];
|
|
5045
|
+
};
|
|
5046
|
+
/** @enum {string} */
|
|
5047
|
+
SaveDatabricksMetricViewIntegrationInputDeletionPolicy: "retain" | "delete-managed";
|
|
5048
|
+
/** @enum {string} */
|
|
5049
|
+
SaveDatabricksMetricViewIntegrationInputSelectionMode: "all" | "selected" | "pattern";
|
|
4788
5050
|
SetBranchStagingEnvironmentRequest: {
|
|
4789
5051
|
branchId?: number | null;
|
|
4790
5052
|
branchName?: string | null;
|
|
@@ -4793,6 +5055,9 @@ export interface components {
|
|
|
4793
5055
|
SetBranchStagingEnvironmentResponse: {
|
|
4794
5056
|
data: components["schemas"]["BranchResponse"];
|
|
4795
5057
|
};
|
|
5058
|
+
SetEmbedDashboardCommentResolvedBody: {
|
|
5059
|
+
resolved: boolean;
|
|
5060
|
+
};
|
|
4796
5061
|
SetEnvVariablesInput: {
|
|
4797
5062
|
env_variables: components["schemas"]["EnvVariableItem"][];
|
|
4798
5063
|
};
|
|
@@ -4928,6 +5193,9 @@ export interface components {
|
|
|
4928
5193
|
};
|
|
4929
5194
|
/** @enum {string} */
|
|
4930
5195
|
UpdateEmbedAccessInputAction: "read" | "none";
|
|
5196
|
+
UpdateEmbedDashboardCommentBody: {
|
|
5197
|
+
body: string;
|
|
5198
|
+
};
|
|
4931
5199
|
UpdateEmbedGroupInput: {
|
|
4932
5200
|
description?: string | null;
|
|
4933
5201
|
};
|
|
@@ -6032,6 +6300,55 @@ export interface operations {
|
|
|
6032
6300
|
};
|
|
6033
6301
|
};
|
|
6034
6302
|
};
|
|
6303
|
+
"DatabricksMetricViewIntegrationPublicController.getIntegration": {
|
|
6304
|
+
parameters: {
|
|
6305
|
+
query?: never;
|
|
6306
|
+
header?: never;
|
|
6307
|
+
path: {
|
|
6308
|
+
deploymentId: number;
|
|
6309
|
+
dataSourceName: string;
|
|
6310
|
+
};
|
|
6311
|
+
cookie?: never;
|
|
6312
|
+
};
|
|
6313
|
+
requestBody?: never;
|
|
6314
|
+
responses: {
|
|
6315
|
+
200: {
|
|
6316
|
+
headers: {
|
|
6317
|
+
[name: string]: any;
|
|
6318
|
+
};
|
|
6319
|
+
content: {
|
|
6320
|
+
"application/json": components["schemas"]["DatabricksMetricViewIntegrationResponse"];
|
|
6321
|
+
};
|
|
6322
|
+
};
|
|
6323
|
+
};
|
|
6324
|
+
};
|
|
6325
|
+
"DatabricksMetricViewIntegrationPublicController.saveIntegration": {
|
|
6326
|
+
parameters: {
|
|
6327
|
+
query?: never;
|
|
6328
|
+
header?: never;
|
|
6329
|
+
path: {
|
|
6330
|
+
deploymentId: number;
|
|
6331
|
+
dataSourceName: string;
|
|
6332
|
+
};
|
|
6333
|
+
cookie?: never;
|
|
6334
|
+
};
|
|
6335
|
+
/** @description SaveDatabricksMetricViewIntegrationInput */
|
|
6336
|
+
requestBody?: {
|
|
6337
|
+
content: {
|
|
6338
|
+
"application/json": components["schemas"]["SaveDatabricksMetricViewIntegrationInput"];
|
|
6339
|
+
};
|
|
6340
|
+
};
|
|
6341
|
+
responses: {
|
|
6342
|
+
200: {
|
|
6343
|
+
headers: {
|
|
6344
|
+
[name: string]: any;
|
|
6345
|
+
};
|
|
6346
|
+
content: {
|
|
6347
|
+
"application/json": components["schemas"]["DatabricksMetricViewIntegrationResponse"];
|
|
6348
|
+
};
|
|
6349
|
+
};
|
|
6350
|
+
};
|
|
6351
|
+
};
|
|
6035
6352
|
"DatabricksMetricViewPublicationPublicController.startPreview": {
|
|
6036
6353
|
parameters: {
|
|
6037
6354
|
query?: never;
|
|
@@ -6265,6 +6582,32 @@ export interface operations {
|
|
|
6265
6582
|
};
|
|
6266
6583
|
};
|
|
6267
6584
|
};
|
|
6585
|
+
"DashboardEmbedAccessPublicController.listEmbedTenantWorkbooks": {
|
|
6586
|
+
parameters: {
|
|
6587
|
+
query?: {
|
|
6588
|
+
accessSource?: components["schemas"]["EmbedTenantWorkbooksListQueryAccessSource"] | null;
|
|
6589
|
+
after?: string;
|
|
6590
|
+
first?: number;
|
|
6591
|
+
};
|
|
6592
|
+
header?: never;
|
|
6593
|
+
path: {
|
|
6594
|
+
deploymentId: number;
|
|
6595
|
+
embedTenantName: string;
|
|
6596
|
+
};
|
|
6597
|
+
cookie?: never;
|
|
6598
|
+
};
|
|
6599
|
+
requestBody?: never;
|
|
6600
|
+
responses: {
|
|
6601
|
+
200: {
|
|
6602
|
+
headers: {
|
|
6603
|
+
[name: string]: any;
|
|
6604
|
+
};
|
|
6605
|
+
content: {
|
|
6606
|
+
"application/json": components["schemas"]["EmbedTenantWorkbooksListResponse"];
|
|
6607
|
+
};
|
|
6608
|
+
};
|
|
6609
|
+
};
|
|
6610
|
+
};
|
|
6268
6611
|
"EnvVariablesPublicController.getEnvVariables": {
|
|
6269
6612
|
parameters: {
|
|
6270
6613
|
query?: {
|
|
@@ -8020,6 +8363,160 @@ export interface operations {
|
|
|
8020
8363
|
};
|
|
8021
8364
|
};
|
|
8022
8365
|
};
|
|
8366
|
+
"EmbedPublicController.listDashboardComments": {
|
|
8367
|
+
parameters: {
|
|
8368
|
+
query?: {
|
|
8369
|
+
includeResolved?: boolean | null;
|
|
8370
|
+
resolvedOnly?: boolean | null;
|
|
8371
|
+
after?: string;
|
|
8372
|
+
first?: number;
|
|
8373
|
+
};
|
|
8374
|
+
header?: never;
|
|
8375
|
+
path: {
|
|
8376
|
+
publicId: string;
|
|
8377
|
+
};
|
|
8378
|
+
cookie?: never;
|
|
8379
|
+
};
|
|
8380
|
+
requestBody?: never;
|
|
8381
|
+
responses: {
|
|
8382
|
+
200: {
|
|
8383
|
+
headers: {
|
|
8384
|
+
[name: string]: any;
|
|
8385
|
+
};
|
|
8386
|
+
content: {
|
|
8387
|
+
"application/json": components["schemas"]["EmbedDashboardCommentThreadsListResponse"];
|
|
8388
|
+
};
|
|
8389
|
+
};
|
|
8390
|
+
};
|
|
8391
|
+
};
|
|
8392
|
+
"EmbedPublicController.createDashboardComment": {
|
|
8393
|
+
parameters: {
|
|
8394
|
+
query?: never;
|
|
8395
|
+
header?: never;
|
|
8396
|
+
path: {
|
|
8397
|
+
publicId: string;
|
|
8398
|
+
};
|
|
8399
|
+
cookie?: never;
|
|
8400
|
+
};
|
|
8401
|
+
/** @description CreateEmbedDashboardCommentBody */
|
|
8402
|
+
requestBody?: {
|
|
8403
|
+
content: {
|
|
8404
|
+
"application/json": components["schemas"]["CreateEmbedDashboardCommentBody"];
|
|
8405
|
+
};
|
|
8406
|
+
};
|
|
8407
|
+
responses: {
|
|
8408
|
+
200: {
|
|
8409
|
+
headers: {
|
|
8410
|
+
[name: string]: any;
|
|
8411
|
+
};
|
|
8412
|
+
content: {
|
|
8413
|
+
"application/json": components["schemas"]["EmbedDashboardCommentDto"];
|
|
8414
|
+
};
|
|
8415
|
+
};
|
|
8416
|
+
};
|
|
8417
|
+
};
|
|
8418
|
+
"EmbedPublicController.listMentionableEmbedUsers": {
|
|
8419
|
+
parameters: {
|
|
8420
|
+
query?: {
|
|
8421
|
+
search?: string | null;
|
|
8422
|
+
after?: string;
|
|
8423
|
+
first?: number;
|
|
8424
|
+
};
|
|
8425
|
+
header?: never;
|
|
8426
|
+
path: {
|
|
8427
|
+
publicId: string;
|
|
8428
|
+
};
|
|
8429
|
+
cookie?: never;
|
|
8430
|
+
};
|
|
8431
|
+
requestBody?: never;
|
|
8432
|
+
responses: {
|
|
8433
|
+
200: {
|
|
8434
|
+
headers: {
|
|
8435
|
+
[name: string]: any;
|
|
8436
|
+
};
|
|
8437
|
+
content: {
|
|
8438
|
+
"application/json": components["schemas"]["EmbedMentionableUsersListResponse"];
|
|
8439
|
+
};
|
|
8440
|
+
};
|
|
8441
|
+
};
|
|
8442
|
+
};
|
|
8443
|
+
"EmbedPublicController.removeDashboardComment": {
|
|
8444
|
+
parameters: {
|
|
8445
|
+
query?: never;
|
|
8446
|
+
header?: never;
|
|
8447
|
+
path: {
|
|
8448
|
+
publicId: string;
|
|
8449
|
+
commentId: number;
|
|
8450
|
+
};
|
|
8451
|
+
cookie?: never;
|
|
8452
|
+
};
|
|
8453
|
+
requestBody?: never;
|
|
8454
|
+
responses: {
|
|
8455
|
+
/** @description Successful response */
|
|
8456
|
+
200: {
|
|
8457
|
+
headers: {
|
|
8458
|
+
[name: string]: any;
|
|
8459
|
+
};
|
|
8460
|
+
content: {
|
|
8461
|
+
"application/json": any;
|
|
8462
|
+
};
|
|
8463
|
+
};
|
|
8464
|
+
};
|
|
8465
|
+
};
|
|
8466
|
+
"EmbedPublicController.updateDashboardComment": {
|
|
8467
|
+
parameters: {
|
|
8468
|
+
query?: never;
|
|
8469
|
+
header?: never;
|
|
8470
|
+
path: {
|
|
8471
|
+
publicId: string;
|
|
8472
|
+
commentId: number;
|
|
8473
|
+
};
|
|
8474
|
+
cookie?: never;
|
|
8475
|
+
};
|
|
8476
|
+
/** @description UpdateEmbedDashboardCommentBody */
|
|
8477
|
+
requestBody?: {
|
|
8478
|
+
content: {
|
|
8479
|
+
"application/json": components["schemas"]["UpdateEmbedDashboardCommentBody"];
|
|
8480
|
+
};
|
|
8481
|
+
};
|
|
8482
|
+
responses: {
|
|
8483
|
+
200: {
|
|
8484
|
+
headers: {
|
|
8485
|
+
[name: string]: any;
|
|
8486
|
+
};
|
|
8487
|
+
content: {
|
|
8488
|
+
"application/json": components["schemas"]["EmbedDashboardCommentDto"];
|
|
8489
|
+
};
|
|
8490
|
+
};
|
|
8491
|
+
};
|
|
8492
|
+
};
|
|
8493
|
+
"EmbedPublicController.setDashboardCommentResolved": {
|
|
8494
|
+
parameters: {
|
|
8495
|
+
query?: never;
|
|
8496
|
+
header?: never;
|
|
8497
|
+
path: {
|
|
8498
|
+
publicId: string;
|
|
8499
|
+
commentId: number;
|
|
8500
|
+
};
|
|
8501
|
+
cookie?: never;
|
|
8502
|
+
};
|
|
8503
|
+
/** @description SetEmbedDashboardCommentResolvedBody */
|
|
8504
|
+
requestBody?: {
|
|
8505
|
+
content: {
|
|
8506
|
+
"application/json": components["schemas"]["SetEmbedDashboardCommentResolvedBody"];
|
|
8507
|
+
};
|
|
8508
|
+
};
|
|
8509
|
+
responses: {
|
|
8510
|
+
200: {
|
|
8511
|
+
headers: {
|
|
8512
|
+
[name: string]: any;
|
|
8513
|
+
};
|
|
8514
|
+
content: {
|
|
8515
|
+
"application/json": components["schemas"]["EmbedDashboardCommentThreadDto"];
|
|
8516
|
+
};
|
|
8517
|
+
};
|
|
8518
|
+
};
|
|
8519
|
+
};
|
|
8023
8520
|
"EmbedPublicController.postDashboardPythonRun": {
|
|
8024
8521
|
parameters: {
|
|
8025
8522
|
query?: never;
|