@cube-dev/platform-client 0.11.0 → 0.12.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 +5 -0
- package/dist/schema.d.ts +236 -3
- package/dist/schema.d.ts.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -9,6 +9,11 @@ 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.12.0] - 2026-09-20
|
|
13
|
+
### Deprecated
|
|
14
|
+
|
|
15
|
+
- The agent Jira/Atlassian integration is gone (CUB-4773). `Agent.integrations` (`AgentIntegrationsDto`, `AgentIntegrationsJiraDto`), `UpdateAgentInput.integrations`, the `atlassianConfig` / `jiraProjects` / `jiraIssueTypes` queries and `useD3AiJiraIntegration` are **deprecated, not removed** — they remain in the schema returning null/false so existing clients keep working, and are deleted in a later release (CUB-4781). Nothing reads or writes them: the OAuth callback, credential storage and token refresh behind them are gone.
|
|
16
|
+
|
|
12
17
|
## [0.11.0] - 2026-09-15
|
|
13
18
|
### Added
|
|
14
19
|
|
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;
|
|
@@ -3072,14 +3120,17 @@ export interface components {
|
|
|
3072
3120
|
updatedAt?: (string) | null;
|
|
3073
3121
|
userId?: number | null;
|
|
3074
3122
|
};
|
|
3075
|
-
|
|
3123
|
+
AgentSkill: {
|
|
3076
3124
|
description: string;
|
|
3077
3125
|
input?: string | null;
|
|
3078
3126
|
name: string;
|
|
3127
|
+
source?: components["schemas"]["AgentSkillSource"] | null;
|
|
3079
3128
|
title: string;
|
|
3080
3129
|
};
|
|
3130
|
+
/** @enum {string} */
|
|
3131
|
+
AgentSkillSource: "deployment" | "system";
|
|
3081
3132
|
AgentSkillsResponse: {
|
|
3082
|
-
skills: components["schemas"]["
|
|
3133
|
+
skills: components["schemas"]["AgentSkill"][];
|
|
3083
3134
|
};
|
|
3084
3135
|
AgentSpace: {
|
|
3085
3136
|
config?: components["schemas"]["AgentSpaceConfigDto"] | null;
|
|
@@ -3100,7 +3151,9 @@ export interface components {
|
|
|
3100
3151
|
appTheme?: components["schemas"]["AppTheme"] | null;
|
|
3101
3152
|
applyThemeGlobally: boolean;
|
|
3102
3153
|
creatorMode?: components["schemas"]["CreatorMode"] | null;
|
|
3154
|
+
dashboardAppsEnabled: boolean;
|
|
3103
3155
|
embedding?: components["schemas"]["EmbedSettings"] | null;
|
|
3156
|
+
restrictDataDownload: boolean;
|
|
3104
3157
|
sheetsAgentChatEnabled: boolean;
|
|
3105
3158
|
sheetsUi?: components["schemas"]["SheetsUiSettings"] | null;
|
|
3106
3159
|
timezoneSettings?: components["schemas"]["TimezoneSettings"] | null;
|
|
@@ -3945,9 +3998,75 @@ export interface components {
|
|
|
3945
3998
|
metricViewYaml?: string | null;
|
|
3946
3999
|
outcome: components["schemas"]["DatabricksMetricViewPublicationViewResultOutcome"];
|
|
3947
4000
|
source?: string | null;
|
|
4001
|
+
/** @description Measures this view could not publish, each named with the cube it comes from. A view with entries here is queryable but incomplete. */
|
|
4002
|
+
withheldMembers: components["schemas"]["DatabricksMetricViewPublicationWithheldMember"][];
|
|
3948
4003
|
};
|
|
3949
4004
|
/** @enum {string} */
|
|
3950
|
-
DatabricksMetricViewPublicationViewResultOutcome: "success" | "failed";
|
|
4005
|
+
DatabricksMetricViewPublicationViewResultOutcome: "success" | "partial" | "failed";
|
|
4006
|
+
DatabricksMetricViewPublicationWithheldMember: {
|
|
4007
|
+
/** @description Why it could not be published, as a stable code. */
|
|
4008
|
+
code: string;
|
|
4009
|
+
cube: string;
|
|
4010
|
+
member: string;
|
|
4011
|
+
};
|
|
4012
|
+
DatabricksMetricViewSyncProgressResponse: {
|
|
4013
|
+
published: number;
|
|
4014
|
+
stage: string;
|
|
4015
|
+
total: number;
|
|
4016
|
+
};
|
|
4017
|
+
DatabricksMetricViewSyncRunListResponse: {
|
|
4018
|
+
items: components["schemas"]["DatabricksMetricViewSyncRunResponse"][];
|
|
4019
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
4020
|
+
};
|
|
4021
|
+
DatabricksMetricViewSyncRunResponse: {
|
|
4022
|
+
buildJobId?: number | null;
|
|
4023
|
+
cancelRequestedAt?: string | null;
|
|
4024
|
+
commit?: string | null;
|
|
4025
|
+
completedAt?: string | null;
|
|
4026
|
+
configurationVersion?: number | null;
|
|
4027
|
+
createdAt: string;
|
|
4028
|
+
dataSourceName: string;
|
|
4029
|
+
deletionPolicy?: string | null;
|
|
4030
|
+
deploymentId: number;
|
|
4031
|
+
durationMs?: number | null;
|
|
4032
|
+
integrationPublicId: string;
|
|
4033
|
+
progress?: components["schemas"]["DatabricksMetricViewSyncProgressResponse"] | null;
|
|
4034
|
+
runId: string;
|
|
4035
|
+
stage?: string | null;
|
|
4036
|
+
startedAt?: string | null;
|
|
4037
|
+
status: components["schemas"]["DatabricksMetricViewSyncRunResponseStatus"];
|
|
4038
|
+
targetCatalog?: string | null;
|
|
4039
|
+
targetSchema?: string | null;
|
|
4040
|
+
trigger: components["schemas"]["DatabricksMetricViewSyncRunResponseTrigger"];
|
|
4041
|
+
/** @description The Cube views this run was planned against. */
|
|
4042
|
+
viewNames: string[];
|
|
4043
|
+
views: components["schemas"]["DatabricksMetricViewSyncViewOutcomeResponse"][];
|
|
4044
|
+
};
|
|
4045
|
+
/** @enum {string} */
|
|
4046
|
+
DatabricksMetricViewSyncRunResponseStatus: "QUEUED" | "RUNNING" | "CANCELLING" | "COMPLETED" | "PARTIAL" | "FAILED" | "CANCELLED";
|
|
4047
|
+
/** @enum {string} */
|
|
4048
|
+
DatabricksMetricViewSyncRunResponseTrigger: "MANUAL";
|
|
4049
|
+
DatabricksMetricViewSyncStartResponse: {
|
|
4050
|
+
/** @description The build whose deployed model this run publishes. */
|
|
4051
|
+
buildJobId: number;
|
|
4052
|
+
commit?: string | null;
|
|
4053
|
+
dataSourceName: string;
|
|
4054
|
+
deploymentId: number;
|
|
4055
|
+
integrationPublicId: string;
|
|
4056
|
+
/** @description True when an idempotent retry returned an existing run. */
|
|
4057
|
+
reused: boolean;
|
|
4058
|
+
runId: string;
|
|
4059
|
+
statusUrl: string;
|
|
4060
|
+
};
|
|
4061
|
+
DatabricksMetricViewSyncViewOutcomeResponse: {
|
|
4062
|
+
cubeViewName: string;
|
|
4063
|
+
detail?: string | null;
|
|
4064
|
+
outcome: components["schemas"]["DatabricksMetricViewSyncViewOutcomeResponseOutcome"];
|
|
4065
|
+
/** @description Measures this view published without, as 'cube.member'. Non-empty means the Metric View is queryable but incomplete. */
|
|
4066
|
+
withheldMembers: string[];
|
|
4067
|
+
};
|
|
4068
|
+
/** @enum {string} */
|
|
4069
|
+
DatabricksMetricViewSyncViewOutcomeResponseOutcome: "unchanged" | "created" | "updated" | "blocked" | "validation_failed" | "publish_failed" | "retained_obsolete" | "deleted_obsolete";
|
|
3951
4070
|
DbtGeneratedFileContent: {
|
|
3952
4071
|
/** @description The generated YAML. */
|
|
3953
4072
|
content: string;
|
|
@@ -4601,6 +4720,8 @@ export interface components {
|
|
|
4601
4720
|
host: string;
|
|
4602
4721
|
id: string;
|
|
4603
4722
|
};
|
|
4723
|
+
/** @enum {string} */
|
|
4724
|
+
ListDatabricksMetricViewSyncsQueryStatus: "QUEUED" | "RUNNING" | "CANCELLING" | "COMPLETED" | "PARTIAL" | "FAILED" | "CANCELLED";
|
|
4604
4725
|
LocalEncryptedSecret: {
|
|
4605
4726
|
authTagBase64: string;
|
|
4606
4727
|
ciphertext: string;
|
|
@@ -4757,6 +4878,7 @@ export interface components {
|
|
|
4757
4878
|
rows: string[];
|
|
4758
4879
|
showAppliedFilters?: boolean | null;
|
|
4759
4880
|
showColumnTotals?: boolean | null;
|
|
4881
|
+
showRowTotals?: boolean | null;
|
|
4760
4882
|
};
|
|
4761
4883
|
/** @enum {string} */
|
|
4762
4884
|
PivotItemsDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
|
|
@@ -4770,6 +4892,7 @@ export interface components {
|
|
|
4770
4892
|
rows: string[];
|
|
4771
4893
|
showAppliedFilters?: boolean | null;
|
|
4772
4894
|
showColumnTotals?: boolean | null;
|
|
4895
|
+
showRowTotals?: boolean | null;
|
|
4773
4896
|
};
|
|
4774
4897
|
/** @enum {string} */
|
|
4775
4898
|
PivotItemsInputDisplayScale: "model" | "absolute" | "thousands" | "millions" | "billions";
|
|
@@ -5074,6 +5197,7 @@ export interface components {
|
|
|
5074
5197
|
name?: string | null;
|
|
5075
5198
|
periodComparisons?: components["schemas"]["PeriodComparison"][] | null;
|
|
5076
5199
|
preferences?: components["schemas"]["ReportSnapshotPreferences"] | null;
|
|
5200
|
+
publicId?: string | null;
|
|
5077
5201
|
pythonCode?: string | null;
|
|
5078
5202
|
reportId: number;
|
|
5079
5203
|
spec?: (string | Record<string, never>) | null;
|
|
@@ -5206,6 +5330,11 @@ export interface components {
|
|
|
5206
5330
|
};
|
|
5207
5331
|
/** @enum {string} */
|
|
5208
5332
|
StartDashboardExportInputFormat: "png" | "pdf";
|
|
5333
|
+
StartDatabricksMetricViewSyncInput: {
|
|
5334
|
+
/** @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. */
|
|
5335
|
+
configurationVersion: number;
|
|
5336
|
+
idempotencyKey?: string | null;
|
|
5337
|
+
};
|
|
5209
5338
|
StartDbtSyncInput: {
|
|
5210
5339
|
branchName?: string | null;
|
|
5211
5340
|
manifest?: {
|
|
@@ -5227,6 +5356,9 @@ export interface components {
|
|
|
5227
5356
|
transaction: components["schemas"]["UploadTransaction"];
|
|
5228
5357
|
};
|
|
5229
5358
|
TenantSettings: {
|
|
5359
|
+
aiTokensAutoPurchaseAmount: number;
|
|
5360
|
+
aiTokensAutoPurchaseEnabled: boolean;
|
|
5361
|
+
aiTokensAutoPurchaseThreshold: number;
|
|
5230
5362
|
auditLogEnabled: boolean;
|
|
5231
5363
|
auditLogEnabledCurrent: boolean;
|
|
5232
5364
|
auditLogEnabledTimestamp: number;
|
|
@@ -5238,6 +5370,8 @@ export interface components {
|
|
|
5238
5370
|
useAIBIUserInterface: boolean;
|
|
5239
5371
|
};
|
|
5240
5372
|
TenantSettingsInput: {
|
|
5373
|
+
aiTokensAutoPurchaseAmount?: number | null;
|
|
5374
|
+
aiTokensAutoPurchaseEnabled?: boolean | null;
|
|
5241
5375
|
auditLogEnabled?: boolean | null;
|
|
5242
5376
|
hasSupportAccess?: boolean | null;
|
|
5243
5377
|
maintenanceWindowDay?: string | null;
|
|
@@ -6494,6 +6628,105 @@ export interface operations {
|
|
|
6494
6628
|
};
|
|
6495
6629
|
};
|
|
6496
6630
|
};
|
|
6631
|
+
"DatabricksMetricViewIntegrationPublicController.listSyncs": {
|
|
6632
|
+
parameters: {
|
|
6633
|
+
query?: {
|
|
6634
|
+
status?: components["schemas"]["ListDatabricksMetricViewSyncsQueryStatus"] | null;
|
|
6635
|
+
after?: string;
|
|
6636
|
+
first?: number;
|
|
6637
|
+
};
|
|
6638
|
+
header?: never;
|
|
6639
|
+
path: {
|
|
6640
|
+
deploymentId: number;
|
|
6641
|
+
dataSourceName: string;
|
|
6642
|
+
};
|
|
6643
|
+
cookie?: never;
|
|
6644
|
+
};
|
|
6645
|
+
requestBody?: never;
|
|
6646
|
+
responses: {
|
|
6647
|
+
200: {
|
|
6648
|
+
headers: {
|
|
6649
|
+
[name: string]: any;
|
|
6650
|
+
};
|
|
6651
|
+
content: {
|
|
6652
|
+
"application/json": components["schemas"]["DatabricksMetricViewSyncRunListResponse"];
|
|
6653
|
+
};
|
|
6654
|
+
};
|
|
6655
|
+
};
|
|
6656
|
+
};
|
|
6657
|
+
"DatabricksMetricViewIntegrationPublicController.startSync": {
|
|
6658
|
+
parameters: {
|
|
6659
|
+
query?: never;
|
|
6660
|
+
header?: never;
|
|
6661
|
+
path: {
|
|
6662
|
+
deploymentId: number;
|
|
6663
|
+
dataSourceName: string;
|
|
6664
|
+
};
|
|
6665
|
+
cookie?: never;
|
|
6666
|
+
};
|
|
6667
|
+
/** @description StartDatabricksMetricViewSyncInput */
|
|
6668
|
+
requestBody: {
|
|
6669
|
+
content: {
|
|
6670
|
+
"application/json": components["schemas"]["StartDatabricksMetricViewSyncInput"];
|
|
6671
|
+
};
|
|
6672
|
+
};
|
|
6673
|
+
responses: {
|
|
6674
|
+
202: {
|
|
6675
|
+
headers: {
|
|
6676
|
+
[name: string]: any;
|
|
6677
|
+
};
|
|
6678
|
+
content: {
|
|
6679
|
+
"application/json": components["schemas"]["DatabricksMetricViewSyncStartResponse"];
|
|
6680
|
+
};
|
|
6681
|
+
};
|
|
6682
|
+
};
|
|
6683
|
+
};
|
|
6684
|
+
"DatabricksMetricViewIntegrationPublicController.syncRun": {
|
|
6685
|
+
parameters: {
|
|
6686
|
+
query?: never;
|
|
6687
|
+
header?: never;
|
|
6688
|
+
path: {
|
|
6689
|
+
deploymentId: number;
|
|
6690
|
+
dataSourceName: string;
|
|
6691
|
+
runId: string;
|
|
6692
|
+
};
|
|
6693
|
+
cookie?: never;
|
|
6694
|
+
};
|
|
6695
|
+
requestBody?: never;
|
|
6696
|
+
responses: {
|
|
6697
|
+
200: {
|
|
6698
|
+
headers: {
|
|
6699
|
+
[name: string]: any;
|
|
6700
|
+
};
|
|
6701
|
+
content: {
|
|
6702
|
+
"application/json": components["schemas"]["DatabricksMetricViewSyncRunResponse"];
|
|
6703
|
+
};
|
|
6704
|
+
};
|
|
6705
|
+
};
|
|
6706
|
+
};
|
|
6707
|
+
"DatabricksMetricViewIntegrationPublicController.cancelSync": {
|
|
6708
|
+
parameters: {
|
|
6709
|
+
query?: never;
|
|
6710
|
+
header?: never;
|
|
6711
|
+
path: {
|
|
6712
|
+
deploymentId: number;
|
|
6713
|
+
dataSourceName: string;
|
|
6714
|
+
runId: string;
|
|
6715
|
+
};
|
|
6716
|
+
cookie?: never;
|
|
6717
|
+
};
|
|
6718
|
+
requestBody?: never;
|
|
6719
|
+
responses: {
|
|
6720
|
+
200: {
|
|
6721
|
+
headers: {
|
|
6722
|
+
[name: string]: any;
|
|
6723
|
+
};
|
|
6724
|
+
content: {
|
|
6725
|
+
"application/json": components["schemas"]["DatabricksMetricViewSyncRunResponse"];
|
|
6726
|
+
};
|
|
6727
|
+
};
|
|
6728
|
+
};
|
|
6729
|
+
};
|
|
6497
6730
|
"DatabricksMetricViewPublicationPublicController.startPreview": {
|
|
6498
6731
|
parameters: {
|
|
6499
6732
|
query?: never;
|