@cube-dev/platform-client 0.6.0 → 0.8.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 +23 -0
- package/dist/schema.d.ts +553 -1
- package/dist/schema.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -305,6 +305,140 @@ export interface paths {
|
|
|
305
305
|
patch?: never;
|
|
306
306
|
trace?: never;
|
|
307
307
|
};
|
|
308
|
+
"/api/v1/deployments/{deploymentId}/dashboard-exports": {
|
|
309
|
+
parameters: {
|
|
310
|
+
query?: never;
|
|
311
|
+
header?: never;
|
|
312
|
+
path?: never;
|
|
313
|
+
cookie?: never;
|
|
314
|
+
};
|
|
315
|
+
get?: never;
|
|
316
|
+
put?: never;
|
|
317
|
+
/**
|
|
318
|
+
* Export a dashboard as PNG or PDF
|
|
319
|
+
* @description Submit a render of a published dashboard. Identify it with either `dashboardId` (numeric) or `dashboardPublicId` (string) — supply exactly one; it must belong to this deployment, otherwise `404` is returned.
|
|
320
|
+
*
|
|
321
|
+
* Returns as soon as the job is accepted, because a render waits for every widget to finish querying. Poll `GET /dashboard-exports/{jobId}` until `status` is `completed`, then fetch the file from `GET /dashboard-exports/{jobId}/download`. The job and its file are dropped at `expiresAt` (5 minutes) — download before then or submit again.
|
|
322
|
+
*
|
|
323
|
+
* Pass `filters`, `timeGrains` and `memberSwitchers` to render the board with specific control values, exactly as a scheduled notification does; omit them to render its saved defaults.
|
|
324
|
+
*
|
|
325
|
+
* By default the dashboard renders under the calling user's own security context, so the file shows what that user would see. Requires **manage** access to the dashboard's workbook — the same permission the console's own "Download as PNG / PDF" actions require, because a whole-dashboard render is a bulk data export.
|
|
326
|
+
*
|
|
327
|
+
* To export on someone else's behalf, pass `renderAs`: the queries behind the image then run under that user's security context instead of yours. **Requires the caller to be a tenant administrator.** Name a console user by `userId` or `email` (`type: USER`), or an embed user by `embedTenantName` + `externalId` (`type: EMBED_USER`). A deactivated console user is not a valid subject and returns `404`; an email is matched case-insensitively.
|
|
328
|
+
*
|
|
329
|
+
* An embed subject is provisioned if it does not exist yet, and `groups`, `userAttributes` and `securityContext` apply to **this render only** — they are carried on the render's own session and are NOT written to the user's stored context, so exporting for someone never changes what their live embedded sessions see. (Use the embed-tenant users API to change a user's stored context.) An embed subject additionally requires the dashboard's workbook to be shared with that embed tenant, otherwise `403` is returned.
|
|
330
|
+
*
|
|
331
|
+
* Returns `403` when the workspace has data downloads restricted — including for an on-behalf-of export, which deliberately does **not** bypass that setting the way a built-in scheduled notification does — and `429` when there are already too many exports in flight for the identity being rendered as.
|
|
332
|
+
*/
|
|
333
|
+
post: operations["DashboardExportsPublicController.startExport"];
|
|
334
|
+
delete?: never;
|
|
335
|
+
options?: never;
|
|
336
|
+
head?: never;
|
|
337
|
+
patch?: never;
|
|
338
|
+
trace?: never;
|
|
339
|
+
};
|
|
340
|
+
"/api/v1/deployments/{deploymentId}/dashboard-exports/{jobId}": {
|
|
341
|
+
parameters: {
|
|
342
|
+
query?: never;
|
|
343
|
+
header?: never;
|
|
344
|
+
path?: never;
|
|
345
|
+
cookie?: never;
|
|
346
|
+
};
|
|
347
|
+
/**
|
|
348
|
+
* Get the status of a dashboard export
|
|
349
|
+
* @description Progress of a submitted render. Poll until `status` is `completed` (then download it) or `failed` (then read `error`); `pending` and `processing` both mean keep waiting.
|
|
350
|
+
*
|
|
351
|
+
* Returns `404` once the job has expired, and for a job submitted by a different user — a job is only ever visible to whoever started it.
|
|
352
|
+
*/
|
|
353
|
+
get: operations["DashboardExportsPublicController.getExportStatus"];
|
|
354
|
+
put?: never;
|
|
355
|
+
post?: never;
|
|
356
|
+
delete?: never;
|
|
357
|
+
options?: never;
|
|
358
|
+
head?: never;
|
|
359
|
+
patch?: never;
|
|
360
|
+
trace?: never;
|
|
361
|
+
};
|
|
362
|
+
"/api/v1/deployments/{deploymentId}/dashboard-exports/{jobId}/download": {
|
|
363
|
+
parameters: {
|
|
364
|
+
query?: never;
|
|
365
|
+
header?: never;
|
|
366
|
+
path?: never;
|
|
367
|
+
cookie?: never;
|
|
368
|
+
};
|
|
369
|
+
/**
|
|
370
|
+
* Download a completed dashboard export
|
|
371
|
+
* @description Stream the rendered file as an attachment, named `dashboard.png` / `dashboard.pdf` unless `?filename=` supplies a different stem (the extension always follows the rendered format).
|
|
372
|
+
*
|
|
373
|
+
* Returns `409` while the job is still rendering — poll `GET /dashboard-exports/{jobId}` first — `422` if the render failed (terminal: submit a new export rather than retrying this one), and `404` once the job has expired or if it belongs to a different user.
|
|
374
|
+
*/
|
|
375
|
+
get: operations["DashboardExportsPublicController.downloadExport"];
|
|
376
|
+
put?: never;
|
|
377
|
+
post?: never;
|
|
378
|
+
delete?: never;
|
|
379
|
+
options?: never;
|
|
380
|
+
head?: never;
|
|
381
|
+
patch?: never;
|
|
382
|
+
trace?: never;
|
|
383
|
+
};
|
|
384
|
+
"/api/v1/deployments/{deploymentId}/databricks-metric-view-previews": {
|
|
385
|
+
parameters: {
|
|
386
|
+
query?: never;
|
|
387
|
+
header?: never;
|
|
388
|
+
path?: never;
|
|
389
|
+
cookie?: never;
|
|
390
|
+
};
|
|
391
|
+
get?: never;
|
|
392
|
+
put?: never;
|
|
393
|
+
/**
|
|
394
|
+
* 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 and useDatabricksMetricViewsPush.
|
|
396
|
+
*/
|
|
397
|
+
post: operations["DatabricksMetricViewPublicationPublicController.startPreview"];
|
|
398
|
+
delete?: never;
|
|
399
|
+
options?: never;
|
|
400
|
+
head?: never;
|
|
401
|
+
patch?: never;
|
|
402
|
+
trace?: never;
|
|
403
|
+
};
|
|
404
|
+
"/api/v1/deployments/{deploymentId}/databricks-metric-view-previews/{previewId}": {
|
|
405
|
+
parameters: {
|
|
406
|
+
query?: never;
|
|
407
|
+
header?: never;
|
|
408
|
+
path?: never;
|
|
409
|
+
cookie?: never;
|
|
410
|
+
};
|
|
411
|
+
/** Get Databricks Metric View preview status */
|
|
412
|
+
get: operations["DatabricksMetricViewPublicationPublicController.previewStatus"];
|
|
413
|
+
put?: never;
|
|
414
|
+
post?: never;
|
|
415
|
+
/** Cancel a Databricks Metric View preview */
|
|
416
|
+
delete: operations["DatabricksMetricViewPublicationPublicController.cancelPreview"];
|
|
417
|
+
options?: never;
|
|
418
|
+
head?: never;
|
|
419
|
+
patch?: never;
|
|
420
|
+
trace?: never;
|
|
421
|
+
};
|
|
422
|
+
"/api/v1/deployments/{deploymentId}/databricks-metric-view-previews/{previewId}/result": {
|
|
423
|
+
parameters: {
|
|
424
|
+
query?: never;
|
|
425
|
+
header?: never;
|
|
426
|
+
path?: never;
|
|
427
|
+
cookie?: never;
|
|
428
|
+
};
|
|
429
|
+
/**
|
|
430
|
+
* Get a completed Databricks Metric View preview result
|
|
431
|
+
* @description Returns 409 while the preview is still running or if it ended without a conversion result.
|
|
432
|
+
*/
|
|
433
|
+
get: operations["DatabricksMetricViewPublicationPublicController.previewResult"];
|
|
434
|
+
put?: never;
|
|
435
|
+
post?: never;
|
|
436
|
+
delete?: never;
|
|
437
|
+
options?: never;
|
|
438
|
+
head?: never;
|
|
439
|
+
patch?: never;
|
|
440
|
+
trace?: never;
|
|
441
|
+
};
|
|
308
442
|
"/api/v1/deployments/{deploymentId}/dbt-sync": {
|
|
309
443
|
parameters: {
|
|
310
444
|
query?: never;
|
|
@@ -2911,11 +3045,13 @@ export interface components {
|
|
|
2911
3045
|
private?: boolean | null;
|
|
2912
3046
|
};
|
|
2913
3047
|
ConnectReportToWorkbookInput: {
|
|
3048
|
+
addressOnly?: boolean | null;
|
|
2914
3049
|
anchorCell?: string | null;
|
|
2915
3050
|
endResultCell?: string | null;
|
|
2916
3051
|
externalWorkbookId: string;
|
|
2917
3052
|
host?: components["schemas"]["ConnectReportToWorkbookInputHost"] | null;
|
|
2918
3053
|
placementId?: string | null;
|
|
3054
|
+
resultChecksum?: components["schemas"]["ReportPlacementResultChecksumInput"] | null;
|
|
2919
3055
|
resultLocation: string;
|
|
2920
3056
|
sheetId?: string | null;
|
|
2921
3057
|
sheetName?: string | null;
|
|
@@ -2990,6 +3126,7 @@ export interface components {
|
|
|
2990
3126
|
dayOfWeek?: number | null;
|
|
2991
3127
|
filters?: components["schemas"]["DashboardFilterInput"][] | null;
|
|
2992
3128
|
hour?: number | null;
|
|
3129
|
+
memberSwitchers?: components["schemas"]["DashboardMemberSwitcherInput"][] | null;
|
|
2993
3130
|
minute?: number | null;
|
|
2994
3131
|
notificationAiSummary?: boolean | null;
|
|
2995
3132
|
notificationEnabled?: boolean | null;
|
|
@@ -3039,6 +3176,7 @@ export interface components {
|
|
|
3039
3176
|
name?: string | null;
|
|
3040
3177
|
pivotItems?: components["schemas"]["PivotItemsInput"] | null;
|
|
3041
3178
|
publicId?: string | null;
|
|
3179
|
+
resultChecksum?: components["schemas"]["ReportPlacementResultChecksumInput"] | null;
|
|
3042
3180
|
resultLocation?: string | null;
|
|
3043
3181
|
sheetId?: string | null;
|
|
3044
3182
|
source?: components["schemas"]["CreateReportInputSource"] | null;
|
|
@@ -3189,6 +3327,20 @@ export interface components {
|
|
|
3189
3327
|
title?: string | null;
|
|
3190
3328
|
widgets?: components["schemas"]["DashboardWidget"][] | null;
|
|
3191
3329
|
};
|
|
3330
|
+
DashboardConfigDraftInput: {
|
|
3331
|
+
app?: components["schemas"]["DashboardAppSourceInput"] | null;
|
|
3332
|
+
description?: string | null;
|
|
3333
|
+
kind?: components["schemas"]["DashboardConfigDraftInputKind"] | null;
|
|
3334
|
+
layout?: components["schemas"]["DashboardLayoutInput"] | null;
|
|
3335
|
+
settings?: {
|
|
3336
|
+
[key: string]: any;
|
|
3337
|
+
} | null;
|
|
3338
|
+
theme?: components["schemas"]["DashboardThemeInput"] | null;
|
|
3339
|
+
title?: string | null;
|
|
3340
|
+
widgets?: components["schemas"]["DashboardWidgetDraftInput"][] | null;
|
|
3341
|
+
};
|
|
3342
|
+
/** @enum {string} */
|
|
3343
|
+
DashboardConfigDraftInputKind: "CLASSIC" | "APP";
|
|
3192
3344
|
DashboardConfigInput: {
|
|
3193
3345
|
app?: components["schemas"]["DashboardAppSourceInput"] | null;
|
|
3194
3346
|
description?: string | null;
|
|
@@ -3211,6 +3363,23 @@ export interface components {
|
|
|
3211
3363
|
allowEmbed: boolean;
|
|
3212
3364
|
publicId: string;
|
|
3213
3365
|
};
|
|
3366
|
+
DashboardExportJobResponse: {
|
|
3367
|
+
/**
|
|
3368
|
+
* Format: date-time
|
|
3369
|
+
* @description When the job (and its rendered file) is evicted from the renderer cache. Download before this, or submit a new export.
|
|
3370
|
+
*/
|
|
3371
|
+
expiresAt: string;
|
|
3372
|
+
/** @description Job id to poll for status and to download the finished file with. */
|
|
3373
|
+
jobId: string;
|
|
3374
|
+
};
|
|
3375
|
+
DashboardExportStatusResponse: {
|
|
3376
|
+
contentType?: string | null;
|
|
3377
|
+
error?: string | null;
|
|
3378
|
+
progress?: number | null;
|
|
3379
|
+
status: components["schemas"]["DashboardExportStatusResponseStatus"];
|
|
3380
|
+
};
|
|
3381
|
+
/** @enum {string} */
|
|
3382
|
+
DashboardExportStatusResponseStatus: "pending" | "processing" | "completed" | "failed";
|
|
3214
3383
|
DashboardFilter: {
|
|
3215
3384
|
caseSensitive?: any | null;
|
|
3216
3385
|
endInclusive?: any | null;
|
|
@@ -3246,6 +3415,16 @@ export interface components {
|
|
|
3246
3415
|
margin?: number[] | null;
|
|
3247
3416
|
rowHeight?: number | null;
|
|
3248
3417
|
};
|
|
3418
|
+
DashboardMemberSwitcher: {
|
|
3419
|
+
member: string;
|
|
3420
|
+
selected: string;
|
|
3421
|
+
};
|
|
3422
|
+
DashboardMemberSwitcherInput: {
|
|
3423
|
+
/** @description Path of the member the control replaces, e.g. "Orders.status" */
|
|
3424
|
+
member: string;
|
|
3425
|
+
/** @description Name of the member to show in its place, e.g. "city" (no view prefix) */
|
|
3426
|
+
selected: string;
|
|
3427
|
+
};
|
|
3249
3428
|
DashboardResponsiveLayouts: {
|
|
3250
3429
|
lg?: components["schemas"]["DashboardWidgetPosition"] | null;
|
|
3251
3430
|
md?: components["schemas"]["DashboardWidgetPosition"] | null;
|
|
@@ -3295,6 +3474,20 @@ export interface components {
|
|
|
3295
3474
|
} | null;
|
|
3296
3475
|
type: components["schemas"]["DashboardWidgetDtoType"];
|
|
3297
3476
|
};
|
|
3477
|
+
DashboardWidgetDraftInput: {
|
|
3478
|
+
config?: {
|
|
3479
|
+
[key: string]: any;
|
|
3480
|
+
} | null;
|
|
3481
|
+
id?: string | null;
|
|
3482
|
+
position: components["schemas"]["DashboardWidgetPositionInput"];
|
|
3483
|
+
responsiveLayouts?: components["schemas"]["DashboardResponsiveLayoutsInput"] | null;
|
|
3484
|
+
style?: {
|
|
3485
|
+
[key: string]: any;
|
|
3486
|
+
} | null;
|
|
3487
|
+
type: components["schemas"]["DashboardWidgetDraftInputType"];
|
|
3488
|
+
};
|
|
3489
|
+
/** @enum {string} */
|
|
3490
|
+
DashboardWidgetDraftInputType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "FIELD" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
|
|
3298
3491
|
/** @enum {string} */
|
|
3299
3492
|
DashboardWidgetDtoType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "FIELD" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
|
|
3300
3493
|
DashboardWidgetInput: {
|
|
@@ -3351,6 +3544,120 @@ export interface components {
|
|
|
3351
3544
|
DataModelWriteResponse: {
|
|
3352
3545
|
success: boolean;
|
|
3353
3546
|
};
|
|
3547
|
+
DatabricksMetricViewPublicationCounts: {
|
|
3548
|
+
dimensions: number;
|
|
3549
|
+
errors: number;
|
|
3550
|
+
joins: number;
|
|
3551
|
+
measures: number;
|
|
3552
|
+
warnings: number;
|
|
3553
|
+
};
|
|
3554
|
+
DatabricksMetricViewPublicationDatasetSource: {
|
|
3555
|
+
dataSource: string;
|
|
3556
|
+
dataset: string;
|
|
3557
|
+
originalSource: string;
|
|
3558
|
+
resolvedSource: string;
|
|
3559
|
+
};
|
|
3560
|
+
DatabricksMetricViewPublicationIssue: {
|
|
3561
|
+
code: string;
|
|
3562
|
+
element?: string | null;
|
|
3563
|
+
message: string;
|
|
3564
|
+
severity: components["schemas"]["DatabricksMetricViewPublicationIssueSeverity"];
|
|
3565
|
+
stage: components["schemas"]["DatabricksMetricViewPublicationIssueStage"];
|
|
3566
|
+
};
|
|
3567
|
+
/** @enum {string} */
|
|
3568
|
+
DatabricksMetricViewPublicationIssueSeverity: "ERROR" | "WARNING";
|
|
3569
|
+
/** @enum {string} */
|
|
3570
|
+
DatabricksMetricViewPublicationIssueStage: "INPUT" | "VIEW_PROJECTION" | "OSSIE_VALIDATION" | "OSSIE_TO_DATABRICKS" | "OUTPUT_VALIDATION" | "EXECUTION";
|
|
3571
|
+
DatabricksMetricViewPublicationPreviewInput: {
|
|
3572
|
+
dataSourceName: string;
|
|
3573
|
+
selectionMode: components["schemas"]["DatabricksMetricViewPublicationPreviewInputSelectionMode"];
|
|
3574
|
+
sourceOverrides?: {
|
|
3575
|
+
[key: string]: string;
|
|
3576
|
+
} | null;
|
|
3577
|
+
targetNames?: {
|
|
3578
|
+
[key: string]: string;
|
|
3579
|
+
} | null;
|
|
3580
|
+
viewNameRegex?: string | null;
|
|
3581
|
+
viewNames?: string[] | null;
|
|
3582
|
+
};
|
|
3583
|
+
/** @enum {string} */
|
|
3584
|
+
DatabricksMetricViewPublicationPreviewInputSelectionMode: "all" | "selected" | "pattern";
|
|
3585
|
+
DatabricksMetricViewPublicationPreviewResultResponse: {
|
|
3586
|
+
buildJobId: number;
|
|
3587
|
+
commit?: string | null;
|
|
3588
|
+
completedAt: string;
|
|
3589
|
+
dataSourceName: string;
|
|
3590
|
+
deploymentId: number;
|
|
3591
|
+
durationMs: number;
|
|
3592
|
+
outcome: components["schemas"]["DatabricksMetricViewPublicationPreviewResultResponseOutcome"];
|
|
3593
|
+
previewId: string;
|
|
3594
|
+
runtime: components["schemas"]["DatabricksMetricViewPublicationRuntime"];
|
|
3595
|
+
sourceSha256: string;
|
|
3596
|
+
version: components["schemas"]["DatabricksMetricViewPublicationPreviewResultResponseVersion"];
|
|
3597
|
+
views: components["schemas"]["DatabricksMetricViewPublicationViewResult"][];
|
|
3598
|
+
};
|
|
3599
|
+
/** @enum {string} */
|
|
3600
|
+
DatabricksMetricViewPublicationPreviewResultResponseOutcome: "success" | "partial" | "failed";
|
|
3601
|
+
/** @enum {integer} */
|
|
3602
|
+
DatabricksMetricViewPublicationPreviewResultResponseVersion: 2;
|
|
3603
|
+
DatabricksMetricViewPublicationPreviewStartResponse: {
|
|
3604
|
+
buildJobId: number;
|
|
3605
|
+
commit?: string | null;
|
|
3606
|
+
dataSourceName: string;
|
|
3607
|
+
deploymentId: number;
|
|
3608
|
+
previewId: string;
|
|
3609
|
+
resultUrl: string;
|
|
3610
|
+
reused: boolean;
|
|
3611
|
+
status: components["schemas"]["DatabricksMetricViewPublicationPreviewStartResponseStatus"];
|
|
3612
|
+
statusUrl: string;
|
|
3613
|
+
};
|
|
3614
|
+
/** @enum {string} */
|
|
3615
|
+
DatabricksMetricViewPublicationPreviewStartResponseStatus: "QUEUED";
|
|
3616
|
+
DatabricksMetricViewPublicationPreviewStatusResponse: {
|
|
3617
|
+
dataSourceName: string;
|
|
3618
|
+
deploymentId: number;
|
|
3619
|
+
error?: string | null;
|
|
3620
|
+
previewId: string;
|
|
3621
|
+
progress: components["schemas"]["DatabricksMetricViewPublicationProgress"];
|
|
3622
|
+
resultAvailable: boolean;
|
|
3623
|
+
startedAt: string;
|
|
3624
|
+
status: components["schemas"]["DatabricksMetricViewPublicationPreviewStatusResponseStatus"];
|
|
3625
|
+
updatedAt: string;
|
|
3626
|
+
};
|
|
3627
|
+
/** @enum {string} */
|
|
3628
|
+
DatabricksMetricViewPublicationPreviewStatusResponseStatus: "QUEUED" | "RUNNING" | "COMPLETED" | "FAILED" | "CANCELLED";
|
|
3629
|
+
DatabricksMetricViewPublicationProgress: {
|
|
3630
|
+
message: string;
|
|
3631
|
+
percentComplete: number;
|
|
3632
|
+
stage: components["schemas"]["DatabricksMetricViewPublicationProgressStage"];
|
|
3633
|
+
};
|
|
3634
|
+
/** @enum {string} */
|
|
3635
|
+
DatabricksMetricViewPublicationProgressStage: "QUEUED" | "RUNNING" | "COMPLETED" | "FAILED" | "CANCELLED";
|
|
3636
|
+
DatabricksMetricViewPublicationRuntime: {
|
|
3637
|
+
bridgeCommit: string;
|
|
3638
|
+
bridgeVersion: string;
|
|
3639
|
+
cubeConverterVersion: string;
|
|
3640
|
+
databricksConverterVersion: string;
|
|
3641
|
+
ossieCommit: string;
|
|
3642
|
+
ossieCoreVersion: string;
|
|
3643
|
+
policyVersion: number;
|
|
3644
|
+
runnerVersion: string;
|
|
3645
|
+
templateName: string;
|
|
3646
|
+
};
|
|
3647
|
+
DatabricksMetricViewPublicationViewResult: {
|
|
3648
|
+
counts: components["schemas"]["DatabricksMetricViewPublicationCounts"];
|
|
3649
|
+
cubeViewName: string;
|
|
3650
|
+
datasetSources: components["schemas"]["DatabricksMetricViewPublicationDatasetSource"][];
|
|
3651
|
+
eligibleForPublication: boolean;
|
|
3652
|
+
issues: components["schemas"]["DatabricksMetricViewPublicationIssue"][];
|
|
3653
|
+
metricViewName: string;
|
|
3654
|
+
metricViewSha256?: string | null;
|
|
3655
|
+
metricViewYaml?: string | null;
|
|
3656
|
+
outcome: components["schemas"]["DatabricksMetricViewPublicationViewResultOutcome"];
|
|
3657
|
+
source?: string | null;
|
|
3658
|
+
};
|
|
3659
|
+
/** @enum {string} */
|
|
3660
|
+
DatabricksMetricViewPublicationViewResultOutcome: "success" | "failed";
|
|
3354
3661
|
DbtSyncCancelResponse: {
|
|
3355
3662
|
message: string;
|
|
3356
3663
|
};
|
|
@@ -3413,6 +3720,8 @@ export interface components {
|
|
|
3413
3720
|
gitRef?: string | null;
|
|
3414
3721
|
lastStage?: string | null;
|
|
3415
3722
|
phases?: components["schemas"]["DbtSyncRunPhase"][] | null;
|
|
3723
|
+
/** @description Where this sync got its dbt metadata: `git` (Cube cloned the dbt repository and ran dbt) or `manifest` (the caller uploaded a `manifest.json` and no repository was accessed). Runs predating the manifest source report `git`. */
|
|
3724
|
+
source: string;
|
|
3416
3725
|
/** @description When the sync started, as an ISO 8601 timestamp. See completedAt before comparing the two. */
|
|
3417
3726
|
startedAt: string;
|
|
3418
3727
|
stats?: components["schemas"]["DbtSyncRunStats"] | null;
|
|
@@ -3440,8 +3749,10 @@ export interface components {
|
|
|
3440
3749
|
};
|
|
3441
3750
|
DbtSyncRunStats: {
|
|
3442
3751
|
cubeCount?: number | null;
|
|
3752
|
+
dbtVersion?: string | null;
|
|
3443
3753
|
generatedFileCount?: number | null;
|
|
3444
3754
|
macros?: number | null;
|
|
3755
|
+
manifestGeneratedAt?: string | null;
|
|
3445
3756
|
models?: number | null;
|
|
3446
3757
|
sources?: number | null;
|
|
3447
3758
|
};
|
|
@@ -3683,13 +3994,19 @@ export interface components {
|
|
|
3683
3994
|
sqlQuery: string;
|
|
3684
3995
|
};
|
|
3685
3996
|
EmbedSessionSettings: {
|
|
3997
|
+
allowAi?: boolean | null;
|
|
3686
3998
|
allowChatWorkspaceAuthoring?: boolean | null;
|
|
3999
|
+
showAiWidgets?: boolean | null;
|
|
3687
4000
|
showDashboardChat?: boolean | null;
|
|
4001
|
+
showWorkbookChat?: boolean | null;
|
|
3688
4002
|
};
|
|
3689
4003
|
EmbedSettings: {
|
|
4004
|
+
allowAi?: boolean | null;
|
|
3690
4005
|
enableDashboardComments?: boolean | null;
|
|
3691
4006
|
locale?: string | null;
|
|
4007
|
+
showAiWidgets?: boolean | null;
|
|
3692
4008
|
showDashboardChat?: boolean | null;
|
|
4009
|
+
showWorkbookChat?: boolean | null;
|
|
3693
4010
|
timezone?: string | null;
|
|
3694
4011
|
};
|
|
3695
4012
|
EmbedTenant: {
|
|
@@ -3753,6 +4070,20 @@ export interface components {
|
|
|
3753
4070
|
items: components["schemas"]["EnvVariableItem"][];
|
|
3754
4071
|
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3755
4072
|
};
|
|
4073
|
+
ExportSubjectInput: {
|
|
4074
|
+
email?: string | null;
|
|
4075
|
+
embedTenantName?: string | null;
|
|
4076
|
+
externalId?: string | null;
|
|
4077
|
+
groups?: string[] | null;
|
|
4078
|
+
securityContext?: {
|
|
4079
|
+
[key: string]: any;
|
|
4080
|
+
} | null;
|
|
4081
|
+
type: components["schemas"]["ExportSubjectInputType"];
|
|
4082
|
+
userAttributes?: components["schemas"]["UserAttributeInput"][] | null;
|
|
4083
|
+
userId?: number | null;
|
|
4084
|
+
};
|
|
4085
|
+
/** @enum {string} */
|
|
4086
|
+
ExportSubjectInputType: "USER" | "EMBED_USER";
|
|
3756
4087
|
FileHash: {
|
|
3757
4088
|
hash: string;
|
|
3758
4089
|
};
|
|
@@ -3972,6 +4303,7 @@ export interface components {
|
|
|
3972
4303
|
humanReadableSchedule: string;
|
|
3973
4304
|
id: number;
|
|
3974
4305
|
isEnabled: boolean;
|
|
4306
|
+
memberSwitchers?: components["schemas"]["DashboardMemberSwitcher"][] | null;
|
|
3975
4307
|
/** @description Whether this notification carries an AI-generated "what changed" summary in its body. */
|
|
3976
4308
|
notificationAiSummary: boolean;
|
|
3977
4309
|
notificationEnabled: boolean;
|
|
@@ -4072,21 +4404,29 @@ export interface components {
|
|
|
4072
4404
|
};
|
|
4073
4405
|
PivotItems: {
|
|
4074
4406
|
columns: string[];
|
|
4407
|
+
displayScale?: components["schemas"]["PivotItemsDisplayScale"] | null;
|
|
4075
4408
|
filters: string[];
|
|
4076
4409
|
measures: string[];
|
|
4077
4410
|
measuresAxis?: components["schemas"]["PivotItemsMeasuresAxis"] | null;
|
|
4078
4411
|
measuresPosition?: components["schemas"]["PivotItemsMeasuresPosition"] | null;
|
|
4079
4412
|
rows: string[];
|
|
4413
|
+
showColumnTotals?: boolean | null;
|
|
4080
4414
|
};
|
|
4415
|
+
/** @enum {string} */
|
|
4416
|
+
PivotItemsDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
|
|
4081
4417
|
PivotItemsInput: {
|
|
4082
4418
|
columns: string[];
|
|
4419
|
+
displayScale?: components["schemas"]["PivotItemsInputDisplayScale"] | null;
|
|
4083
4420
|
filters: string[];
|
|
4084
4421
|
measures: string[];
|
|
4085
4422
|
measuresAxis?: components["schemas"]["PivotItemsInputMeasuresAxis"] | null;
|
|
4086
4423
|
measuresPosition?: components["schemas"]["PivotItemsInputMeasuresPosition"] | null;
|
|
4087
4424
|
rows: string[];
|
|
4425
|
+
showColumnTotals?: boolean | null;
|
|
4088
4426
|
};
|
|
4089
4427
|
/** @enum {string} */
|
|
4428
|
+
PivotItemsInputDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
|
|
4429
|
+
/** @enum {string} */
|
|
4090
4430
|
PivotItemsInputMeasuresAxis: "columns" | "rows";
|
|
4091
4431
|
/** @enum {string} */
|
|
4092
4432
|
PivotItemsInputMeasuresPosition: "before" | "after";
|
|
@@ -4167,6 +4507,7 @@ export interface components {
|
|
|
4167
4507
|
anchorCell?: string | null;
|
|
4168
4508
|
externalWorkbookId?: string | null;
|
|
4169
4509
|
placementId?: string | null;
|
|
4510
|
+
resultChecksum?: components["schemas"]["ReportPlacementResultChecksumInput"] | null;
|
|
4170
4511
|
resultLocation?: string | null;
|
|
4171
4512
|
sheetId?: string | null;
|
|
4172
4513
|
sheetName?: string | null;
|
|
@@ -4344,6 +4685,7 @@ export interface components {
|
|
|
4344
4685
|
queryChecksum?: string | null;
|
|
4345
4686
|
refreshedAt?: string | null;
|
|
4346
4687
|
refreshedByUserId?: number | null;
|
|
4688
|
+
resultChecksum?: components["schemas"]["ReportPlacementResultChecksum"] | null;
|
|
4347
4689
|
resultLocation: string;
|
|
4348
4690
|
sheetId?: string | null;
|
|
4349
4691
|
sheetName?: string | null;
|
|
@@ -4353,6 +4695,24 @@ export interface components {
|
|
|
4353
4695
|
};
|
|
4354
4696
|
/** @enum {string} */
|
|
4355
4697
|
ReportPlacementHost: "GOOGLE_SHEETS" | "EXCEL";
|
|
4698
|
+
ReportPlacementResultChecksum: {
|
|
4699
|
+
chunks: components["schemas"]["ReportPlacementResultChunk"][];
|
|
4700
|
+
v: number;
|
|
4701
|
+
};
|
|
4702
|
+
ReportPlacementResultChecksumInput: {
|
|
4703
|
+
chunks: components["schemas"]["ReportPlacementResultChunkInput"][];
|
|
4704
|
+
v: number;
|
|
4705
|
+
};
|
|
4706
|
+
ReportPlacementResultChunk: {
|
|
4707
|
+
from: number;
|
|
4708
|
+
hash: string;
|
|
4709
|
+
to?: number | null;
|
|
4710
|
+
};
|
|
4711
|
+
ReportPlacementResultChunkInput: {
|
|
4712
|
+
from: number;
|
|
4713
|
+
hash: string;
|
|
4714
|
+
to?: number | null;
|
|
4715
|
+
};
|
|
4356
4716
|
/** @enum {string} */
|
|
4357
4717
|
ReportPlacementSyncStatus: "UP_TO_DATE" | "CHANGED" | "UNKNOWN";
|
|
4358
4718
|
ReportSnapshot: {
|
|
@@ -4459,10 +4819,27 @@ export interface components {
|
|
|
4459
4819
|
}[];
|
|
4460
4820
|
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
4461
4821
|
};
|
|
4822
|
+
StartDashboardExportInput: {
|
|
4823
|
+
dashboardId?: number | null;
|
|
4824
|
+
dashboardPublicId?: string | null;
|
|
4825
|
+
filters?: components["schemas"]["DashboardFilterInput"][] | null;
|
|
4826
|
+
format: components["schemas"]["StartDashboardExportInputFormat"];
|
|
4827
|
+
memberSwitchers?: components["schemas"]["DashboardMemberSwitcherInput"][] | null;
|
|
4828
|
+
renderAs?: components["schemas"]["ExportSubjectInput"] | null;
|
|
4829
|
+
timeGrains?: components["schemas"]["DashboardTimeGrainInput"][] | null;
|
|
4830
|
+
};
|
|
4831
|
+
/** @enum {string} */
|
|
4832
|
+
StartDashboardExportInputFormat: "png" | "pdf";
|
|
4462
4833
|
StartDbtSyncInput: {
|
|
4463
4834
|
branchName?: string | null;
|
|
4835
|
+
manifest?: {
|
|
4836
|
+
[key: string]: any;
|
|
4837
|
+
} | null;
|
|
4464
4838
|
ref?: string | null;
|
|
4839
|
+
source?: components["schemas"]["StartDbtSyncInputSource"] | null;
|
|
4465
4840
|
};
|
|
4841
|
+
/** @enum {string} */
|
|
4842
|
+
StartDbtSyncInputSource: "git" | "manifest";
|
|
4466
4843
|
StartDevModeRequest: {
|
|
4467
4844
|
branchName?: string | null;
|
|
4468
4845
|
};
|
|
@@ -4565,6 +4942,7 @@ export interface components {
|
|
|
4565
4942
|
filters?: components["schemas"]["DashboardFilterInput"][] | null;
|
|
4566
4943
|
hour?: number | null;
|
|
4567
4944
|
isEnabled?: boolean | null;
|
|
4945
|
+
memberSwitchers?: components["schemas"]["DashboardMemberSwitcherInput"][] | null;
|
|
4568
4946
|
minute?: number | null;
|
|
4569
4947
|
notificationAiSummary?: boolean | null;
|
|
4570
4948
|
notificationEnabled?: boolean | null;
|
|
@@ -4619,6 +4997,7 @@ export interface components {
|
|
|
4619
4997
|
pivotItems?: components["schemas"]["PivotItems"] | null;
|
|
4620
4998
|
placementId?: string | null;
|
|
4621
4999
|
publicId?: string | null;
|
|
5000
|
+
resultChecksum?: components["schemas"]["ReportPlacementResultChecksumInput"] | null;
|
|
4622
5001
|
resultLocation?: string | null;
|
|
4623
5002
|
sheetId?: string | null;
|
|
4624
5003
|
sqlQuery?: string | null;
|
|
@@ -4901,7 +5280,7 @@ export interface components {
|
|
|
4901
5280
|
dashboardPublished?: components["schemas"]["DashboardConfig"] | null;
|
|
4902
5281
|
};
|
|
4903
5282
|
WorkbookDashboardInput: {
|
|
4904
|
-
dashboardDraft?: components["schemas"]["
|
|
5283
|
+
dashboardDraft?: components["schemas"]["DashboardConfigDraftInput"] | null;
|
|
4905
5284
|
};
|
|
4906
5285
|
/** @enum {string} */
|
|
4907
5286
|
WorkbookDtoType: "FOLDER" | "WORKBOOK" | "REPORT";
|
|
@@ -5573,6 +5952,179 @@ export interface operations {
|
|
|
5573
5952
|
};
|
|
5574
5953
|
};
|
|
5575
5954
|
};
|
|
5955
|
+
"DashboardExportsPublicController.startExport": {
|
|
5956
|
+
parameters: {
|
|
5957
|
+
query?: never;
|
|
5958
|
+
header?: never;
|
|
5959
|
+
path: {
|
|
5960
|
+
/** @description Numeric id of the deployment that owns the dashboard. */
|
|
5961
|
+
deploymentId: number;
|
|
5962
|
+
};
|
|
5963
|
+
cookie?: never;
|
|
5964
|
+
};
|
|
5965
|
+
/** @description StartDashboardExportInput */
|
|
5966
|
+
requestBody: {
|
|
5967
|
+
content: {
|
|
5968
|
+
"application/json": components["schemas"]["StartDashboardExportInput"];
|
|
5969
|
+
};
|
|
5970
|
+
};
|
|
5971
|
+
responses: {
|
|
5972
|
+
200: {
|
|
5973
|
+
headers: {
|
|
5974
|
+
[name: string]: any;
|
|
5975
|
+
};
|
|
5976
|
+
content: {
|
|
5977
|
+
"application/json": components["schemas"]["DashboardExportJobResponse"];
|
|
5978
|
+
};
|
|
5979
|
+
};
|
|
5980
|
+
};
|
|
5981
|
+
};
|
|
5982
|
+
"DashboardExportsPublicController.getExportStatus": {
|
|
5983
|
+
parameters: {
|
|
5984
|
+
query?: never;
|
|
5985
|
+
header?: never;
|
|
5986
|
+
path: {
|
|
5987
|
+
/** @description Numeric id of the deployment that owns the dashboard. */
|
|
5988
|
+
deploymentId: number;
|
|
5989
|
+
/** @description Job id returned when the export was submitted. */
|
|
5990
|
+
jobId: string;
|
|
5991
|
+
};
|
|
5992
|
+
cookie?: never;
|
|
5993
|
+
};
|
|
5994
|
+
requestBody?: never;
|
|
5995
|
+
responses: {
|
|
5996
|
+
200: {
|
|
5997
|
+
headers: {
|
|
5998
|
+
[name: string]: any;
|
|
5999
|
+
};
|
|
6000
|
+
content: {
|
|
6001
|
+
"application/json": components["schemas"]["DashboardExportStatusResponse"];
|
|
6002
|
+
};
|
|
6003
|
+
};
|
|
6004
|
+
};
|
|
6005
|
+
};
|
|
6006
|
+
"DashboardExportsPublicController.downloadExport": {
|
|
6007
|
+
parameters: {
|
|
6008
|
+
query?: {
|
|
6009
|
+
/** @description Filename stem for the attachment, without extension. Defaults to `dashboard`. */
|
|
6010
|
+
filename?: string;
|
|
6011
|
+
};
|
|
6012
|
+
header?: never;
|
|
6013
|
+
path: {
|
|
6014
|
+
/** @description Numeric id of the deployment that owns the dashboard. */
|
|
6015
|
+
deploymentId: number;
|
|
6016
|
+
/** @description Job id returned when the export was submitted. */
|
|
6017
|
+
jobId: string;
|
|
6018
|
+
};
|
|
6019
|
+
cookie?: never;
|
|
6020
|
+
};
|
|
6021
|
+
requestBody?: never;
|
|
6022
|
+
responses: {
|
|
6023
|
+
/** @description The rendered dashboard. */
|
|
6024
|
+
200: {
|
|
6025
|
+
headers: {
|
|
6026
|
+
[name: string]: any;
|
|
6027
|
+
};
|
|
6028
|
+
content: {
|
|
6029
|
+
"application/pdf": string;
|
|
6030
|
+
"image/png": string;
|
|
6031
|
+
};
|
|
6032
|
+
};
|
|
6033
|
+
};
|
|
6034
|
+
};
|
|
6035
|
+
"DatabricksMetricViewPublicationPublicController.startPreview": {
|
|
6036
|
+
parameters: {
|
|
6037
|
+
query?: never;
|
|
6038
|
+
header?: never;
|
|
6039
|
+
path: {
|
|
6040
|
+
deploymentId: number;
|
|
6041
|
+
};
|
|
6042
|
+
cookie?: never;
|
|
6043
|
+
};
|
|
6044
|
+
/** @description DatabricksMetricViewPublicationPreviewInput */
|
|
6045
|
+
requestBody: {
|
|
6046
|
+
content: {
|
|
6047
|
+
"application/json": components["schemas"]["DatabricksMetricViewPublicationPreviewInput"];
|
|
6048
|
+
};
|
|
6049
|
+
};
|
|
6050
|
+
responses: {
|
|
6051
|
+
202: {
|
|
6052
|
+
headers: {
|
|
6053
|
+
[name: string]: any;
|
|
6054
|
+
};
|
|
6055
|
+
content: {
|
|
6056
|
+
"application/json": components["schemas"]["DatabricksMetricViewPublicationPreviewStartResponse"];
|
|
6057
|
+
};
|
|
6058
|
+
};
|
|
6059
|
+
};
|
|
6060
|
+
};
|
|
6061
|
+
"DatabricksMetricViewPublicationPublicController.previewStatus": {
|
|
6062
|
+
parameters: {
|
|
6063
|
+
query?: never;
|
|
6064
|
+
header?: never;
|
|
6065
|
+
path: {
|
|
6066
|
+
deploymentId: number;
|
|
6067
|
+
previewId: string;
|
|
6068
|
+
};
|
|
6069
|
+
cookie?: never;
|
|
6070
|
+
};
|
|
6071
|
+
requestBody?: never;
|
|
6072
|
+
responses: {
|
|
6073
|
+
200: {
|
|
6074
|
+
headers: {
|
|
6075
|
+
[name: string]: any;
|
|
6076
|
+
};
|
|
6077
|
+
content: {
|
|
6078
|
+
"application/json": components["schemas"]["DatabricksMetricViewPublicationPreviewStatusResponse"];
|
|
6079
|
+
};
|
|
6080
|
+
};
|
|
6081
|
+
};
|
|
6082
|
+
};
|
|
6083
|
+
"DatabricksMetricViewPublicationPublicController.cancelPreview": {
|
|
6084
|
+
parameters: {
|
|
6085
|
+
query?: never;
|
|
6086
|
+
header?: never;
|
|
6087
|
+
path: {
|
|
6088
|
+
deploymentId: number;
|
|
6089
|
+
previewId: string;
|
|
6090
|
+
};
|
|
6091
|
+
cookie?: never;
|
|
6092
|
+
};
|
|
6093
|
+
requestBody?: never;
|
|
6094
|
+
responses: {
|
|
6095
|
+
/** @description Successful response */
|
|
6096
|
+
200: {
|
|
6097
|
+
headers: {
|
|
6098
|
+
[name: string]: any;
|
|
6099
|
+
};
|
|
6100
|
+
content: {
|
|
6101
|
+
"application/json": any;
|
|
6102
|
+
};
|
|
6103
|
+
};
|
|
6104
|
+
};
|
|
6105
|
+
};
|
|
6106
|
+
"DatabricksMetricViewPublicationPublicController.previewResult": {
|
|
6107
|
+
parameters: {
|
|
6108
|
+
query?: never;
|
|
6109
|
+
header?: never;
|
|
6110
|
+
path: {
|
|
6111
|
+
deploymentId: number;
|
|
6112
|
+
previewId: string;
|
|
6113
|
+
};
|
|
6114
|
+
cookie?: never;
|
|
6115
|
+
};
|
|
6116
|
+
requestBody?: never;
|
|
6117
|
+
responses: {
|
|
6118
|
+
200: {
|
|
6119
|
+
headers: {
|
|
6120
|
+
[name: string]: any;
|
|
6121
|
+
};
|
|
6122
|
+
content: {
|
|
6123
|
+
"application/json": components["schemas"]["DatabricksMetricViewPublicationPreviewResultResponse"];
|
|
6124
|
+
};
|
|
6125
|
+
};
|
|
6126
|
+
};
|
|
6127
|
+
};
|
|
5576
6128
|
"DbtSyncPublicController.listDbtSyncs": {
|
|
5577
6129
|
parameters: {
|
|
5578
6130
|
query?: {
|