@cube-dev/platform-client 0.11.0 → 0.13.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 +32 -0
- package/dist/schema.d.ts +595 -28
- package/dist/schema.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -425,6 +425,54 @@ export interface paths {
|
|
|
425
425
|
patch?: never;
|
|
426
426
|
trace?: never;
|
|
427
427
|
};
|
|
428
|
+
"/api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}/syncs": {
|
|
429
|
+
parameters: {
|
|
430
|
+
query?: never;
|
|
431
|
+
header?: never;
|
|
432
|
+
path?: never;
|
|
433
|
+
cookie?: never;
|
|
434
|
+
};
|
|
435
|
+
/**
|
|
436
|
+
* List Databricks Metric View publication runs
|
|
437
|
+
* @description Durable run history for this datasource, newest first. It remains available after a run finishes. Requires a Databricks datasource. This is currently in preview — reach out to the Cube support team to activate it for your account.
|
|
438
|
+
*/
|
|
439
|
+
get: operations["DatabricksMetricViewIntegrationPublicController.listSyncs"];
|
|
440
|
+
put?: never;
|
|
441
|
+
/**
|
|
442
|
+
* Start a Databricks Metric View publication run
|
|
443
|
+
* @description Converts the configured Cube views from the deployment's latest successful build and creates or replaces each one's managed Databricks Metric View. Views publish independently: one that is incompatible, fails Databricks validation, or whose destination belongs to another integration keeps its last good definition and does not stop the others, and a view whose definition is unchanged is skipped without a Databricks write. One run per integration at a time; a second start while one is active returns 409. Requires a Databricks datasource, enabled publication settings, and SchemaUpdate access. This is currently in preview — reach out to the Cube support team to activate it for your account.
|
|
444
|
+
*/
|
|
445
|
+
post: operations["DatabricksMetricViewIntegrationPublicController.startSync"];
|
|
446
|
+
delete?: never;
|
|
447
|
+
options?: never;
|
|
448
|
+
head?: never;
|
|
449
|
+
patch?: never;
|
|
450
|
+
trace?: never;
|
|
451
|
+
};
|
|
452
|
+
"/api/v1/deployments/{deploymentId}/databricks-metric-view-integrations/{dataSourceName}/syncs/{runId}": {
|
|
453
|
+
parameters: {
|
|
454
|
+
query?: never;
|
|
455
|
+
header?: never;
|
|
456
|
+
path?: never;
|
|
457
|
+
cookie?: never;
|
|
458
|
+
};
|
|
459
|
+
/**
|
|
460
|
+
* Get a Databricks Metric View publication run
|
|
461
|
+
* @description Returns the run with its per-view outcomes, plus live stage and published counts while it is still active.
|
|
462
|
+
*/
|
|
463
|
+
get: operations["DatabricksMetricViewIntegrationPublicController.syncRun"];
|
|
464
|
+
put?: never;
|
|
465
|
+
post?: never;
|
|
466
|
+
/**
|
|
467
|
+
* Cancel a Databricks Metric View publication run
|
|
468
|
+
* @description Requests cancellation of an active run and returns its state. Metric Views already written in the run are not rolled back. Requires SchemaUpdate access.
|
|
469
|
+
*/
|
|
470
|
+
delete: operations["DatabricksMetricViewIntegrationPublicController.cancelSync"];
|
|
471
|
+
options?: never;
|
|
472
|
+
head?: never;
|
|
473
|
+
patch?: never;
|
|
474
|
+
trace?: never;
|
|
475
|
+
};
|
|
428
476
|
"/api/v1/deployments/{deploymentId}/databricks-metric-view-previews": {
|
|
429
477
|
parameters: {
|
|
430
478
|
query?: never;
|
|
@@ -1341,6 +1389,81 @@ export interface paths {
|
|
|
1341
1389
|
patch?: never;
|
|
1342
1390
|
trace?: never;
|
|
1343
1391
|
};
|
|
1392
|
+
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotion": {
|
|
1393
|
+
parameters: {
|
|
1394
|
+
query?: never;
|
|
1395
|
+
header?: never;
|
|
1396
|
+
path?: never;
|
|
1397
|
+
cookie?: never;
|
|
1398
|
+
};
|
|
1399
|
+
/** Get workbook promotion provenance */
|
|
1400
|
+
get: operations["WorkbookPromotionsPublicController.getWorkbookPromotion"];
|
|
1401
|
+
put?: never;
|
|
1402
|
+
post?: never;
|
|
1403
|
+
delete?: never;
|
|
1404
|
+
options?: never;
|
|
1405
|
+
head?: never;
|
|
1406
|
+
patch?: never;
|
|
1407
|
+
trace?: never;
|
|
1408
|
+
};
|
|
1409
|
+
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotion-links": {
|
|
1410
|
+
parameters: {
|
|
1411
|
+
query?: never;
|
|
1412
|
+
header?: never;
|
|
1413
|
+
path?: never;
|
|
1414
|
+
cookie?: never;
|
|
1415
|
+
};
|
|
1416
|
+
/** List workbook promotion destinations */
|
|
1417
|
+
get: operations["WorkbookPromotionsPublicController.getWorkbookPromotionLinks"];
|
|
1418
|
+
put?: never;
|
|
1419
|
+
post?: never;
|
|
1420
|
+
delete?: never;
|
|
1421
|
+
options?: never;
|
|
1422
|
+
head?: never;
|
|
1423
|
+
patch?: never;
|
|
1424
|
+
trace?: never;
|
|
1425
|
+
};
|
|
1426
|
+
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotion-previews": {
|
|
1427
|
+
parameters: {
|
|
1428
|
+
query?: never;
|
|
1429
|
+
header?: never;
|
|
1430
|
+
path?: never;
|
|
1431
|
+
cookie?: never;
|
|
1432
|
+
};
|
|
1433
|
+
get?: never;
|
|
1434
|
+
put?: never;
|
|
1435
|
+
/**
|
|
1436
|
+
* Preview a workbook promotion
|
|
1437
|
+
* @description Validate promotion of the complete workbook and published dashboard to another deployment. The source slug is preserved so deployment-scoped dashboard links remain stable. Returns content hashes for optimistic concurrency; no preview is stored. Requires access to both deployments.
|
|
1438
|
+
*/
|
|
1439
|
+
post: operations["WorkbookPromotionsPublicController.previewWorkbookPromotion"];
|
|
1440
|
+
delete?: never;
|
|
1441
|
+
options?: never;
|
|
1442
|
+
head?: never;
|
|
1443
|
+
patch?: never;
|
|
1444
|
+
trace?: never;
|
|
1445
|
+
};
|
|
1446
|
+
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions": {
|
|
1447
|
+
parameters: {
|
|
1448
|
+
query?: never;
|
|
1449
|
+
header?: never;
|
|
1450
|
+
path?: never;
|
|
1451
|
+
cookie?: never;
|
|
1452
|
+
};
|
|
1453
|
+
/** List workbook promotion history */
|
|
1454
|
+
get: operations["WorkbookPromotionsPublicController.getWorkbookPromotions"];
|
|
1455
|
+
put?: never;
|
|
1456
|
+
/**
|
|
1457
|
+
* Promote and publish a workbook
|
|
1458
|
+
* @description Promote the current workbook atomically if its source hash still matches the preview. Repeated promotions update the linked copy, including its deployment-scoped slug. Override replaces destination edits, never source validation or permissions. An idempotency key makes retries safe.
|
|
1459
|
+
*/
|
|
1460
|
+
post: operations["WorkbookPromotionsPublicController.promoteWorkbook"];
|
|
1461
|
+
delete?: never;
|
|
1462
|
+
options?: never;
|
|
1463
|
+
head?: never;
|
|
1464
|
+
patch?: never;
|
|
1465
|
+
trace?: never;
|
|
1466
|
+
};
|
|
1344
1467
|
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/publish": {
|
|
1345
1468
|
parameters: {
|
|
1346
1469
|
query?: never;
|
|
@@ -1929,6 +2052,34 @@ export interface paths {
|
|
|
1929
2052
|
patch?: never;
|
|
1930
2053
|
trace?: never;
|
|
1931
2054
|
};
|
|
2055
|
+
"/api/v1/external-documents/{externalWorkbookId}/placements": {
|
|
2056
|
+
parameters: {
|
|
2057
|
+
query?: never;
|
|
2058
|
+
header?: never;
|
|
2059
|
+
path?: never;
|
|
2060
|
+
cookie?: never;
|
|
2061
|
+
};
|
|
2062
|
+
/**
|
|
2063
|
+
* List the Cube placements in an external spreadsheet
|
|
2064
|
+
* @description Every block of Cube-written cells in the external document `externalWorkbookId` — a Google Drive file id, or the custom property the Excel add-in writes — across the whole tenant.
|
|
2065
|
+
*
|
|
2066
|
+
* Unlike `GET /api/v1/deployments/{deploymentId}/reports?externalWorkbookId=`, which lists only the reports the caller can read, this endpoint also reports the placements they **cannot**: each entry carries `access`, which is `GRANTED` when the caller may open the exploration and `DENIED` when they may not. It is how a recipient of a shared workbook learns that a block they are looking at is backed by an exploration nobody has shared with them, and who to ask.
|
|
2067
|
+
*
|
|
2068
|
+
* A `DENIED` entry carries only the placement's address, its opaque `reportId`/`placementId` and the exploration's `owner`. `reportName` is `null` on a denied entry — the name is withheld along with the exploration — and reading the report itself still answers `403`.
|
|
2069
|
+
*
|
|
2070
|
+
* Results are returned in pages using cursor-based pagination: pass `first` to set the page size and `after` (the previous response's `pageInfo.endCursor`) to fetch the next page. Omitting `first` returns every placement in the document.
|
|
2071
|
+
*
|
|
2072
|
+
* A document holding more than 500 placed explorations, or more than 2000 placements in total, is answered with `422` rather than a truncated page — an inventory that looks complete but is not would hide the very placement a recipient needs to see.
|
|
2073
|
+
*/
|
|
2074
|
+
get: operations["ExternalDocumentsPublicController.listExternalDocumentPlacements"];
|
|
2075
|
+
put?: never;
|
|
2076
|
+
post?: never;
|
|
2077
|
+
delete?: never;
|
|
2078
|
+
options?: never;
|
|
2079
|
+
head?: never;
|
|
2080
|
+
patch?: never;
|
|
2081
|
+
trace?: never;
|
|
2082
|
+
};
|
|
1932
2083
|
"/api/v1/github/installations": {
|
|
1933
2084
|
parameters: {
|
|
1934
2085
|
query?: never;
|
|
@@ -3043,19 +3194,10 @@ export interface components {
|
|
|
3043
3194
|
embeddingLlm?: components["schemas"]["AgentLlm"] | null;
|
|
3044
3195
|
embeddingUrl?: string | null;
|
|
3045
3196
|
id: number;
|
|
3046
|
-
integrations?: components["schemas"]["AgentIntegrationsDto"] | null;
|
|
3047
3197
|
name?: string | null;
|
|
3048
3198
|
updatedAt: string;
|
|
3049
3199
|
userId?: number | null;
|
|
3050
3200
|
};
|
|
3051
|
-
AgentIntegrationsDto: {
|
|
3052
|
-
jira?: components["schemas"]["AgentIntegrationsJiraDto"] | null;
|
|
3053
|
-
};
|
|
3054
|
-
AgentIntegrationsJiraDto: {
|
|
3055
|
-
connected?: boolean | null;
|
|
3056
|
-
jiraIssueType?: components["schemas"]["JiraIssueType"] | null;
|
|
3057
|
-
jiraProject?: components["schemas"]["JiraProject"] | null;
|
|
3058
|
-
};
|
|
3059
3201
|
AgentLlm: {
|
|
3060
3202
|
config?: {
|
|
3061
3203
|
[key: string]: any;
|
|
@@ -3072,14 +3214,17 @@ export interface components {
|
|
|
3072
3214
|
updatedAt?: (string) | null;
|
|
3073
3215
|
userId?: number | null;
|
|
3074
3216
|
};
|
|
3075
|
-
|
|
3217
|
+
AgentSkill: {
|
|
3076
3218
|
description: string;
|
|
3077
3219
|
input?: string | null;
|
|
3078
3220
|
name: string;
|
|
3221
|
+
source?: components["schemas"]["AgentSkillSource"] | null;
|
|
3079
3222
|
title: string;
|
|
3080
3223
|
};
|
|
3224
|
+
/** @enum {string} */
|
|
3225
|
+
AgentSkillSource: "deployment" | "system";
|
|
3081
3226
|
AgentSkillsResponse: {
|
|
3082
|
-
skills: components["schemas"]["
|
|
3227
|
+
skills: components["schemas"]["AgentSkill"][];
|
|
3083
3228
|
};
|
|
3084
3229
|
AgentSpace: {
|
|
3085
3230
|
config?: components["schemas"]["AgentSpaceConfigDto"] | null;
|
|
@@ -3100,7 +3245,9 @@ export interface components {
|
|
|
3100
3245
|
appTheme?: components["schemas"]["AppTheme"] | null;
|
|
3101
3246
|
applyThemeGlobally: boolean;
|
|
3102
3247
|
creatorMode?: components["schemas"]["CreatorMode"] | null;
|
|
3248
|
+
dashboardAppsEnabled: boolean;
|
|
3103
3249
|
embedding?: components["schemas"]["EmbedSettings"] | null;
|
|
3250
|
+
restrictDataDownload: boolean;
|
|
3104
3251
|
sheetsAgentChatEnabled: boolean;
|
|
3105
3252
|
sheetsUi?: components["schemas"]["SheetsUiSettings"] | null;
|
|
3106
3253
|
timezoneSettings?: components["schemas"]["TimezoneSettings"] | null;
|
|
@@ -3177,6 +3324,15 @@ export interface components {
|
|
|
3177
3324
|
fonts: components["schemas"]["ThemeFont"][];
|
|
3178
3325
|
heading: components["schemas"]["AppThemeFontRef"];
|
|
3179
3326
|
};
|
|
3327
|
+
ApplyWorkbookPromotionInput: {
|
|
3328
|
+
expectedDestinationHash?: string | null;
|
|
3329
|
+
expectedSourceHash: string;
|
|
3330
|
+
/** Format: uuid */
|
|
3331
|
+
idempotencyKey: string;
|
|
3332
|
+
override?: boolean | null;
|
|
3333
|
+
targetDeploymentId: number;
|
|
3334
|
+
targetFolderId?: number | null;
|
|
3335
|
+
};
|
|
3180
3336
|
BranchResponse: {
|
|
3181
3337
|
id: number;
|
|
3182
3338
|
isStagingEnvironmentEnabled?: boolean | null;
|
|
@@ -3945,9 +4101,75 @@ export interface components {
|
|
|
3945
4101
|
metricViewYaml?: string | null;
|
|
3946
4102
|
outcome: components["schemas"]["DatabricksMetricViewPublicationViewResultOutcome"];
|
|
3947
4103
|
source?: string | null;
|
|
4104
|
+
/** @description Measures this view could not publish, each named with the cube it comes from. A view with entries here is queryable but incomplete. */
|
|
4105
|
+
withheldMembers: components["schemas"]["DatabricksMetricViewPublicationWithheldMember"][];
|
|
4106
|
+
};
|
|
4107
|
+
/** @enum {string} */
|
|
4108
|
+
DatabricksMetricViewPublicationViewResultOutcome: "success" | "partial" | "failed";
|
|
4109
|
+
DatabricksMetricViewPublicationWithheldMember: {
|
|
4110
|
+
/** @description Why it could not be published, as a stable code. */
|
|
4111
|
+
code: string;
|
|
4112
|
+
cube: string;
|
|
4113
|
+
member: string;
|
|
4114
|
+
};
|
|
4115
|
+
DatabricksMetricViewSyncProgressResponse: {
|
|
4116
|
+
published: number;
|
|
4117
|
+
stage: string;
|
|
4118
|
+
total: number;
|
|
4119
|
+
};
|
|
4120
|
+
DatabricksMetricViewSyncRunListResponse: {
|
|
4121
|
+
items: components["schemas"]["DatabricksMetricViewSyncRunResponse"][];
|
|
4122
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
4123
|
+
};
|
|
4124
|
+
DatabricksMetricViewSyncRunResponse: {
|
|
4125
|
+
buildJobId?: number | null;
|
|
4126
|
+
cancelRequestedAt?: string | null;
|
|
4127
|
+
commit?: string | null;
|
|
4128
|
+
completedAt?: string | null;
|
|
4129
|
+
configurationVersion?: number | null;
|
|
4130
|
+
createdAt: string;
|
|
4131
|
+
dataSourceName: string;
|
|
4132
|
+
deletionPolicy?: string | null;
|
|
4133
|
+
deploymentId: number;
|
|
4134
|
+
durationMs?: number | null;
|
|
4135
|
+
integrationPublicId: string;
|
|
4136
|
+
progress?: components["schemas"]["DatabricksMetricViewSyncProgressResponse"] | null;
|
|
4137
|
+
runId: string;
|
|
4138
|
+
stage?: string | null;
|
|
4139
|
+
startedAt?: string | null;
|
|
4140
|
+
status: components["schemas"]["DatabricksMetricViewSyncRunResponseStatus"];
|
|
4141
|
+
targetCatalog?: string | null;
|
|
4142
|
+
targetSchema?: string | null;
|
|
4143
|
+
trigger: components["schemas"]["DatabricksMetricViewSyncRunResponseTrigger"];
|
|
4144
|
+
/** @description The Cube views this run was planned against. */
|
|
4145
|
+
viewNames: string[];
|
|
4146
|
+
views: components["schemas"]["DatabricksMetricViewSyncViewOutcomeResponse"][];
|
|
4147
|
+
};
|
|
4148
|
+
/** @enum {string} */
|
|
4149
|
+
DatabricksMetricViewSyncRunResponseStatus: "QUEUED" | "RUNNING" | "CANCELLING" | "COMPLETED" | "PARTIAL" | "FAILED" | "CANCELLED";
|
|
4150
|
+
/** @enum {string} */
|
|
4151
|
+
DatabricksMetricViewSyncRunResponseTrigger: "MANUAL";
|
|
4152
|
+
DatabricksMetricViewSyncStartResponse: {
|
|
4153
|
+
/** @description The build whose deployed model this run publishes. */
|
|
4154
|
+
buildJobId: number;
|
|
4155
|
+
commit?: string | null;
|
|
4156
|
+
dataSourceName: string;
|
|
4157
|
+
deploymentId: number;
|
|
4158
|
+
integrationPublicId: string;
|
|
4159
|
+
/** @description True when an idempotent retry returned an existing run. */
|
|
4160
|
+
reused: boolean;
|
|
4161
|
+
runId: string;
|
|
4162
|
+
statusUrl: string;
|
|
4163
|
+
};
|
|
4164
|
+
DatabricksMetricViewSyncViewOutcomeResponse: {
|
|
4165
|
+
cubeViewName: string;
|
|
4166
|
+
detail?: string | null;
|
|
4167
|
+
outcome: components["schemas"]["DatabricksMetricViewSyncViewOutcomeResponseOutcome"];
|
|
4168
|
+
/** @description Measures this view published without, as 'cube.member'. Non-empty means the Metric View is queryable but incomplete. */
|
|
4169
|
+
withheldMembers: string[];
|
|
3948
4170
|
};
|
|
3949
4171
|
/** @enum {string} */
|
|
3950
|
-
|
|
4172
|
+
DatabricksMetricViewSyncViewOutcomeResponseOutcome: "unchanged" | "created" | "updated" | "blocked" | "validation_failed" | "publish_failed" | "retained_obsolete" | "deleted_obsolete";
|
|
3951
4173
|
DbtGeneratedFileContent: {
|
|
3952
4174
|
/** @description The generated YAML. */
|
|
3953
4175
|
content: string;
|
|
@@ -4427,6 +4649,30 @@ export interface components {
|
|
|
4427
4649
|
};
|
|
4428
4650
|
/** @enum {string} */
|
|
4429
4651
|
ExportSubjectInputType: "USER" | "EMBED_USER";
|
|
4652
|
+
ExternalDocumentPlacementResponse: {
|
|
4653
|
+
access: components["schemas"]["ExternalDocumentPlacementResponseAccess"];
|
|
4654
|
+
anchorCell?: string | null;
|
|
4655
|
+
deploymentId: number;
|
|
4656
|
+
endResultCell?: string | null;
|
|
4657
|
+
host?: components["schemas"]["ExternalDocumentPlacementResponseHost"] | null;
|
|
4658
|
+
owner?: components["schemas"]["ResourceOwner"] | null;
|
|
4659
|
+
placedAt?: string | null;
|
|
4660
|
+
placementId?: string | null;
|
|
4661
|
+
refreshedAt?: string | null;
|
|
4662
|
+
reportId: number;
|
|
4663
|
+
reportName?: string | null;
|
|
4664
|
+
resultLocation: string;
|
|
4665
|
+
sheetId?: string | null;
|
|
4666
|
+
sheetName?: string | null;
|
|
4667
|
+
};
|
|
4668
|
+
/** @enum {string} */
|
|
4669
|
+
ExternalDocumentPlacementResponseAccess: "GRANTED" | "DENIED";
|
|
4670
|
+
/** @enum {string} */
|
|
4671
|
+
ExternalDocumentPlacementResponseHost: "GOOGLE_SHEETS" | "EXCEL";
|
|
4672
|
+
ExternalDocumentPlacementsListResponse: {
|
|
4673
|
+
items: components["schemas"]["ExternalDocumentPlacementResponse"][];
|
|
4674
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
4675
|
+
};
|
|
4430
4676
|
FileHash: {
|
|
4431
4677
|
hash: string;
|
|
4432
4678
|
};
|
|
@@ -4585,22 +4831,8 @@ export interface components {
|
|
|
4585
4831
|
};
|
|
4586
4832
|
/** @enum {string} */
|
|
4587
4833
|
InheritedUserPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
4588
|
-
|
|
4589
|
-
|
|
4590
|
-
iconUrl?: string | null;
|
|
4591
|
-
id: string;
|
|
4592
|
-
name: string;
|
|
4593
|
-
};
|
|
4594
|
-
JiraProject: {
|
|
4595
|
-
id: string;
|
|
4596
|
-
key: string;
|
|
4597
|
-
name: string;
|
|
4598
|
-
site: components["schemas"]["JiraSite"];
|
|
4599
|
-
};
|
|
4600
|
-
JiraSite: {
|
|
4601
|
-
host: string;
|
|
4602
|
-
id: string;
|
|
4603
|
-
};
|
|
4834
|
+
/** @enum {string} */
|
|
4835
|
+
ListDatabricksMetricViewSyncsQueryStatus: "QUEUED" | "RUNNING" | "CANCELLING" | "COMPLETED" | "PARTIAL" | "FAILED" | "CANCELLED";
|
|
4604
4836
|
LocalEncryptedSecret: {
|
|
4605
4837
|
authTagBase64: string;
|
|
4606
4838
|
ciphertext: string;
|
|
@@ -4757,6 +4989,7 @@ export interface components {
|
|
|
4757
4989
|
rows: string[];
|
|
4758
4990
|
showAppliedFilters?: boolean | null;
|
|
4759
4991
|
showColumnTotals?: boolean | null;
|
|
4992
|
+
showRowTotals?: boolean | null;
|
|
4760
4993
|
};
|
|
4761
4994
|
/** @enum {string} */
|
|
4762
4995
|
PivotItemsDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
|
|
@@ -4770,6 +5003,7 @@ export interface components {
|
|
|
4770
5003
|
rows: string[];
|
|
4771
5004
|
showAppliedFilters?: boolean | null;
|
|
4772
5005
|
showColumnTotals?: boolean | null;
|
|
5006
|
+
showRowTotals?: boolean | null;
|
|
4773
5007
|
};
|
|
4774
5008
|
/** @enum {string} */
|
|
4775
5009
|
PivotItemsInputDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
|
|
@@ -4791,6 +5025,26 @@ export interface components {
|
|
|
4791
5025
|
PostTokenBySessionIdInput: {
|
|
4792
5026
|
sessionId: string;
|
|
4793
5027
|
};
|
|
5028
|
+
PreviewWorkbookPromotionInput: {
|
|
5029
|
+
targetDeploymentId: number;
|
|
5030
|
+
targetFolderId?: number | null;
|
|
5031
|
+
};
|
|
5032
|
+
PromotionActorDto: {
|
|
5033
|
+
apiKeyId?: number | null;
|
|
5034
|
+
authenticationMethod: components["schemas"]["PromotionActorDtoAuthenticationMethod"];
|
|
5035
|
+
displayName: string;
|
|
5036
|
+
userId: number;
|
|
5037
|
+
};
|
|
5038
|
+
/** @enum {string} */
|
|
5039
|
+
PromotionActorDtoAuthenticationMethod: "session" | "apiKey";
|
|
5040
|
+
PromotionReferenceDto: {
|
|
5041
|
+
availability: components["schemas"]["PromotionReferenceDtoAvailability"];
|
|
5042
|
+
deploymentId?: number | null;
|
|
5043
|
+
name?: string | null;
|
|
5044
|
+
workbookId?: number | null;
|
|
5045
|
+
};
|
|
5046
|
+
/** @enum {string} */
|
|
5047
|
+
PromotionReferenceDtoAvailability: "available" | "unavailable";
|
|
4794
5048
|
ProvisionEmbedUserFailure: {
|
|
4795
5049
|
error: components["schemas"]["BulkActionError"];
|
|
4796
5050
|
/** @description The `externalId` of the entry that failed, normalized the same way a successful one is. */
|
|
@@ -5074,6 +5328,7 @@ export interface components {
|
|
|
5074
5328
|
name?: string | null;
|
|
5075
5329
|
periodComparisons?: components["schemas"]["PeriodComparison"][] | null;
|
|
5076
5330
|
preferences?: components["schemas"]["ReportSnapshotPreferences"] | null;
|
|
5331
|
+
publicId?: string | null;
|
|
5077
5332
|
pythonCode?: string | null;
|
|
5078
5333
|
reportId: number;
|
|
5079
5334
|
spec?: (string | Record<string, never>) | null;
|
|
@@ -5206,6 +5461,11 @@ export interface components {
|
|
|
5206
5461
|
};
|
|
5207
5462
|
/** @enum {string} */
|
|
5208
5463
|
StartDashboardExportInputFormat: "png" | "pdf";
|
|
5464
|
+
StartDatabricksMetricViewSyncInput: {
|
|
5465
|
+
/** @description The configurationVersion returned by GET. A run is refused when settings changed after they were loaded, so a publish always uses the configuration the caller saw. */
|
|
5466
|
+
configurationVersion: number;
|
|
5467
|
+
idempotencyKey?: string | null;
|
|
5468
|
+
};
|
|
5209
5469
|
StartDbtSyncInput: {
|
|
5210
5470
|
branchName?: string | null;
|
|
5211
5471
|
manifest?: {
|
|
@@ -5227,6 +5487,9 @@ export interface components {
|
|
|
5227
5487
|
transaction: components["schemas"]["UploadTransaction"];
|
|
5228
5488
|
};
|
|
5229
5489
|
TenantSettings: {
|
|
5490
|
+
aiTokensAutoPurchaseAmount: number;
|
|
5491
|
+
aiTokensAutoPurchaseEnabled: boolean;
|
|
5492
|
+
aiTokensAutoPurchaseThreshold: number;
|
|
5230
5493
|
auditLogEnabled: boolean;
|
|
5231
5494
|
auditLogEnabledCurrent: boolean;
|
|
5232
5495
|
auditLogEnabledTimestamp: number;
|
|
@@ -5238,6 +5501,8 @@ export interface components {
|
|
|
5238
5501
|
useAIBIUserInterface: boolean;
|
|
5239
5502
|
};
|
|
5240
5503
|
TenantSettingsInput: {
|
|
5504
|
+
aiTokensAutoPurchaseAmount?: number | null;
|
|
5505
|
+
aiTokensAutoPurchaseEnabled?: boolean | null;
|
|
5241
5506
|
auditLogEnabled?: boolean | null;
|
|
5242
5507
|
hasSupportAccess?: boolean | null;
|
|
5243
5508
|
maintenanceWindowDay?: string | null;
|
|
@@ -5654,6 +5919,7 @@ export interface components {
|
|
|
5654
5919
|
[key: string]: any;
|
|
5655
5920
|
};
|
|
5656
5921
|
name: string;
|
|
5922
|
+
promotion?: components["schemas"]["WorkbookPromotionSummaryDto"] | null;
|
|
5657
5923
|
publishedDashboard?: components["schemas"]["Dashboard"] | null;
|
|
5658
5924
|
slug?: string | null;
|
|
5659
5925
|
type: components["schemas"]["WorkbookDtoType"];
|
|
@@ -5670,6 +5936,51 @@ export interface components {
|
|
|
5670
5936
|
};
|
|
5671
5937
|
/** @enum {string} */
|
|
5672
5938
|
WorkbookDtoType: "FOLDER" | "WORKBOOK" | "REPORT";
|
|
5939
|
+
WorkbookPromotionDto: {
|
|
5940
|
+
completedAt: string;
|
|
5941
|
+
destinationChangedSincePreview: boolean;
|
|
5942
|
+
destinationWasDiverged: boolean;
|
|
5943
|
+
id: number;
|
|
5944
|
+
linkId: number;
|
|
5945
|
+
outcome: components["schemas"]["WorkbookPromotionDtoOutcome"];
|
|
5946
|
+
overrideRequested: boolean;
|
|
5947
|
+
performedBy: components["schemas"]["PromotionActorDto"];
|
|
5948
|
+
source?: components["schemas"]["PromotionReferenceDto"] | null;
|
|
5949
|
+
target?: components["schemas"]["PromotionReferenceDto"] | null;
|
|
5950
|
+
targetDashboardVersionId: number;
|
|
5951
|
+
};
|
|
5952
|
+
/** @enum {string} */
|
|
5953
|
+
WorkbookPromotionDtoOutcome: "created" | "updated" | "unchanged";
|
|
5954
|
+
WorkbookPromotionLinkDto: {
|
|
5955
|
+
id: number;
|
|
5956
|
+
target: components["schemas"]["PromotionReferenceDto"];
|
|
5957
|
+
};
|
|
5958
|
+
WorkbookPromotionLinksListResponse: {
|
|
5959
|
+
items: components["schemas"]["WorkbookPromotionLinkDto"][];
|
|
5960
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
5961
|
+
};
|
|
5962
|
+
WorkbookPromotionPreviewDto: {
|
|
5963
|
+
destinationHash?: string | null;
|
|
5964
|
+
destinationWasDiverged: boolean;
|
|
5965
|
+
reportCount: number;
|
|
5966
|
+
sourceHash: string;
|
|
5967
|
+
targetDeploymentId: number;
|
|
5968
|
+
targetWorkbookId?: number | null;
|
|
5969
|
+
};
|
|
5970
|
+
WorkbookPromotionSummaryDto: {
|
|
5971
|
+
firstPromotion?: components["schemas"]["WorkbookPromotionDto"] | null;
|
|
5972
|
+
lastPromotion?: components["schemas"]["WorkbookPromotionDto"] | null;
|
|
5973
|
+
linkId: number;
|
|
5974
|
+
origin: components["schemas"]["PromotionReferenceDto"];
|
|
5975
|
+
parent: components["schemas"]["PromotionReferenceDto"];
|
|
5976
|
+
};
|
|
5977
|
+
WorkbookPromotionSummaryResponse: {
|
|
5978
|
+
promotion?: components["schemas"]["WorkbookPromotionSummaryDto"] | null;
|
|
5979
|
+
};
|
|
5980
|
+
WorkbookPromotionsListResponse: {
|
|
5981
|
+
items: components["schemas"]["WorkbookPromotionDto"][];
|
|
5982
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
5983
|
+
};
|
|
5673
5984
|
WorkbooksListResponse: {
|
|
5674
5985
|
count?: number | null;
|
|
5675
5986
|
/**
|
|
@@ -6494,6 +6805,105 @@ export interface operations {
|
|
|
6494
6805
|
};
|
|
6495
6806
|
};
|
|
6496
6807
|
};
|
|
6808
|
+
"DatabricksMetricViewIntegrationPublicController.listSyncs": {
|
|
6809
|
+
parameters: {
|
|
6810
|
+
query?: {
|
|
6811
|
+
status?: components["schemas"]["ListDatabricksMetricViewSyncsQueryStatus"] | null;
|
|
6812
|
+
after?: string;
|
|
6813
|
+
first?: number;
|
|
6814
|
+
};
|
|
6815
|
+
header?: never;
|
|
6816
|
+
path: {
|
|
6817
|
+
deploymentId: number;
|
|
6818
|
+
dataSourceName: string;
|
|
6819
|
+
};
|
|
6820
|
+
cookie?: never;
|
|
6821
|
+
};
|
|
6822
|
+
requestBody?: never;
|
|
6823
|
+
responses: {
|
|
6824
|
+
200: {
|
|
6825
|
+
headers: {
|
|
6826
|
+
[name: string]: any;
|
|
6827
|
+
};
|
|
6828
|
+
content: {
|
|
6829
|
+
"application/json": components["schemas"]["DatabricksMetricViewSyncRunListResponse"];
|
|
6830
|
+
};
|
|
6831
|
+
};
|
|
6832
|
+
};
|
|
6833
|
+
};
|
|
6834
|
+
"DatabricksMetricViewIntegrationPublicController.startSync": {
|
|
6835
|
+
parameters: {
|
|
6836
|
+
query?: never;
|
|
6837
|
+
header?: never;
|
|
6838
|
+
path: {
|
|
6839
|
+
deploymentId: number;
|
|
6840
|
+
dataSourceName: string;
|
|
6841
|
+
};
|
|
6842
|
+
cookie?: never;
|
|
6843
|
+
};
|
|
6844
|
+
/** @description StartDatabricksMetricViewSyncInput */
|
|
6845
|
+
requestBody: {
|
|
6846
|
+
content: {
|
|
6847
|
+
"application/json": components["schemas"]["StartDatabricksMetricViewSyncInput"];
|
|
6848
|
+
};
|
|
6849
|
+
};
|
|
6850
|
+
responses: {
|
|
6851
|
+
202: {
|
|
6852
|
+
headers: {
|
|
6853
|
+
[name: string]: any;
|
|
6854
|
+
};
|
|
6855
|
+
content: {
|
|
6856
|
+
"application/json": components["schemas"]["DatabricksMetricViewSyncStartResponse"];
|
|
6857
|
+
};
|
|
6858
|
+
};
|
|
6859
|
+
};
|
|
6860
|
+
};
|
|
6861
|
+
"DatabricksMetricViewIntegrationPublicController.syncRun": {
|
|
6862
|
+
parameters: {
|
|
6863
|
+
query?: never;
|
|
6864
|
+
header?: never;
|
|
6865
|
+
path: {
|
|
6866
|
+
deploymentId: number;
|
|
6867
|
+
dataSourceName: string;
|
|
6868
|
+
runId: string;
|
|
6869
|
+
};
|
|
6870
|
+
cookie?: never;
|
|
6871
|
+
};
|
|
6872
|
+
requestBody?: never;
|
|
6873
|
+
responses: {
|
|
6874
|
+
200: {
|
|
6875
|
+
headers: {
|
|
6876
|
+
[name: string]: any;
|
|
6877
|
+
};
|
|
6878
|
+
content: {
|
|
6879
|
+
"application/json": components["schemas"]["DatabricksMetricViewSyncRunResponse"];
|
|
6880
|
+
};
|
|
6881
|
+
};
|
|
6882
|
+
};
|
|
6883
|
+
};
|
|
6884
|
+
"DatabricksMetricViewIntegrationPublicController.cancelSync": {
|
|
6885
|
+
parameters: {
|
|
6886
|
+
query?: never;
|
|
6887
|
+
header?: never;
|
|
6888
|
+
path: {
|
|
6889
|
+
deploymentId: number;
|
|
6890
|
+
dataSourceName: string;
|
|
6891
|
+
runId: string;
|
|
6892
|
+
};
|
|
6893
|
+
cookie?: never;
|
|
6894
|
+
};
|
|
6895
|
+
requestBody?: never;
|
|
6896
|
+
responses: {
|
|
6897
|
+
200: {
|
|
6898
|
+
headers: {
|
|
6899
|
+
[name: string]: any;
|
|
6900
|
+
};
|
|
6901
|
+
content: {
|
|
6902
|
+
"application/json": components["schemas"]["DatabricksMetricViewSyncRunResponse"];
|
|
6903
|
+
};
|
|
6904
|
+
};
|
|
6905
|
+
};
|
|
6906
|
+
};
|
|
6497
6907
|
"DatabricksMetricViewPublicationPublicController.startPreview": {
|
|
6498
6908
|
parameters: {
|
|
6499
6909
|
query?: never;
|
|
@@ -7989,6 +8399,132 @@ export interface operations {
|
|
|
7989
8399
|
};
|
|
7990
8400
|
};
|
|
7991
8401
|
};
|
|
8402
|
+
"WorkbookPromotionsPublicController.getWorkbookPromotion": {
|
|
8403
|
+
parameters: {
|
|
8404
|
+
query?: never;
|
|
8405
|
+
header?: never;
|
|
8406
|
+
path: {
|
|
8407
|
+
deploymentId: number;
|
|
8408
|
+
workbookId: number;
|
|
8409
|
+
};
|
|
8410
|
+
cookie?: never;
|
|
8411
|
+
};
|
|
8412
|
+
requestBody?: never;
|
|
8413
|
+
responses: {
|
|
8414
|
+
200: {
|
|
8415
|
+
headers: {
|
|
8416
|
+
[name: string]: any;
|
|
8417
|
+
};
|
|
8418
|
+
content: {
|
|
8419
|
+
"application/json": components["schemas"]["WorkbookPromotionSummaryResponse"];
|
|
8420
|
+
};
|
|
8421
|
+
};
|
|
8422
|
+
};
|
|
8423
|
+
};
|
|
8424
|
+
"WorkbookPromotionsPublicController.getWorkbookPromotionLinks": {
|
|
8425
|
+
parameters: {
|
|
8426
|
+
query?: {
|
|
8427
|
+
after?: string | null;
|
|
8428
|
+
first?: number | null;
|
|
8429
|
+
};
|
|
8430
|
+
header?: never;
|
|
8431
|
+
path: {
|
|
8432
|
+
deploymentId: number;
|
|
8433
|
+
workbookId: number;
|
|
8434
|
+
};
|
|
8435
|
+
cookie?: never;
|
|
8436
|
+
};
|
|
8437
|
+
requestBody?: never;
|
|
8438
|
+
responses: {
|
|
8439
|
+
200: {
|
|
8440
|
+
headers: {
|
|
8441
|
+
[name: string]: any;
|
|
8442
|
+
};
|
|
8443
|
+
content: {
|
|
8444
|
+
"application/json": components["schemas"]["WorkbookPromotionLinksListResponse"];
|
|
8445
|
+
};
|
|
8446
|
+
};
|
|
8447
|
+
};
|
|
8448
|
+
};
|
|
8449
|
+
"WorkbookPromotionsPublicController.previewWorkbookPromotion": {
|
|
8450
|
+
parameters: {
|
|
8451
|
+
query?: never;
|
|
8452
|
+
header?: never;
|
|
8453
|
+
path: {
|
|
8454
|
+
deploymentId: number;
|
|
8455
|
+
workbookId: number;
|
|
8456
|
+
};
|
|
8457
|
+
cookie?: never;
|
|
8458
|
+
};
|
|
8459
|
+
/** @description PreviewWorkbookPromotionInput */
|
|
8460
|
+
requestBody?: {
|
|
8461
|
+
content: {
|
|
8462
|
+
"application/json": components["schemas"]["PreviewWorkbookPromotionInput"];
|
|
8463
|
+
};
|
|
8464
|
+
};
|
|
8465
|
+
responses: {
|
|
8466
|
+
200: {
|
|
8467
|
+
headers: {
|
|
8468
|
+
[name: string]: any;
|
|
8469
|
+
};
|
|
8470
|
+
content: {
|
|
8471
|
+
"application/json": components["schemas"]["WorkbookPromotionPreviewDto"];
|
|
8472
|
+
};
|
|
8473
|
+
};
|
|
8474
|
+
};
|
|
8475
|
+
};
|
|
8476
|
+
"WorkbookPromotionsPublicController.getWorkbookPromotions": {
|
|
8477
|
+
parameters: {
|
|
8478
|
+
query?: {
|
|
8479
|
+
after?: string | null;
|
|
8480
|
+
first?: number | null;
|
|
8481
|
+
};
|
|
8482
|
+
header?: never;
|
|
8483
|
+
path: {
|
|
8484
|
+
deploymentId: number;
|
|
8485
|
+
workbookId: number;
|
|
8486
|
+
};
|
|
8487
|
+
cookie?: never;
|
|
8488
|
+
};
|
|
8489
|
+
requestBody?: never;
|
|
8490
|
+
responses: {
|
|
8491
|
+
200: {
|
|
8492
|
+
headers: {
|
|
8493
|
+
[name: string]: any;
|
|
8494
|
+
};
|
|
8495
|
+
content: {
|
|
8496
|
+
"application/json": components["schemas"]["WorkbookPromotionsListResponse"];
|
|
8497
|
+
};
|
|
8498
|
+
};
|
|
8499
|
+
};
|
|
8500
|
+
};
|
|
8501
|
+
"WorkbookPromotionsPublicController.promoteWorkbook": {
|
|
8502
|
+
parameters: {
|
|
8503
|
+
query?: never;
|
|
8504
|
+
header?: never;
|
|
8505
|
+
path: {
|
|
8506
|
+
deploymentId: number;
|
|
8507
|
+
workbookId: number;
|
|
8508
|
+
};
|
|
8509
|
+
cookie?: never;
|
|
8510
|
+
};
|
|
8511
|
+
/** @description ApplyWorkbookPromotionInput */
|
|
8512
|
+
requestBody?: {
|
|
8513
|
+
content: {
|
|
8514
|
+
"application/json": components["schemas"]["ApplyWorkbookPromotionInput"];
|
|
8515
|
+
};
|
|
8516
|
+
};
|
|
8517
|
+
responses: {
|
|
8518
|
+
200: {
|
|
8519
|
+
headers: {
|
|
8520
|
+
[name: string]: any;
|
|
8521
|
+
};
|
|
8522
|
+
content: {
|
|
8523
|
+
"application/json": components["schemas"]["WorkbookPromotionDto"];
|
|
8524
|
+
};
|
|
8525
|
+
};
|
|
8526
|
+
};
|
|
8527
|
+
};
|
|
7992
8528
|
"WorkbooksPublicController.publishDashboard": {
|
|
7993
8529
|
parameters: {
|
|
7994
8530
|
query?: never;
|
|
@@ -8793,6 +9329,37 @@ export interface operations {
|
|
|
8793
9329
|
};
|
|
8794
9330
|
};
|
|
8795
9331
|
};
|
|
9332
|
+
"ExternalDocumentsPublicController.listExternalDocumentPlacements": {
|
|
9333
|
+
parameters: {
|
|
9334
|
+
query?: {
|
|
9335
|
+
after?: string | null;
|
|
9336
|
+
first?: number | null;
|
|
9337
|
+
};
|
|
9338
|
+
header?: never;
|
|
9339
|
+
path: {
|
|
9340
|
+
externalWorkbookId: string;
|
|
9341
|
+
};
|
|
9342
|
+
cookie?: never;
|
|
9343
|
+
};
|
|
9344
|
+
requestBody?: never;
|
|
9345
|
+
responses: {
|
|
9346
|
+
200: {
|
|
9347
|
+
headers: {
|
|
9348
|
+
[name: string]: any;
|
|
9349
|
+
};
|
|
9350
|
+
content: {
|
|
9351
|
+
"application/json": components["schemas"]["ExternalDocumentPlacementsListResponse"];
|
|
9352
|
+
};
|
|
9353
|
+
};
|
|
9354
|
+
/** @description The document holds more placements than this endpoint will report on. A state, not a malformed request: the answer is deliberately an error rather than a page that silently omits placements no cursor can reach. */
|
|
9355
|
+
422: {
|
|
9356
|
+
headers: {
|
|
9357
|
+
[name: string]: any;
|
|
9358
|
+
};
|
|
9359
|
+
content?: never;
|
|
9360
|
+
};
|
|
9361
|
+
};
|
|
9362
|
+
};
|
|
8796
9363
|
"GitHubPublicController.installations": {
|
|
8797
9364
|
parameters: {
|
|
8798
9365
|
query?: {
|