@cube-dev/platform-client 0.19.1 → 0.21.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 +25 -0
- package/dist/schema.d.ts +313 -45
- package/dist/schema.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -256,6 +256,23 @@ export interface paths {
|
|
|
256
256
|
patch?: never;
|
|
257
257
|
trace?: never;
|
|
258
258
|
};
|
|
259
|
+
"/api/v1/deployments/{deploymentId}/agent-defaults": {
|
|
260
|
+
parameters: {
|
|
261
|
+
query?: never;
|
|
262
|
+
header?: never;
|
|
263
|
+
path?: never;
|
|
264
|
+
cookie?: never;
|
|
265
|
+
};
|
|
266
|
+
/** Get agent defaults */
|
|
267
|
+
get: operations["AgentsPublicController.getAgentDefaults"];
|
|
268
|
+
put?: never;
|
|
269
|
+
post?: never;
|
|
270
|
+
delete?: never;
|
|
271
|
+
options?: never;
|
|
272
|
+
head?: never;
|
|
273
|
+
patch?: never;
|
|
274
|
+
trace?: never;
|
|
275
|
+
};
|
|
259
276
|
"/api/v1/deployments/{deploymentId}/agent-skills": {
|
|
260
277
|
parameters: {
|
|
261
278
|
query?: never;
|
|
@@ -423,11 +440,11 @@ export interface paths {
|
|
|
423
440
|
* Export a dashboard as PNG or PDF
|
|
424
441
|
* @description Submit a render of a published dashboard. Identify it with either `dashboardId` (numeric) or `dashboardPublicId` (string) — supply exactly one; it must belong to this deployment, otherwise `404` is returned.
|
|
425
442
|
*
|
|
426
|
-
* Returns as soon as the job is accepted, because a render waits for every widget to finish querying. Poll `GET /dashboard-exports/{jobId}` until `status` is `completed`, then fetch the file from `GET /dashboard-exports/{jobId}/download`. The job and its file are dropped at `expiresAt` (5 minutes) — download before then or submit again.
|
|
443
|
+
* Returns as soon as the job is accepted, because a render waits for every widget to finish querying. Poll `GET /dashboard-exports/{jobId}` until `status` is `completed`, then fetch the file from `GET /dashboard-exports/{jobId}/download`. The job and its file are dropped at `expiresAt` (5 minutes; 15 for `layout: print`, which can take minutes on a long table) — download before then or submit again.
|
|
427
444
|
*
|
|
428
445
|
* Pass `filters`, `timeGrains` and `memberSwitchers` to render the board with specific control values, exactly as a scheduled notification does; omit them to render its saved defaults.
|
|
429
446
|
*
|
|
430
|
-
* Pass `layout: print` with `format: pdf` for the paginated A4 document the dashboard's "
|
|
447
|
+
* Pass `layout: print` with `format: pdf` for the paginated A4 document the dashboard's "Download print version" menu item produces — one column, every table row, the filter state as a summary line — instead of the default `screenshot` of the board. `print` with `format: png` returns `400`.
|
|
431
448
|
*
|
|
432
449
|
* By default the dashboard renders under the calling user's own security context, so the file shows what that user would see. Requires **manage** access to the dashboard's workbook — the same permission the console's own "Download as PNG / PDF" actions require, because a whole-dashboard render is a bulk data export.
|
|
433
450
|
*
|
|
@@ -1204,7 +1221,7 @@ export interface paths {
|
|
|
1204
1221
|
};
|
|
1205
1222
|
/**
|
|
1206
1223
|
* List report deliveries
|
|
1207
|
-
* @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.
|
|
1224
|
+
* @description In preview: ask Cube support to enable it. Newest first. Filter by `reportId`, `ownerUserId`, `spreadsheet` or `status`. Admins and roles granting `ScheduledTasksRead` or `ScheduledTasksManage` on the deployment see every delivery; others only their own.
|
|
1208
1225
|
*/
|
|
1209
1226
|
get: operations["ReportDeliveriesPublicController.getReportDeliveries"];
|
|
1210
1227
|
put?: never;
|
|
@@ -1228,7 +1245,7 @@ export interface paths {
|
|
|
1228
1245
|
};
|
|
1229
1246
|
/**
|
|
1230
1247
|
* Get a report delivery
|
|
1231
|
-
* @description In preview: ask Cube support to enable it. `404` if the caller cannot see it. Admins see every delivery; others only their own.
|
|
1248
|
+
* @description In preview: ask Cube support to enable it. `404` if the caller cannot see it. Admins and roles granting `ScheduledTasksRead` or `ScheduledTasksManage` on the deployment see every delivery; others only their own.
|
|
1232
1249
|
*/
|
|
1233
1250
|
get: operations["ReportDeliveriesPublicController.getReportDelivery"];
|
|
1234
1251
|
/**
|
|
@@ -1296,7 +1313,7 @@ export interface paths {
|
|
|
1296
1313
|
};
|
|
1297
1314
|
/**
|
|
1298
1315
|
* List runs of a report delivery
|
|
1299
|
-
* @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.
|
|
1316
|
+
* @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 and roles granting `ScheduledTasksRead` or `ScheduledTasksManage` on the deployment see every delivery; others only their own.
|
|
1300
1317
|
*/
|
|
1301
1318
|
get: operations["ReportDeliveriesPublicController.getReportDeliveryRuns"];
|
|
1302
1319
|
put?: never;
|
|
@@ -1407,7 +1424,7 @@ export interface paths {
|
|
|
1407
1424
|
*
|
|
1408
1425
|
* `source` is **create-only**: it is recorded when the report is first created and ignored on subsequent updates (it describes where the report originated, not its current definition).
|
|
1409
1426
|
*
|
|
1410
|
-
* Access: updating requires **edit** access to the existing report;
|
|
1427
|
+
* Access: updating requires **edit** access to the existing report; moving it to a different parent requires **manage** access to the report and **edit** access to the destination. Creating requires the same access as `POST /reports`.
|
|
1411
1428
|
*/
|
|
1412
1429
|
put: operations["ReportsPublicController.upsertReportByPublicId"];
|
|
1413
1430
|
post?: never;
|
|
@@ -1434,7 +1451,7 @@ export interface paths {
|
|
|
1434
1451
|
*
|
|
1435
1452
|
* The id you assign must be one you chose (any distinct 12-character `[0-9A-Za-z]` id). The auto-generated placeholder id shown for a report that has no stable id yet cannot be assigned — it is not unique — and is rejected with `400`.
|
|
1436
1453
|
*
|
|
1437
|
-
* Requires **edit** access to the report.
|
|
1454
|
+
* Requires **edit** access to the report. Moving it to a different parent requires **manage** access to the report and **edit** access to the destination.
|
|
1438
1455
|
*/
|
|
1439
1456
|
put: operations["ReportsPublicController.updateReport"];
|
|
1440
1457
|
post?: never;
|
|
@@ -1556,7 +1573,7 @@ export interface paths {
|
|
|
1556
1573
|
};
|
|
1557
1574
|
/**
|
|
1558
1575
|
* List scheduled tasks
|
|
1559
|
-
* @description The scheduled tasks in the deployment the caller can see — their own and those shared with them, or every task for an admin — most recently updated first, with each next run time. Needs access to the deployment; embed sessions get `403`.
|
|
1576
|
+
* @description The scheduled tasks in the deployment the caller can see — their own and those shared with them, or every task for an admin or a role granting `ScheduledTasksRead` or `ScheduledTasksManage` — most recently updated first, with each next run time. Needs access to the deployment; embed sessions get `403`.
|
|
1560
1577
|
*/
|
|
1561
1578
|
get: operations["ScheduledTasksPublicController.listScheduledTasks"];
|
|
1562
1579
|
put?: never;
|
|
@@ -1580,18 +1597,18 @@ export interface paths {
|
|
|
1580
1597
|
};
|
|
1581
1598
|
/**
|
|
1582
1599
|
* Get a scheduled task
|
|
1583
|
-
* @description A task is visible to its creator, to admins and to whoever it is shared with; anyone else gets `404`.
|
|
1600
|
+
* @description A task is visible to its creator, to admins, to roles granting `ScheduledTasksRead` or `ScheduledTasksManage` on the deployment, and to whoever it is shared with; anyone else gets `404`.
|
|
1584
1601
|
*/
|
|
1585
1602
|
get: operations["ScheduledTasksPublicController.getScheduledTask"];
|
|
1586
1603
|
/**
|
|
1587
1604
|
* Update a scheduled task
|
|
1588
|
-
* @description Changes the fields sent; `cronExpression: null` makes the task Manual. Only the creator
|
|
1605
|
+
* @description Changes the fields sent; `cronExpression: null` makes the task Manual. Only the creator, an admin or a role granting `ScheduledTasksManage` on the deployment may do this (`403` otherwise). A cron fires at most hourly (`400` otherwise), and a user can have 20 active tasks (`409` past that).
|
|
1589
1606
|
*/
|
|
1590
1607
|
put: operations["ScheduledTasksPublicController.updateScheduledTask"];
|
|
1591
1608
|
post?: never;
|
|
1592
1609
|
/**
|
|
1593
1610
|
* Delete a scheduled task
|
|
1594
|
-
* @description Deletes the task and its schedule; the chat threads of past runs are kept. Only the creator
|
|
1611
|
+
* @description Deletes the task and its schedule; the chat threads of past runs are kept. Only the creator, an admin or a role granting `ScheduledTasksManage` on the deployment may do this (`403` otherwise).
|
|
1595
1612
|
*/
|
|
1596
1613
|
delete: operations["ScheduledTasksPublicController.deleteScheduledTask"];
|
|
1597
1614
|
options?: never;
|
|
@@ -1610,7 +1627,7 @@ export interface paths {
|
|
|
1610
1627
|
put?: never;
|
|
1611
1628
|
/**
|
|
1612
1629
|
* Run a scheduled task now
|
|
1613
|
-
* @description Starts one run now, even for a paused or Manual task, and returns its chat thread. Only the creator
|
|
1630
|
+
* @description Starts one run now, even for a paused or Manual task, and returns its chat thread. Only the creator, an admin or a role granting `ScheduledTasksManage` on the deployment may do this (`403` otherwise).
|
|
1614
1631
|
*/
|
|
1615
1632
|
post: operations["ScheduledTasksPublicController.runScheduledTask"];
|
|
1616
1633
|
delete?: never;
|
|
@@ -1872,7 +1889,7 @@ export interface paths {
|
|
|
1872
1889
|
*
|
|
1873
1890
|
* If a workbook with this slug exists in the deployment, it is updated: only the fields you send are changed, and `meta` is merged into the existing metadata (a `meta.dashboardDraft` is validated like everywhere else). Otherwise a new workbook is created with this slug. The slug is normalized (trimmed, lowercased) before matching. Re-applying the same request is a no-op.
|
|
1874
1891
|
*
|
|
1875
|
-
* Access: updating requires **edit** access to the workbook holding the slug (requests that include `folderId` require **manage** access, plus **edit** access to the destination folder); creating requires the same access as `POST /workbooks` (AI BI User role or higher).
|
|
1892
|
+
* Access: updating requires **edit** access to the workbook holding the slug (requests that include `folderId` require **manage** access, plus **edit** access to the destination folder); creating requires the same access as `POST /workbooks` (AI BI User role or higher, plus **edit** access to a supplied destination folder).
|
|
1876
1893
|
*
|
|
1877
1894
|
* Whether this request creates or updates is decided — and access-checked — before it is applied. If another writer changes that in between (creates or deletes the workbook holding this slug), the request is rejected with `409` and `code: "upsert_branch_changed"` rather than applied under the wrong permission check. This is **transient: retry the request**. It only happens when two writers target the same slug concurrently — for example two pipeline runs applying the same bundle at once, where one creates the workbook and the other must then retry into the update path.
|
|
1878
1895
|
*
|
|
@@ -2153,7 +2170,7 @@ export interface paths {
|
|
|
2153
2170
|
* Supported query parameters:
|
|
2154
2171
|
* - `folderId` — list the contents of this folder (omit for the root).
|
|
2155
2172
|
* - `types` — restrict the results to one or more item types (`FOLDER`, `WORKBOOK`, `REPORT`). Repeat the parameter to pass several.
|
|
2156
|
-
* - `search` — case-insensitive substring match on item names; searches across all folders, not just the current level.
|
|
2173
|
+
* - `search` — case-insensitive substring match on item names; searches across all folders, not just the current level. A workbook also matches when a report inside it does, so a search finds a dashboard by the name of a chart on it. Use this to find an item by name instead of walking folders.
|
|
2157
2174
|
* - `orderByField` / `orderByDirection` — sort the non-folder items (e.g. by `name`, `updated_at`, `created_at`, or `viewer_last_viewed_at`).
|
|
2158
2175
|
* - `first` / `after` — cursor-based pagination.
|
|
2159
2176
|
*
|
|
@@ -2242,19 +2259,7 @@ export interface paths {
|
|
|
2242
2259
|
put?: never;
|
|
2243
2260
|
/**
|
|
2244
2261
|
* Move a workspace item
|
|
2245
|
-
* @description Move
|
|
2246
|
-
*
|
|
2247
|
-
* Request body:
|
|
2248
|
-
* - `type` — the item type: `WORKBOOK`, `REPORT`, or `FOLDER`.
|
|
2249
|
-
* - `id` — the id of the item to move.
|
|
2250
|
-
* - `folderId` — the destination folder id, or `null` to move the item to the workspace root. For a folder, this becomes its new parent.
|
|
2251
|
-
*
|
|
2252
|
-
* Access requirements depend on the item type and mirror the per-type rules:
|
|
2253
|
-
* - **Workbook** — manage access to the workbook, plus edit access to the destination folder when moving into one.
|
|
2254
|
-
* - **Report** — edit access to the report (with the report-manage permission).
|
|
2255
|
-
* - **Folder** — manage access to the folder being moved, plus manage or edit access to the destination parent folder.
|
|
2256
|
-
*
|
|
2257
|
-
* Moving a folder into one of its own descendants, or exceeding the maximum folder depth, is rejected with `400`. Returns `404` if the item does not exist or belongs to a different deployment.
|
|
2262
|
+
* @description Move a workbook, report, or folder to folderId (null for root). Source and destination permissions are checked, and a report's destination must be in the route deployment.
|
|
2258
2263
|
*/
|
|
2259
2264
|
post: operations["WorkspacePublicController.moveWorkspaceObject"];
|
|
2260
2265
|
delete?: never;
|
|
@@ -3179,6 +3184,8 @@ export interface paths {
|
|
|
3179
3184
|
* @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
|
|
3180
3185
|
*
|
|
3181
3186
|
* Lists the tenant's custom roles, newest first, cursor-paginated via `first`/`after`. Cube's built-in roles are not included — they are not tenant data.
|
|
3187
|
+
*
|
|
3188
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3182
3189
|
*/
|
|
3183
3190
|
get: operations["RolesPublicController.getRoles"];
|
|
3184
3191
|
put?: never;
|
|
@@ -3211,6 +3218,8 @@ export interface paths {
|
|
|
3211
3218
|
* The tier is **not** required and is **not** derived from the deployment actions: a role sent without one is accepted and simply confers no tier, so a user holding only that role gets the deployment grants and still cannot use the product. That is deliberate — a user holds the union of their roles, so a role that only adds a deployment scope beside another role carrying the tier is valid — but it means nothing warns you. Omit the `Global` policy only when some other role supplies the tier. Note the console does require one on every role it writes, so a role created here without a tier shows an unset Base Role when opened in the role builder.
|
|
3212
3219
|
*
|
|
3213
3220
|
* Use `["All"]` as `resources` to cover every deployment, and `"All"` as the single action for full access to the deployments in scope. A policy is rejected when it grants no action, when it names no resource, or when a `Deployment` resource is not a deployment id — pass the numeric id returned by POST /build/api/v1/deployments, not a slug or a name. Ids are checked for shape, not existence, so an id whose deployment was since deleted is kept and simply grants nothing.
|
|
3221
|
+
*
|
|
3222
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3214
3223
|
*/
|
|
3215
3224
|
post: operations["RolesPublicController.createRole"];
|
|
3216
3225
|
delete?: never;
|
|
@@ -3231,6 +3240,8 @@ export interface paths {
|
|
|
3231
3240
|
* @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
|
|
3232
3241
|
*
|
|
3233
3242
|
* Returns one custom role by id, with its policies.
|
|
3243
|
+
*
|
|
3244
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3234
3245
|
*/
|
|
3235
3246
|
get: operations["RolesPublicController.getRole"];
|
|
3236
3247
|
/**
|
|
@@ -3238,6 +3249,8 @@ export interface paths {
|
|
|
3238
3249
|
* @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
|
|
3239
3250
|
*
|
|
3240
3251
|
* Updates the fields present in the body and leaves the rest alone. Sending `policies` replaces the role's policies outright, so read the role first if you mean to add one rather than start over. Renaming to a name another role already holds answers `409`. Built-in roles cannot be updated.
|
|
3252
|
+
*
|
|
3253
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3241
3254
|
*/
|
|
3242
3255
|
put: operations["RolesPublicController.updateRole"];
|
|
3243
3256
|
post?: never;
|
|
@@ -3246,6 +3259,8 @@ export interface paths {
|
|
|
3246
3259
|
* @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
|
|
3247
3260
|
*
|
|
3248
3261
|
* Deletes the role and every assignment of it, from users and from groups. Built-in roles cannot be deleted.
|
|
3262
|
+
*
|
|
3263
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3249
3264
|
*/
|
|
3250
3265
|
delete: operations["RolesPublicController.deleteRole"];
|
|
3251
3266
|
options?: never;
|
|
@@ -3253,6 +3268,30 @@ export interface paths {
|
|
|
3253
3268
|
patch?: never;
|
|
3254
3269
|
trace?: never;
|
|
3255
3270
|
};
|
|
3271
|
+
"/api/v1/roles/{roleId}/users": {
|
|
3272
|
+
parameters: {
|
|
3273
|
+
query?: never;
|
|
3274
|
+
header?: never;
|
|
3275
|
+
path?: never;
|
|
3276
|
+
cookie?: never;
|
|
3277
|
+
};
|
|
3278
|
+
/**
|
|
3279
|
+
* List the users holding a role
|
|
3280
|
+
* @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
|
|
3281
|
+
*
|
|
3282
|
+
* Lists every user holding the role, directly or through a group, newest first, cursor-paginated via `first`/`after`. Accepts built-in role ids. Each user carries every role they hold, so a combination such as "holds Explorer but not my custom role" is one pass over these pages. Deactivated users are included.
|
|
3283
|
+
*
|
|
3284
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3285
|
+
*/
|
|
3286
|
+
get: operations["RolesPublicController.getRoleHolders"];
|
|
3287
|
+
put?: never;
|
|
3288
|
+
post?: never;
|
|
3289
|
+
delete?: never;
|
|
3290
|
+
options?: never;
|
|
3291
|
+
head?: never;
|
|
3292
|
+
patch?: never;
|
|
3293
|
+
trace?: never;
|
|
3294
|
+
};
|
|
3256
3295
|
"/api/v1/roles/{roleId}/users/{userId}": {
|
|
3257
3296
|
parameters: {
|
|
3258
3297
|
query?: never;
|
|
@@ -3268,6 +3307,8 @@ export interface paths {
|
|
|
3268
3307
|
* Gives the user everything the role grants. Idempotent — assigning a role the user already holds changes nothing. Returns `404` if either the user or the role is unknown.
|
|
3269
3308
|
*
|
|
3270
3309
|
* Unlike the other endpoints here, this one is not limited to your custom roles: it also accepts the id of a built-in role, and assigning one grants everything that role confers. **Cube's Admin role is the exception and cannot be granted this way** — it is not among the built-in roles this endpoint resolves, so its id returns `404`. No call to this endpoint can make a user an account-wide administrator.
|
|
3310
|
+
*
|
|
3311
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3271
3312
|
*/
|
|
3272
3313
|
put: operations["RolesPublicController.assignRoleToUser"];
|
|
3273
3314
|
post?: never;
|
|
@@ -3276,6 +3317,8 @@ export interface paths {
|
|
|
3276
3317
|
* @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
|
|
3277
3318
|
*
|
|
3278
3319
|
* Takes the role away from the user. Idempotent — removing a role the user does not hold changes nothing. Returns `404` if the user is unknown.
|
|
3320
|
+
*
|
|
3321
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3279
3322
|
*/
|
|
3280
3323
|
delete: operations["RolesPublicController.removeRoleFromUser"];
|
|
3281
3324
|
options?: never;
|
|
@@ -3545,6 +3588,8 @@ export interface paths {
|
|
|
3545
3588
|
* - A tenant must always keep at least one active, direct admin, so the action that would remove the last one fails with `403` while the rest of the batch still applies.
|
|
3546
3589
|
*
|
|
3547
3590
|
* Reapplying an action a user is already in (deactivating a deactivated user) succeeds as a no-op.
|
|
3591
|
+
*
|
|
3592
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3548
3593
|
*/
|
|
3549
3594
|
post: operations["UsersAdminPublicController.bulkUserAction"];
|
|
3550
3595
|
delete?: never;
|
|
@@ -3602,7 +3647,7 @@ export interface paths {
|
|
|
3602
3647
|
head?: never;
|
|
3603
3648
|
/**
|
|
3604
3649
|
* Update my settings
|
|
3605
|
-
* @description Merge a partial patch into the authenticated user's own settings. Omitted fields are left as they are; `sheets`
|
|
3650
|
+
* @description Merge a partial patch into the authenticated user's own settings. Omitted fields are left as they are; `sheets` and `memory` merge field-by-field, and an explicit `null` clears one.
|
|
3606
3651
|
*/
|
|
3607
3652
|
patch: operations["UsersPublicController.updateMySettings"];
|
|
3608
3653
|
trace?: never;
|
|
@@ -3625,6 +3670,30 @@ export interface paths {
|
|
|
3625
3670
|
patch?: never;
|
|
3626
3671
|
trace?: never;
|
|
3627
3672
|
};
|
|
3673
|
+
"/api/v1/users/{id}/roles": {
|
|
3674
|
+
parameters: {
|
|
3675
|
+
query?: never;
|
|
3676
|
+
header?: never;
|
|
3677
|
+
path?: never;
|
|
3678
|
+
cookie?: never;
|
|
3679
|
+
};
|
|
3680
|
+
/**
|
|
3681
|
+
* List a user's roles
|
|
3682
|
+
* @description **🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.
|
|
3683
|
+
*
|
|
3684
|
+
* Every role the user holds, built-in and custom, whether assigned directly or through a group. Only a direct assignment can be removed with `DELETE /api/v1/roles/{roleId}/users/{userId}`.
|
|
3685
|
+
*
|
|
3686
|
+
* An API key scoped to specific deployments answers `403` here.
|
|
3687
|
+
*/
|
|
3688
|
+
get: operations["UsersAdminPublicController.getUserRoles"];
|
|
3689
|
+
put?: never;
|
|
3690
|
+
post?: never;
|
|
3691
|
+
delete?: never;
|
|
3692
|
+
options?: never;
|
|
3693
|
+
head?: never;
|
|
3694
|
+
patch?: never;
|
|
3695
|
+
trace?: never;
|
|
3696
|
+
};
|
|
3628
3697
|
"/build/api/v1/deployments/": {
|
|
3629
3698
|
parameters: {
|
|
3630
3699
|
query?: never;
|
|
@@ -3938,6 +4007,7 @@ export interface components {
|
|
|
3938
4007
|
graphqlToken?: string | null;
|
|
3939
4008
|
hasAgentAccess?: any | null;
|
|
3940
4009
|
mcpToken?: string | null;
|
|
4010
|
+
memoryGenerationEnabled?: boolean | null;
|
|
3941
4011
|
resolvedTimezone?: string | null;
|
|
3942
4012
|
scheduledTaskPolicies?: components["schemas"]["ChatThreadPolicy"][] | null;
|
|
3943
4013
|
timezoneSettings?: components["schemas"]["TimezoneSettings"] | null;
|
|
@@ -3972,6 +4042,10 @@ export interface components {
|
|
|
3972
4042
|
updatedAt: string;
|
|
3973
4043
|
userId?: number | null;
|
|
3974
4044
|
};
|
|
4045
|
+
AgentDefaultsResponse: {
|
|
4046
|
+
autoAgentEnabled: boolean;
|
|
4047
|
+
defaultAgentId?: number | null;
|
|
4048
|
+
};
|
|
3975
4049
|
AgentLlm: {
|
|
3976
4050
|
config?: {
|
|
3977
4051
|
[key: string]: any;
|
|
@@ -4294,7 +4368,7 @@ export interface components {
|
|
|
4294
4368
|
/** @enum {string} */
|
|
4295
4369
|
ChatHistoryUserType: "internal" | "external";
|
|
4296
4370
|
ChatThreadPolicy: {
|
|
4297
|
-
actions: ("All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
|
|
4371
|
+
actions: ("All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "ScheduledTasksRead" | "ScheduledTasksManage" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
|
|
4298
4372
|
effect?: components["schemas"]["ChatThreadPolicyEffect"] | null;
|
|
4299
4373
|
resourceType: components["schemas"]["ChatThreadPolicyResourceType"];
|
|
4300
4374
|
resources: string[];
|
|
@@ -4439,7 +4513,7 @@ export interface components {
|
|
|
4439
4513
|
timezone?: string | null;
|
|
4440
4514
|
};
|
|
4441
4515
|
/** @enum {string} */
|
|
4442
|
-
CreateNotificationInputNotificationFormat: "png" | "pdf";
|
|
4516
|
+
CreateNotificationInputNotificationFormat: "png" | "pdf" | "pdf_print";
|
|
4443
4517
|
/** @enum {string} */
|
|
4444
4518
|
CreateNotificationInputScheduleType: "HOURLY" | "DAILY" | "WEEKLY" | "MONTHLY" | "CUSTOM";
|
|
4445
4519
|
CreateOAuthIntegrationInput: {
|
|
@@ -4514,6 +4588,8 @@ export interface components {
|
|
|
4514
4588
|
CreateScheduledTaskInput: {
|
|
4515
4589
|
/** @description The agent that runs the task. Omit for the deployment default. */
|
|
4516
4590
|
agentId?: number | null;
|
|
4591
|
+
/** @description Notify only when: on each fire the measure is read once, before the agent runs, and the agent runs only when the condition starts to hold, with the crossing facts at the top of its thread; it runs again only after the condition has stopped holding. A `change` or `anomaly` rule needs `timeDimension` and `granularity`. The creator gets an inbox row only with `notificationEnabled: true`. Omit to run the agent on every fire. */
|
|
4592
|
+
condition?: components["schemas"]["ScheduledTaskCondition"] | null;
|
|
4517
4593
|
/** @description Standard 5-field cron (minute hour day-of-month month day-of-week), e.g. `0 9 * * 1-5` for 9:00 on weekdays. A task runs at most once an hour, so the minute field is a single number. Null or omitted makes the task Manual: it runs only when started with `POST /scheduled-tasks/{taskId}/run`. */
|
|
4518
4594
|
cronExpression?: string | null;
|
|
4519
4595
|
description?: string | null;
|
|
@@ -4746,17 +4822,17 @@ export interface components {
|
|
|
4746
4822
|
endInclusive?: any | null;
|
|
4747
4823
|
/** @description Dimension path, e.g. "Orders.status" */
|
|
4748
4824
|
member: string;
|
|
4749
|
-
/** @description Filter operator (defaults to "equals") */
|
|
4825
|
+
/** @description Filter operator (defaults to "equals"; with an empty value, omitting it clears the control instead) */
|
|
4750
4826
|
operator?: components["schemas"]["DashboardFilterInputOperator"] | null;
|
|
4751
4827
|
/** @description For between filters: whether the start bound is inclusive */
|
|
4752
4828
|
startInclusive?: any | null;
|
|
4753
|
-
/** @description Filter value. Omit for is_null / is_not_null / is_empty / is_not_empty; provide a 2-element [start, end] array for between. */
|
|
4829
|
+
/** @description Filter value. Omit for is_null / is_not_null / is_empty / is_not_empty; provide a 2-element [start, end] array for between. An empty array or empty string with no operator renders the filter cleared; with an operator, the filter keeps that operator. */
|
|
4754
4830
|
value?: (string | number | boolean | unknown[]) | null;
|
|
4755
4831
|
};
|
|
4756
4832
|
/** @enum {string} */
|
|
4757
|
-
DashboardFilterInputOperator: "equals" | "not_equals" | "greater_than" | "greater_than_or_equal" | "less_than" | "less_than_or_equal" | "contains" | "not_contains" | "starts_with" | "not_starts_with" | "ends_with" | "not_ends_with" | "is_null" | "is_not_null" | "is_empty" | "is_not_empty" | "between" | "custom";
|
|
4833
|
+
DashboardFilterInputOperator: "equals" | "not_equals" | "greater_than" | "greater_than_or_equal" | "less_than" | "less_than_or_equal" | "contains" | "not_contains" | "starts_with" | "not_starts_with" | "ends_with" | "not_ends_with" | "in_month" | "not_in_month" | "in_quarter" | "not_in_quarter" | "in_year" | "not_in_year" | "is_null" | "is_not_null" | "is_empty" | "is_not_empty" | "between" | "custom";
|
|
4758
4834
|
/** @enum {string} */
|
|
4759
|
-
DashboardFilterOperator: "equals" | "not_equals" | "greater_than" | "greater_than_or_equal" | "less_than" | "less_than_or_equal" | "contains" | "not_contains" | "starts_with" | "not_starts_with" | "ends_with" | "not_ends_with" | "is_null" | "is_not_null" | "is_empty" | "is_not_empty" | "between" | "custom";
|
|
4835
|
+
DashboardFilterOperator: "equals" | "not_equals" | "greater_than" | "greater_than_or_equal" | "less_than" | "less_than_or_equal" | "contains" | "not_contains" | "starts_with" | "not_starts_with" | "ends_with" | "not_ends_with" | "in_month" | "not_in_month" | "in_quarter" | "not_in_quarter" | "in_year" | "not_in_year" | "is_null" | "is_not_null" | "is_empty" | "is_not_empty" | "between" | "custom";
|
|
4760
4836
|
DashboardLayout: {
|
|
4761
4837
|
breakpoints?: components["schemas"]["DashboardBreakpoints"] | null;
|
|
4762
4838
|
cols?: components["schemas"]["DashboardBreakpointCols"] | null;
|
|
@@ -4813,7 +4889,7 @@ export interface components {
|
|
|
4813
4889
|
member: string;
|
|
4814
4890
|
};
|
|
4815
4891
|
DashboardTimeGrainInput: {
|
|
4816
|
-
/** @description Granularity, e.g. "day", "week", "month" */
|
|
4892
|
+
/** @description Granularity, e.g. "day", "week", "month". An empty string renders the control cleared. */
|
|
4817
4893
|
grain: string;
|
|
4818
4894
|
/** @description Time dimension path, e.g. "Orders.created_at" */
|
|
4819
4895
|
member: string;
|
|
@@ -5390,6 +5466,7 @@ export interface components {
|
|
|
5390
5466
|
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
5391
5467
|
};
|
|
5392
5468
|
DeploymentSettings: {
|
|
5469
|
+
autoAgentEnabled: boolean;
|
|
5393
5470
|
autoDomain?: string | null;
|
|
5394
5471
|
cloudProvider: components["schemas"]["DeploymentSettingsCloudProvider"];
|
|
5395
5472
|
creationMethod?: components["schemas"]["DeploymentSettingsCreationMethod"] | null;
|
|
@@ -5398,6 +5475,7 @@ export interface components {
|
|
|
5398
5475
|
cubeImageCloud?: string | null;
|
|
5399
5476
|
cubeImageVersion?: string | null;
|
|
5400
5477
|
customDomain?: string | null;
|
|
5478
|
+
defaultAgentId?: number | null;
|
|
5401
5479
|
defaultLaunchpadViewGroup?: string | null;
|
|
5402
5480
|
deployBranchMergeAllowed: boolean;
|
|
5403
5481
|
deployBranchName: string;
|
|
@@ -5665,11 +5743,21 @@ export interface components {
|
|
|
5665
5743
|
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
5666
5744
|
};
|
|
5667
5745
|
EvaluationResultResponse: {
|
|
5746
|
+
/** @description The agent's text answer, which may be truncated. */
|
|
5747
|
+
agentResponse?: string | null;
|
|
5748
|
+
/** @description The SQL the agent ran to answer the question. */
|
|
5749
|
+
agentSql?: string | null;
|
|
5750
|
+
/** @description The grader's explanation of the verdict: why the question failed or errored, a note for a result that needs review, or the AI check's rationale. */
|
|
5751
|
+
analysis?: string | null;
|
|
5668
5752
|
createdAt: string;
|
|
5669
5753
|
evaluationId: number;
|
|
5754
|
+
/** @description The ground-truth SQL the agent result was compared against. */
|
|
5755
|
+
groundTruthSql?: string | null;
|
|
5670
5756
|
id: number;
|
|
5671
5757
|
questionTextSnapshot: string;
|
|
5672
5758
|
score?: number | null;
|
|
5759
|
+
/** @description Short categories for a non-passing verdict, such as "Row count mismatch" or "Query error". Empty when the question passed. */
|
|
5760
|
+
scoreReasons: string[];
|
|
5673
5761
|
updatedAt: string;
|
|
5674
5762
|
/** @description Question outcome: pass, fail, review, skipped, or error. */
|
|
5675
5763
|
verdict?: string | null;
|
|
@@ -5905,7 +5993,7 @@ export interface components {
|
|
|
5905
5993
|
userCount?: number | null;
|
|
5906
5994
|
};
|
|
5907
5995
|
/** @enum {string} */
|
|
5908
|
-
InheritedGroupPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
5996
|
+
InheritedGroupPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "ScheduledTasksRead" | "ScheduledTasksManage" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
5909
5997
|
InheritedUserPolicyDto: {
|
|
5910
5998
|
action: components["schemas"]["InheritedUserPolicyDtoAction"];
|
|
5911
5999
|
email?: string | null;
|
|
@@ -5915,7 +6003,7 @@ export interface components {
|
|
|
5915
6003
|
userId?: number | null;
|
|
5916
6004
|
};
|
|
5917
6005
|
/** @enum {string} */
|
|
5918
|
-
InheritedUserPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
6006
|
+
InheritedUserPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "ScheduledTasksRead" | "ScheduledTasksManage" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
5919
6007
|
JsonConfigFileDto: {
|
|
5920
6008
|
/** @description The configuration as canonical JSON text: keys sorted, 2-space indentation, trailing newline. `oldText` in a replacement must match this text exactly. */
|
|
5921
6009
|
content: string;
|
|
@@ -5934,6 +6022,9 @@ export interface components {
|
|
|
5934
6022
|
locale: string;
|
|
5935
6023
|
value: string;
|
|
5936
6024
|
};
|
|
6025
|
+
MemoryUserSettingsInput: {
|
|
6026
|
+
generateFromChats?: boolean | null;
|
|
6027
|
+
};
|
|
5937
6028
|
MergeIntoParentBranchRequest: {
|
|
5938
6029
|
branchId?: number;
|
|
5939
6030
|
branchName?: string;
|
|
@@ -6239,7 +6330,7 @@ export interface components {
|
|
|
6239
6330
|
/** @enum {string} */
|
|
6240
6331
|
PivotItemsMeasuresPosition: "before" | "after";
|
|
6241
6332
|
Policy: {
|
|
6242
|
-
actions: ("All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
|
|
6333
|
+
actions: ("All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "ScheduledTasksRead" | "ScheduledTasksManage" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
|
|
6243
6334
|
resourceType: components["schemas"]["PolicyResourceType"];
|
|
6244
6335
|
resources: string[];
|
|
6245
6336
|
};
|
|
@@ -6753,7 +6844,7 @@ export interface components {
|
|
|
6753
6844
|
userCount?: number | null;
|
|
6754
6845
|
};
|
|
6755
6846
|
/** @enum {string} */
|
|
6756
|
-
ResourceGroupPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
6847
|
+
ResourceGroupPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "ScheduledTasksRead" | "ScheduledTasksManage" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
6757
6848
|
ResourceOwner: {
|
|
6758
6849
|
email: string;
|
|
6759
6850
|
firstName?: string | null;
|
|
@@ -6774,7 +6865,7 @@ export interface components {
|
|
|
6774
6865
|
userId?: number | null;
|
|
6775
6866
|
};
|
|
6776
6867
|
/** @enum {string} */
|
|
6777
|
-
ResourceUserPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
6868
|
+
ResourceUserPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "ScheduledTasksRead" | "ScheduledTasksManage" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
6778
6869
|
RevokeEmbedSessionInput: {
|
|
6779
6870
|
/** @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. */
|
|
6780
6871
|
sessionId: string;
|
|
@@ -6792,6 +6883,19 @@ export interface components {
|
|
|
6792
6883
|
/** @description What the role grants. Scope a policy to specific deployments by setting `resourceType` to `Deployment` and listing the deployment ids — as returned by POST /build/api/v1/deployments — in `resources`, or `["All"]` for every deployment. An empty `policies` list is accepted and creates a role that grants nothing yet; an individual policy with no actions, or none naming a resource, is rejected. */
|
|
6793
6884
|
policies: components["schemas"]["Policy"][];
|
|
6794
6885
|
};
|
|
6886
|
+
RoleHolder: {
|
|
6887
|
+
email: string;
|
|
6888
|
+
firstName?: string | null;
|
|
6889
|
+
id: number;
|
|
6890
|
+
/** @description Set by the user's own Admin flag or by a group granting Admin. */
|
|
6891
|
+
isAdmin: boolean;
|
|
6892
|
+
isDeactivated: boolean;
|
|
6893
|
+
roles: components["schemas"]["UserRoleAssignmentResponse"][];
|
|
6894
|
+
};
|
|
6895
|
+
RoleHoldersListResponse: {
|
|
6896
|
+
items: components["schemas"]["RoleHolder"][];
|
|
6897
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
6898
|
+
};
|
|
6795
6899
|
RoleUpdateBody: {
|
|
6796
6900
|
/** @description Omit to leave the description unchanged; `null` clears it. */
|
|
6797
6901
|
description?: string | null;
|
|
@@ -6801,7 +6905,7 @@ export interface components {
|
|
|
6801
6905
|
policies?: components["schemas"]["Policy"][];
|
|
6802
6906
|
};
|
|
6803
6907
|
RoleWithAccess: {
|
|
6804
|
-
actions: ("All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
|
|
6908
|
+
actions: ("All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "ScheduledTasksRead" | "ScheduledTasksManage" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage")[];
|
|
6805
6909
|
id: number;
|
|
6806
6910
|
name: string;
|
|
6807
6911
|
};
|
|
@@ -6835,6 +6939,61 @@ export interface components {
|
|
|
6835
6939
|
SaveDatabricksMetricViewIntegrationInputDeletionPolicy: "retain" | "delete-managed";
|
|
6836
6940
|
/** @enum {string} */
|
|
6837
6941
|
SaveDatabricksMetricViewIntegrationInputSelectionMode: "all" | "selected" | "pattern";
|
|
6942
|
+
ScheduledTaskCondition: {
|
|
6943
|
+
granularity?: components["schemas"]["ScheduledTaskConditionGranularity"] | null;
|
|
6944
|
+
/** @description Changes whenever the condition does. Read-only. */
|
|
6945
|
+
id?: string | null;
|
|
6946
|
+
/** @description Full measure name, e.g. `orders.revenue`. */
|
|
6947
|
+
measure: string;
|
|
6948
|
+
measureTitle?: string | null;
|
|
6949
|
+
rule: components["schemas"]["ScheduledTaskConditionRule"];
|
|
6950
|
+
/** @description Full time dimension name, e.g. `orders.created_at`. */
|
|
6951
|
+
timeDimension?: string | null;
|
|
6952
|
+
timeDimensionTitle?: string | null;
|
|
6953
|
+
};
|
|
6954
|
+
ScheduledTaskConditionBand: {
|
|
6955
|
+
high: number;
|
|
6956
|
+
low: number;
|
|
6957
|
+
median: number;
|
|
6958
|
+
};
|
|
6959
|
+
/** @enum {string} */
|
|
6960
|
+
ScheduledTaskConditionGranularity: "day" | "week" | "month" | "quarter" | "year";
|
|
6961
|
+
ScheduledTaskConditionRule: {
|
|
6962
|
+
/** @description For `change`: increases, decreases, or changes either way. */
|
|
6963
|
+
direction?: components["schemas"]["ScheduledTaskConditionRuleDirection"] | null;
|
|
6964
|
+
/** @description For `threshold`: above, below or equal to. */
|
|
6965
|
+
operator?: components["schemas"]["ScheduledTaskConditionRuleOperator"] | null;
|
|
6966
|
+
/** @description For `change`: the percentage, greater than 0, e.g. `5` for 5 %. */
|
|
6967
|
+
percent?: number | null;
|
|
6968
|
+
/** @description `threshold`: the last complete period (or the total, with no time dimension) is above, below or equal to `value`. `change`: the last complete period moved by at least `percent` % from the one before it. `anomaly`: the last complete period lies outside median ± 3·MAD of the at least 8 complete periods before it. */
|
|
6969
|
+
type: components["schemas"]["ScheduledTaskConditionRuleType"];
|
|
6970
|
+
/** @description For `threshold`: the number compared with. */
|
|
6971
|
+
value?: number | null;
|
|
6972
|
+
};
|
|
6973
|
+
/** @enum {string} */
|
|
6974
|
+
ScheduledTaskConditionRuleDirection: "up" | "down" | "either";
|
|
6975
|
+
/** @enum {string} */
|
|
6976
|
+
ScheduledTaskConditionRuleOperator: "gt" | "lt" | "eq";
|
|
6977
|
+
/** @enum {string} */
|
|
6978
|
+
ScheduledTaskConditionRuleType: "threshold" | "change" | "anomaly";
|
|
6979
|
+
ScheduledTaskLastConditionCheck: {
|
|
6980
|
+
/** @description When the check ran (ISO 8601). */
|
|
6981
|
+
at: string;
|
|
6982
|
+
band?: components["schemas"]["ScheduledTaskConditionBand"] | null;
|
|
6983
|
+
changePercent?: number | null;
|
|
6984
|
+
conditionId: string;
|
|
6985
|
+
notifiedAt?: string | null;
|
|
6986
|
+
/** @description Start of the period read, `YYYY-MM-DD`. */
|
|
6987
|
+
period?: string | null;
|
|
6988
|
+
previous?: number | null;
|
|
6989
|
+
previousPeriod?: string | null;
|
|
6990
|
+
reason?: string | null;
|
|
6991
|
+
/** @description `held-notified` ran the agent; `held-already-notified` was still holding since an earlier notification; `cannot-evaluate` carries a `reason` code; an `error` carries its text in `reason` to the task's creator only, as do the figures the check read. */
|
|
6992
|
+
status: components["schemas"]["ScheduledTaskLastConditionCheckStatus"];
|
|
6993
|
+
value?: number | null;
|
|
6994
|
+
};
|
|
6995
|
+
/** @enum {string} */
|
|
6996
|
+
ScheduledTaskLastConditionCheckStatus: "not-held" | "held-notified" | "held-already-notified" | "cannot-evaluate" | "error";
|
|
6838
6997
|
ScheduledTaskListResponse: {
|
|
6839
6998
|
items: components["schemas"]["ScheduledTaskResponse"][];
|
|
6840
6999
|
pageInfo: components["schemas"]["PageInfo"];
|
|
@@ -6842,6 +7001,8 @@ export interface components {
|
|
|
6842
7001
|
ScheduledTaskResponse: {
|
|
6843
7002
|
/** @description The agent that runs the task; null runs the deployment default. */
|
|
6844
7003
|
agentId?: number | null;
|
|
7004
|
+
/** @description Notify only when: on each fire the measure is read once, before the agent runs, and the agent runs only when the condition starts to hold, with the crossing facts at the top of its thread; it runs again only after the condition has stopped holding. A `change` or `anomaly` rule needs `timeDimension` and `granularity`. The creator gets an inbox row only with `notificationEnabled: true`. Null runs the agent on every fire. */
|
|
7005
|
+
condition?: components["schemas"]["ScheduledTaskCondition"] | null;
|
|
6845
7006
|
/** @description Standard 5-field cron (minute hour day-of-month month day-of-week), e.g. `0 9 * * 1-5` for 9:00 on weekdays. Null when the task is Manual: it runs only when started with `POST /scheduled-tasks/{taskId}/run`. */
|
|
6846
7007
|
cronExpression?: string | null;
|
|
6847
7008
|
deploymentId: number;
|
|
@@ -6849,6 +7010,8 @@ export interface components {
|
|
|
6849
7010
|
id: number;
|
|
6850
7011
|
/** @description False while the schedule is paused. */
|
|
6851
7012
|
isEnabled: boolean;
|
|
7013
|
+
/** @description The latest condition check; null before the first one. */
|
|
7014
|
+
lastConditionCheck?: components["schemas"]["ScheduledTaskLastConditionCheck"] | null;
|
|
6852
7015
|
name: string;
|
|
6853
7016
|
/** @description When the schedule next fires (ISO 8601, UTC); null for a Manual or paused task. */
|
|
6854
7017
|
nextRunAt?: string | null;
|
|
@@ -6954,7 +7117,7 @@ export interface components {
|
|
|
6954
7117
|
/** @description Output format: `png` or `pdf`. */
|
|
6955
7118
|
format: components["schemas"]["StartDashboardExportInputFormat"];
|
|
6956
7119
|
/**
|
|
6957
|
-
* @description How the dashboard is laid out. `screenshot` (the default) renders the board as it looks on screen. `print` renders the paginated A4 document the dashboard's '
|
|
7120
|
+
* @description How the dashboard is laid out. `screenshot` (the default) renders the board as it looks on screen. `print` renders the paginated A4 document the dashboard's 'Download print version' menu item produces: one column, every table row, and the filter state as a summary line instead of filter controls. `print` is available for `format: 'pdf'` only.
|
|
6958
7121
|
* @default screenshot
|
|
6959
7122
|
*/
|
|
6960
7123
|
layout?: components["schemas"]["StartDashboardExportInputLayout"] | null;
|
|
@@ -7000,6 +7163,10 @@ export interface components {
|
|
|
7000
7163
|
branchName: string;
|
|
7001
7164
|
/** @description Path of one eval-question YAML file to run, relative to the agents directory. Omit to run the complete eval set. */
|
|
7002
7165
|
questionFile?: string | null;
|
|
7166
|
+
/** @description Security context to evaluate under, merged over the caller's own. Applies to the ground-truth queries, and to the agent's queries when the run's agent is defined in the deployment's agent config; the default `auto` agent queries under the caller's own context. Requires deployment edit access; a `cubeCloud` key requires an admin. */
|
|
7167
|
+
securityContext?: {
|
|
7168
|
+
[key: string]: any;
|
|
7169
|
+
} | null;
|
|
7003
7170
|
};
|
|
7004
7171
|
StartReportDeliveryRunResponse: {
|
|
7005
7172
|
/** @description Id of the run, which writes the sheet in the background; poll it for the outcome. */
|
|
@@ -7093,10 +7260,12 @@ export interface components {
|
|
|
7093
7260
|
files: components["schemas"]["DataModelFileContent"][];
|
|
7094
7261
|
};
|
|
7095
7262
|
UpdateDeploymentInput: {
|
|
7263
|
+
autoAgentEnabled?: boolean | null;
|
|
7096
7264
|
cloudProvider?: components["schemas"]["UpdateDeploymentInputCloudProvider"] | null;
|
|
7097
7265
|
creationMethod?: components["schemas"]["UpdateDeploymentInputCreationMethod"] | null;
|
|
7098
7266
|
cspsConfig?: components["schemas"]["CspsConfigInput"] | null;
|
|
7099
7267
|
customDomain?: string | null;
|
|
7268
|
+
defaultAgentId?: number | null;
|
|
7100
7269
|
defaultLaunchpadViewGroup?: string | null;
|
|
7101
7270
|
deployBranchMergeAllowed?: boolean | null;
|
|
7102
7271
|
deployBranchName?: string | null;
|
|
@@ -7166,7 +7335,7 @@ export interface components {
|
|
|
7166
7335
|
timezone?: string | null;
|
|
7167
7336
|
};
|
|
7168
7337
|
/** @enum {string} */
|
|
7169
|
-
UpdateNotificationInputNotificationFormat: "png" | "pdf";
|
|
7338
|
+
UpdateNotificationInputNotificationFormat: "png" | "pdf" | "pdf_print";
|
|
7170
7339
|
/** @enum {string} */
|
|
7171
7340
|
UpdateNotificationInputScheduleType: "HOURLY" | "DAILY" | "WEEKLY" | "MONTHLY" | "CUSTOM";
|
|
7172
7341
|
UpdateOAuthIntegrationInput: {
|
|
@@ -7248,7 +7417,7 @@ export interface components {
|
|
|
7248
7417
|
resourceType: components["schemas"]["UpdateResourceGroupPolicyBodyResourceType"];
|
|
7249
7418
|
};
|
|
7250
7419
|
/** @enum {string} */
|
|
7251
|
-
UpdateResourceGroupPolicyBodyAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
7420
|
+
UpdateResourceGroupPolicyBodyAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "ScheduledTasksRead" | "ScheduledTasksManage" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
7252
7421
|
/** @enum {string} */
|
|
7253
7422
|
UpdateResourceGroupPolicyBodyResourceType: "Global" | "Deployment" | "Report" | "ReportFolder" | "Agent" | "AgentSpace" | "Workbook" | "Dashboard" | "Folder" | "ChatThread" | "ScheduledTask";
|
|
7254
7423
|
UpdateResourceUserPolicyBody: {
|
|
@@ -7258,12 +7427,14 @@ export interface components {
|
|
|
7258
7427
|
userId?: number | null;
|
|
7259
7428
|
};
|
|
7260
7429
|
/** @enum {string} */
|
|
7261
|
-
UpdateResourceUserPolicyBodyAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
7430
|
+
UpdateResourceUserPolicyBodyAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "ScheduledTasksCreate" | "ScheduledTaskRead" | "ScheduledTasksRead" | "ScheduledTasksManage" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
7262
7431
|
/** @enum {string} */
|
|
7263
7432
|
UpdateResourceUserPolicyBodyResourceType: "Global" | "Deployment" | "Report" | "ReportFolder" | "Agent" | "AgentSpace" | "Workbook" | "Dashboard" | "Folder" | "ChatThread" | "ScheduledTask";
|
|
7264
7433
|
UpdateScheduledTaskInput: {
|
|
7265
7434
|
/** @description The agent that runs the task. Omit to leave unchanged; null resets it to the deployment default. */
|
|
7266
7435
|
agentId?: number | null;
|
|
7436
|
+
/** @description Notify only when: on each fire the measure is read once, before the agent runs, and the agent runs only when the condition starts to hold, with the crossing facts at the top of its thread; it runs again only after the condition has stopped holding. A `change` or `anomaly` rule needs `timeDimension` and `granularity`. The creator gets an inbox row only with `notificationEnabled: true`. Omit to leave unchanged; null removes it. A changed condition starts its breach state fresh. */
|
|
7437
|
+
condition?: components["schemas"]["ScheduledTaskCondition"] | null;
|
|
7267
7438
|
/** @description New standard 5-field cron, at most hourly (the minute field is a single number). Omit it to keep the current schedule; send null to make the task Manual. */
|
|
7268
7439
|
cronExpression?: string | null;
|
|
7269
7440
|
/** @description Omit to leave unchanged. Send null to clear the description. */
|
|
@@ -7450,6 +7621,22 @@ export interface components {
|
|
|
7450
7621
|
updatedAt: string;
|
|
7451
7622
|
userId: number;
|
|
7452
7623
|
};
|
|
7624
|
+
UserRoleAssignmentResponse: {
|
|
7625
|
+
builtIn: boolean;
|
|
7626
|
+
description?: string | null;
|
|
7627
|
+
/** @description Assigned to the user directly — the assignment `DELETE /api/v1/roles/{roleId}/users/{userId}` removes. */
|
|
7628
|
+
direct: boolean;
|
|
7629
|
+
/** @description Groups that grant the role. Removing it from the user does not touch these; change the group instead. */
|
|
7630
|
+
groupIds: number[];
|
|
7631
|
+
/** @description Role id. Built-in roles have fixed negative ids. */
|
|
7632
|
+
id: number;
|
|
7633
|
+
name: string;
|
|
7634
|
+
};
|
|
7635
|
+
UserRolesResponse: {
|
|
7636
|
+
/** @description Set by the user's own Admin flag or by a group granting Admin. */
|
|
7637
|
+
isAdmin: boolean;
|
|
7638
|
+
roles: components["schemas"]["UserRoleAssignmentResponse"][];
|
|
7639
|
+
};
|
|
7453
7640
|
UserSettingsInput: {
|
|
7454
7641
|
alternatingRowColors?: boolean | null;
|
|
7455
7642
|
defaultDeploymentId?: number | null;
|
|
@@ -7459,6 +7646,7 @@ export interface components {
|
|
|
7459
7646
|
*/
|
|
7460
7647
|
lastSeenChangelogId?: number | null;
|
|
7461
7648
|
locale?: string | null;
|
|
7649
|
+
memory?: components["schemas"]["MemoryUserSettingsInput"] | null;
|
|
7462
7650
|
sheets?: components["schemas"]["SheetsUserSettingsInput"] | null;
|
|
7463
7651
|
theme?: string | null;
|
|
7464
7652
|
timezone?: string | null;
|
|
@@ -8232,6 +8420,27 @@ export interface operations {
|
|
|
8232
8420
|
};
|
|
8233
8421
|
};
|
|
8234
8422
|
};
|
|
8423
|
+
"AgentsPublicController.getAgentDefaults": {
|
|
8424
|
+
parameters: {
|
|
8425
|
+
query?: never;
|
|
8426
|
+
header?: never;
|
|
8427
|
+
path: {
|
|
8428
|
+
deploymentId: number;
|
|
8429
|
+
};
|
|
8430
|
+
cookie?: never;
|
|
8431
|
+
};
|
|
8432
|
+
requestBody?: never;
|
|
8433
|
+
responses: {
|
|
8434
|
+
200: {
|
|
8435
|
+
headers: {
|
|
8436
|
+
[name: string]: any;
|
|
8437
|
+
};
|
|
8438
|
+
content: {
|
|
8439
|
+
"application/json": components["schemas"]["AgentDefaultsResponse"];
|
|
8440
|
+
};
|
|
8441
|
+
};
|
|
8442
|
+
};
|
|
8443
|
+
};
|
|
8235
8444
|
"AgentsPublicController.getAgentSkills": {
|
|
8236
8445
|
parameters: {
|
|
8237
8446
|
query?: {
|
|
@@ -12930,6 +13139,37 @@ export interface operations {
|
|
|
12930
13139
|
};
|
|
12931
13140
|
};
|
|
12932
13141
|
};
|
|
13142
|
+
"RolesPublicController.getRoleHolders": {
|
|
13143
|
+
parameters: {
|
|
13144
|
+
query?: {
|
|
13145
|
+
after?: string | null;
|
|
13146
|
+
first?: number | null;
|
|
13147
|
+
};
|
|
13148
|
+
header?: never;
|
|
13149
|
+
path: {
|
|
13150
|
+
roleId: number;
|
|
13151
|
+
};
|
|
13152
|
+
cookie?: never;
|
|
13153
|
+
};
|
|
13154
|
+
requestBody?: never;
|
|
13155
|
+
responses: {
|
|
13156
|
+
200: {
|
|
13157
|
+
headers: {
|
|
13158
|
+
[name: string]: any;
|
|
13159
|
+
};
|
|
13160
|
+
content: {
|
|
13161
|
+
"application/json": components["schemas"]["RoleHoldersListResponse"];
|
|
13162
|
+
};
|
|
13163
|
+
};
|
|
13164
|
+
/** @description No role has that id. Cube's Admin role answers `404` too. */
|
|
13165
|
+
404: {
|
|
13166
|
+
headers: {
|
|
13167
|
+
[name: string]: any;
|
|
13168
|
+
};
|
|
13169
|
+
content?: never;
|
|
13170
|
+
};
|
|
13171
|
+
};
|
|
13172
|
+
};
|
|
12933
13173
|
"RolesPublicController.assignRoleToUser": {
|
|
12934
13174
|
parameters: {
|
|
12935
13175
|
query?: never;
|
|
@@ -13519,6 +13759,34 @@ export interface operations {
|
|
|
13519
13759
|
};
|
|
13520
13760
|
};
|
|
13521
13761
|
};
|
|
13762
|
+
"UsersAdminPublicController.getUserRoles": {
|
|
13763
|
+
parameters: {
|
|
13764
|
+
query?: never;
|
|
13765
|
+
header?: never;
|
|
13766
|
+
path: {
|
|
13767
|
+
id: number;
|
|
13768
|
+
};
|
|
13769
|
+
cookie?: never;
|
|
13770
|
+
};
|
|
13771
|
+
requestBody?: never;
|
|
13772
|
+
responses: {
|
|
13773
|
+
200: {
|
|
13774
|
+
headers: {
|
|
13775
|
+
[name: string]: any;
|
|
13776
|
+
};
|
|
13777
|
+
content: {
|
|
13778
|
+
"application/json": components["schemas"]["UserRolesResponse"];
|
|
13779
|
+
};
|
|
13780
|
+
};
|
|
13781
|
+
/** @description The user is unknown. */
|
|
13782
|
+
404: {
|
|
13783
|
+
headers: {
|
|
13784
|
+
[name: string]: any;
|
|
13785
|
+
};
|
|
13786
|
+
content?: never;
|
|
13787
|
+
};
|
|
13788
|
+
};
|
|
13789
|
+
};
|
|
13522
13790
|
"DeploymentsBuildPublicController.createDeployment": {
|
|
13523
13791
|
parameters: {
|
|
13524
13792
|
query?: never;
|