@cube-dev/platform-client 0.16.0 → 0.17.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 +16 -0
- package/dist/schema.d.ts +492 -16
- package/dist/schema.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -273,6 +273,23 @@ export interface paths {
|
|
|
273
273
|
patch?: never;
|
|
274
274
|
trace?: never;
|
|
275
275
|
};
|
|
276
|
+
"/api/v1/deployments/{deploymentId}/agent-suggestions": {
|
|
277
|
+
parameters: {
|
|
278
|
+
query?: never;
|
|
279
|
+
header?: never;
|
|
280
|
+
path?: never;
|
|
281
|
+
cookie?: never;
|
|
282
|
+
};
|
|
283
|
+
/** Get agent suggestions */
|
|
284
|
+
get: operations["AgentsPublicController.getAgentSuggestions"];
|
|
285
|
+
put?: never;
|
|
286
|
+
post?: never;
|
|
287
|
+
delete?: never;
|
|
288
|
+
options?: never;
|
|
289
|
+
head?: never;
|
|
290
|
+
patch?: never;
|
|
291
|
+
trace?: never;
|
|
292
|
+
};
|
|
276
293
|
"/api/v1/deployments/{deploymentId}/agents": {
|
|
277
294
|
parameters: {
|
|
278
295
|
query?: never;
|
|
@@ -1055,7 +1072,7 @@ export interface paths {
|
|
|
1055
1072
|
};
|
|
1056
1073
|
/**
|
|
1057
1074
|
* List report deliveries
|
|
1058
|
-
* @description In preview: ask Cube support to enable it. Newest first. Filter by `reportId`, `ownerUserId` or `
|
|
1075
|
+
* @description In preview: ask Cube support to enable it. Newest first. Filter by `reportId`, `ownerUserId`, `spreadsheet` or `status`. Admins see every delivery; others only their own.
|
|
1059
1076
|
*/
|
|
1060
1077
|
get: operations["ReportDeliveriesPublicController.getReportDeliveries"];
|
|
1061
1078
|
put?: never;
|
|
@@ -1084,7 +1101,7 @@ export interface paths {
|
|
|
1084
1101
|
get: operations["ReportDeliveriesPublicController.getReportDelivery"];
|
|
1085
1102
|
/**
|
|
1086
1103
|
* Update a report delivery
|
|
1087
|
-
* @description In preview: ask Cube support to enable it. Omitted fields stay unchanged; `destination` and `schedule` are replaced whole, and `schedule: null` removes it. A new `reportId` needs read access to that report.
|
|
1104
|
+
* @description In preview: ask Cube support to enable it. Omitted fields stay unchanged; `destination` and `schedule` are replaced whole, and `schedule: null` removes it. A new `reportId` needs read access to that report; `ownerUserId` transfers the delivery.
|
|
1088
1105
|
*/
|
|
1089
1106
|
put: operations["ReportDeliveriesPublicController.updateReportDelivery"];
|
|
1090
1107
|
post?: never;
|
|
@@ -1098,7 +1115,27 @@ export interface paths {
|
|
|
1098
1115
|
patch?: never;
|
|
1099
1116
|
trace?: never;
|
|
1100
1117
|
};
|
|
1101
|
-
"/api/v1/deployments/{deploymentId}/report-deliveries/{id}/
|
|
1118
|
+
"/api/v1/deployments/{deploymentId}/report-deliveries/{id}/pause": {
|
|
1119
|
+
parameters: {
|
|
1120
|
+
query?: never;
|
|
1121
|
+
header?: never;
|
|
1122
|
+
path?: never;
|
|
1123
|
+
cookie?: never;
|
|
1124
|
+
};
|
|
1125
|
+
get?: never;
|
|
1126
|
+
put?: never;
|
|
1127
|
+
/**
|
|
1128
|
+
* Pause a report delivery
|
|
1129
|
+
* @description In preview: ask Cube support to enable it. Its schedule stops firing until it is resumed; a run can still be started by hand. Pausing a paused delivery changes nothing.
|
|
1130
|
+
*/
|
|
1131
|
+
post: operations["ReportDeliveriesPublicController.pauseReportDelivery"];
|
|
1132
|
+
delete?: never;
|
|
1133
|
+
options?: never;
|
|
1134
|
+
head?: never;
|
|
1135
|
+
patch?: never;
|
|
1136
|
+
trace?: never;
|
|
1137
|
+
};
|
|
1138
|
+
"/api/v1/deployments/{deploymentId}/report-deliveries/{id}/resume": {
|
|
1102
1139
|
parameters: {
|
|
1103
1140
|
query?: never;
|
|
1104
1141
|
header?: never;
|
|
@@ -1107,6 +1144,30 @@ export interface paths {
|
|
|
1107
1144
|
};
|
|
1108
1145
|
get?: never;
|
|
1109
1146
|
put?: never;
|
|
1147
|
+
/**
|
|
1148
|
+
* Resume a paused report delivery
|
|
1149
|
+
* @description In preview: ask Cube support to enable it. Its schedule fires again from the next due time; the fires missed while paused are not run.
|
|
1150
|
+
*/
|
|
1151
|
+
post: operations["ReportDeliveriesPublicController.resumeReportDelivery"];
|
|
1152
|
+
delete?: never;
|
|
1153
|
+
options?: never;
|
|
1154
|
+
head?: never;
|
|
1155
|
+
patch?: never;
|
|
1156
|
+
trace?: never;
|
|
1157
|
+
};
|
|
1158
|
+
"/api/v1/deployments/{deploymentId}/report-deliveries/{id}/runs": {
|
|
1159
|
+
parameters: {
|
|
1160
|
+
query?: never;
|
|
1161
|
+
header?: never;
|
|
1162
|
+
path?: never;
|
|
1163
|
+
cookie?: never;
|
|
1164
|
+
};
|
|
1165
|
+
/**
|
|
1166
|
+
* List runs of a report delivery
|
|
1167
|
+
* @description In preview: ask Cube support to enable it. Newest first unless `sortDirection` says otherwise, a running one included. `404` if the caller cannot see the delivery. Admins see every delivery; others only their own.
|
|
1168
|
+
*/
|
|
1169
|
+
get: operations["ReportDeliveriesPublicController.getReportDeliveryRuns"];
|
|
1170
|
+
put?: never;
|
|
1110
1171
|
/**
|
|
1111
1172
|
* Run a report delivery now
|
|
1112
1173
|
* @description In preview: ask Cube support to enable it. Starts a run in the background and returns its id. The run writes the report’s current results into the destination, whether or not the delivery is paused. `409` while another run of it is still going.
|
|
@@ -1118,6 +1179,26 @@ export interface paths {
|
|
|
1118
1179
|
patch?: never;
|
|
1119
1180
|
trace?: never;
|
|
1120
1181
|
};
|
|
1182
|
+
"/api/v1/deployments/{deploymentId}/report-deliveries/{id}/runs/{runId}": {
|
|
1183
|
+
parameters: {
|
|
1184
|
+
query?: never;
|
|
1185
|
+
header?: never;
|
|
1186
|
+
path?: never;
|
|
1187
|
+
cookie?: never;
|
|
1188
|
+
};
|
|
1189
|
+
/**
|
|
1190
|
+
* Get a report delivery run
|
|
1191
|
+
* @description In preview: ask Cube support to enable it. Poll it after starting a run: `status` stays `running` until the run finishes.
|
|
1192
|
+
*/
|
|
1193
|
+
get: operations["ReportDeliveriesPublicController.getReportDeliveryRun"];
|
|
1194
|
+
put?: never;
|
|
1195
|
+
post?: never;
|
|
1196
|
+
delete?: never;
|
|
1197
|
+
options?: never;
|
|
1198
|
+
head?: never;
|
|
1199
|
+
patch?: never;
|
|
1200
|
+
trace?: never;
|
|
1201
|
+
};
|
|
1121
1202
|
"/api/v1/deployments/{deploymentId}/report-folders": {
|
|
1122
1203
|
parameters: {
|
|
1123
1204
|
query?: never;
|
|
@@ -1287,6 +1368,36 @@ export interface paths {
|
|
|
1287
1368
|
patch?: never;
|
|
1288
1369
|
trace?: never;
|
|
1289
1370
|
};
|
|
1371
|
+
"/api/v1/deployments/{deploymentId}/reports/{reportId}/file": {
|
|
1372
|
+
parameters: {
|
|
1373
|
+
query?: never;
|
|
1374
|
+
header?: never;
|
|
1375
|
+
path?: never;
|
|
1376
|
+
cookie?: never;
|
|
1377
|
+
};
|
|
1378
|
+
/**
|
|
1379
|
+
* Read a report definition as editable JSON text
|
|
1380
|
+
* @description Returns the report's definition as canonical JSON text (`content`) and its SHA-256 (`hash`): `name` plus the definition fields of `meta` (`sqlQuery`, `chartCategory`, chart specs, `pivotItems`, …). `vegaSpec` appears as a JSON object. Placements and run state are left out.
|
|
1381
|
+
*
|
|
1382
|
+
* Use it with `PATCH /reports/{reportId}/file` to change part of a report without resending it.
|
|
1383
|
+
*/
|
|
1384
|
+
get: operations["ReportsPublicController.getReportFile"];
|
|
1385
|
+
put?: never;
|
|
1386
|
+
post?: never;
|
|
1387
|
+
delete?: never;
|
|
1388
|
+
options?: never;
|
|
1389
|
+
head?: never;
|
|
1390
|
+
/**
|
|
1391
|
+
* Replace text in a report definition
|
|
1392
|
+
* @description Changes part of a report by exact-text replacement, so a small change (a column, a filter, one chart property) sends only that change instead of the whole report.
|
|
1393
|
+
*
|
|
1394
|
+
* Read `GET /reports/{reportId}/file` first and copy each `oldText` from its `content`, including whitespace. Without `replaceAll`, `oldText` must occur exactly once. Edits apply in order; if any one fails, nothing is saved. A field removed from the file is cleared; fields outside the file cannot be added.
|
|
1395
|
+
*
|
|
1396
|
+
* Returns the new `content` and `hash`. Pass `expectedHash` to get `409` instead of editing a report that changed since you read it. Requires **edit** access to the report.
|
|
1397
|
+
*/
|
|
1398
|
+
patch: operations["ReportsPublicController.replaceReportFileText"];
|
|
1399
|
+
trace?: never;
|
|
1400
|
+
};
|
|
1290
1401
|
"/api/v1/deployments/{deploymentId}/reports/{reportId}/refresh": {
|
|
1291
1402
|
parameters: {
|
|
1292
1403
|
query?: never;
|
|
@@ -1319,7 +1430,7 @@ export interface paths {
|
|
|
1319
1430
|
put?: never;
|
|
1320
1431
|
/**
|
|
1321
1432
|
* Create a scheduled task
|
|
1322
|
-
* @description Saves a prompt
|
|
1433
|
+
* @description Saves a prompt the agent runs as the caller on `cronExpression` in `timezone`, or on demand. Needs `ScheduledTasksCreate` (`403` otherwise). A cron fires at most hourly (`400` otherwise), and a user can have 20 active tasks (`409` past that).
|
|
1323
1434
|
*/
|
|
1324
1435
|
post: operations["ScheduledTasksPublicController.createScheduledTask"];
|
|
1325
1436
|
delete?: never;
|
|
@@ -1704,6 +1815,36 @@ export interface paths {
|
|
|
1704
1815
|
patch?: never;
|
|
1705
1816
|
trace?: never;
|
|
1706
1817
|
};
|
|
1818
|
+
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/file": {
|
|
1819
|
+
parameters: {
|
|
1820
|
+
query?: never;
|
|
1821
|
+
header?: never;
|
|
1822
|
+
path?: never;
|
|
1823
|
+
cookie?: never;
|
|
1824
|
+
};
|
|
1825
|
+
/**
|
|
1826
|
+
* Read the dashboard draft as editable JSON text
|
|
1827
|
+
* @description Returns the workbook's classic dashboard draft as canonical JSON text (`content`) and its SHA-256 (`hash`).
|
|
1828
|
+
*
|
|
1829
|
+
* Use it with `PATCH /workbooks/{workbookId}/dashboard/file` to change part of the dashboard without resending the whole configuration. Returns `400` for a workbook whose dashboard is a Dashboard App.
|
|
1830
|
+
*/
|
|
1831
|
+
get: operations["WorkbooksPublicController.getWorkbookDashboardFile"];
|
|
1832
|
+
put?: never;
|
|
1833
|
+
post?: never;
|
|
1834
|
+
delete?: never;
|
|
1835
|
+
options?: never;
|
|
1836
|
+
head?: never;
|
|
1837
|
+
/**
|
|
1838
|
+
* Replace text in the dashboard draft
|
|
1839
|
+
* @description Changes part of the classic dashboard draft by exact-text replacement, so a small change sends only that change instead of the whole configuration.
|
|
1840
|
+
*
|
|
1841
|
+
* Read `GET /workbooks/{workbookId}/dashboard/file` first and copy each `oldText` from its `content`, including whitespace. Without `replaceAll`, `oldText` must occur exactly once. Edits apply in order; if any one fails, nothing is saved. The result is validated like `PUT /workbooks/{workbookId}/dashboard`.
|
|
1842
|
+
*
|
|
1843
|
+
* Returns the new `content` and `hash`. Pass `expectedHash` to get `409` instead of editing a draft that changed since you read it. Requires **manage** access to the workbook.
|
|
1844
|
+
*/
|
|
1845
|
+
patch: operations["WorkbooksPublicController.replaceWorkbookDashboardFileText"];
|
|
1846
|
+
trace?: never;
|
|
1847
|
+
};
|
|
1707
1848
|
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/duplicate": {
|
|
1708
1849
|
parameters: {
|
|
1709
1850
|
query?: never;
|
|
@@ -3621,6 +3762,10 @@ export interface components {
|
|
|
3621
3762
|
scopeDeploymentId?: number | null;
|
|
3622
3763
|
spaceConfigName?: string | null;
|
|
3623
3764
|
};
|
|
3765
|
+
AgentSuggestionsListResponse: {
|
|
3766
|
+
items: string[];
|
|
3767
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3768
|
+
};
|
|
3624
3769
|
ApiKeyCreatedResponse: {
|
|
3625
3770
|
allowedEndpoints?: string[] | null;
|
|
3626
3771
|
createdAt: string;
|
|
@@ -3808,7 +3953,7 @@ export interface components {
|
|
|
3808
3953
|
/** @enum {string} */
|
|
3809
3954
|
BulkUserActionResponseAction: "DEACTIVATE" | "ACTIVATE" | "DELETE";
|
|
3810
3955
|
ChatThreadPolicy: {
|
|
3811
|
-
actions: ("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")[];
|
|
3956
|
+
actions: ("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" | "ScheduledTasksCreate" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
|
|
3812
3957
|
effect?: components["schemas"]["ChatThreadPolicyEffect"] | null;
|
|
3813
3958
|
resourceType: components["schemas"]["ChatThreadPolicyResourceType"];
|
|
3814
3959
|
resources: string[];
|
|
@@ -3964,16 +4109,23 @@ export interface components {
|
|
|
3964
4109
|
isEnabled?: boolean | null;
|
|
3965
4110
|
name?: string | null;
|
|
3966
4111
|
subFormat?: string | null;
|
|
4112
|
+
subjectType?: components["schemas"]["CreateOidcTokenConfigInputSubjectType"] | null;
|
|
3967
4113
|
targetEnvVar?: string | null;
|
|
3968
4114
|
};
|
|
4115
|
+
/** @enum {string} */
|
|
4116
|
+
CreateOidcTokenConfigInputSubjectType: "deployment" | "user";
|
|
3969
4117
|
CreateReportDeliveryInput: {
|
|
3970
4118
|
destination: components["schemas"]["ReportDeliveryDestinationInput"];
|
|
3971
4119
|
name: string;
|
|
4120
|
+
notifications?: components["schemas"]["ReportDeliveryNotificationsInput"] | null;
|
|
3972
4121
|
/** @description Id of the report whose results are delivered. It must belong to this deployment, and the caller must be able to read it. */
|
|
3973
4122
|
reportId: number;
|
|
3974
4123
|
schedule?: components["schemas"]["ReportDeliveryScheduleInput"] | null;
|
|
3975
4124
|
shape?: components["schemas"]["ReportDeliveryShapeInput"] | null;
|
|
4125
|
+
writeMode?: components["schemas"]["CreateReportDeliveryInputWriteMode"] | null;
|
|
3976
4126
|
};
|
|
4127
|
+
/** @enum {string} */
|
|
4128
|
+
CreateReportDeliveryInputWriteMode: "overwrite" | "append" | "new_sheet";
|
|
3977
4129
|
CreateReportInput: {
|
|
3978
4130
|
endResultCell?: string | null;
|
|
3979
4131
|
externalWorkbookId?: string | null;
|
|
@@ -4005,6 +4157,7 @@ export interface components {
|
|
|
4005
4157
|
description?: string | null;
|
|
4006
4158
|
isEnabled?: boolean | null;
|
|
4007
4159
|
name: string;
|
|
4160
|
+
notificationEnabled?: boolean | null;
|
|
4008
4161
|
/** @description What the agent is asked on every run, shown as the task's Instructions in Cube. Each run starts a new chat thread with no memory of earlier ones, so write the whole request. */
|
|
4009
4162
|
prompt: string;
|
|
4010
4163
|
timezone?: string | null;
|
|
@@ -4016,6 +4169,15 @@ export interface components {
|
|
|
4016
4169
|
} | null;
|
|
4017
4170
|
name?: string | null;
|
|
4018
4171
|
};
|
|
4172
|
+
CreatedDeploymentEnvironmentToken: {
|
|
4173
|
+
created_at: string;
|
|
4174
|
+
expires_at: string;
|
|
4175
|
+
scopes: string[];
|
|
4176
|
+
security_context: {
|
|
4177
|
+
[key: string]: any;
|
|
4178
|
+
};
|
|
4179
|
+
token: string;
|
|
4180
|
+
};
|
|
4019
4181
|
/** @enum {string} */
|
|
4020
4182
|
CreationStep: "project" | "upload" | "schema" | "github" | "ssh" | "databases" | "ready" | "demo";
|
|
4021
4183
|
CreatorMode: {
|
|
@@ -4768,7 +4930,7 @@ export interface components {
|
|
|
4768
4930
|
token: string;
|
|
4769
4931
|
};
|
|
4770
4932
|
DeploymentEnvironmentTokenResponse: {
|
|
4771
|
-
data: components["schemas"]["
|
|
4933
|
+
data: components["schemas"]["CreatedDeploymentEnvironmentToken"];
|
|
4772
4934
|
};
|
|
4773
4935
|
DeploymentEnvironmentTokensListResponse: {
|
|
4774
4936
|
/**
|
|
@@ -5214,6 +5376,10 @@ export interface components {
|
|
|
5214
5376
|
/** @enum {string} */
|
|
5215
5377
|
GetDeploymentEnvironmentsQueryType: "production" | "staging" | "development";
|
|
5216
5378
|
/** @enum {string} */
|
|
5379
|
+
GetReportDeliveriesQueryStatus: "active" | "failing" | "needs_reconnect" | "orphaned";
|
|
5380
|
+
/** @enum {string} */
|
|
5381
|
+
GetReportDeliveryRunsQuerySortDirection: "ASC" | "DESC";
|
|
5382
|
+
/** @enum {string} */
|
|
5217
5383
|
GetReportsQuerySortBy: "name" | "createdAt" | "updatedAt" | "lastViewedAt";
|
|
5218
5384
|
/** @enum {string} */
|
|
5219
5385
|
GetReportsQuerySortDirection: "ASC" | "DESC";
|
|
@@ -5284,7 +5450,7 @@ export interface components {
|
|
|
5284
5450
|
userCount?: number | null;
|
|
5285
5451
|
};
|
|
5286
5452
|
/** @enum {string} */
|
|
5287
|
-
InheritedGroupPolicyDtoAction: "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";
|
|
5453
|
+
InheritedGroupPolicyDtoAction: "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" | "ScheduledTasksCreate" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
5288
5454
|
InheritedUserPolicyDto: {
|
|
5289
5455
|
action: components["schemas"]["InheritedUserPolicyDtoAction"];
|
|
5290
5456
|
email?: string | null;
|
|
@@ -5294,7 +5460,13 @@ export interface components {
|
|
|
5294
5460
|
userId?: number | null;
|
|
5295
5461
|
};
|
|
5296
5462
|
/** @enum {string} */
|
|
5297
|
-
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";
|
|
5463
|
+
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" | "ScheduledTasksCreate" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
5464
|
+
JsonConfigFileDto: {
|
|
5465
|
+
/** @description The configuration as canonical JSON text: keys sorted, 2-space indentation, trailing newline. `oldText` in a replacement must match this text exactly. */
|
|
5466
|
+
content: string;
|
|
5467
|
+
/** @description SHA-256 of `content`. Send it back as `expectedHash` to reject the write if the configuration changed since you read it. */
|
|
5468
|
+
hash: string;
|
|
5469
|
+
};
|
|
5298
5470
|
/** @enum {string} */
|
|
5299
5471
|
ListDatabricksMetricViewSyncsQueryStatus: "QUEUED" | "RUNNING" | "CANCELLING" | "COMPLETED" | "PARTIAL" | "FAILED" | "CANCELLED";
|
|
5300
5472
|
LocalEncryptedSecret: {
|
|
@@ -5424,9 +5596,12 @@ export interface components {
|
|
|
5424
5596
|
isEnabled: boolean;
|
|
5425
5597
|
name: string;
|
|
5426
5598
|
subFormat?: string | null;
|
|
5599
|
+
subjectType: components["schemas"]["OidcTokenConfigDTOSubjectType"];
|
|
5427
5600
|
targetEnvVar?: string | null;
|
|
5428
5601
|
updatedAt: string;
|
|
5429
5602
|
};
|
|
5603
|
+
/** @enum {string} */
|
|
5604
|
+
OidcTokenConfigDTOSubjectType: "deployment" | "user";
|
|
5430
5605
|
PageInfo: {
|
|
5431
5606
|
endCursor?: string | null;
|
|
5432
5607
|
hasNextPage: boolean;
|
|
@@ -5480,7 +5655,7 @@ export interface components {
|
|
|
5480
5655
|
/** @enum {string} */
|
|
5481
5656
|
PivotItemsMeasuresPosition: "before" | "after";
|
|
5482
5657
|
Policy: {
|
|
5483
|
-
actions: ("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")[];
|
|
5658
|
+
actions: ("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" | "ScheduledTasksCreate" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
|
|
5484
5659
|
resourceType: components["schemas"]["PolicyResourceType"];
|
|
5485
5660
|
resources: string[];
|
|
5486
5661
|
};
|
|
@@ -5686,6 +5861,11 @@ export interface components {
|
|
|
5686
5861
|
branchName?: string;
|
|
5687
5862
|
files: components["schemas"]["DataModelFileRename"][];
|
|
5688
5863
|
};
|
|
5864
|
+
ReplaceJsonConfigTextInput: {
|
|
5865
|
+
/** @description Replacements applied in order, each to the result of the previous one. Either all apply or nothing is saved. */
|
|
5866
|
+
edits: components["schemas"]["TextReplacementInput"][];
|
|
5867
|
+
expectedHash?: string | null;
|
|
5868
|
+
};
|
|
5689
5869
|
Report: {
|
|
5690
5870
|
canEdit?: boolean | null;
|
|
5691
5871
|
canManage?: boolean | null;
|
|
@@ -5751,28 +5931,81 @@ export interface components {
|
|
|
5751
5931
|
/** @description The Google Sheets spreadsheet: its URL or its id. */
|
|
5752
5932
|
spreadsheet: string;
|
|
5753
5933
|
};
|
|
5934
|
+
ReportDeliveryNotificationSettings: {
|
|
5935
|
+
email: boolean;
|
|
5936
|
+
inbox: boolean;
|
|
5937
|
+
slackChannelId?: string | null;
|
|
5938
|
+
slackChannelName?: string | null;
|
|
5939
|
+
};
|
|
5940
|
+
ReportDeliveryNotificationsInput: {
|
|
5941
|
+
/** @description Email the owner's Cube address. */
|
|
5942
|
+
email: boolean;
|
|
5943
|
+
/** @description Notify in the owner's Cube inbox. */
|
|
5944
|
+
inbox: boolean;
|
|
5945
|
+
slackChannelId?: string | null;
|
|
5946
|
+
slackChannelName?: string | null;
|
|
5947
|
+
};
|
|
5754
5948
|
ReportDeliveryResponse: {
|
|
5755
5949
|
deploymentId: number;
|
|
5756
5950
|
destination: components["schemas"]["ReportDeliveryDestination"];
|
|
5757
5951
|
id: number;
|
|
5952
|
+
lastRunAt?: string | null;
|
|
5953
|
+
lastSuccessAt?: string | null;
|
|
5758
5954
|
name: string;
|
|
5759
5955
|
nextRunAt?: any | null;
|
|
5956
|
+
/** @description How the owner hears that the delivery failed or recovered. A delivery that runs more than once a day reports only changes in its status; a daily or rarer one reports every failed run. */
|
|
5957
|
+
notifications: components["schemas"]["ReportDeliveryNotificationSettings"];
|
|
5760
5958
|
ownerUserId?: number | null;
|
|
5761
5959
|
pausedAt?: any | null;
|
|
5762
5960
|
reportId?: number | null;
|
|
5961
|
+
reportName?: string | null;
|
|
5962
|
+
reportPublicId?: string | null;
|
|
5963
|
+
reportWorkbookId?: number | null;
|
|
5763
5964
|
runAsUserId?: number | null;
|
|
5965
|
+
runningSince?: string | null;
|
|
5764
5966
|
schedule?: components["schemas"]["ReportDeliverySchedule"] | null;
|
|
5765
5967
|
shape?: components["schemas"]["ReportDeliveryShape"] | null;
|
|
5968
|
+
sheetTitle?: string | null;
|
|
5969
|
+
spreadsheetTitle?: string | null;
|
|
5766
5970
|
status: components["schemas"]["ReportDeliveryResponseStatus"];
|
|
5971
|
+
writeMode: components["schemas"]["ReportDeliveryResponseWriteMode"];
|
|
5767
5972
|
};
|
|
5768
5973
|
/** @enum {string} */
|
|
5769
5974
|
ReportDeliveryResponseStatus: "active" | "failing" | "needs_reconnect" | "orphaned";
|
|
5975
|
+
/** @enum {string} */
|
|
5976
|
+
ReportDeliveryResponseWriteMode: "overwrite" | "append" | "new_sheet";
|
|
5977
|
+
ReportDeliveryRunFailure: {
|
|
5978
|
+
/** @description Why the run failed, e.g. `collision`, `shape-changed`, `query-failed` or `reconnect`. */
|
|
5979
|
+
code: string;
|
|
5980
|
+
/** @description A sentence for a person to read; never raw Google or warehouse output. */
|
|
5981
|
+
text: string;
|
|
5982
|
+
};
|
|
5983
|
+
ReportDeliveryRunResponse: {
|
|
5984
|
+
cellsWritten?: number | null;
|
|
5985
|
+
deliveryId: number;
|
|
5986
|
+
error?: components["schemas"]["ReportDeliveryRunFailure"] | null;
|
|
5987
|
+
finishedAt?: string | null;
|
|
5988
|
+
id: number;
|
|
5989
|
+
rowsWritten?: number | null;
|
|
5990
|
+
/** Format: date-time */
|
|
5991
|
+
startedAt: string;
|
|
5992
|
+
status: components["schemas"]["ReportDeliveryRunResponseStatus"];
|
|
5993
|
+
trigger: components["schemas"]["ReportDeliveryRunResponseTrigger"];
|
|
5994
|
+
};
|
|
5995
|
+
/** @enum {string} */
|
|
5996
|
+
ReportDeliveryRunResponseStatus: "running" | "succeeded" | "unchanged" | "failed" | "skipped" | "missed";
|
|
5997
|
+
/** @enum {string} */
|
|
5998
|
+
ReportDeliveryRunResponseTrigger: "manual" | "schedule";
|
|
5999
|
+
ReportDeliveryRunsListResponse: {
|
|
6000
|
+
items: components["schemas"]["ReportDeliveryRunResponse"][];
|
|
6001
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
6002
|
+
};
|
|
5770
6003
|
ReportDeliverySchedule: {
|
|
5771
6004
|
cronExpressions: string[];
|
|
5772
6005
|
timezone: string;
|
|
5773
6006
|
};
|
|
5774
6007
|
ReportDeliveryScheduleInput: {
|
|
5775
|
-
/** @description Five-field cron expressions; the delivery runs whenever any matches.
|
|
6008
|
+
/** @description Five-field cron expressions; the delivery runs whenever any matches. Runs of one expression must be at least 15 minutes apart: `*\/15 9-17 * * 1-5` is every quarter hour from 09:00 to 17:45 on weekdays. */
|
|
5776
6009
|
cronExpressions: string[];
|
|
5777
6010
|
timezone?: string | null;
|
|
5778
6011
|
};
|
|
@@ -5889,7 +6122,7 @@ export interface components {
|
|
|
5889
6122
|
userCount?: number | null;
|
|
5890
6123
|
};
|
|
5891
6124
|
/** @enum {string} */
|
|
5892
|
-
ResourceGroupPolicyDtoAction: "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";
|
|
6125
|
+
ResourceGroupPolicyDtoAction: "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" | "ScheduledTasksCreate" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
5893
6126
|
ResourceOwner: {
|
|
5894
6127
|
email: string;
|
|
5895
6128
|
firstName?: string | null;
|
|
@@ -5910,13 +6143,13 @@ export interface components {
|
|
|
5910
6143
|
userId?: number | null;
|
|
5911
6144
|
};
|
|
5912
6145
|
/** @enum {string} */
|
|
5913
|
-
ResourceUserPolicyDtoAction: "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";
|
|
6146
|
+
ResourceUserPolicyDtoAction: "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" | "ScheduledTasksCreate" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
5914
6147
|
RevokeEmbedSessionInput: {
|
|
5915
6148
|
/** @description The session id returned by `POST /api/v1/embed/generate-session`. Works whether or not the session has already been exchanged for a token. */
|
|
5916
6149
|
sessionId: string;
|
|
5917
6150
|
};
|
|
5918
6151
|
RoleWithAccess: {
|
|
5919
|
-
actions: ("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")[];
|
|
6152
|
+
actions: ("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" | "ScheduledTasksCreate" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
|
|
5920
6153
|
id: number;
|
|
5921
6154
|
name: string;
|
|
5922
6155
|
};
|
|
@@ -5959,6 +6192,8 @@ export interface components {
|
|
|
5959
6192
|
isEnabled: boolean;
|
|
5960
6193
|
name: string;
|
|
5961
6194
|
nextRunAt?: string | null;
|
|
6195
|
+
/** @description Whether a finished run notifies the creator in Cube's notification inbox. */
|
|
6196
|
+
notificationEnabled: boolean;
|
|
5962
6197
|
/** @description What the agent is asked on every run, shown as the task's Instructions in Cube. Each run starts a new chat thread, so the prompt has to stand on its own. */
|
|
5963
6198
|
prompt: string;
|
|
5964
6199
|
/** @description IANA time zone the cron is read in, e.g. `America/New_York`. Defaults to `UTC`. */
|
|
@@ -6086,7 +6321,7 @@ export interface components {
|
|
|
6086
6321
|
questionFile?: string | null;
|
|
6087
6322
|
};
|
|
6088
6323
|
StartReportDeliveryRunResponse: {
|
|
6089
|
-
/** @description Id of the run, which writes the sheet in the background. */
|
|
6324
|
+
/** @description Id of the run, which writes the sheet in the background; poll it for the outcome. */
|
|
6090
6325
|
runId: number;
|
|
6091
6326
|
};
|
|
6092
6327
|
StartSnowflakeSemanticViewPullInput: {
|
|
@@ -6142,6 +6377,13 @@ export interface components {
|
|
|
6142
6377
|
configurationVersion: number;
|
|
6143
6378
|
previewId?: string | null;
|
|
6144
6379
|
};
|
|
6380
|
+
TextReplacementInput: {
|
|
6381
|
+
/** @description Text to put in place of `oldText`. */
|
|
6382
|
+
newText: string;
|
|
6383
|
+
/** @description Exact text to replace, copied from `content`, including whitespace. Must occur exactly once unless `replaceAll` is set. */
|
|
6384
|
+
oldText: string;
|
|
6385
|
+
replaceAll?: boolean | null;
|
|
6386
|
+
};
|
|
6145
6387
|
ThemeFont: {
|
|
6146
6388
|
family?: string | null;
|
|
6147
6389
|
format: string;
|
|
@@ -6265,12 +6507,18 @@ export interface components {
|
|
|
6265
6507
|
UpdateReportDeliveryInput: {
|
|
6266
6508
|
destination?: components["schemas"]["ReportDeliveryDestinationInput"] | null;
|
|
6267
6509
|
name?: string | null;
|
|
6510
|
+
notifications?: components["schemas"]["ReportDeliveryNotificationsInput"] | null;
|
|
6511
|
+
ownerUserId?: number | null;
|
|
6268
6512
|
reportId?: number | null;
|
|
6269
6513
|
schedule?: components["schemas"]["ReportDeliveryScheduleInput"] | null;
|
|
6270
6514
|
shape?: components["schemas"]["ReportDeliveryShapeInput"] | null;
|
|
6515
|
+
writeMode?: components["schemas"]["UpdateReportDeliveryInputWriteMode"] | null;
|
|
6271
6516
|
};
|
|
6517
|
+
/** @enum {string} */
|
|
6518
|
+
UpdateReportDeliveryInputWriteMode: "overwrite" | "append" | "new_sheet";
|
|
6272
6519
|
UpdateReportInput: {
|
|
6273
6520
|
endResultCell?: string | null;
|
|
6521
|
+
expectedVersion?: number | null;
|
|
6274
6522
|
externalWorkbookId?: string | null;
|
|
6275
6523
|
folderId?: number | null;
|
|
6276
6524
|
host?: components["schemas"]["UpdateReportInputHost"] | null;
|
|
@@ -6299,7 +6547,7 @@ export interface components {
|
|
|
6299
6547
|
resourceType: components["schemas"]["UpdateResourceGroupPolicyBodyResourceType"];
|
|
6300
6548
|
};
|
|
6301
6549
|
/** @enum {string} */
|
|
6302
|
-
UpdateResourceGroupPolicyBodyAction: "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";
|
|
6550
|
+
UpdateResourceGroupPolicyBodyAction: "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" | "ScheduledTasksCreate" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
6303
6551
|
/** @enum {string} */
|
|
6304
6552
|
UpdateResourceGroupPolicyBodyResourceType: "Global" | "Deployment" | "Report" | "ReportFolder" | "Agent" | "AgentSpace" | "Workbook" | "Dashboard" | "Folder" | "ChatThread";
|
|
6305
6553
|
UpdateResourceUserPolicyBody: {
|
|
@@ -6309,7 +6557,7 @@ export interface components {
|
|
|
6309
6557
|
userId?: number | null;
|
|
6310
6558
|
};
|
|
6311
6559
|
/** @enum {string} */
|
|
6312
|
-
UpdateResourceUserPolicyBodyAction: "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";
|
|
6560
|
+
UpdateResourceUserPolicyBodyAction: "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" | "ScheduledTasksCreate" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
6313
6561
|
/** @enum {string} */
|
|
6314
6562
|
UpdateResourceUserPolicyBodyResourceType: "Global" | "Deployment" | "Report" | "ReportFolder" | "Agent" | "AgentSpace" | "Workbook" | "Dashboard" | "Folder" | "ChatThread";
|
|
6315
6563
|
UpdateScheduledTaskInput: {
|
|
@@ -6318,6 +6566,7 @@ export interface components {
|
|
|
6318
6566
|
description?: string | null;
|
|
6319
6567
|
isEnabled?: boolean | null;
|
|
6320
6568
|
name?: string | null;
|
|
6569
|
+
notificationEnabled?: boolean | null;
|
|
6321
6570
|
prompt?: string | null;
|
|
6322
6571
|
timezone?: string | null;
|
|
6323
6572
|
};
|
|
@@ -7288,6 +7537,32 @@ export interface operations {
|
|
|
7288
7537
|
};
|
|
7289
7538
|
};
|
|
7290
7539
|
};
|
|
7540
|
+
"AgentsPublicController.getAgentSuggestions": {
|
|
7541
|
+
parameters: {
|
|
7542
|
+
query?: {
|
|
7543
|
+
agent?: string | null;
|
|
7544
|
+
branchName?: string | null;
|
|
7545
|
+
after?: string;
|
|
7546
|
+
first?: number;
|
|
7547
|
+
};
|
|
7548
|
+
header?: never;
|
|
7549
|
+
path: {
|
|
7550
|
+
deploymentId: number;
|
|
7551
|
+
};
|
|
7552
|
+
cookie?: never;
|
|
7553
|
+
};
|
|
7554
|
+
requestBody?: never;
|
|
7555
|
+
responses: {
|
|
7556
|
+
200: {
|
|
7557
|
+
headers: {
|
|
7558
|
+
[name: string]: any;
|
|
7559
|
+
};
|
|
7560
|
+
content: {
|
|
7561
|
+
"application/json": components["schemas"]["AgentSuggestionsListResponse"];
|
|
7562
|
+
};
|
|
7563
|
+
};
|
|
7564
|
+
};
|
|
7565
|
+
};
|
|
7291
7566
|
"AgentsPublicController.getAgents": {
|
|
7292
7567
|
parameters: {
|
|
7293
7568
|
query?: {
|
|
@@ -8567,6 +8842,7 @@ export interface operations {
|
|
|
8567
8842
|
reportId?: number | null;
|
|
8568
8843
|
ownerUserId?: number | null;
|
|
8569
8844
|
spreadsheet?: string | null;
|
|
8845
|
+
status?: components["schemas"]["GetReportDeliveriesQueryStatus"] | null;
|
|
8570
8846
|
after?: string;
|
|
8571
8847
|
first?: number;
|
|
8572
8848
|
};
|
|
@@ -8701,6 +8977,82 @@ export interface operations {
|
|
|
8701
8977
|
};
|
|
8702
8978
|
};
|
|
8703
8979
|
};
|
|
8980
|
+
"ReportDeliveriesPublicController.pauseReportDelivery": {
|
|
8981
|
+
parameters: {
|
|
8982
|
+
query?: never;
|
|
8983
|
+
header?: never;
|
|
8984
|
+
path: {
|
|
8985
|
+
/** @description Numeric id of the deployment that owns the delivery. */
|
|
8986
|
+
deploymentId: number;
|
|
8987
|
+
/** @description Numeric id of the report delivery. */
|
|
8988
|
+
id: number;
|
|
8989
|
+
};
|
|
8990
|
+
cookie?: never;
|
|
8991
|
+
};
|
|
8992
|
+
requestBody?: never;
|
|
8993
|
+
responses: {
|
|
8994
|
+
200: {
|
|
8995
|
+
headers: {
|
|
8996
|
+
[name: string]: any;
|
|
8997
|
+
};
|
|
8998
|
+
content: {
|
|
8999
|
+
"application/json": components["schemas"]["ReportDeliveryResponse"];
|
|
9000
|
+
};
|
|
9001
|
+
};
|
|
9002
|
+
};
|
|
9003
|
+
};
|
|
9004
|
+
"ReportDeliveriesPublicController.resumeReportDelivery": {
|
|
9005
|
+
parameters: {
|
|
9006
|
+
query?: never;
|
|
9007
|
+
header?: never;
|
|
9008
|
+
path: {
|
|
9009
|
+
/** @description Numeric id of the deployment that owns the delivery. */
|
|
9010
|
+
deploymentId: number;
|
|
9011
|
+
/** @description Numeric id of the report delivery. */
|
|
9012
|
+
id: number;
|
|
9013
|
+
};
|
|
9014
|
+
cookie?: never;
|
|
9015
|
+
};
|
|
9016
|
+
requestBody?: never;
|
|
9017
|
+
responses: {
|
|
9018
|
+
200: {
|
|
9019
|
+
headers: {
|
|
9020
|
+
[name: string]: any;
|
|
9021
|
+
};
|
|
9022
|
+
content: {
|
|
9023
|
+
"application/json": components["schemas"]["ReportDeliveryResponse"];
|
|
9024
|
+
};
|
|
9025
|
+
};
|
|
9026
|
+
};
|
|
9027
|
+
};
|
|
9028
|
+
"ReportDeliveriesPublicController.getReportDeliveryRuns": {
|
|
9029
|
+
parameters: {
|
|
9030
|
+
query?: {
|
|
9031
|
+
sortDirection?: components["schemas"]["GetReportDeliveryRunsQuerySortDirection"] | null;
|
|
9032
|
+
after?: string;
|
|
9033
|
+
first?: number;
|
|
9034
|
+
};
|
|
9035
|
+
header?: never;
|
|
9036
|
+
path: {
|
|
9037
|
+
/** @description Numeric id of the deployment that owns the delivery. */
|
|
9038
|
+
deploymentId: number;
|
|
9039
|
+
/** @description Numeric id of the report delivery. */
|
|
9040
|
+
id: number;
|
|
9041
|
+
};
|
|
9042
|
+
cookie?: never;
|
|
9043
|
+
};
|
|
9044
|
+
requestBody?: never;
|
|
9045
|
+
responses: {
|
|
9046
|
+
200: {
|
|
9047
|
+
headers: {
|
|
9048
|
+
[name: string]: any;
|
|
9049
|
+
};
|
|
9050
|
+
content: {
|
|
9051
|
+
"application/json": components["schemas"]["ReportDeliveryRunsListResponse"];
|
|
9052
|
+
};
|
|
9053
|
+
};
|
|
9054
|
+
};
|
|
9055
|
+
};
|
|
8704
9056
|
"ReportDeliveriesPublicController.startReportDeliveryRun": {
|
|
8705
9057
|
parameters: {
|
|
8706
9058
|
query?: never;
|
|
@@ -8725,6 +9077,32 @@ export interface operations {
|
|
|
8725
9077
|
};
|
|
8726
9078
|
};
|
|
8727
9079
|
};
|
|
9080
|
+
"ReportDeliveriesPublicController.getReportDeliveryRun": {
|
|
9081
|
+
parameters: {
|
|
9082
|
+
query?: never;
|
|
9083
|
+
header?: never;
|
|
9084
|
+
path: {
|
|
9085
|
+
/** @description Numeric id of the deployment that owns the delivery. */
|
|
9086
|
+
deploymentId: number;
|
|
9087
|
+
/** @description Numeric id of the report delivery. */
|
|
9088
|
+
id: number;
|
|
9089
|
+
/** @description Numeric id of the run, as returned when it was started. */
|
|
9090
|
+
runId: number;
|
|
9091
|
+
};
|
|
9092
|
+
cookie?: never;
|
|
9093
|
+
};
|
|
9094
|
+
requestBody?: never;
|
|
9095
|
+
responses: {
|
|
9096
|
+
200: {
|
|
9097
|
+
headers: {
|
|
9098
|
+
[name: string]: any;
|
|
9099
|
+
};
|
|
9100
|
+
content: {
|
|
9101
|
+
"application/json": components["schemas"]["ReportDeliveryRunResponse"];
|
|
9102
|
+
};
|
|
9103
|
+
};
|
|
9104
|
+
};
|
|
9105
|
+
};
|
|
8728
9106
|
"ReportsPublicController.getReportFolders": {
|
|
8729
9107
|
parameters: {
|
|
8730
9108
|
query?: {
|
|
@@ -8960,6 +9338,55 @@ export interface operations {
|
|
|
8960
9338
|
};
|
|
8961
9339
|
};
|
|
8962
9340
|
};
|
|
9341
|
+
"ReportsPublicController.getReportFile": {
|
|
9342
|
+
parameters: {
|
|
9343
|
+
query?: never;
|
|
9344
|
+
header?: never;
|
|
9345
|
+
path: {
|
|
9346
|
+
deploymentId: number;
|
|
9347
|
+
reportId: number;
|
|
9348
|
+
};
|
|
9349
|
+
cookie?: never;
|
|
9350
|
+
};
|
|
9351
|
+
requestBody?: never;
|
|
9352
|
+
responses: {
|
|
9353
|
+
200: {
|
|
9354
|
+
headers: {
|
|
9355
|
+
[name: string]: any;
|
|
9356
|
+
};
|
|
9357
|
+
content: {
|
|
9358
|
+
"application/json": components["schemas"]["JsonConfigFileDto"];
|
|
9359
|
+
};
|
|
9360
|
+
};
|
|
9361
|
+
};
|
|
9362
|
+
};
|
|
9363
|
+
"ReportsPublicController.replaceReportFileText": {
|
|
9364
|
+
parameters: {
|
|
9365
|
+
query?: never;
|
|
9366
|
+
header?: never;
|
|
9367
|
+
path: {
|
|
9368
|
+
deploymentId: number;
|
|
9369
|
+
reportId: number;
|
|
9370
|
+
};
|
|
9371
|
+
cookie?: never;
|
|
9372
|
+
};
|
|
9373
|
+
/** @description ReplaceJsonConfigTextInput */
|
|
9374
|
+
requestBody?: {
|
|
9375
|
+
content: {
|
|
9376
|
+
"application/json": components["schemas"]["ReplaceJsonConfigTextInput"];
|
|
9377
|
+
};
|
|
9378
|
+
};
|
|
9379
|
+
responses: {
|
|
9380
|
+
200: {
|
|
9381
|
+
headers: {
|
|
9382
|
+
[name: string]: any;
|
|
9383
|
+
};
|
|
9384
|
+
content: {
|
|
9385
|
+
"application/json": components["schemas"]["JsonConfigFileDto"];
|
|
9386
|
+
};
|
|
9387
|
+
};
|
|
9388
|
+
};
|
|
9389
|
+
};
|
|
8963
9390
|
"ReportsPublicController.refreshReport": {
|
|
8964
9391
|
parameters: {
|
|
8965
9392
|
query?: never;
|
|
@@ -9601,6 +10028,55 @@ export interface operations {
|
|
|
9601
10028
|
};
|
|
9602
10029
|
};
|
|
9603
10030
|
};
|
|
10031
|
+
"WorkbooksPublicController.getWorkbookDashboardFile": {
|
|
10032
|
+
parameters: {
|
|
10033
|
+
query?: never;
|
|
10034
|
+
header?: never;
|
|
10035
|
+
path: {
|
|
10036
|
+
deploymentId: number;
|
|
10037
|
+
workbookId: number;
|
|
10038
|
+
};
|
|
10039
|
+
cookie?: never;
|
|
10040
|
+
};
|
|
10041
|
+
requestBody?: never;
|
|
10042
|
+
responses: {
|
|
10043
|
+
200: {
|
|
10044
|
+
headers: {
|
|
10045
|
+
[name: string]: any;
|
|
10046
|
+
};
|
|
10047
|
+
content: {
|
|
10048
|
+
"application/json": components["schemas"]["JsonConfigFileDto"];
|
|
10049
|
+
};
|
|
10050
|
+
};
|
|
10051
|
+
};
|
|
10052
|
+
};
|
|
10053
|
+
"WorkbooksPublicController.replaceWorkbookDashboardFileText": {
|
|
10054
|
+
parameters: {
|
|
10055
|
+
query?: never;
|
|
10056
|
+
header?: never;
|
|
10057
|
+
path: {
|
|
10058
|
+
deploymentId: number;
|
|
10059
|
+
workbookId: number;
|
|
10060
|
+
};
|
|
10061
|
+
cookie?: never;
|
|
10062
|
+
};
|
|
10063
|
+
/** @description ReplaceJsonConfigTextInput */
|
|
10064
|
+
requestBody?: {
|
|
10065
|
+
content: {
|
|
10066
|
+
"application/json": components["schemas"]["ReplaceJsonConfigTextInput"];
|
|
10067
|
+
};
|
|
10068
|
+
};
|
|
10069
|
+
responses: {
|
|
10070
|
+
200: {
|
|
10071
|
+
headers: {
|
|
10072
|
+
[name: string]: any;
|
|
10073
|
+
};
|
|
10074
|
+
content: {
|
|
10075
|
+
"application/json": components["schemas"]["JsonConfigFileDto"];
|
|
10076
|
+
};
|
|
10077
|
+
};
|
|
10078
|
+
};
|
|
10079
|
+
};
|
|
9604
10080
|
"WorkbooksPublicController.duplicateWorkbook": {
|
|
9605
10081
|
parameters: {
|
|
9606
10082
|
query?: never;
|