@cube-dev/platform-client 0.3.0 → 0.5.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 +68 -0
- package/dist/schema.d.ts +1894 -305
- package/dist/schema.d.ts.map +1 -1
- package/package.json +6 -7
package/dist/schema.d.ts
CHANGED
|
@@ -207,7 +207,10 @@ export interface paths {
|
|
|
207
207
|
};
|
|
208
208
|
/** Get deployment */
|
|
209
209
|
get: operations["DeploymentsPublicController.getDeployment"];
|
|
210
|
-
/**
|
|
210
|
+
/**
|
|
211
|
+
* Update a deployment
|
|
212
|
+
* @description Update any subset of a deployment’s settings — everything the console’s Settings pages own — and read the full settings back. Fields you omit are left alone, and `templateVariables` is merged key-by-key rather than replaced, so setting one configuration flag never clears the others. `releaseChannelVersion` must be one of the versions `GET /:deploymentId/versions` lists for the target channel (in any of the forms it reports) — anything else is a 400, and the container image is resolved from the version rather than sent. Choosing a version that is not the channel’s latest also sets `releaseChannelVersionHold` unless you send it explicitly, so auto-upgrade does not undo the pin.
|
|
213
|
+
*/
|
|
211
214
|
put: operations["DeploymentsPublicController.updateDeployment"];
|
|
212
215
|
post?: never;
|
|
213
216
|
/** Delete deployment */
|
|
@@ -309,7 +312,8 @@ export interface paths {
|
|
|
309
312
|
path?: never;
|
|
310
313
|
cookie?: never;
|
|
311
314
|
};
|
|
312
|
-
|
|
315
|
+
/** List dbt syncs for a deployment */
|
|
316
|
+
get: operations["DbtSyncPublicController.listDbtSyncs"];
|
|
313
317
|
put?: never;
|
|
314
318
|
/** Start a dbt sync for a deployment */
|
|
315
319
|
post: operations["DbtSyncPublicController.startDbtSync"];
|
|
@@ -319,6 +323,58 @@ export interface paths {
|
|
|
319
323
|
patch?: never;
|
|
320
324
|
trace?: never;
|
|
321
325
|
};
|
|
326
|
+
"/api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}": {
|
|
327
|
+
parameters: {
|
|
328
|
+
query?: never;
|
|
329
|
+
header?: never;
|
|
330
|
+
path?: never;
|
|
331
|
+
cookie?: never;
|
|
332
|
+
};
|
|
333
|
+
/** Get the status of a dbt sync */
|
|
334
|
+
get: operations["DbtSyncPublicController.getDbtSyncStatus"];
|
|
335
|
+
put?: never;
|
|
336
|
+
post?: never;
|
|
337
|
+
/** Cancel a running dbt sync */
|
|
338
|
+
delete: operations["DbtSyncPublicController.cancelDbtSync"];
|
|
339
|
+
options?: never;
|
|
340
|
+
head?: never;
|
|
341
|
+
patch?: never;
|
|
342
|
+
trace?: never;
|
|
343
|
+
};
|
|
344
|
+
"/api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}/logs": {
|
|
345
|
+
parameters: {
|
|
346
|
+
query?: never;
|
|
347
|
+
header?: never;
|
|
348
|
+
path?: never;
|
|
349
|
+
cookie?: never;
|
|
350
|
+
};
|
|
351
|
+
/** Get the log of a dbt sync */
|
|
352
|
+
get: operations["DbtSyncPublicController.getDbtSyncLogs"];
|
|
353
|
+
put?: never;
|
|
354
|
+
post?: never;
|
|
355
|
+
delete?: never;
|
|
356
|
+
options?: never;
|
|
357
|
+
head?: never;
|
|
358
|
+
patch?: never;
|
|
359
|
+
trace?: never;
|
|
360
|
+
};
|
|
361
|
+
"/api/v1/deployments/{deploymentId}/dbt-sync/{syncJobId}/result": {
|
|
362
|
+
parameters: {
|
|
363
|
+
query?: never;
|
|
364
|
+
header?: never;
|
|
365
|
+
path?: never;
|
|
366
|
+
cookie?: never;
|
|
367
|
+
};
|
|
368
|
+
/** Get the result of a completed dbt sync */
|
|
369
|
+
get: operations["DbtSyncPublicController.getDbtSyncResult"];
|
|
370
|
+
put?: never;
|
|
371
|
+
post?: never;
|
|
372
|
+
delete?: never;
|
|
373
|
+
options?: never;
|
|
374
|
+
head?: never;
|
|
375
|
+
patch?: never;
|
|
376
|
+
trace?: never;
|
|
377
|
+
};
|
|
322
378
|
"/api/v1/deployments/{deploymentId}/env-vars": {
|
|
323
379
|
parameters: {
|
|
324
380
|
query?: never;
|
|
@@ -328,12 +384,12 @@ export interface paths {
|
|
|
328
384
|
};
|
|
329
385
|
/**
|
|
330
386
|
* Get env variables
|
|
331
|
-
* @description Lists the deployment environment variables
|
|
387
|
+
* @description Lists the deployment environment variables, cursor-paginated via `first`/`after`. Values of secret-named variables (containing PASS, SECRET, TOKEN, KEY, or CREDENTIAL) are returned as `[ENCRYPTED]`.
|
|
332
388
|
*/
|
|
333
389
|
get: operations["EnvVariablesPublicController.getEnvVariables"];
|
|
334
390
|
/**
|
|
335
391
|
* Set env variables
|
|
336
|
-
* @description Upserts deployment environment variables by name; variables not included keep their existing values. Passing the `[ENCRYPTED]` placeholder (the masked read value) is rejected — omit variables you do not intend to change.
|
|
392
|
+
* @description Upserts deployment environment variables by name; variables not included keep their existing values. Passing the `[ENCRYPTED]` placeholder (the masked read value) is rejected — omit variables you do not intend to change. New variable names must be POSIX identifiers (`^[A-Za-z_][A-Za-z0-9_]*$`); names already stored on the deployment may be resent unchanged so a legacy name can still be updated or removed.
|
|
337
393
|
*/
|
|
338
394
|
put: operations["EnvVariablesPublicController.setEnvVariables"];
|
|
339
395
|
post?: never;
|
|
@@ -628,7 +684,10 @@ export interface paths {
|
|
|
628
684
|
path?: never;
|
|
629
685
|
cookie?: never;
|
|
630
686
|
};
|
|
631
|
-
/**
|
|
687
|
+
/**
|
|
688
|
+
* List report folders
|
|
689
|
+
* @description List the report folders in a deployment, scoped to the folders the calling user can access, cursor-paginated via `first`/`after` (pass the previous response's `pageInfo.endCursor` as `after` to fetch the next page).
|
|
690
|
+
*/
|
|
632
691
|
get: operations["ReportsPublicController.getReportFolders"];
|
|
633
692
|
put?: never;
|
|
634
693
|
post?: never;
|
|
@@ -752,7 +811,36 @@ export interface paths {
|
|
|
752
811
|
*/
|
|
753
812
|
put: operations["ReportsPublicController.connectReportToWorkbook"];
|
|
754
813
|
post?: never;
|
|
755
|
-
|
|
814
|
+
/**
|
|
815
|
+
* Disconnect a report from one spot in a spreadsheet
|
|
816
|
+
* @description Remove a single placement of a report — one sheet + anchor in one
|
|
817
|
+
* spreadsheet — leaving every other placement, in this workbook and in others, alone.
|
|
818
|
+
*
|
|
819
|
+
* Address the placement by `placementId`, or (for placements recorded before ids
|
|
820
|
+
* existed) by `externalWorkbookId` plus `sheetName` and `anchorCell` — or a
|
|
821
|
+
* `resultLocation` naming both. Neither the sheet name nor the anchor is optional in
|
|
822
|
+
* that form: matching is by sheet + anchor, and a target missing either addresses
|
|
823
|
+
* nothing.
|
|
824
|
+
*
|
|
825
|
+
* `sheetId` is an optional extra, not a substitute for `sheetName`: a placement
|
|
826
|
+
* written before that field existed has only a name, and no id the server could
|
|
827
|
+
* resolve to it, so an id-only address would match nothing while looking correct.
|
|
828
|
+
*
|
|
829
|
+
* Send a `sheetId` only when you know it is the one the placement was stored with.
|
|
830
|
+
* It NARROWS the target — a placement recorded under a different id is not matched,
|
|
831
|
+
* even when the sheet name and anchor agree, because the stored name may belong to a
|
|
832
|
+
* tab that has since been renamed and the id is the only stable identity. If your id
|
|
833
|
+
* may have moved on (a tab deleted and recreated under the same name reports a new
|
|
834
|
+
* one), address the placement by `placementId`, or by sheet name with no
|
|
835
|
+
* `sheetId` at all.
|
|
836
|
+
*
|
|
837
|
+
* A target that matches no placement succeeds and changes nothing, so retrying is
|
|
838
|
+
* safe.
|
|
839
|
+
*
|
|
840
|
+
* Like connecting, this records nothing about the report's definition and so requires
|
|
841
|
+
* only read access: unplacing a report from your own sheet is not an edit to the report.
|
|
842
|
+
*/
|
|
843
|
+
delete: operations["ReportsPublicController.disconnectReportFromWorkbook"];
|
|
756
844
|
options?: never;
|
|
757
845
|
head?: never;
|
|
758
846
|
patch?: never;
|
|
@@ -775,6 +863,26 @@ export interface paths {
|
|
|
775
863
|
patch?: never;
|
|
776
864
|
trace?: never;
|
|
777
865
|
};
|
|
866
|
+
"/api/v1/deployments/{deploymentId}/settings": {
|
|
867
|
+
parameters: {
|
|
868
|
+
query?: never;
|
|
869
|
+
header?: never;
|
|
870
|
+
path?: never;
|
|
871
|
+
cookie?: never;
|
|
872
|
+
};
|
|
873
|
+
/**
|
|
874
|
+
* Get deployment settings
|
|
875
|
+
* @description Every setting of a deployment in one payload — the full contents of the console Settings pages (general, configuration flags, deploy, launchpad, Cube Store private storage), plus the read-only values displayed alongside them. Secrets are excluded; read environment variables through `/env-vars` instead. Writes go to `PUT /:deploymentId`, which accepts the same fields and returns this payload.
|
|
876
|
+
*/
|
|
877
|
+
get: operations["DeploymentsPublicController.getDeploymentSettings"];
|
|
878
|
+
put?: never;
|
|
879
|
+
post?: never;
|
|
880
|
+
delete?: never;
|
|
881
|
+
options?: never;
|
|
882
|
+
head?: never;
|
|
883
|
+
patch?: never;
|
|
884
|
+
trace?: never;
|
|
885
|
+
};
|
|
778
886
|
"/api/v1/deployments/{deploymentId}/shared-workspace": {
|
|
779
887
|
parameters: {
|
|
780
888
|
query?: never;
|
|
@@ -816,6 +924,26 @@ export interface paths {
|
|
|
816
924
|
patch?: never;
|
|
817
925
|
trace?: never;
|
|
818
926
|
};
|
|
927
|
+
"/api/v1/deployments/{deploymentId}/versions": {
|
|
928
|
+
parameters: {
|
|
929
|
+
query?: never;
|
|
930
|
+
header?: never;
|
|
931
|
+
path?: never;
|
|
932
|
+
cookie?: never;
|
|
933
|
+
};
|
|
934
|
+
/**
|
|
935
|
+
* List available Cube versions
|
|
936
|
+
* @description Every Cube version this deployment can be switched to — the same set the console’s version picker offers: the head of each release channel, plus the older versions the tenant has run before (its release history). Pass a listed `releaseChannelVersion` to `PUT /:deploymentId`; anything else is rejected. The container image is resolved server-side and is not part of the write surface.
|
|
937
|
+
*/
|
|
938
|
+
get: operations["DeploymentsPublicController.listDeploymentVersions"];
|
|
939
|
+
put?: never;
|
|
940
|
+
post?: never;
|
|
941
|
+
delete?: never;
|
|
942
|
+
options?: never;
|
|
943
|
+
head?: never;
|
|
944
|
+
patch?: never;
|
|
945
|
+
trace?: never;
|
|
946
|
+
};
|
|
819
947
|
"/api/v1/deployments/{deploymentId}/workbooks": {
|
|
820
948
|
parameters: {
|
|
821
949
|
query?: never;
|
|
@@ -909,23 +1037,6 @@ export interface paths {
|
|
|
909
1037
|
patch?: never;
|
|
910
1038
|
trace?: never;
|
|
911
1039
|
};
|
|
912
|
-
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread": {
|
|
913
|
-
parameters: {
|
|
914
|
-
query?: never;
|
|
915
|
-
header?: never;
|
|
916
|
-
path?: never;
|
|
917
|
-
cookie?: never;
|
|
918
|
-
};
|
|
919
|
-
get?: never;
|
|
920
|
-
put?: never;
|
|
921
|
-
/** Update published dashboard ai widget thread */
|
|
922
|
-
post: operations["WorkbooksPublicController.updatePublishedDashboardAiWidgetThread"];
|
|
923
|
-
delete?: never;
|
|
924
|
-
options?: never;
|
|
925
|
-
head?: never;
|
|
926
|
-
patch?: never;
|
|
927
|
-
trace?: never;
|
|
928
|
-
};
|
|
929
1040
|
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/duplicate": {
|
|
930
1041
|
parameters: {
|
|
931
1042
|
query?: never;
|
|
@@ -1269,6 +1380,32 @@ export interface paths {
|
|
|
1269
1380
|
patch?: never;
|
|
1270
1381
|
trace?: never;
|
|
1271
1382
|
};
|
|
1383
|
+
"/api/v1/embed-tenants/{embedTenantName}/user": {
|
|
1384
|
+
parameters: {
|
|
1385
|
+
query?: never;
|
|
1386
|
+
header?: never;
|
|
1387
|
+
path?: never;
|
|
1388
|
+
cookie?: never;
|
|
1389
|
+
};
|
|
1390
|
+
get?: never;
|
|
1391
|
+
put?: never;
|
|
1392
|
+
/**
|
|
1393
|
+
* Provision an embed user
|
|
1394
|
+
* @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.
|
|
1395
|
+
*
|
|
1396
|
+
* Creates or updates one embed user from the identity your own system knows. An embed user is otherwise created the first time they generate a session, so this is how an integration puts its own directory into Cube up front: a user provisioned here is immediately addressable — listable, searchable, assignable to groups, and selectable wherever the product offers a choice of users — before they have ever opened the embed.
|
|
1397
|
+
*
|
|
1398
|
+
* Idempotent, and the body is the desired state: provisioning an `externalId` that already exists updates it rather than failing. `email`, `userProfile.displayName` and `userProfile.picture` are overwritten when supplied and preserved when omitted; each group lane is REPLACED when supplied, preserved when omitted, and cleared by `[]`. The embed tenant itself is created on demand, so it need not exist yet.
|
|
1399
|
+
*
|
|
1400
|
+
* Everything set here is exactly what `generate-session` would have set, and a later session for the same `externalId` re-applies whatever it carries — so provisioning changes when a user exists, never what their session grants them.
|
|
1401
|
+
*/
|
|
1402
|
+
post: operations["EmbedTenantAdminPublicController.provisionEmbedUser"];
|
|
1403
|
+
delete?: never;
|
|
1404
|
+
options?: never;
|
|
1405
|
+
head?: never;
|
|
1406
|
+
patch?: never;
|
|
1407
|
+
trace?: never;
|
|
1408
|
+
};
|
|
1272
1409
|
"/api/v1/embed-tenants/{embedTenantName}/users": {
|
|
1273
1410
|
parameters: {
|
|
1274
1411
|
query?: never;
|
|
@@ -1284,7 +1421,19 @@ export interface paths {
|
|
|
1284
1421
|
*/
|
|
1285
1422
|
get: operations["EmbedTenantAdminPublicController.listEmbedUsers"];
|
|
1286
1423
|
put?: never;
|
|
1287
|
-
|
|
1424
|
+
/**
|
|
1425
|
+
* Provision embed users in bulk
|
|
1426
|
+
* @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.
|
|
1427
|
+
*
|
|
1428
|
+
* Provisions up to 100 embed users in one request, each exactly as `POST /embed-tenants/{embedTenantName}/user` would. Use it to load a user directory into an embed tenant, and send further requests to cover a directory larger than one batch.
|
|
1429
|
+
*
|
|
1430
|
+
* **This endpoint is partially successful.** It returns `200` whenever the request itself is well formed, and reports each user separately:
|
|
1431
|
+
* - `succeeded` — the users that were provisioned, in the order requested.
|
|
1432
|
+
* - `failed` — the entries that were not, each with the `externalId` and an `error` carrying the `status` and `message` the single-user endpoint would have returned (`400` for a group name that does not exist, `429` once the tenant is at its embed-user limit).
|
|
1433
|
+
*
|
|
1434
|
+
* Users are applied one at a time in the order given, and earlier ones are not rolled back when a later one fails. Since provisioning is idempotent, resending the whole batch after fixing the failures is safe. A repeated `externalId` within one batch is applied once per entry, so the last one wins.
|
|
1435
|
+
*/
|
|
1436
|
+
post: operations["EmbedTenantAdminPublicController.provisionEmbedUsers"];
|
|
1288
1437
|
delete?: never;
|
|
1289
1438
|
options?: never;
|
|
1290
1439
|
head?: never;
|
|
@@ -1587,25 +1736,41 @@ export interface paths {
|
|
|
1587
1736
|
path?: never;
|
|
1588
1737
|
cookie?: never;
|
|
1589
1738
|
};
|
|
1590
|
-
/**
|
|
1739
|
+
/**
|
|
1740
|
+
* List regions
|
|
1741
|
+
* @description Lists the regions available to the account, cursor-paginated via `first`/`after`. The legacy `data` field returns the full, unpaginated list and is deprecated — use `items` + `pageInfo` instead.
|
|
1742
|
+
*/
|
|
1591
1743
|
get: operations["RegionsPublicController.listRegions"];
|
|
1592
1744
|
put?: never;
|
|
1593
|
-
|
|
1745
|
+
/**
|
|
1746
|
+
* Create a region
|
|
1747
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1748
|
+
*
|
|
1749
|
+
* Creates the region, its provisioner stack and both Private APIs in one transaction, and returns immediately. **No cloud infrastructure exists yet** — the rows describe what will be built, and `POST /api/v1/regions/{regionId}/apply` is what builds it.
|
|
1750
|
+
*
|
|
1751
|
+
* The name is derived (`<cloudProvider>-<cloudProviderRegion>-t-<tenantId>[-<label>]`) and is unique, so one account can hold one region per cloud region per `label`. Repeating a create is rejected rather than silently returning the existing region.
|
|
1752
|
+
*/
|
|
1753
|
+
post: operations["RegionsPublicController.createRegion"];
|
|
1594
1754
|
delete?: never;
|
|
1595
1755
|
options?: never;
|
|
1596
1756
|
head?: never;
|
|
1597
1757
|
patch?: never;
|
|
1598
1758
|
trace?: never;
|
|
1599
1759
|
};
|
|
1600
|
-
"/api/v1/
|
|
1760
|
+
"/api/v1/regions/cloud-provider-catalog": {
|
|
1601
1761
|
parameters: {
|
|
1602
1762
|
query?: never;
|
|
1603
1763
|
header?: never;
|
|
1604
1764
|
path?: never;
|
|
1605
1765
|
cookie?: never;
|
|
1606
1766
|
};
|
|
1607
|
-
/**
|
|
1608
|
-
|
|
1767
|
+
/**
|
|
1768
|
+
* List the clouds and cloud regions a region can be provisioned in
|
|
1769
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1770
|
+
*
|
|
1771
|
+
* The accepted values for `cloudProvider` and `cloudProviderRegion` when creating a region — ask rather than guess, since an unsupported cloud region is rejected. `availabilityZones` is informational: the zones a region will span are allocated, not chosen.
|
|
1772
|
+
*/
|
|
1773
|
+
get: operations["RegionsPublicController.listCloudProviderCatalog"];
|
|
1609
1774
|
put?: never;
|
|
1610
1775
|
post?: never;
|
|
1611
1776
|
delete?: never;
|
|
@@ -1614,24 +1779,43 @@ export interface paths {
|
|
|
1614
1779
|
patch?: never;
|
|
1615
1780
|
trace?: never;
|
|
1616
1781
|
};
|
|
1617
|
-
"/api/v1/
|
|
1782
|
+
"/api/v1/regions/{regionId}": {
|
|
1618
1783
|
parameters: {
|
|
1619
1784
|
query?: never;
|
|
1620
1785
|
header?: never;
|
|
1621
1786
|
path?: never;
|
|
1622
1787
|
cookie?: never;
|
|
1623
1788
|
};
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
1789
|
+
/**
|
|
1790
|
+
* Get one region
|
|
1791
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1792
|
+
*
|
|
1793
|
+
* Answers `404` for a region another account owns — the same response as for a region that does not exist, so the API never confirms the existence of infrastructure belonging to someone else.
|
|
1794
|
+
*/
|
|
1795
|
+
get: operations["RegionsPublicController.getRegion"];
|
|
1796
|
+
/**
|
|
1797
|
+
* Update a region's title and path-based-routing overrides
|
|
1798
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1799
|
+
*
|
|
1800
|
+
* Only the fields present in the body are written; send an empty string on an override to clear it. The region's `name` is not editable — it is the prefix every cloud resource in the region is named from, so changing it would orphan infrastructure rather than rename it.
|
|
1801
|
+
*/
|
|
1802
|
+
put: operations["RegionsPublicController.updateRegion"];
|
|
1627
1803
|
post?: never;
|
|
1628
|
-
|
|
1804
|
+
/**
|
|
1805
|
+
* Destroy a region
|
|
1806
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1807
|
+
*
|
|
1808
|
+
* Queues a teardown of the whole region and returns a job to poll. **The region is not gone when this returns** — a destroy runs 15–25 minutes, and the rows disappear only when the job succeeds. Poll `GET /api/v1/regions/{regionId}/provisioning-status` until the provisioning status stops resolving or the run reaches a terminal state.
|
|
1809
|
+
*
|
|
1810
|
+
* `jobId` is `null` when there was nothing to enqueue — a repeat call while a teardown is already in flight, or a region already torn down. That is not an error, and it is not "never provisioned": a region that was never applied gets a real job.
|
|
1811
|
+
*/
|
|
1812
|
+
delete: operations["RegionsPublicController.destroyRegion"];
|
|
1629
1813
|
options?: never;
|
|
1630
1814
|
head?: never;
|
|
1631
1815
|
patch?: never;
|
|
1632
1816
|
trace?: never;
|
|
1633
1817
|
};
|
|
1634
|
-
"/api/v1/
|
|
1818
|
+
"/api/v1/regions/{regionId}/apply": {
|
|
1635
1819
|
parameters: {
|
|
1636
1820
|
query?: never;
|
|
1637
1821
|
header?: never;
|
|
@@ -1639,59 +1823,108 @@ export interface paths {
|
|
|
1639
1823
|
cookie?: never;
|
|
1640
1824
|
};
|
|
1641
1825
|
get?: never;
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
|
|
1826
|
+
put?: never;
|
|
1827
|
+
/**
|
|
1828
|
+
* Apply a region — build or converge its infrastructure
|
|
1829
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1830
|
+
*
|
|
1831
|
+
* Queues the run that reconciles the cloud with the intent recorded on the region, and returns a job to poll. Apply is what actually spends money, and it is idempotent in the Pulumi sense: running it on an unchanged region converges to the same state.
|
|
1832
|
+
*
|
|
1833
|
+
* Call it after creating a region, and again after any PrivateLink change — editing a PrivateLink records intent and touches nothing in AWS until the next apply.
|
|
1834
|
+
*/
|
|
1835
|
+
post: operations["RegionsPublicController.applyRegion"];
|
|
1645
1836
|
delete?: never;
|
|
1646
1837
|
options?: never;
|
|
1647
1838
|
head?: never;
|
|
1648
1839
|
patch?: never;
|
|
1649
1840
|
trace?: never;
|
|
1650
1841
|
};
|
|
1651
|
-
"/api/v1/
|
|
1842
|
+
"/api/v1/regions/{regionId}/private-links/": {
|
|
1652
1843
|
parameters: {
|
|
1653
1844
|
query?: never;
|
|
1654
1845
|
header?: never;
|
|
1655
1846
|
path?: never;
|
|
1656
1847
|
cookie?: never;
|
|
1657
1848
|
};
|
|
1658
|
-
/**
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
|
|
1849
|
+
/**
|
|
1850
|
+
* List a region's PrivateLinks
|
|
1851
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1852
|
+
*
|
|
1853
|
+
* Cursor-paginated via `first`/`after`. Each entry carries the `status` the row is in, not the state of AWS: a link edited since the last apply reports what was asked for.
|
|
1854
|
+
*
|
|
1855
|
+
* Answers `404` for a region another account owns.
|
|
1856
|
+
*/
|
|
1857
|
+
get: operations["RegionPrivateLinksPublicController.listPrivateLinks"];
|
|
1858
|
+
put?: never;
|
|
1859
|
+
/**
|
|
1860
|
+
* Create a PrivateLink
|
|
1861
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1862
|
+
*
|
|
1863
|
+
* Records the intent to open an endpoint into a service you publish. **Nothing is created in AWS until the next apply** — call `POST /api/v1/regions/{regionId}/apply` afterwards, and the row stays `pending` until that run reaches it.
|
|
1864
|
+
*
|
|
1865
|
+
* `ports` is required and must list at least one port: they become the ingress rules of the endpoint's security group, so an endpoint with none is one nothing in the region can reach.
|
|
1866
|
+
*
|
|
1867
|
+
* Expect `pending_acceptance` once the endpoint exists: the acceptance happens in **your own AWS account**, so that state is not a failure and not something Cube can clear. Accept the endpoint connection there and the status moves on.
|
|
1868
|
+
*/
|
|
1869
|
+
post: operations["RegionPrivateLinksPublicController.createPrivateLink"];
|
|
1663
1870
|
delete?: never;
|
|
1664
1871
|
options?: never;
|
|
1665
1872
|
head?: never;
|
|
1666
1873
|
patch?: never;
|
|
1667
1874
|
trace?: never;
|
|
1668
1875
|
};
|
|
1669
|
-
"/api/v1/
|
|
1876
|
+
"/api/v1/regions/{regionId}/private-links/{privateLinkId}": {
|
|
1670
1877
|
parameters: {
|
|
1671
1878
|
query?: never;
|
|
1672
1879
|
header?: never;
|
|
1673
1880
|
path?: never;
|
|
1674
1881
|
cookie?: never;
|
|
1675
1882
|
};
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1883
|
+
/**
|
|
1884
|
+
* Get one PrivateLink
|
|
1885
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1886
|
+
*
|
|
1887
|
+
* Answers `404` when the PrivateLink does not exist, or belongs to a different region than the one in the path — an id from another region is not silently honoured.
|
|
1888
|
+
*/
|
|
1889
|
+
get: operations["RegionPrivateLinksPublicController.getPrivateLink"];
|
|
1890
|
+
/**
|
|
1891
|
+
* Update a PrivateLink
|
|
1892
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1893
|
+
*
|
|
1894
|
+
* Every field is optional; only what is sent is written. Like the create, this changes intent and nothing else — the AWS endpoint follows on the next apply, which means a link can sit in a state that no longer matches this row until then.
|
|
1895
|
+
*/
|
|
1896
|
+
put: operations["RegionPrivateLinksPublicController.updatePrivateLink"];
|
|
1897
|
+
post?: never;
|
|
1898
|
+
/**
|
|
1899
|
+
* Mark a PrivateLink for removal
|
|
1900
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1901
|
+
*
|
|
1902
|
+
* Removes the PrivateLink — and **`pendingApply` says whether that is already finished**, so read it rather than assuming.
|
|
1903
|
+
*
|
|
1904
|
+
* `pendingApply: false` means the endpoint had never been realized in AWS, so the row was deleted outright and there is nothing left to do. `pendingApply: true` means a live VPC endpoint exists: the row moves to `deleting` and the endpoint disappears on the next apply. Neither answers `204 No Content`, because in the second case a response that read as "gone" would be wrong for however long that run takes.
|
|
1905
|
+
*/
|
|
1906
|
+
delete: operations["RegionPrivateLinksPublicController.removePrivateLink"];
|
|
1681
1907
|
options?: never;
|
|
1682
1908
|
head?: never;
|
|
1683
1909
|
patch?: never;
|
|
1684
1910
|
trace?: never;
|
|
1685
1911
|
};
|
|
1686
|
-
"/api/v1/
|
|
1912
|
+
"/api/v1/regions/{regionId}/provisioning-status": {
|
|
1687
1913
|
parameters: {
|
|
1688
1914
|
query?: never;
|
|
1689
1915
|
header?: never;
|
|
1690
1916
|
path?: never;
|
|
1691
1917
|
cookie?: never;
|
|
1692
1918
|
};
|
|
1693
|
-
/**
|
|
1694
|
-
|
|
1919
|
+
/**
|
|
1920
|
+
* The region's latest provisioning run
|
|
1921
|
+
* @description **🔒 Cube super admin only.** Requires Cube staff privileges — a tenant administrator cannot call this endpoint. It provisions or destroys real cloud infrastructure, which is why the bar is higher than for the rest of the API.
|
|
1922
|
+
*
|
|
1923
|
+
* The state of the most recent apply or destroy — this is the poll half of every write on this surface.
|
|
1924
|
+
*
|
|
1925
|
+
* Answers `204 No Content` when there is no run to report, which is a state and not an error: it means either that the region has never been applied, or that the provisioner does not manage it at all. The two are indistinguishable here by design; the run log and the engine diagnostics behind it are operator surfaces and are not exposed.
|
|
1926
|
+
*/
|
|
1927
|
+
get: operations["RegionsPublicController.getRegionProvisioningStatus"];
|
|
1695
1928
|
put?: never;
|
|
1696
1929
|
post?: never;
|
|
1697
1930
|
delete?: never;
|
|
@@ -1700,25 +1933,24 @@ export interface paths {
|
|
|
1700
1933
|
patch?: never;
|
|
1701
1934
|
trace?: never;
|
|
1702
1935
|
};
|
|
1703
|
-
"/api/v1/
|
|
1936
|
+
"/api/v1/resource-policies/": {
|
|
1704
1937
|
parameters: {
|
|
1705
1938
|
query?: never;
|
|
1706
1939
|
header?: never;
|
|
1707
1940
|
path?: never;
|
|
1708
1941
|
cookie?: never;
|
|
1709
1942
|
};
|
|
1710
|
-
/** Get
|
|
1711
|
-
get: operations["
|
|
1943
|
+
/** Get policies */
|
|
1944
|
+
get: operations["ResourcePoliciesPublicController.getPolicies"];
|
|
1712
1945
|
put?: never;
|
|
1713
|
-
|
|
1714
|
-
post: operations["UserAttributesPublicController.createUserAttribute"];
|
|
1946
|
+
post?: never;
|
|
1715
1947
|
delete?: never;
|
|
1716
1948
|
options?: never;
|
|
1717
1949
|
head?: never;
|
|
1718
1950
|
patch?: never;
|
|
1719
1951
|
trace?: never;
|
|
1720
1952
|
};
|
|
1721
|
-
"/api/v1/
|
|
1953
|
+
"/api/v1/resource-policies/group": {
|
|
1722
1954
|
parameters: {
|
|
1723
1955
|
query?: never;
|
|
1724
1956
|
header?: never;
|
|
@@ -1726,26 +1958,25 @@ export interface paths {
|
|
|
1726
1958
|
cookie?: never;
|
|
1727
1959
|
};
|
|
1728
1960
|
get?: never;
|
|
1729
|
-
/** Update
|
|
1730
|
-
put: operations["
|
|
1961
|
+
/** Update group policy */
|
|
1962
|
+
put: operations["ResourcePoliciesPublicController.updateGroupPolicy"];
|
|
1731
1963
|
post?: never;
|
|
1732
|
-
|
|
1733
|
-
delete: operations["UserAttributesPublicController.deleteUserAttribute"];
|
|
1964
|
+
delete?: never;
|
|
1734
1965
|
options?: never;
|
|
1735
1966
|
head?: never;
|
|
1736
1967
|
patch?: never;
|
|
1737
1968
|
trace?: never;
|
|
1738
1969
|
};
|
|
1739
|
-
"/api/v1/
|
|
1970
|
+
"/api/v1/resource-policies/user": {
|
|
1740
1971
|
parameters: {
|
|
1741
1972
|
query?: never;
|
|
1742
1973
|
header?: never;
|
|
1743
1974
|
path?: never;
|
|
1744
1975
|
cookie?: never;
|
|
1745
1976
|
};
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
put
|
|
1977
|
+
get?: never;
|
|
1978
|
+
/** Update user policy */
|
|
1979
|
+
put: operations["ResourcePoliciesPublicController.updateUserPolicy"];
|
|
1749
1980
|
post?: never;
|
|
1750
1981
|
delete?: never;
|
|
1751
1982
|
options?: never;
|
|
@@ -1753,15 +1984,18 @@ export interface paths {
|
|
|
1753
1984
|
patch?: never;
|
|
1754
1985
|
trace?: never;
|
|
1755
1986
|
};
|
|
1756
|
-
"/api/v1/
|
|
1987
|
+
"/api/v1/spec": {
|
|
1757
1988
|
parameters: {
|
|
1758
1989
|
query?: never;
|
|
1759
1990
|
header?: never;
|
|
1760
1991
|
path?: never;
|
|
1761
1992
|
cookie?: never;
|
|
1762
1993
|
};
|
|
1763
|
-
/**
|
|
1764
|
-
|
|
1994
|
+
/**
|
|
1995
|
+
* Get the OpenAPI specification
|
|
1996
|
+
* @description The full OpenAPI 3.1 document for this API, as served by the build handling the request — every path, parameter, request body and schema. Intended for runtime discovery by clients and agents; `cube spec` wraps it with filtering.
|
|
1997
|
+
*/
|
|
1998
|
+
get: operations["OpenApiSpecPublicController.getSpec"];
|
|
1765
1999
|
put?: never;
|
|
1766
2000
|
post?: never;
|
|
1767
2001
|
delete?: never;
|
|
@@ -1770,25 +2004,25 @@ export interface paths {
|
|
|
1770
2004
|
patch?: never;
|
|
1771
2005
|
trace?: never;
|
|
1772
2006
|
};
|
|
1773
|
-
"/api/v1/
|
|
2007
|
+
"/api/v1/tenant/settings": {
|
|
1774
2008
|
parameters: {
|
|
1775
2009
|
query?: never;
|
|
1776
2010
|
header?: never;
|
|
1777
2011
|
path?: never;
|
|
1778
2012
|
cookie?: never;
|
|
1779
2013
|
};
|
|
1780
|
-
/** Get
|
|
1781
|
-
get: operations["
|
|
1782
|
-
|
|
2014
|
+
/** Get tenant settings */
|
|
2015
|
+
get: operations["TenantSettingsPublicController.getTenantSettings"];
|
|
2016
|
+
/** Update tenant settings */
|
|
2017
|
+
put: operations["TenantSettingsPublicController.updateTenantSettings"];
|
|
1783
2018
|
post?: never;
|
|
1784
|
-
|
|
1785
|
-
delete: operations["UserOAuthTokensPublicController.revokeUserOAuthToken"];
|
|
2019
|
+
delete?: never;
|
|
1786
2020
|
options?: never;
|
|
1787
2021
|
head?: never;
|
|
1788
2022
|
patch?: never;
|
|
1789
2023
|
trace?: never;
|
|
1790
2024
|
};
|
|
1791
|
-
"/api/v1/
|
|
2025
|
+
"/api/v1/usage-analytics/token": {
|
|
1792
2026
|
parameters: {
|
|
1793
2027
|
query?: never;
|
|
1794
2028
|
header?: never;
|
|
@@ -1797,22 +2031,181 @@ export interface paths {
|
|
|
1797
2031
|
};
|
|
1798
2032
|
get?: never;
|
|
1799
2033
|
put?: never;
|
|
1800
|
-
/**
|
|
1801
|
-
|
|
2034
|
+
/**
|
|
2035
|
+
* Issue a Cube API token for Usage Analytics
|
|
2036
|
+
* @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.
|
|
2037
|
+
*
|
|
2038
|
+
* Issues a short-lived Cube API token for Cube's internal **Usage Analytics** deployment — the data shown on **Admin → Usage Analytics** — so you can query your own usage and billing data programmatically (REST API, BI tools, scripts) instead of only through the embedded page.
|
|
2039
|
+
*
|
|
2040
|
+
* The token is scoped to your account: it carries the same server-resolved security context as the embedded Usage Analytics page, so queries only ever see your own data. Send it as `Authorization: Bearer <token>` on requests to the returned `apiUrl` (the deployment's [Cube REST API](https://cube.dev/docs/product/apis-integrations/rest-api)).
|
|
2041
|
+
*
|
|
2042
|
+
* Tokens expire after ~24 hours (see `expiresAt`). Issue a fresh one per session or scheduled refresh — issuing is idempotent and cheap.
|
|
2043
|
+
*
|
|
2044
|
+
* Requires Usage Analytics to be enabled for the account, otherwise `404` is returned.
|
|
2045
|
+
*/
|
|
2046
|
+
post: operations["UsageAnalyticsPublicController.createToken"];
|
|
1802
2047
|
delete?: never;
|
|
1803
2048
|
options?: never;
|
|
1804
2049
|
head?: never;
|
|
1805
2050
|
patch?: never;
|
|
1806
2051
|
trace?: never;
|
|
1807
2052
|
};
|
|
1808
|
-
"/api/v1/
|
|
2053
|
+
"/api/v1/user-attribute-values/": {
|
|
1809
2054
|
parameters: {
|
|
1810
2055
|
query?: never;
|
|
1811
2056
|
header?: never;
|
|
1812
2057
|
path?: never;
|
|
1813
2058
|
cookie?: never;
|
|
1814
2059
|
};
|
|
1815
|
-
|
|
2060
|
+
get?: never;
|
|
2061
|
+
put?: never;
|
|
2062
|
+
/** Upsert user attribute value */
|
|
2063
|
+
post: operations["UserAttributeValuesPublicController.upsertUserAttributeValue"];
|
|
2064
|
+
delete?: never;
|
|
2065
|
+
options?: never;
|
|
2066
|
+
head?: never;
|
|
2067
|
+
patch?: never;
|
|
2068
|
+
trace?: never;
|
|
2069
|
+
};
|
|
2070
|
+
"/api/v1/user-attribute-values/{userId}": {
|
|
2071
|
+
parameters: {
|
|
2072
|
+
query?: never;
|
|
2073
|
+
header?: never;
|
|
2074
|
+
path?: never;
|
|
2075
|
+
cookie?: never;
|
|
2076
|
+
};
|
|
2077
|
+
/** Get user attribute values */
|
|
2078
|
+
get: operations["UserAttributeValuesPublicController.getUserAttributeValues"];
|
|
2079
|
+
put?: never;
|
|
2080
|
+
post?: never;
|
|
2081
|
+
delete?: never;
|
|
2082
|
+
options?: never;
|
|
2083
|
+
head?: never;
|
|
2084
|
+
patch?: never;
|
|
2085
|
+
trace?: never;
|
|
2086
|
+
};
|
|
2087
|
+
"/api/v1/user-attributes/": {
|
|
2088
|
+
parameters: {
|
|
2089
|
+
query?: never;
|
|
2090
|
+
header?: never;
|
|
2091
|
+
path?: never;
|
|
2092
|
+
cookie?: never;
|
|
2093
|
+
};
|
|
2094
|
+
/**
|
|
2095
|
+
* Get user attributes
|
|
2096
|
+
* @description List user attributes, newest first, cursor-paginated via `first`/`after`. The legacy `offset`/`limit` query params and the `data`/`count` response fields are deprecated — use `items` + `pageInfo` instead.
|
|
2097
|
+
*/
|
|
2098
|
+
get: operations["UserAttributesPublicController.getUserAttributes"];
|
|
2099
|
+
put?: never;
|
|
2100
|
+
/** Create user attribute */
|
|
2101
|
+
post: operations["UserAttributesPublicController.createUserAttribute"];
|
|
2102
|
+
delete?: never;
|
|
2103
|
+
options?: never;
|
|
2104
|
+
head?: never;
|
|
2105
|
+
patch?: never;
|
|
2106
|
+
trace?: never;
|
|
2107
|
+
};
|
|
2108
|
+
"/api/v1/user-attributes/{id}": {
|
|
2109
|
+
parameters: {
|
|
2110
|
+
query?: never;
|
|
2111
|
+
header?: never;
|
|
2112
|
+
path?: never;
|
|
2113
|
+
cookie?: never;
|
|
2114
|
+
};
|
|
2115
|
+
get?: never;
|
|
2116
|
+
/** Update user attribute */
|
|
2117
|
+
put: operations["UserAttributesPublicController.updateUserAttribute"];
|
|
2118
|
+
post?: never;
|
|
2119
|
+
/** Delete user attribute */
|
|
2120
|
+
delete: operations["UserAttributesPublicController.deleteUserAttribute"];
|
|
2121
|
+
options?: never;
|
|
2122
|
+
head?: never;
|
|
2123
|
+
patch?: never;
|
|
2124
|
+
trace?: never;
|
|
2125
|
+
};
|
|
2126
|
+
"/api/v1/user-groups/": {
|
|
2127
|
+
parameters: {
|
|
2128
|
+
query?: never;
|
|
2129
|
+
header?: never;
|
|
2130
|
+
path?: never;
|
|
2131
|
+
cookie?: never;
|
|
2132
|
+
};
|
|
2133
|
+
/**
|
|
2134
|
+
* List groups
|
|
2135
|
+
* @description List user groups, newest first, cursor-paginated via `first`/`after`. Pass `search` for a case-insensitive substring match on the group name — pickers must use it rather than filtering a single page client-side, which cannot reach groups beyond the first page on tenants with many groups.
|
|
2136
|
+
*/
|
|
2137
|
+
get: operations["UserGroupsPublicController.listGroups"];
|
|
2138
|
+
put?: never;
|
|
2139
|
+
post?: never;
|
|
2140
|
+
delete?: never;
|
|
2141
|
+
options?: never;
|
|
2142
|
+
head?: never;
|
|
2143
|
+
patch?: never;
|
|
2144
|
+
trace?: never;
|
|
2145
|
+
};
|
|
2146
|
+
"/api/v1/user-oauth-tokens/": {
|
|
2147
|
+
parameters: {
|
|
2148
|
+
query?: never;
|
|
2149
|
+
header?: never;
|
|
2150
|
+
path?: never;
|
|
2151
|
+
cookie?: never;
|
|
2152
|
+
};
|
|
2153
|
+
/** List user o auth tokens */
|
|
2154
|
+
get: operations["UserOAuthTokensPublicController.listUserOAuthTokens"];
|
|
2155
|
+
put?: never;
|
|
2156
|
+
post?: never;
|
|
2157
|
+
delete?: never;
|
|
2158
|
+
options?: never;
|
|
2159
|
+
head?: never;
|
|
2160
|
+
patch?: never;
|
|
2161
|
+
trace?: never;
|
|
2162
|
+
};
|
|
2163
|
+
"/api/v1/user-oauth-tokens/{integrationId}": {
|
|
2164
|
+
parameters: {
|
|
2165
|
+
query?: never;
|
|
2166
|
+
header?: never;
|
|
2167
|
+
path?: never;
|
|
2168
|
+
cookie?: never;
|
|
2169
|
+
};
|
|
2170
|
+
/** Get user o auth token */
|
|
2171
|
+
get: operations["UserOAuthTokensPublicController.getUserOAuthToken"];
|
|
2172
|
+
put?: never;
|
|
2173
|
+
post?: never;
|
|
2174
|
+
/** Revoke user o auth token */
|
|
2175
|
+
delete: operations["UserOAuthTokensPublicController.revokeUserOAuthToken"];
|
|
2176
|
+
options?: never;
|
|
2177
|
+
head?: never;
|
|
2178
|
+
patch?: never;
|
|
2179
|
+
trace?: never;
|
|
2180
|
+
};
|
|
2181
|
+
"/api/v1/user-oauth-tokens/{integrationId}/initiate": {
|
|
2182
|
+
parameters: {
|
|
2183
|
+
query?: never;
|
|
2184
|
+
header?: never;
|
|
2185
|
+
path?: never;
|
|
2186
|
+
cookie?: never;
|
|
2187
|
+
};
|
|
2188
|
+
get?: never;
|
|
2189
|
+
put?: never;
|
|
2190
|
+
/** Initiate o auth flow */
|
|
2191
|
+
post: operations["UserOAuthTokensPublicController.initiateOAuthFlow"];
|
|
2192
|
+
delete?: never;
|
|
2193
|
+
options?: never;
|
|
2194
|
+
head?: never;
|
|
2195
|
+
patch?: never;
|
|
2196
|
+
trace?: never;
|
|
2197
|
+
};
|
|
2198
|
+
"/api/v1/users/": {
|
|
2199
|
+
parameters: {
|
|
2200
|
+
query?: never;
|
|
2201
|
+
header?: never;
|
|
2202
|
+
path?: never;
|
|
2203
|
+
cookie?: never;
|
|
2204
|
+
};
|
|
2205
|
+
/**
|
|
2206
|
+
* Get users
|
|
2207
|
+
* @description List users, newest first, cursor-paginated via `first`/`after`. Pass `search` for a case-insensitive substring match on first name, username or email — pickers must use it rather than filtering a single page client-side, which cannot reach users beyond the first page on large tenants.
|
|
2208
|
+
*/
|
|
1816
2209
|
get: operations["UsersPublicController.getUsers"];
|
|
1817
2210
|
put?: never;
|
|
1818
2211
|
/** Create user */
|
|
@@ -1945,6 +2338,34 @@ export interface paths {
|
|
|
1945
2338
|
put?: never;
|
|
1946
2339
|
/** Create a branch (optionally entering dev mode on it) */
|
|
1947
2340
|
post: operations["DataModelPublicController.createBranch"];
|
|
2341
|
+
/**
|
|
2342
|
+
* Delete a branch
|
|
2343
|
+
* @description Deletes the branch and its git ref — the API-side counterpart of pruning a branch in Cube Cloud, for callers that create branches per run (a CI job syncing dbt on every pull request, say) and would otherwise accumulate them forever. Child branches are re-parented onto the deleted branch’s own parent, and anyone viewing the branch in dev mode is moved back to the default branch, so a branch that is currently open is deleted rather than refused. The deploy branch cannot be deleted (400) and an unknown branch is a 404.
|
|
2344
|
+
*
|
|
2345
|
+
* `removeOnUpstream=true` additionally deletes the branch on the connected git provider (GitHub/GitLab). It defaults to `false`, so by default the branch is removed from Cube Cloud only and the ref on your own remote is left alone — a CI job cleaning up branches it created itself should opt in explicitly.
|
|
2346
|
+
*
|
|
2347
|
+
* `branchName` is a query parameter rather than a path segment because branch names contain slashes (`dbt-sync/main-20260817120000-a1b2c3d4`).
|
|
2348
|
+
*/
|
|
2349
|
+
delete: operations["DataModelPublicController.removeBranch"];
|
|
2350
|
+
options?: never;
|
|
2351
|
+
head?: never;
|
|
2352
|
+
patch?: never;
|
|
2353
|
+
trace?: never;
|
|
2354
|
+
};
|
|
2355
|
+
"/build/api/v1/deployments/{deploymentId}/branches/staging-environment": {
|
|
2356
|
+
parameters: {
|
|
2357
|
+
query?: never;
|
|
2358
|
+
header?: never;
|
|
2359
|
+
path?: never;
|
|
2360
|
+
cookie?: never;
|
|
2361
|
+
};
|
|
2362
|
+
get?: never;
|
|
2363
|
+
/**
|
|
2364
|
+
* Enable or disable a branch’s staging environment
|
|
2365
|
+
* @description Enabling a branch keeps its staging environment always active and accessible at `<deploymentUrl>/dev-mode/{branchName}/cubejs-api/v1`; disabled (the default) it is only active while the branch is viewed in Cube Cloud. Enabled branches are the ones listed by `GET /api/v1/deployments/{deploymentId}/environments?type=staging`. Only shared branches qualify — personal dev branches and the deploy branch are rejected.
|
|
2366
|
+
*/
|
|
2367
|
+
put: operations["DataModelPublicController.setBranchStagingEnvironment"];
|
|
2368
|
+
post?: never;
|
|
1948
2369
|
delete?: never;
|
|
1949
2370
|
options?: never;
|
|
1950
2371
|
head?: never;
|
|
@@ -1992,7 +2413,10 @@ export interface paths {
|
|
|
1992
2413
|
path?: never;
|
|
1993
2414
|
cookie?: never;
|
|
1994
2415
|
};
|
|
1995
|
-
/**
|
|
2416
|
+
/**
|
|
2417
|
+
* List the data-model source files for a deployment
|
|
2418
|
+
* @description Returns the data-model file tree. `first`/`after` (from the shared cursor params) paginate the **top-level** tree nodes only — a single node can carry a large subtree, so this bounds the number of roots returned, not the total file count. Omit `first` to get the whole tree.
|
|
2419
|
+
*/
|
|
1996
2420
|
get: operations["DataModelPublicController.listFiles"];
|
|
1997
2421
|
/** Create or overwrite data-model source files */
|
|
1998
2422
|
put: operations["DataModelPublicController.updateFiles"];
|
|
@@ -2072,6 +2496,26 @@ export interface paths {
|
|
|
2072
2496
|
patch?: never;
|
|
2073
2497
|
trace?: never;
|
|
2074
2498
|
};
|
|
2499
|
+
"/build/api/v1/deployments/{deploymentId}/data-model/validate": {
|
|
2500
|
+
parameters: {
|
|
2501
|
+
query?: never;
|
|
2502
|
+
header?: never;
|
|
2503
|
+
path?: never;
|
|
2504
|
+
cookie?: never;
|
|
2505
|
+
};
|
|
2506
|
+
/**
|
|
2507
|
+
* Compile a deployment's data model and report compilation errors
|
|
2508
|
+
* @description Asks the branch's own Cube runtime for `GET /cubejs-api/v1/meta` — the same call the console makes in dev mode — so the verdict is the one that branch's API would give. With neither parameter it validates the deploy branch (production). `branchName` validates a named branch, and `devMode=true` validates the caller's active dev-mode branch; the two are mutually exclusive. Answers 200 with `valid: false` and the compiler's errors when the model doesn't compile — a broken model is a result, not a request error.
|
|
2509
|
+
*/
|
|
2510
|
+
get: operations["DataModelPublicController.validateDataModel"];
|
|
2511
|
+
put?: never;
|
|
2512
|
+
post?: never;
|
|
2513
|
+
delete?: never;
|
|
2514
|
+
options?: never;
|
|
2515
|
+
head?: never;
|
|
2516
|
+
patch?: never;
|
|
2517
|
+
trace?: never;
|
|
2518
|
+
};
|
|
2075
2519
|
"/build/api/v1/deployments/{deploymentId}/dev-mode": {
|
|
2076
2520
|
parameters: {
|
|
2077
2521
|
query?: never;
|
|
@@ -2171,9 +2615,12 @@ export interface components {
|
|
|
2171
2615
|
agentsConfigCredentials?: components["schemas"]["AIEngineerCubeCredentialsDTO"] | null;
|
|
2172
2616
|
chatThreadPolicies?: components["schemas"]["ChatThreadPolicy"][] | null;
|
|
2173
2617
|
cubeCredentials?: components["schemas"]["AIEngineerCubeCredentialsDTO"] | null;
|
|
2618
|
+
deployBranchName?: string | null;
|
|
2174
2619
|
graphqlToken?: string | null;
|
|
2175
2620
|
hasAgentAccess?: any | null;
|
|
2176
2621
|
mcpToken?: string | null;
|
|
2622
|
+
resolvedTimezone?: string | null;
|
|
2623
|
+
timezoneSettings?: components["schemas"]["TimezoneSettings"] | null;
|
|
2177
2624
|
token: string;
|
|
2178
2625
|
url: string;
|
|
2179
2626
|
};
|
|
@@ -2243,12 +2690,14 @@ export interface components {
|
|
|
2243
2690
|
createdAt?: (string) | null;
|
|
2244
2691
|
id: number;
|
|
2245
2692
|
name?: string | null;
|
|
2693
|
+
scopeDeploymentId?: number | null;
|
|
2246
2694
|
spaceConfigName?: string | null;
|
|
2247
2695
|
updatedAt?: (string) | null;
|
|
2248
2696
|
userId?: number | null;
|
|
2249
2697
|
};
|
|
2250
2698
|
AgentSpaceConfigDto: {
|
|
2251
2699
|
name?: string | null;
|
|
2700
|
+
scopeDeploymentId?: number | null;
|
|
2252
2701
|
spaceConfigName?: string | null;
|
|
2253
2702
|
};
|
|
2254
2703
|
AppConfigResponse: {
|
|
@@ -2257,6 +2706,7 @@ export interface components {
|
|
|
2257
2706
|
creatorMode?: components["schemas"]["CreatorMode"] | null;
|
|
2258
2707
|
embedding?: components["schemas"]["EmbedSettings"] | null;
|
|
2259
2708
|
sheetsUi?: components["schemas"]["SheetsUiSettings"] | null;
|
|
2709
|
+
timezoneSettings?: components["schemas"]["TimezoneSettings"] | null;
|
|
2260
2710
|
};
|
|
2261
2711
|
AppTheme: {
|
|
2262
2712
|
dark: components["schemas"]["AppThemeScheme"];
|
|
@@ -2287,12 +2737,19 @@ export interface components {
|
|
|
2287
2737
|
};
|
|
2288
2738
|
BranchResponse: {
|
|
2289
2739
|
id: number;
|
|
2740
|
+
isStagingEnvironmentEnabled?: boolean | null;
|
|
2290
2741
|
lastHash?: string | null;
|
|
2291
2742
|
name: string;
|
|
2292
2743
|
parentBranch?: string | null;
|
|
2293
2744
|
};
|
|
2294
2745
|
BranchesListResponse: {
|
|
2746
|
+
/**
|
|
2747
|
+
* @deprecated
|
|
2748
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
2749
|
+
*/
|
|
2295
2750
|
data: components["schemas"]["BranchResponse"][];
|
|
2751
|
+
items: components["schemas"]["BranchResponse"][];
|
|
2752
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
2296
2753
|
};
|
|
2297
2754
|
BuildStatusResponse: {
|
|
2298
2755
|
branchName: string;
|
|
@@ -2372,10 +2829,18 @@ export interface components {
|
|
|
2372
2829
|
private?: boolean | null;
|
|
2373
2830
|
};
|
|
2374
2831
|
ConnectReportToWorkbookInput: {
|
|
2832
|
+
anchorCell?: string | null;
|
|
2375
2833
|
endResultCell?: string | null;
|
|
2376
2834
|
externalWorkbookId: string;
|
|
2835
|
+
host?: components["schemas"]["ConnectReportToWorkbookInputHost"] | null;
|
|
2836
|
+
placementId?: string | null;
|
|
2377
2837
|
resultLocation: string;
|
|
2838
|
+
sheetId?: string | null;
|
|
2839
|
+
sheetName?: string | null;
|
|
2840
|
+
workbookName?: string | null;
|
|
2378
2841
|
};
|
|
2842
|
+
/** @enum {string} */
|
|
2843
|
+
ConnectReportToWorkbookInputHost: "GOOGLE_SHEETS" | "EXCEL";
|
|
2379
2844
|
ControlThemeBorderSectionInput: {
|
|
2380
2845
|
color?: string | null;
|
|
2381
2846
|
radius?: string | null;
|
|
@@ -2441,6 +2906,7 @@ export interface components {
|
|
|
2441
2906
|
filters?: components["schemas"]["DashboardFilterInput"][] | null;
|
|
2442
2907
|
hour?: number | null;
|
|
2443
2908
|
minute?: number | null;
|
|
2909
|
+
notificationAiSummary?: boolean | null;
|
|
2444
2910
|
notificationEnabled?: boolean | null;
|
|
2445
2911
|
notificationFormat?: components["schemas"]["CreateNotificationInputNotificationFormat"] | null;
|
|
2446
2912
|
scheduleType: components["schemas"]["CreateNotificationInputScheduleType"];
|
|
@@ -2480,6 +2946,7 @@ export interface components {
|
|
|
2480
2946
|
endResultCell?: string | null;
|
|
2481
2947
|
externalWorkbookId?: string | null;
|
|
2482
2948
|
folderId?: number | null;
|
|
2949
|
+
host?: components["schemas"]["CreateReportInputHost"] | null;
|
|
2483
2950
|
jsonQuery?: string | null;
|
|
2484
2951
|
meta?: {
|
|
2485
2952
|
[key: string]: any;
|
|
@@ -2488,12 +2955,16 @@ export interface components {
|
|
|
2488
2955
|
pivotItems?: components["schemas"]["PivotItemsInput"] | null;
|
|
2489
2956
|
publicId?: string | null;
|
|
2490
2957
|
resultLocation?: string | null;
|
|
2958
|
+
sheetId?: string | null;
|
|
2491
2959
|
source?: components["schemas"]["CreateReportInputSource"] | null;
|
|
2492
2960
|
sqlQuery?: string | null;
|
|
2493
2961
|
title?: string | null;
|
|
2494
2962
|
workbookId?: number | null;
|
|
2963
|
+
workbookName?: string | null;
|
|
2495
2964
|
};
|
|
2496
2965
|
/** @enum {string} */
|
|
2966
|
+
CreateReportInputHost: "GOOGLE_SHEETS" | "EXCEL";
|
|
2967
|
+
/** @enum {string} */
|
|
2497
2968
|
CreateReportInputSource: "GOOGLE_SHEETS" | "EXCEL" | "PLAYGROUND" | "D3";
|
|
2498
2969
|
CreateWorkbookInput: {
|
|
2499
2970
|
folderId?: number | null;
|
|
@@ -2511,6 +2982,21 @@ export interface components {
|
|
|
2511
2982
|
showWorkspaceTitle?: boolean | null;
|
|
2512
2983
|
workspaceTitle?: string | null;
|
|
2513
2984
|
};
|
|
2985
|
+
CspsConfig: {
|
|
2986
|
+
awsRoleArn?: string | null;
|
|
2987
|
+
azureClientId?: string | null;
|
|
2988
|
+
azureContainer?: string | null;
|
|
2989
|
+
azureStorageAccount?: string | null;
|
|
2990
|
+
azureTenantId?: string | null;
|
|
2991
|
+
enabled: boolean;
|
|
2992
|
+
gcpServiceAccountEmail?: string | null;
|
|
2993
|
+
gcpWorkloadIdentityProvider?: string | null;
|
|
2994
|
+
gcsBucket?: string | null;
|
|
2995
|
+
s3Bucket?: string | null;
|
|
2996
|
+
s3Region?: string | null;
|
|
2997
|
+
s3Sse?: string | null;
|
|
2998
|
+
storageProvider: string;
|
|
2999
|
+
};
|
|
2514
3000
|
CspsConfigInput: {
|
|
2515
3001
|
awsRoleArn?: string | null;
|
|
2516
3002
|
azureClientId?: string | null;
|
|
@@ -2658,9 +3144,9 @@ export interface components {
|
|
|
2658
3144
|
value?: (string | number | boolean | unknown[]) | null;
|
|
2659
3145
|
};
|
|
2660
3146
|
/** @enum {string} */
|
|
2661
|
-
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" | "between" | "custom";
|
|
3147
|
+
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";
|
|
2662
3148
|
/** @enum {string} */
|
|
2663
|
-
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" | "between" | "custom";
|
|
3149
|
+
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";
|
|
2664
3150
|
DashboardLayout: {
|
|
2665
3151
|
breakpoints?: components["schemas"]["DashboardBreakpoints"] | null;
|
|
2666
3152
|
cols?: components["schemas"]["DashboardBreakpointCols"] | null;
|
|
@@ -2725,7 +3211,7 @@ export interface components {
|
|
|
2725
3211
|
type: components["schemas"]["DashboardWidgetDtoType"];
|
|
2726
3212
|
};
|
|
2727
3213
|
/** @enum {string} */
|
|
2728
|
-
DashboardWidgetDtoType: "CHART" | "TEXT" | "FILTER" | "AI" | "
|
|
3214
|
+
DashboardWidgetDtoType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
|
|
2729
3215
|
DashboardWidgetInput: {
|
|
2730
3216
|
config?: {
|
|
2731
3217
|
[key: string]: any;
|
|
@@ -2739,7 +3225,7 @@ export interface components {
|
|
|
2739
3225
|
type: components["schemas"]["DashboardWidgetInputType"];
|
|
2740
3226
|
};
|
|
2741
3227
|
/** @enum {string} */
|
|
2742
|
-
DashboardWidgetInputType: "CHART" | "TEXT" | "FILTER" | "AI" | "
|
|
3228
|
+
DashboardWidgetInputType: "CHART" | "TEXT" | "FILTER" | "AI" | "TIME_GRAIN" | "PARENT" | "SPACER" | "DIVIDER" | "CONTAINER";
|
|
2743
3229
|
DashboardWidgetPosition: {
|
|
2744
3230
|
h: number;
|
|
2745
3231
|
w: number;
|
|
@@ -2763,14 +3249,135 @@ export interface components {
|
|
|
2763
3249
|
newPath: string;
|
|
2764
3250
|
path: string;
|
|
2765
3251
|
};
|
|
3252
|
+
DataModelValidationError: {
|
|
3253
|
+
fileName?: string | null;
|
|
3254
|
+
message: string;
|
|
3255
|
+
};
|
|
3256
|
+
DataModelValidationResponse: {
|
|
3257
|
+
branchName: string;
|
|
3258
|
+
cubesCount?: number | null;
|
|
3259
|
+
deploymentId: number;
|
|
3260
|
+
errors: components["schemas"]["DataModelValidationError"][];
|
|
3261
|
+
mode: components["schemas"]["DataModelValidationResponseMode"];
|
|
3262
|
+
valid: boolean;
|
|
3263
|
+
};
|
|
3264
|
+
/** @enum {string} */
|
|
3265
|
+
DataModelValidationResponseMode: "production" | "dev_mode";
|
|
2766
3266
|
DataModelWriteResponse: {
|
|
2767
3267
|
success: boolean;
|
|
2768
3268
|
};
|
|
3269
|
+
DbtSyncCancelResponse: {
|
|
3270
|
+
message: string;
|
|
3271
|
+
};
|
|
3272
|
+
DbtSyncGeneratedFile: {
|
|
3273
|
+
/** @description Path of the generated file within the data model project. */
|
|
3274
|
+
path: string;
|
|
3275
|
+
};
|
|
3276
|
+
DbtSyncLogEntriesListResponse: {
|
|
3277
|
+
items: components["schemas"]["DbtSyncLogEntry"][];
|
|
3278
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
3279
|
+
};
|
|
3280
|
+
DbtSyncLogEntry: {
|
|
3281
|
+
durationMs?: number | null;
|
|
3282
|
+
/** @description info or error. */
|
|
3283
|
+
level: string;
|
|
3284
|
+
message: string;
|
|
3285
|
+
phase?: string | null;
|
|
3286
|
+
/** @description Always "system" in this version. "stdout" and "stderr" join it once dbt’s own output is captured, so treat this as an open set. */
|
|
3287
|
+
stream: string;
|
|
3288
|
+
/** @description When the line was produced, as an ISO 8601 timestamp. */
|
|
3289
|
+
timestamp: string;
|
|
3290
|
+
};
|
|
3291
|
+
DbtSyncManifestStats: {
|
|
3292
|
+
macros: number;
|
|
3293
|
+
models: number;
|
|
3294
|
+
sources: number;
|
|
3295
|
+
};
|
|
3296
|
+
DbtSyncProgress: {
|
|
3297
|
+
message?: string | null;
|
|
3298
|
+
/** @description Rough completion percentage derived from the stage. Progress reporting only — do not gate on it; gate on the status reaching COMPLETED or FAILED. */
|
|
3299
|
+
percentComplete: number;
|
|
3300
|
+
/** @description The stage the sync is currently in, from the same set of values as the sync status. */
|
|
3301
|
+
stage: string;
|
|
3302
|
+
};
|
|
2769
3303
|
DbtSyncResponse: {
|
|
2770
3304
|
branchName: string;
|
|
2771
3305
|
syncJobId: string;
|
|
2772
3306
|
workflowId: string;
|
|
2773
3307
|
};
|
|
3308
|
+
DbtSyncResultResponse: {
|
|
3309
|
+
/** @description When the sync finished, as an ISO 8601 timestamp. */
|
|
3310
|
+
completedAt: string;
|
|
3311
|
+
/** @description How many cubes the sync generated from the dbt manifest. */
|
|
3312
|
+
cubeCount: number;
|
|
3313
|
+
/** @description End-to-end sync duration in milliseconds. */
|
|
3314
|
+
durationMs: number;
|
|
3315
|
+
/** @description The cube files this sync generated and committed to the branch it created. */
|
|
3316
|
+
generatedFiles: components["schemas"]["DbtSyncGeneratedFile"][];
|
|
3317
|
+
manifestStats: components["schemas"]["DbtSyncManifestStats"];
|
|
3318
|
+
syncJobId: string;
|
|
3319
|
+
};
|
|
3320
|
+
DbtSyncRun: {
|
|
3321
|
+
/** @description The Cube branch this sync wrote its generated cubes to. */
|
|
3322
|
+
branchName: string;
|
|
3323
|
+
completedAt?: string | null;
|
|
3324
|
+
deploymentId: number;
|
|
3325
|
+
durationMs?: number | null;
|
|
3326
|
+
errorMessage?: string | null;
|
|
3327
|
+
failedPhase?: string | null;
|
|
3328
|
+
gitRef?: string | null;
|
|
3329
|
+
lastStage?: string | null;
|
|
3330
|
+
phases?: components["schemas"]["DbtSyncRunPhase"][] | null;
|
|
3331
|
+
/** @description When the sync started, as an ISO 8601 timestamp. See completedAt before comparing the two. */
|
|
3332
|
+
startedAt: string;
|
|
3333
|
+
stats?: components["schemas"]["DbtSyncRunStats"] | null;
|
|
3334
|
+
/** @description RUNNING, COMPLETED, FAILED, CANCELLED or UNKNOWN. UNKNOWN means the outcome could not be established (the run’s record was lost and the workflow engine no longer knows the workflow) and is deliberately distinct from FAILED. Treat an unrecognized value as non-terminal. */
|
|
3335
|
+
status: string;
|
|
3336
|
+
syncJobId: string;
|
|
3337
|
+
/** @description What started the sync: manual (the Cube Cloud UI), api (this REST API), webhook (a push to the dbt repository), agent (Cube AI), or unknown. */
|
|
3338
|
+
trigger: string;
|
|
3339
|
+
triggerContext?: components["schemas"]["DbtSyncRunTriggerContext"] | null;
|
|
3340
|
+
userId?: number | null;
|
|
3341
|
+
};
|
|
3342
|
+
DbtSyncRunListResponse: {
|
|
3343
|
+
items: components["schemas"]["DbtSyncRun"][];
|
|
3344
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
3345
|
+
};
|
|
3346
|
+
DbtSyncRunPhase: {
|
|
3347
|
+
/** @description How long the phase took, in milliseconds. */
|
|
3348
|
+
durationMs: number;
|
|
3349
|
+
/** @description ok or failed. */
|
|
3350
|
+
outcome: string;
|
|
3351
|
+
/** @description Phase token, e.g. repo-clone, dbt-deps, dbt-compile. */
|
|
3352
|
+
phase: string;
|
|
3353
|
+
/** @description When the phase began, in milliseconds after the sync started. */
|
|
3354
|
+
startedOffsetMs: number;
|
|
3355
|
+
};
|
|
3356
|
+
DbtSyncRunStats: {
|
|
3357
|
+
cubeCount?: number | null;
|
|
3358
|
+
generatedFileCount?: number | null;
|
|
3359
|
+
macros?: number | null;
|
|
3360
|
+
models?: number | null;
|
|
3361
|
+
sources?: number | null;
|
|
3362
|
+
};
|
|
3363
|
+
DbtSyncRunTriggerContext: {
|
|
3364
|
+
headSha?: string | null;
|
|
3365
|
+
pushedBranch?: string | null;
|
|
3366
|
+
targetBranch?: string | null;
|
|
3367
|
+
};
|
|
3368
|
+
/** @enum {string} */
|
|
3369
|
+
DbtSyncRunsQueryStatus: "RUNNING" | "COMPLETED" | "FAILED" | "CANCELLED" | "UNKNOWN";
|
|
3370
|
+
/** @enum {string} */
|
|
3371
|
+
DbtSyncRunsQueryTrigger: "manual" | "api" | "webhook" | "agent" | "unknown";
|
|
3372
|
+
DbtSyncStatusResponse: {
|
|
3373
|
+
error?: string | null;
|
|
3374
|
+
progress: components["schemas"]["DbtSyncProgress"];
|
|
3375
|
+
/** @description One of INITIALIZING, CREATING_SANDBOX, UPLOADING_PROJECT, INSTALLING_DEPENDENCIES, RUNNING_DBT_DEPS, COMPILING_DBT, PROCESSING_MANIFEST, WRITING_CUBE_FILES, FINALIZING, COMPLETED, FAILED. COMPLETED and FAILED are the only terminal values: poll until one of them, then read the result. Treat any unrecognized value as still running. */
|
|
3376
|
+
status: string;
|
|
3377
|
+
syncJobId: string;
|
|
3378
|
+
/** @description When this status was last updated, as an ISO 8601 timestamp. */
|
|
3379
|
+
updatedAt: string;
|
|
3380
|
+
};
|
|
2774
3381
|
Deployment: {
|
|
2775
3382
|
creationStep: components["schemas"]["CreationStep"];
|
|
2776
3383
|
deploymentUrl: string;
|
|
@@ -2809,14 +3416,26 @@ export interface components {
|
|
|
2809
3416
|
data: components["schemas"]["DeploymentEnvironmentToken"];
|
|
2810
3417
|
};
|
|
2811
3418
|
DeploymentEnvironmentTokensListResponse: {
|
|
3419
|
+
/**
|
|
3420
|
+
* @deprecated
|
|
3421
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
3422
|
+
*/
|
|
2812
3423
|
data: components["schemas"]["DeploymentEnvironmentToken"][];
|
|
2813
|
-
|
|
3424
|
+
items: components["schemas"]["DeploymentEnvironmentToken"][];
|
|
3425
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3426
|
+
pagination?: components["schemas"]["DeploymentsPagination"] | null;
|
|
2814
3427
|
};
|
|
2815
3428
|
/** @enum {string} */
|
|
2816
3429
|
DeploymentEnvironmentType: "production" | "staging" | "development";
|
|
2817
3430
|
DeploymentEnvironmentsListResponse: {
|
|
3431
|
+
/**
|
|
3432
|
+
* @deprecated
|
|
3433
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
3434
|
+
*/
|
|
2818
3435
|
data: components["schemas"]["DeploymentEnvironment"][];
|
|
2819
|
-
|
|
3436
|
+
items: components["schemas"]["DeploymentEnvironment"][];
|
|
3437
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3438
|
+
pagination?: components["schemas"]["DeploymentsPagination"] | null;
|
|
2820
3439
|
};
|
|
2821
3440
|
DeploymentLogLine: {
|
|
2822
3441
|
date: string;
|
|
@@ -2829,6 +3448,7 @@ export interface components {
|
|
|
2829
3448
|
DeploymentLogsQuerySource: "production" | "dev";
|
|
2830
3449
|
DeploymentLogsResponse: {
|
|
2831
3450
|
items: components["schemas"]["DeploymentLogLine"][];
|
|
3451
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
2832
3452
|
};
|
|
2833
3453
|
DeploymentPod: {
|
|
2834
3454
|
containers?: string[] | null;
|
|
@@ -2840,15 +3460,83 @@ export interface components {
|
|
|
2840
3460
|
};
|
|
2841
3461
|
DeploymentPodsResponse: {
|
|
2842
3462
|
items: components["schemas"]["DeploymentPod"][];
|
|
3463
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
2843
3464
|
};
|
|
2844
|
-
|
|
2845
|
-
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
|
|
3465
|
+
DeploymentSettings: {
|
|
3466
|
+
autoDomain?: string | null;
|
|
3467
|
+
cloudProvider: components["schemas"]["DeploymentSettingsCloudProvider"];
|
|
3468
|
+
creationMethod?: components["schemas"]["DeploymentSettingsCreationMethod"] | null;
|
|
3469
|
+
creationStep: components["schemas"]["CreationStep"];
|
|
3470
|
+
cspsConfig?: components["schemas"]["CspsConfig"] | null;
|
|
3471
|
+
cubeImageCloud?: string | null;
|
|
3472
|
+
cubeImageVersion?: string | null;
|
|
3473
|
+
customDomain?: string | null;
|
|
3474
|
+
defaultLaunchpadViewGroup?: string | null;
|
|
3475
|
+
deployBranchMergeAllowed: boolean;
|
|
3476
|
+
deployBranchName: string;
|
|
3477
|
+
deployBranchReadOnly: boolean;
|
|
3478
|
+
deployMode?: components["schemas"]["DeploymentSettingsDeployMode"] | null;
|
|
3479
|
+
deployProjectRoot: string;
|
|
3480
|
+
deploymentUrl: string;
|
|
3481
|
+
id: number;
|
|
3482
|
+
isCold?: boolean | null;
|
|
3483
|
+
isCubeSqlEnabled: boolean;
|
|
3484
|
+
isManaged?: boolean | null;
|
|
3485
|
+
isSupportPreAggregations: boolean;
|
|
3486
|
+
launchpadTabs?: string[] | null;
|
|
3487
|
+
name: string;
|
|
3488
|
+
region?: string | null;
|
|
3489
|
+
releaseChannel: components["schemas"]["DeploymentSettingsReleaseChannel"];
|
|
3490
|
+
releaseChannelVersion?: string | null;
|
|
3491
|
+
releaseChannelVersionHold?: boolean | null;
|
|
3492
|
+
repoType?: components["schemas"]["DeploymentSettingsRepoType"] | null;
|
|
3493
|
+
targetPlatform?: string | null;
|
|
3494
|
+
template: components["schemas"]["DeploymentSettingsTemplate"];
|
|
3495
|
+
templateVariables?: {
|
|
3496
|
+
[key: string]: any;
|
|
3497
|
+
} | null;
|
|
3498
|
+
};
|
|
3499
|
+
/** @enum {string} */
|
|
3500
|
+
DeploymentSettingsCloudProvider: "cubecloud" | "aws" | "gcp";
|
|
3501
|
+
/** @enum {string} */
|
|
3502
|
+
DeploymentSettingsCreationMethod: "upload" | "cubecloud" | "github" | "ssh";
|
|
3503
|
+
/** @enum {string} */
|
|
3504
|
+
DeploymentSettingsDeployMode: "git" | "cli";
|
|
3505
|
+
/** @enum {string} */
|
|
3506
|
+
DeploymentSettingsReleaseChannel: "latest" | "release";
|
|
3507
|
+
/** @enum {string} */
|
|
3508
|
+
DeploymentSettingsRepoType: "git" | "deployRepo";
|
|
3509
|
+
/** @enum {string} */
|
|
3510
|
+
DeploymentSettingsTemplate: "single" | "simpleCluster" | "multiCluster";
|
|
3511
|
+
DeploymentTokenResponse: {
|
|
3512
|
+
cubeApiToken: string;
|
|
3513
|
+
};
|
|
3514
|
+
DeploymentVersion: {
|
|
3515
|
+
isCurrent: boolean;
|
|
3516
|
+
isLatestInChannel: boolean;
|
|
3517
|
+
releaseChannel: components["schemas"]["DeploymentVersionReleaseChannel"];
|
|
3518
|
+
releaseChannelVersion: string;
|
|
3519
|
+
version: string;
|
|
3520
|
+
};
|
|
3521
|
+
/** @enum {string} */
|
|
3522
|
+
DeploymentVersionReleaseChannel: "latest" | "release";
|
|
3523
|
+
DeploymentVersionsResponse: {
|
|
3524
|
+
items: components["schemas"]["DeploymentVersion"][];
|
|
3525
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3526
|
+
};
|
|
3527
|
+
DeploymentsListResponse: {
|
|
3528
|
+
count?: number | null;
|
|
3529
|
+
/**
|
|
3530
|
+
* @deprecated
|
|
3531
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
3532
|
+
*/
|
|
3533
|
+
data: components["schemas"]["Deployment"][];
|
|
2850
3534
|
items: components["schemas"]["Deployment"][];
|
|
2851
3535
|
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3536
|
+
/**
|
|
3537
|
+
* @deprecated
|
|
3538
|
+
* @description Deprecated: use `pageInfo` instead. Kept for backward compatibility.
|
|
3539
|
+
*/
|
|
2852
3540
|
pagination: components["schemas"]["DeploymentsPagination"];
|
|
2853
3541
|
totalCount?: number | null;
|
|
2854
3542
|
};
|
|
@@ -2862,6 +3550,14 @@ export interface components {
|
|
|
2862
3550
|
branchName?: string | null;
|
|
2863
3551
|
parentBranch?: string | null;
|
|
2864
3552
|
};
|
|
3553
|
+
DisconnectReportFromWorkbookInput: {
|
|
3554
|
+
anchorCell?: string | null;
|
|
3555
|
+
externalWorkbookId?: string | null;
|
|
3556
|
+
placementId?: string | null;
|
|
3557
|
+
resultLocation?: string | null;
|
|
3558
|
+
sheetId?: string | null;
|
|
3559
|
+
sheetName?: string | null;
|
|
3560
|
+
};
|
|
2865
3561
|
DuplicateWorkbookInput: {
|
|
2866
3562
|
shared?: boolean | null;
|
|
2867
3563
|
};
|
|
@@ -2902,11 +3598,14 @@ export interface components {
|
|
|
2902
3598
|
sqlQuery: string;
|
|
2903
3599
|
};
|
|
2904
3600
|
EmbedSessionSettings: {
|
|
3601
|
+
allowChatWorkspaceAuthoring?: boolean | null;
|
|
2905
3602
|
showDashboardChat?: boolean | null;
|
|
2906
3603
|
};
|
|
2907
3604
|
EmbedSettings: {
|
|
3605
|
+
enableDashboardComments?: boolean | null;
|
|
2908
3606
|
locale?: string | null;
|
|
2909
3607
|
showDashboardChat?: boolean | null;
|
|
3608
|
+
timezone?: string | null;
|
|
2910
3609
|
};
|
|
2911
3610
|
EmbedTenant: {
|
|
2912
3611
|
createdAt?: (string) | null;
|
|
@@ -2961,7 +3660,13 @@ export interface components {
|
|
|
2961
3660
|
value: string;
|
|
2962
3661
|
};
|
|
2963
3662
|
EnvVariablesListResponse: {
|
|
3663
|
+
/**
|
|
3664
|
+
* @deprecated
|
|
3665
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
3666
|
+
*/
|
|
2964
3667
|
data: components["schemas"]["EnvVariableItem"][];
|
|
3668
|
+
items: components["schemas"]["EnvVariableItem"][];
|
|
3669
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
2965
3670
|
};
|
|
2966
3671
|
FileHash: {
|
|
2967
3672
|
hash: string;
|
|
@@ -3054,7 +3759,13 @@ export interface components {
|
|
|
3054
3759
|
name: string;
|
|
3055
3760
|
};
|
|
3056
3761
|
GitHubBranchesListResponse: {
|
|
3762
|
+
/**
|
|
3763
|
+
* @deprecated
|
|
3764
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
3765
|
+
*/
|
|
3057
3766
|
data: components["schemas"]["GitHubBranchResponse"][];
|
|
3767
|
+
items: components["schemas"]["GitHubBranchResponse"][];
|
|
3768
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3058
3769
|
};
|
|
3059
3770
|
GitHubConnectStatusResponse: {
|
|
3060
3771
|
connected: boolean;
|
|
@@ -3068,7 +3779,13 @@ export interface components {
|
|
|
3068
3779
|
login: string;
|
|
3069
3780
|
};
|
|
3070
3781
|
GitHubInstallationsListResponse: {
|
|
3782
|
+
/**
|
|
3783
|
+
* @deprecated
|
|
3784
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
3785
|
+
*/
|
|
3071
3786
|
data: components["schemas"]["GitHubInstallationResponse"][];
|
|
3787
|
+
items: components["schemas"]["GitHubInstallationResponse"][];
|
|
3788
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3072
3789
|
};
|
|
3073
3790
|
GitHubRepoResponse: {
|
|
3074
3791
|
htmlUrl: string;
|
|
@@ -3076,7 +3793,13 @@ export interface components {
|
|
|
3076
3793
|
name: string;
|
|
3077
3794
|
};
|
|
3078
3795
|
GitHubReposListResponse: {
|
|
3796
|
+
/**
|
|
3797
|
+
* @deprecated
|
|
3798
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
3799
|
+
*/
|
|
3079
3800
|
data: components["schemas"]["GitHubRepoResponse"][];
|
|
3801
|
+
items: components["schemas"]["GitHubRepoResponse"][];
|
|
3802
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3080
3803
|
};
|
|
3081
3804
|
GroupDefinition: {
|
|
3082
3805
|
description?: string | null;
|
|
@@ -3085,7 +3808,9 @@ export interface components {
|
|
|
3085
3808
|
InheritedGroupPolicyDto: {
|
|
3086
3809
|
action: components["schemas"]["InheritedGroupPolicyDtoAction"];
|
|
3087
3810
|
groupId: number;
|
|
3811
|
+
name?: string | null;
|
|
3088
3812
|
sourceFolder?: components["schemas"]["Folder"] | null;
|
|
3813
|
+
userCount?: number | null;
|
|
3089
3814
|
};
|
|
3090
3815
|
/** @enum {string} */
|
|
3091
3816
|
InheritedGroupPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "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";
|
|
@@ -3162,6 +3887,8 @@ export interface components {
|
|
|
3162
3887
|
humanReadableSchedule: string;
|
|
3163
3888
|
id: number;
|
|
3164
3889
|
isEnabled: boolean;
|
|
3890
|
+
/** @description Whether this notification carries an AI-generated "what changed" summary in its body. */
|
|
3891
|
+
notificationAiSummary: boolean;
|
|
3165
3892
|
notificationEnabled: boolean;
|
|
3166
3893
|
notificationFormat: string;
|
|
3167
3894
|
timeGrains?: components["schemas"]["DashboardTimeGrain"][] | null;
|
|
@@ -3262,17 +3989,66 @@ export interface components {
|
|
|
3262
3989
|
columns: string[];
|
|
3263
3990
|
filters: string[];
|
|
3264
3991
|
measures: string[];
|
|
3992
|
+
measuresAxis?: components["schemas"]["PivotItemsMeasuresAxis"] | null;
|
|
3993
|
+
measuresPosition?: components["schemas"]["PivotItemsMeasuresPosition"] | null;
|
|
3265
3994
|
rows: string[];
|
|
3266
3995
|
};
|
|
3267
3996
|
PivotItemsInput: {
|
|
3268
3997
|
columns: string[];
|
|
3269
3998
|
filters: string[];
|
|
3270
3999
|
measures: string[];
|
|
4000
|
+
measuresAxis?: components["schemas"]["PivotItemsInputMeasuresAxis"] | null;
|
|
4001
|
+
measuresPosition?: components["schemas"]["PivotItemsInputMeasuresPosition"] | null;
|
|
3271
4002
|
rows: string[];
|
|
3272
4003
|
};
|
|
4004
|
+
/** @enum {string} */
|
|
4005
|
+
PivotItemsInputMeasuresAxis: "columns" | "rows";
|
|
4006
|
+
/** @enum {string} */
|
|
4007
|
+
PivotItemsInputMeasuresPosition: "before" | "after";
|
|
4008
|
+
/** @enum {string} */
|
|
4009
|
+
PivotItemsMeasuresAxis: "columns" | "rows";
|
|
4010
|
+
/** @enum {string} */
|
|
4011
|
+
PivotItemsMeasuresPosition: "before" | "after";
|
|
3273
4012
|
PostTokenBySessionIdInput: {
|
|
3274
4013
|
sessionId: string;
|
|
3275
4014
|
};
|
|
4015
|
+
ProvisionEmbedUserFailure: {
|
|
4016
|
+
error: components["schemas"]["BulkActionError"];
|
|
4017
|
+
/** @description The `externalId` of the entry that failed, normalized the same way a successful one is. */
|
|
4018
|
+
externalId: string;
|
|
4019
|
+
};
|
|
4020
|
+
ProvisionEmbedUserInput: {
|
|
4021
|
+
email?: string | null;
|
|
4022
|
+
/** @description The id your own system knows this user by — the same `externalId` you will pass to `generate-session`. Trimmed and lowercased before it is stored, so casing never produces a second user. */
|
|
4023
|
+
externalId: string;
|
|
4024
|
+
groups?: string[] | null;
|
|
4025
|
+
tenantGroups?: string[] | null;
|
|
4026
|
+
userProfile?: components["schemas"]["EmbedUserProfile"] | null;
|
|
4027
|
+
};
|
|
4028
|
+
ProvisionEmbedUsersInput: {
|
|
4029
|
+
/** @description Embed users to provision (1–100 per request). */
|
|
4030
|
+
users: components["schemas"]["ProvisionEmbedUserInput"][];
|
|
4031
|
+
};
|
|
4032
|
+
ProvisionEmbedUsersResponse: {
|
|
4033
|
+
/** @description The entries that were not applied, each with the reason. */
|
|
4034
|
+
failed: components["schemas"]["ProvisionEmbedUserFailure"][];
|
|
4035
|
+
/** @description The users that were provisioned, in the order they were requested. */
|
|
4036
|
+
succeeded: components["schemas"]["EmbedUser"][];
|
|
4037
|
+
};
|
|
4038
|
+
ProvisionedRegionResponse: {
|
|
4039
|
+
availabilityZones?: string[] | null;
|
|
4040
|
+
cloudProvider?: string | null;
|
|
4041
|
+
cloudProviderRegion?: string | null;
|
|
4042
|
+
id: number;
|
|
4043
|
+
isDedicated?: boolean | null;
|
|
4044
|
+
isPublic?: boolean | null;
|
|
4045
|
+
label?: string | null;
|
|
4046
|
+
lifecycleStatus?: string | null;
|
|
4047
|
+
name: string;
|
|
4048
|
+
provider?: string | null;
|
|
4049
|
+
subnetNumber?: number | null;
|
|
4050
|
+
title?: string | null;
|
|
4051
|
+
};
|
|
3276
4052
|
PublishDashboardInput: {
|
|
3277
4053
|
allowEmbed?: boolean | null;
|
|
3278
4054
|
config?: components["schemas"]["DashboardConfigInput"] | null;
|
|
@@ -3295,6 +4071,76 @@ export interface components {
|
|
|
3295
4071
|
stderr: string;
|
|
3296
4072
|
stdout: string;
|
|
3297
4073
|
};
|
|
4074
|
+
RefreshReportInput: {
|
|
4075
|
+
anchorCell?: string | null;
|
|
4076
|
+
externalWorkbookId?: string | null;
|
|
4077
|
+
placementId?: string | null;
|
|
4078
|
+
resultLocation?: string | null;
|
|
4079
|
+
sheetId?: string | null;
|
|
4080
|
+
sheetName?: string | null;
|
|
4081
|
+
};
|
|
4082
|
+
RegionCloudProviderCatalogListResponse: {
|
|
4083
|
+
items: components["schemas"]["RegionCloudProviderCatalogResponse"][];
|
|
4084
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
4085
|
+
};
|
|
4086
|
+
RegionCloudProviderCatalogResponse: {
|
|
4087
|
+
cloudProvider: string;
|
|
4088
|
+
regions: components["schemas"]["RegionCloudProviderRegionResponse"][];
|
|
4089
|
+
};
|
|
4090
|
+
RegionCloudProviderRegionResponse: {
|
|
4091
|
+
availabilityZones: string[];
|
|
4092
|
+
code: string;
|
|
4093
|
+
title: string;
|
|
4094
|
+
};
|
|
4095
|
+
RegionCreateRequest: {
|
|
4096
|
+
cloudProvider: string;
|
|
4097
|
+
cloudProviderRegion: string;
|
|
4098
|
+
label?: string | null;
|
|
4099
|
+
};
|
|
4100
|
+
RegionPrivateLinkCreateRequest: {
|
|
4101
|
+
dnsName?: string | null;
|
|
4102
|
+
endpointServiceName: string;
|
|
4103
|
+
name: string;
|
|
4104
|
+
ports: number[];
|
|
4105
|
+
serviceRegion?: string | null;
|
|
4106
|
+
};
|
|
4107
|
+
RegionPrivateLinkRemoveResponse: {
|
|
4108
|
+
markedForRemoval: boolean;
|
|
4109
|
+
pendingApply: boolean;
|
|
4110
|
+
};
|
|
4111
|
+
RegionPrivateLinkResponse: {
|
|
4112
|
+
dnsName?: string | null;
|
|
4113
|
+
endpointId?: string | null;
|
|
4114
|
+
endpointServiceName: string;
|
|
4115
|
+
id: number;
|
|
4116
|
+
name: string;
|
|
4117
|
+
ports: number[];
|
|
4118
|
+
regionId: number;
|
|
4119
|
+
serviceRegion?: string | null;
|
|
4120
|
+
status: string;
|
|
4121
|
+
};
|
|
4122
|
+
RegionPrivateLinkUpdateRequest: {
|
|
4123
|
+
dnsName?: string | null;
|
|
4124
|
+
endpointServiceName?: string | null;
|
|
4125
|
+
name?: string | null;
|
|
4126
|
+
ports?: number[] | null;
|
|
4127
|
+
serviceRegion?: string | null;
|
|
4128
|
+
};
|
|
4129
|
+
RegionPrivateLinksListResponse: {
|
|
4130
|
+
items: components["schemas"]["RegionPrivateLinkResponse"][];
|
|
4131
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
4132
|
+
};
|
|
4133
|
+
RegionProvisioningRunResponse: {
|
|
4134
|
+
action: string;
|
|
4135
|
+
jobId?: number | null;
|
|
4136
|
+
};
|
|
4137
|
+
RegionProvisioningStatusResponse: {
|
|
4138
|
+
action: string;
|
|
4139
|
+
finishedAt?: string | null;
|
|
4140
|
+
id: number;
|
|
4141
|
+
startedAt?: string | null;
|
|
4142
|
+
state: string;
|
|
4143
|
+
};
|
|
3298
4144
|
RegionResponse: {
|
|
3299
4145
|
id: number;
|
|
3300
4146
|
isDedicated?: boolean | null;
|
|
@@ -3305,8 +4151,19 @@ export interface components {
|
|
|
3305
4151
|
title?: string | null;
|
|
3306
4152
|
useAiEngineer?: boolean | null;
|
|
3307
4153
|
};
|
|
4154
|
+
RegionUpdateRequest: {
|
|
4155
|
+
pathBasedRoutingDomainOverride?: string | null;
|
|
4156
|
+
pathBasedRoutingSQLDomainOverride?: string | null;
|
|
4157
|
+
title?: string | null;
|
|
4158
|
+
};
|
|
3308
4159
|
RegionsListResponse: {
|
|
4160
|
+
/**
|
|
4161
|
+
* @deprecated
|
|
4162
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
4163
|
+
*/
|
|
3309
4164
|
data: components["schemas"]["RegionResponse"][];
|
|
4165
|
+
items: components["schemas"]["RegionResponse"][];
|
|
4166
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3310
4167
|
};
|
|
3311
4168
|
RemoveDataModelFilesInput: {
|
|
3312
4169
|
branchId?: number;
|
|
@@ -3375,17 +4232,37 @@ export interface components {
|
|
|
3375
4232
|
reportsCount?: number | null;
|
|
3376
4233
|
};
|
|
3377
4234
|
ReportFoldersFindAllResult: {
|
|
4235
|
+
count?: number | null;
|
|
4236
|
+
/**
|
|
4237
|
+
* @deprecated
|
|
4238
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
4239
|
+
*/
|
|
3378
4240
|
data: components["schemas"]["ReportFolder"][];
|
|
4241
|
+
items: components["schemas"]["ReportFolder"][];
|
|
4242
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3379
4243
|
};
|
|
3380
4244
|
ReportPlacement: {
|
|
4245
|
+
anchorCell?: string | null;
|
|
3381
4246
|
endResultCell?: string | null;
|
|
4247
|
+
host?: components["schemas"]["ReportPlacementHost"] | null;
|
|
4248
|
+
id?: string | null;
|
|
4249
|
+
placedAt?: string | null;
|
|
4250
|
+
placedByUserId?: number | null;
|
|
4251
|
+
refreshedAt?: string | null;
|
|
4252
|
+
refreshedByUserId?: number | null;
|
|
3382
4253
|
resultLocation: string;
|
|
4254
|
+
sheetId?: string | null;
|
|
4255
|
+
sheetName?: string | null;
|
|
3383
4256
|
workbookId: string;
|
|
4257
|
+
workbookName?: string | null;
|
|
3384
4258
|
};
|
|
4259
|
+
/** @enum {string} */
|
|
4260
|
+
ReportPlacementHost: "GOOGLE_SHEETS" | "EXCEL";
|
|
3385
4261
|
ReportSnapshot: {
|
|
3386
4262
|
description?: string | null;
|
|
3387
4263
|
fillMissingRows?: components["schemas"]["FillMissingRows"] | null;
|
|
3388
4264
|
id: number;
|
|
4265
|
+
isSourceReport?: boolean | null;
|
|
3389
4266
|
kind?: components["schemas"]["ReportSnapshotDtoKind"] | null;
|
|
3390
4267
|
meta?: {
|
|
3391
4268
|
[key: string]: any;
|
|
@@ -3393,6 +4270,7 @@ export interface components {
|
|
|
3393
4270
|
name?: string | null;
|
|
3394
4271
|
periodComparisons?: components["schemas"]["PeriodComparison"][] | null;
|
|
3395
4272
|
preferences?: components["schemas"]["ReportSnapshotPreferences"] | null;
|
|
4273
|
+
pythonCode?: string | null;
|
|
3396
4274
|
reportId: number;
|
|
3397
4275
|
spec?: (string | Record<string, never>) | null;
|
|
3398
4276
|
sqlQuery?: string | null;
|
|
@@ -3400,7 +4278,7 @@ export interface components {
|
|
|
3400
4278
|
versionNumber: number;
|
|
3401
4279
|
};
|
|
3402
4280
|
/** @enum {string} */
|
|
3403
|
-
ReportSnapshotDtoKind: "vega" | "table" | "kpi" | "html" | "map";
|
|
4281
|
+
ReportSnapshotDtoKind: "vega" | "table" | "kpi" | "html" | "map" | "sankey";
|
|
3404
4282
|
ReportSnapshotPreferences: {
|
|
3405
4283
|
columnFormats?: {
|
|
3406
4284
|
[key: string]: components["schemas"]["ColumnFormatOverride"];
|
|
@@ -3419,6 +4297,8 @@ export interface components {
|
|
|
3419
4297
|
ResourceGroupPolicyDto: {
|
|
3420
4298
|
action: components["schemas"]["ResourceGroupPolicyDtoAction"];
|
|
3421
4299
|
groupId: number;
|
|
4300
|
+
name?: string | null;
|
|
4301
|
+
userCount?: number | null;
|
|
3422
4302
|
};
|
|
3423
4303
|
/** @enum {string} */
|
|
3424
4304
|
ResourceGroupPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "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";
|
|
@@ -3448,6 +4328,14 @@ export interface components {
|
|
|
3448
4328
|
id: number;
|
|
3449
4329
|
name: string;
|
|
3450
4330
|
};
|
|
4331
|
+
SetBranchStagingEnvironmentRequest: {
|
|
4332
|
+
branchId?: number | null;
|
|
4333
|
+
branchName?: string | null;
|
|
4334
|
+
enabled: boolean;
|
|
4335
|
+
};
|
|
4336
|
+
SetBranchStagingEnvironmentResponse: {
|
|
4337
|
+
data: components["schemas"]["BranchResponse"];
|
|
4338
|
+
};
|
|
3451
4339
|
SetEnvVariablesInput: {
|
|
3452
4340
|
env_variables: components["schemas"]["EnvVariableItem"][];
|
|
3453
4341
|
};
|
|
@@ -3455,12 +4343,21 @@ export interface components {
|
|
|
3455
4343
|
showAppliedFilters?: boolean | null;
|
|
3456
4344
|
};
|
|
3457
4345
|
SourceTreeResponse: {
|
|
4346
|
+
/**
|
|
4347
|
+
* @deprecated
|
|
4348
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
4349
|
+
*/
|
|
3458
4350
|
data: {
|
|
3459
4351
|
[key: string]: any;
|
|
3460
4352
|
}[];
|
|
4353
|
+
items: {
|
|
4354
|
+
[key: string]: any;
|
|
4355
|
+
}[];
|
|
4356
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3461
4357
|
};
|
|
3462
4358
|
StartDbtSyncInput: {
|
|
3463
4359
|
branchName?: string | null;
|
|
4360
|
+
ref?: string | null;
|
|
3464
4361
|
};
|
|
3465
4362
|
StartDevModeRequest: {
|
|
3466
4363
|
branchName?: string | null;
|
|
@@ -3496,6 +4393,11 @@ export interface components {
|
|
|
3496
4393
|
name?: string | null;
|
|
3497
4394
|
url: string;
|
|
3498
4395
|
};
|
|
4396
|
+
TimezoneSettings: {
|
|
4397
|
+
allowUserOverride?: boolean | null;
|
|
4398
|
+
enabled?: boolean | null;
|
|
4399
|
+
timezone?: string | null;
|
|
4400
|
+
};
|
|
3499
4401
|
UpdateDashboardEmbeddingInput: {
|
|
3500
4402
|
/** @description Whether customer-signed embedding is allowed for this dashboard ("Allow signed embedding" in the UI). `true` lets embed sessions fetch the dashboard via `GET /api/v1/embed/dashboard/{publicId}`; `false` makes that fetch return `403`. Does not affect creator-mode sessions or dashboards shared with all embed users. */
|
|
3501
4403
|
allowEmbed: boolean;
|
|
@@ -3506,20 +4408,37 @@ export interface components {
|
|
|
3506
4408
|
files: components["schemas"]["DataModelFileContent"][];
|
|
3507
4409
|
};
|
|
3508
4410
|
UpdateDeploymentInput: {
|
|
4411
|
+
cloudProvider?: components["schemas"]["UpdateDeploymentInputCloudProvider"] | null;
|
|
3509
4412
|
creationMethod?: components["schemas"]["UpdateDeploymentInputCreationMethod"] | null;
|
|
3510
4413
|
cspsConfig?: components["schemas"]["CspsConfigInput"] | null;
|
|
3511
4414
|
customDomain?: string | null;
|
|
4415
|
+
defaultLaunchpadViewGroup?: string | null;
|
|
3512
4416
|
deployBranchMergeAllowed?: boolean | null;
|
|
3513
4417
|
deployBranchName?: string | null;
|
|
3514
4418
|
deployBranchReadOnly?: boolean | null;
|
|
3515
4419
|
deployMode?: components["schemas"]["UpdateDeploymentInputDeployMode"] | null;
|
|
3516
4420
|
deployProjectRoot?: string | null;
|
|
4421
|
+
launchpadTabs?: string[] | null;
|
|
3517
4422
|
name?: string | null;
|
|
4423
|
+
region?: string | null;
|
|
4424
|
+
releaseChannel?: components["schemas"]["UpdateDeploymentInputReleaseChannel"] | null;
|
|
4425
|
+
releaseChannelVersion?: string | null;
|
|
4426
|
+
releaseChannelVersionHold?: boolean | null;
|
|
4427
|
+
template?: components["schemas"]["UpdateDeploymentInputTemplate"] | null;
|
|
4428
|
+
templateVariables?: {
|
|
4429
|
+
[key: string]: any;
|
|
4430
|
+
} | null;
|
|
3518
4431
|
};
|
|
3519
4432
|
/** @enum {string} */
|
|
4433
|
+
UpdateDeploymentInputCloudProvider: "cubecloud" | "aws" | "gcp";
|
|
4434
|
+
/** @enum {string} */
|
|
3520
4435
|
UpdateDeploymentInputCreationMethod: "upload" | "cubecloud" | "github" | "ssh";
|
|
3521
4436
|
/** @enum {string} */
|
|
3522
4437
|
UpdateDeploymentInputDeployMode: "git" | "cli";
|
|
4438
|
+
/** @enum {string} */
|
|
4439
|
+
UpdateDeploymentInputReleaseChannel: "latest" | "release";
|
|
4440
|
+
/** @enum {string} */
|
|
4441
|
+
UpdateDeploymentInputTemplate: "single" | "simpleCluster" | "multiCluster";
|
|
3523
4442
|
UpdateEmbedAccessInput: {
|
|
3524
4443
|
action?: components["schemas"]["UpdateEmbedAccessInputAction"] | null;
|
|
3525
4444
|
allEmbedUsers?: boolean | null;
|
|
@@ -3543,6 +4462,7 @@ export interface components {
|
|
|
3543
4462
|
hour?: number | null;
|
|
3544
4463
|
isEnabled?: boolean | null;
|
|
3545
4464
|
minute?: number | null;
|
|
4465
|
+
notificationAiSummary?: boolean | null;
|
|
3546
4466
|
notificationEnabled?: boolean | null;
|
|
3547
4467
|
notificationFormat?: components["schemas"]["UpdateNotificationInputNotificationFormat"] | null;
|
|
3548
4468
|
scheduleType?: components["schemas"]["UpdateNotificationInputScheduleType"] | null;
|
|
@@ -3577,27 +4497,28 @@ export interface components {
|
|
|
3577
4497
|
subFormat?: string | null;
|
|
3578
4498
|
targetEnvVar?: string | null;
|
|
3579
4499
|
};
|
|
3580
|
-
UpdatePublishedAiWidgetThreadInput: {
|
|
3581
|
-
checksum?: string | null;
|
|
3582
|
-
threadId: string;
|
|
3583
|
-
widgetId: string;
|
|
3584
|
-
};
|
|
3585
4500
|
UpdateReportInput: {
|
|
3586
4501
|
endResultCell?: string | null;
|
|
3587
4502
|
externalWorkbookId?: string | null;
|
|
3588
4503
|
folderId?: number | null;
|
|
4504
|
+
host?: components["schemas"]["UpdateReportInputHost"] | null;
|
|
3589
4505
|
jsonQuery?: string | null;
|
|
3590
4506
|
meta?: {
|
|
3591
4507
|
[key: string]: any;
|
|
3592
4508
|
} | null;
|
|
3593
4509
|
name?: string | null;
|
|
3594
4510
|
pivotItems?: components["schemas"]["PivotItems"] | null;
|
|
4511
|
+
placementId?: string | null;
|
|
3595
4512
|
publicId?: string | null;
|
|
3596
4513
|
resultLocation?: string | null;
|
|
4514
|
+
sheetId?: string | null;
|
|
3597
4515
|
sqlQuery?: string | null;
|
|
3598
4516
|
title?: string | null;
|
|
3599
4517
|
workbookId?: number | null;
|
|
4518
|
+
workbookName?: string | null;
|
|
3600
4519
|
};
|
|
4520
|
+
/** @enum {string} */
|
|
4521
|
+
UpdateReportInputHost: "GOOGLE_SHEETS" | "EXCEL";
|
|
3601
4522
|
UpdateResourceGroupPolicyBody: {
|
|
3602
4523
|
action?: components["schemas"]["UpdateResourceGroupPolicyBodyAction"] | null;
|
|
3603
4524
|
groupId: number;
|
|
@@ -3634,6 +4555,15 @@ export interface components {
|
|
|
3634
4555
|
UploadTransaction: {
|
|
3635
4556
|
id: string;
|
|
3636
4557
|
};
|
|
4558
|
+
UsageAnalyticsTokenResponse: {
|
|
4559
|
+
/** @description Base URL of the Usage Analytics deployment’s Cube REST API (e.g. `https://<host>/cubejs-api/v1`). Query it with the returned token. */
|
|
4560
|
+
apiUrl: string;
|
|
4561
|
+
/** @description Id of the Usage Analytics deployment the token was issued for. */
|
|
4562
|
+
deploymentId: number;
|
|
4563
|
+
expiresAt?: string | null;
|
|
4564
|
+
/** @description A short-lived JWT for the Usage Analytics deployment, carrying this tenant’s security context. Send it as `Authorization: Bearer <token>` on requests to `apiUrl`. */
|
|
4565
|
+
token: string;
|
|
4566
|
+
};
|
|
3637
4567
|
User: {
|
|
3638
4568
|
activeRoleId?: number | null;
|
|
3639
4569
|
aliases?: components["schemas"]["UserAlias"][] | null;
|
|
@@ -3724,8 +4654,18 @@ export interface components {
|
|
|
3724
4654
|
/** @enum {string} */
|
|
3725
4655
|
UserAttributeValueType: "string" | "number" | "boolean" | "string_array" | "number_array";
|
|
3726
4656
|
UserAttributesListResponse: {
|
|
4657
|
+
/**
|
|
4658
|
+
* @deprecated
|
|
4659
|
+
* @description Deprecated: total number of user attributes, ignoring pagination. Kept for backward compatibility.
|
|
4660
|
+
*/
|
|
3727
4661
|
count: number;
|
|
4662
|
+
/**
|
|
4663
|
+
* @deprecated
|
|
4664
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
4665
|
+
*/
|
|
3728
4666
|
data: components["schemas"]["UserAttribute"][];
|
|
4667
|
+
items: components["schemas"]["UserAttribute"][];
|
|
4668
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
3729
4669
|
};
|
|
3730
4670
|
UserCreateInput: {
|
|
3731
4671
|
defaultRoles?: string[] | null;
|
|
@@ -3736,6 +4676,9 @@ export interface components {
|
|
|
3736
4676
|
isExternal?: any | null;
|
|
3737
4677
|
password?: string | null;
|
|
3738
4678
|
picture?: any | null;
|
|
4679
|
+
settings?: {
|
|
4680
|
+
[key: string]: any;
|
|
4681
|
+
} | null;
|
|
3739
4682
|
username: string;
|
|
3740
4683
|
};
|
|
3741
4684
|
UserGroupDTO: {
|
|
@@ -3766,6 +4709,7 @@ export interface components {
|
|
|
3766
4709
|
};
|
|
3767
4710
|
UserSettingsInput: {
|
|
3768
4711
|
alternatingRowColors?: boolean | null;
|
|
4712
|
+
defaultDeploymentId?: number | null;
|
|
3769
4713
|
lastSeenChangelogId?: number | null;
|
|
3770
4714
|
locale?: string | null;
|
|
3771
4715
|
theme?: string | null;
|
|
@@ -3852,6 +4796,10 @@ export interface components {
|
|
|
3852
4796
|
WorkbookDtoType: "FOLDER" | "WORKBOOK" | "REPORT";
|
|
3853
4797
|
WorkbooksListResponse: {
|
|
3854
4798
|
count?: number | null;
|
|
4799
|
+
/**
|
|
4800
|
+
* @deprecated
|
|
4801
|
+
* @description Deprecated: use `items` instead. Kept for backward compatibility.
|
|
4802
|
+
*/
|
|
3855
4803
|
data: components["schemas"]["Workbook"][];
|
|
3856
4804
|
items: components["schemas"]["Workbook"][];
|
|
3857
4805
|
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
@@ -4310,10 +5258,8 @@ export interface operations {
|
|
|
4310
5258
|
creationStep?: components["schemas"]["CreationStep"] | components["schemas"]["CreationStep"][];
|
|
4311
5259
|
offset?: number | null;
|
|
4312
5260
|
limit?: number | null;
|
|
4313
|
-
/** @description Page size for cursor-based pagination */
|
|
4314
|
-
first?: number;
|
|
4315
|
-
/** @description Cursor for fetching the next page */
|
|
4316
5261
|
after?: string;
|
|
5262
|
+
first?: number;
|
|
4317
5263
|
};
|
|
4318
5264
|
header?: never;
|
|
4319
5265
|
path?: never;
|
|
@@ -4373,7 +5319,7 @@ export interface operations {
|
|
|
4373
5319
|
[name: string]: any;
|
|
4374
5320
|
};
|
|
4375
5321
|
content: {
|
|
4376
|
-
"application/json": components["schemas"]["
|
|
5322
|
+
"application/json": components["schemas"]["DeploymentSettings"];
|
|
4377
5323
|
};
|
|
4378
5324
|
};
|
|
4379
5325
|
};
|
|
@@ -4516,6 +5462,32 @@ export interface operations {
|
|
|
4516
5462
|
};
|
|
4517
5463
|
};
|
|
4518
5464
|
};
|
|
5465
|
+
"DbtSyncPublicController.listDbtSyncs": {
|
|
5466
|
+
parameters: {
|
|
5467
|
+
query?: {
|
|
5468
|
+
status?: components["schemas"]["DbtSyncRunsQueryStatus"] | null;
|
|
5469
|
+
trigger?: components["schemas"]["DbtSyncRunsQueryTrigger"] | null;
|
|
5470
|
+
after?: string;
|
|
5471
|
+
first?: number;
|
|
5472
|
+
};
|
|
5473
|
+
header?: never;
|
|
5474
|
+
path: {
|
|
5475
|
+
deploymentId: number;
|
|
5476
|
+
};
|
|
5477
|
+
cookie?: never;
|
|
5478
|
+
};
|
|
5479
|
+
requestBody?: never;
|
|
5480
|
+
responses: {
|
|
5481
|
+
200: {
|
|
5482
|
+
headers: {
|
|
5483
|
+
[name: string]: any;
|
|
5484
|
+
};
|
|
5485
|
+
content: {
|
|
5486
|
+
"application/json": components["schemas"]["DbtSyncRunListResponse"];
|
|
5487
|
+
};
|
|
5488
|
+
};
|
|
5489
|
+
};
|
|
5490
|
+
};
|
|
4519
5491
|
"DbtSyncPublicController.startDbtSync": {
|
|
4520
5492
|
parameters: {
|
|
4521
5493
|
query?: never;
|
|
@@ -4542,12 +5514,13 @@ export interface operations {
|
|
|
4542
5514
|
};
|
|
4543
5515
|
};
|
|
4544
5516
|
};
|
|
4545
|
-
"
|
|
5517
|
+
"DbtSyncPublicController.getDbtSyncStatus": {
|
|
4546
5518
|
parameters: {
|
|
4547
5519
|
query?: never;
|
|
4548
5520
|
header?: never;
|
|
4549
5521
|
path: {
|
|
4550
5522
|
deploymentId: number;
|
|
5523
|
+
syncJobId: string;
|
|
4551
5524
|
};
|
|
4552
5525
|
cookie?: never;
|
|
4553
5526
|
};
|
|
@@ -4558,47 +5531,40 @@ export interface operations {
|
|
|
4558
5531
|
[name: string]: any;
|
|
4559
5532
|
};
|
|
4560
5533
|
content: {
|
|
4561
|
-
"application/json": components["schemas"]["
|
|
5534
|
+
"application/json": components["schemas"]["DbtSyncStatusResponse"];
|
|
4562
5535
|
};
|
|
4563
5536
|
};
|
|
4564
5537
|
};
|
|
4565
5538
|
};
|
|
4566
|
-
"
|
|
5539
|
+
"DbtSyncPublicController.cancelDbtSync": {
|
|
4567
5540
|
parameters: {
|
|
4568
5541
|
query?: never;
|
|
4569
5542
|
header?: never;
|
|
4570
5543
|
path: {
|
|
4571
5544
|
deploymentId: number;
|
|
5545
|
+
syncJobId: string;
|
|
4572
5546
|
};
|
|
4573
5547
|
cookie?: never;
|
|
4574
5548
|
};
|
|
4575
|
-
|
|
4576
|
-
requestBody?: {
|
|
4577
|
-
content: {
|
|
4578
|
-
"application/json": components["schemas"]["SetEnvVariablesInput"];
|
|
4579
|
-
};
|
|
4580
|
-
};
|
|
5549
|
+
requestBody?: never;
|
|
4581
5550
|
responses: {
|
|
4582
5551
|
200: {
|
|
4583
5552
|
headers: {
|
|
4584
5553
|
[name: string]: any;
|
|
4585
5554
|
};
|
|
4586
5555
|
content: {
|
|
4587
|
-
"application/json": components["schemas"]["
|
|
5556
|
+
"application/json": components["schemas"]["DbtSyncCancelResponse"];
|
|
4588
5557
|
};
|
|
4589
5558
|
};
|
|
4590
5559
|
};
|
|
4591
5560
|
};
|
|
4592
|
-
"
|
|
5561
|
+
"DbtSyncPublicController.getDbtSyncLogs": {
|
|
4593
5562
|
parameters: {
|
|
4594
|
-
query?:
|
|
4595
|
-
type?: "production" | "staging" | "development";
|
|
4596
|
-
offset?: number | null;
|
|
4597
|
-
limit?: number | null;
|
|
4598
|
-
};
|
|
5563
|
+
query?: never;
|
|
4599
5564
|
header?: never;
|
|
4600
5565
|
path: {
|
|
4601
5566
|
deploymentId: number;
|
|
5567
|
+
syncJobId: string;
|
|
4602
5568
|
};
|
|
4603
5569
|
cookie?: never;
|
|
4604
5570
|
};
|
|
@@ -4609,21 +5575,18 @@ export interface operations {
|
|
|
4609
5575
|
[name: string]: any;
|
|
4610
5576
|
};
|
|
4611
5577
|
content: {
|
|
4612
|
-
"application/json": components["schemas"]["
|
|
5578
|
+
"application/json": components["schemas"]["DbtSyncLogEntriesListResponse"];
|
|
4613
5579
|
};
|
|
4614
5580
|
};
|
|
4615
5581
|
};
|
|
4616
5582
|
};
|
|
4617
|
-
"
|
|
5583
|
+
"DbtSyncPublicController.getDbtSyncResult": {
|
|
4618
5584
|
parameters: {
|
|
4619
|
-
query?:
|
|
4620
|
-
offset?: number | null;
|
|
4621
|
-
limit?: number | null;
|
|
4622
|
-
};
|
|
5585
|
+
query?: never;
|
|
4623
5586
|
header?: never;
|
|
4624
5587
|
path: {
|
|
4625
5588
|
deploymentId: number;
|
|
4626
|
-
|
|
5589
|
+
syncJobId: string;
|
|
4627
5590
|
};
|
|
4628
5591
|
cookie?: never;
|
|
4629
5592
|
};
|
|
@@ -4634,52 +5597,48 @@ export interface operations {
|
|
|
4634
5597
|
[name: string]: any;
|
|
4635
5598
|
};
|
|
4636
5599
|
content: {
|
|
4637
|
-
"application/json": components["schemas"]["
|
|
5600
|
+
"application/json": components["schemas"]["DbtSyncResultResponse"];
|
|
4638
5601
|
};
|
|
4639
5602
|
};
|
|
4640
5603
|
};
|
|
4641
5604
|
};
|
|
4642
|
-
"
|
|
5605
|
+
"EnvVariablesPublicController.getEnvVariables": {
|
|
4643
5606
|
parameters: {
|
|
4644
|
-
query?:
|
|
5607
|
+
query?: {
|
|
5608
|
+
after?: string | null;
|
|
5609
|
+
first?: number | null;
|
|
5610
|
+
};
|
|
4645
5611
|
header?: never;
|
|
4646
5612
|
path: {
|
|
4647
5613
|
deploymentId: number;
|
|
4648
|
-
environmentId: number;
|
|
4649
5614
|
};
|
|
4650
5615
|
cookie?: never;
|
|
4651
5616
|
};
|
|
4652
|
-
|
|
4653
|
-
requestBody?: {
|
|
4654
|
-
content: {
|
|
4655
|
-
"application/json": components["schemas"]["CreateDeploymentEnvironmentTokenInput"];
|
|
4656
|
-
};
|
|
4657
|
-
};
|
|
5617
|
+
requestBody?: never;
|
|
4658
5618
|
responses: {
|
|
4659
5619
|
200: {
|
|
4660
5620
|
headers: {
|
|
4661
5621
|
[name: string]: any;
|
|
4662
5622
|
};
|
|
4663
5623
|
content: {
|
|
4664
|
-
"application/json": components["schemas"]["
|
|
5624
|
+
"application/json": components["schemas"]["EnvVariablesListResponse"];
|
|
4665
5625
|
};
|
|
4666
5626
|
};
|
|
4667
5627
|
};
|
|
4668
5628
|
};
|
|
4669
|
-
"
|
|
5629
|
+
"EnvVariablesPublicController.setEnvVariables": {
|
|
4670
5630
|
parameters: {
|
|
4671
5631
|
query?: never;
|
|
4672
5632
|
header?: never;
|
|
4673
5633
|
path: {
|
|
4674
5634
|
deploymentId: number;
|
|
4675
|
-
environmentId: number;
|
|
4676
5635
|
};
|
|
4677
5636
|
cookie?: never;
|
|
4678
5637
|
};
|
|
4679
|
-
/** @description
|
|
5638
|
+
/** @description SetEnvVariablesInput */
|
|
4680
5639
|
requestBody?: {
|
|
4681
5640
|
content: {
|
|
4682
|
-
"application/json": components["schemas"]["
|
|
5641
|
+
"application/json": components["schemas"]["SetEnvVariablesInput"];
|
|
4683
5642
|
};
|
|
4684
5643
|
};
|
|
4685
5644
|
responses: {
|
|
@@ -4688,15 +5647,17 @@ export interface operations {
|
|
|
4688
5647
|
[name: string]: any;
|
|
4689
5648
|
};
|
|
4690
5649
|
content: {
|
|
4691
|
-
"application/json": components["schemas"]["
|
|
5650
|
+
"application/json": components["schemas"]["EnvVariablesListResponse"];
|
|
4692
5651
|
};
|
|
4693
5652
|
};
|
|
4694
5653
|
};
|
|
4695
5654
|
};
|
|
4696
|
-
"
|
|
5655
|
+
"DeploymentEnvironmentPublicController.getDeploymentEnvironments": {
|
|
4697
5656
|
parameters: {
|
|
4698
5657
|
query?: {
|
|
4699
|
-
|
|
5658
|
+
type?: "production" | "staging" | "development";
|
|
5659
|
+
offset?: number | null;
|
|
5660
|
+
limit?: number | null;
|
|
4700
5661
|
after?: string;
|
|
4701
5662
|
first?: number;
|
|
4702
5663
|
};
|
|
@@ -4713,25 +5674,131 @@ export interface operations {
|
|
|
4713
5674
|
[name: string]: any;
|
|
4714
5675
|
};
|
|
4715
5676
|
content: {
|
|
4716
|
-
"application/json": components["schemas"]["
|
|
5677
|
+
"application/json": components["schemas"]["DeploymentEnvironmentsListResponse"];
|
|
4717
5678
|
};
|
|
4718
5679
|
};
|
|
4719
5680
|
};
|
|
4720
5681
|
};
|
|
4721
|
-
"
|
|
5682
|
+
"DeploymentEnvironmentPublicController.getDeploymentEnvironmentTokens": {
|
|
4722
5683
|
parameters: {
|
|
4723
|
-
query?:
|
|
5684
|
+
query?: {
|
|
5685
|
+
offset?: number | null;
|
|
5686
|
+
limit?: number | null;
|
|
5687
|
+
after?: string;
|
|
5688
|
+
first?: number;
|
|
5689
|
+
};
|
|
4724
5690
|
header?: never;
|
|
4725
5691
|
path: {
|
|
4726
5692
|
deploymentId: number;
|
|
5693
|
+
environmentId: number;
|
|
4727
5694
|
};
|
|
4728
5695
|
cookie?: never;
|
|
4729
5696
|
};
|
|
4730
|
-
|
|
4731
|
-
|
|
4732
|
-
|
|
4733
|
-
|
|
4734
|
-
|
|
5697
|
+
requestBody?: never;
|
|
5698
|
+
responses: {
|
|
5699
|
+
200: {
|
|
5700
|
+
headers: {
|
|
5701
|
+
[name: string]: any;
|
|
5702
|
+
};
|
|
5703
|
+
content: {
|
|
5704
|
+
"application/json": components["schemas"]["DeploymentEnvironmentTokensListResponse"];
|
|
5705
|
+
};
|
|
5706
|
+
};
|
|
5707
|
+
};
|
|
5708
|
+
};
|
|
5709
|
+
"DeploymentEnvironmentPublicController.createDeploymentEnvironmentToken": {
|
|
5710
|
+
parameters: {
|
|
5711
|
+
query?: never;
|
|
5712
|
+
header?: never;
|
|
5713
|
+
path: {
|
|
5714
|
+
deploymentId: number;
|
|
5715
|
+
environmentId: number;
|
|
5716
|
+
};
|
|
5717
|
+
cookie?: never;
|
|
5718
|
+
};
|
|
5719
|
+
/** @description CreateDeploymentEnvironmentTokenInput */
|
|
5720
|
+
requestBody?: {
|
|
5721
|
+
content: {
|
|
5722
|
+
"application/json": components["schemas"]["CreateDeploymentEnvironmentTokenInput"];
|
|
5723
|
+
};
|
|
5724
|
+
};
|
|
5725
|
+
responses: {
|
|
5726
|
+
200: {
|
|
5727
|
+
headers: {
|
|
5728
|
+
[name: string]: any;
|
|
5729
|
+
};
|
|
5730
|
+
content: {
|
|
5731
|
+
"application/json": components["schemas"]["DeploymentEnvironmentTokenResponse"];
|
|
5732
|
+
};
|
|
5733
|
+
};
|
|
5734
|
+
};
|
|
5735
|
+
};
|
|
5736
|
+
"DeploymentEnvironmentPublicController.createDeploymentEnvironmentTokenForMetaSync": {
|
|
5737
|
+
parameters: {
|
|
5738
|
+
query?: never;
|
|
5739
|
+
header?: never;
|
|
5740
|
+
path: {
|
|
5741
|
+
deploymentId: number;
|
|
5742
|
+
environmentId: number;
|
|
5743
|
+
};
|
|
5744
|
+
cookie?: never;
|
|
5745
|
+
};
|
|
5746
|
+
/** @description CreateDeploymentEnvironmentTokenInput */
|
|
5747
|
+
requestBody?: {
|
|
5748
|
+
content: {
|
|
5749
|
+
"application/json": components["schemas"]["CreateDeploymentEnvironmentTokenInput"];
|
|
5750
|
+
};
|
|
5751
|
+
};
|
|
5752
|
+
responses: {
|
|
5753
|
+
200: {
|
|
5754
|
+
headers: {
|
|
5755
|
+
[name: string]: any;
|
|
5756
|
+
};
|
|
5757
|
+
content: {
|
|
5758
|
+
"application/json": components["schemas"]["DeploymentEnvironmentTokenResponse"];
|
|
5759
|
+
};
|
|
5760
|
+
};
|
|
5761
|
+
};
|
|
5762
|
+
};
|
|
5763
|
+
"FoldersPublicController.getFolders": {
|
|
5764
|
+
parameters: {
|
|
5765
|
+
query?: {
|
|
5766
|
+
parentId?: number | null;
|
|
5767
|
+
after?: string;
|
|
5768
|
+
first?: number;
|
|
5769
|
+
};
|
|
5770
|
+
header?: never;
|
|
5771
|
+
path: {
|
|
5772
|
+
deploymentId: number;
|
|
5773
|
+
};
|
|
5774
|
+
cookie?: never;
|
|
5775
|
+
};
|
|
5776
|
+
requestBody?: never;
|
|
5777
|
+
responses: {
|
|
5778
|
+
200: {
|
|
5779
|
+
headers: {
|
|
5780
|
+
[name: string]: any;
|
|
5781
|
+
};
|
|
5782
|
+
content: {
|
|
5783
|
+
"application/json": components["schemas"]["FoldersListResponse"];
|
|
5784
|
+
};
|
|
5785
|
+
};
|
|
5786
|
+
};
|
|
5787
|
+
};
|
|
5788
|
+
"FoldersPublicController.createFolder": {
|
|
5789
|
+
parameters: {
|
|
5790
|
+
query?: never;
|
|
5791
|
+
header?: never;
|
|
5792
|
+
path: {
|
|
5793
|
+
deploymentId: number;
|
|
5794
|
+
};
|
|
5795
|
+
cookie?: never;
|
|
5796
|
+
};
|
|
5797
|
+
/** @description CreateFolderInput */
|
|
5798
|
+
requestBody?: {
|
|
5799
|
+
content: {
|
|
5800
|
+
"application/json": components["schemas"]["CreateFolderInput"];
|
|
5801
|
+
};
|
|
4735
5802
|
};
|
|
4736
5803
|
responses: {
|
|
4737
5804
|
200: {
|
|
@@ -4822,6 +5889,8 @@ export interface operations {
|
|
|
4822
5889
|
source?: components["schemas"]["DeploymentLogsQuerySource"] | null;
|
|
4823
5890
|
pod?: string | null;
|
|
4824
5891
|
container?: components["schemas"]["DeploymentLogsQueryContainer"] | null;
|
|
5892
|
+
after?: string;
|
|
5893
|
+
first?: number;
|
|
4825
5894
|
};
|
|
4826
5895
|
header?: never;
|
|
4827
5896
|
path: {
|
|
@@ -4844,22 +5913,14 @@ export interface operations {
|
|
|
4844
5913
|
"NotificationsPublicController.getNotifications": {
|
|
4845
5914
|
parameters: {
|
|
4846
5915
|
query?: {
|
|
4847
|
-
/** @description Optional filter: only return notifications for this numeric dashboard id. Provide this OR `dashboardPublicId`, not both. */
|
|
4848
5916
|
dashboardId?: number | null;
|
|
4849
|
-
/** @description Optional filter: only return notifications for this dashboard public id. Provide this OR `dashboardId`, not both. */
|
|
4850
5917
|
dashboardPublicId?: string | null;
|
|
4851
|
-
/** @description Optional filter: only return notifications received by this user, by user id. Mutually exclusive with `recipientEmail` and the embed-user filter. */
|
|
4852
5918
|
recipientUserId?: number | null;
|
|
4853
|
-
/** @description Optional filter: only return notifications received by this user, by email. Mutually exclusive with `recipientUserId` and the embed-user filter. */
|
|
4854
5919
|
recipientEmail?: string | null;
|
|
4855
|
-
/** @description Optional filter: only return notifications received by this embed user. Required together with `recipientExternalId`; mutually exclusive with the user filters. */
|
|
4856
5920
|
recipientEmbedTenantName?: string | null;
|
|
4857
|
-
/** @description Optional filter: only return notifications received by this embed user. Required together with `recipientEmbedTenantName`; mutually exclusive with the user filters. */
|
|
4858
5921
|
recipientExternalId?: string | null;
|
|
4859
|
-
/** @description Page size for cursor pagination (default 100, max 200). */
|
|
4860
|
-
first?: number;
|
|
4861
|
-
/** @description Opaque cursor for the next page; pass the previous response's `pageInfo.endCursor`. */
|
|
4862
5922
|
after?: string;
|
|
5923
|
+
first?: number;
|
|
4863
5924
|
};
|
|
4864
5925
|
header?: never;
|
|
4865
5926
|
path: {
|
|
@@ -4995,10 +6056,8 @@ export interface operations {
|
|
|
4995
6056
|
"NotificationsPublicController.getRecipients": {
|
|
4996
6057
|
parameters: {
|
|
4997
6058
|
query?: {
|
|
4998
|
-
|
|
4999
|
-
first?: number |
|
|
5000
|
-
/** @description Opaque cursor for the next page; pass the previous response's `pageInfo.endCursor`. */
|
|
5001
|
-
after?: string | number | null;
|
|
6059
|
+
after?: string | null;
|
|
6060
|
+
first?: number | null;
|
|
5002
6061
|
};
|
|
5003
6062
|
header?: never;
|
|
5004
6063
|
path: {
|
|
@@ -5089,7 +6148,10 @@ export interface operations {
|
|
|
5089
6148
|
};
|
|
5090
6149
|
"DeploymentsPublicController.pods": {
|
|
5091
6150
|
parameters: {
|
|
5092
|
-
query?:
|
|
6151
|
+
query?: {
|
|
6152
|
+
after?: string | null;
|
|
6153
|
+
first?: number | null;
|
|
6154
|
+
};
|
|
5093
6155
|
header?: never;
|
|
5094
6156
|
path: {
|
|
5095
6157
|
deploymentId: number;
|
|
@@ -5110,7 +6172,10 @@ export interface operations {
|
|
|
5110
6172
|
};
|
|
5111
6173
|
"ReportsPublicController.getReportFolders": {
|
|
5112
6174
|
parameters: {
|
|
5113
|
-
query?:
|
|
6175
|
+
query?: {
|
|
6176
|
+
after?: string | null;
|
|
6177
|
+
first?: number | null;
|
|
6178
|
+
};
|
|
5114
6179
|
header?: never;
|
|
5115
6180
|
path: {
|
|
5116
6181
|
deploymentId: number;
|
|
@@ -5313,6 +6378,33 @@ export interface operations {
|
|
|
5313
6378
|
};
|
|
5314
6379
|
};
|
|
5315
6380
|
};
|
|
6381
|
+
"ReportsPublicController.disconnectReportFromWorkbook": {
|
|
6382
|
+
parameters: {
|
|
6383
|
+
query?: never;
|
|
6384
|
+
header?: never;
|
|
6385
|
+
path: {
|
|
6386
|
+
deploymentId: number;
|
|
6387
|
+
reportId: number;
|
|
6388
|
+
};
|
|
6389
|
+
cookie?: never;
|
|
6390
|
+
};
|
|
6391
|
+
/** @description DisconnectReportFromWorkbookInput */
|
|
6392
|
+
requestBody?: {
|
|
6393
|
+
content: {
|
|
6394
|
+
"application/json": components["schemas"]["DisconnectReportFromWorkbookInput"];
|
|
6395
|
+
};
|
|
6396
|
+
};
|
|
6397
|
+
responses: {
|
|
6398
|
+
200: {
|
|
6399
|
+
headers: {
|
|
6400
|
+
[name: string]: any;
|
|
6401
|
+
};
|
|
6402
|
+
content: {
|
|
6403
|
+
"application/json": components["schemas"]["Report"];
|
|
6404
|
+
};
|
|
6405
|
+
};
|
|
6406
|
+
};
|
|
6407
|
+
};
|
|
5316
6408
|
"ReportsPublicController.refreshReport": {
|
|
5317
6409
|
parameters: {
|
|
5318
6410
|
query?: never;
|
|
@@ -5323,7 +6415,12 @@ export interface operations {
|
|
|
5323
6415
|
};
|
|
5324
6416
|
cookie?: never;
|
|
5325
6417
|
};
|
|
5326
|
-
|
|
6418
|
+
/** @description RefreshReportInput */
|
|
6419
|
+
requestBody?: {
|
|
6420
|
+
content: {
|
|
6421
|
+
"application/json": components["schemas"]["RefreshReportInput"];
|
|
6422
|
+
};
|
|
6423
|
+
};
|
|
5327
6424
|
responses: {
|
|
5328
6425
|
200: {
|
|
5329
6426
|
headers: {
|
|
@@ -5335,6 +6432,27 @@ export interface operations {
|
|
|
5335
6432
|
};
|
|
5336
6433
|
};
|
|
5337
6434
|
};
|
|
6435
|
+
"DeploymentsPublicController.getDeploymentSettings": {
|
|
6436
|
+
parameters: {
|
|
6437
|
+
query?: never;
|
|
6438
|
+
header?: never;
|
|
6439
|
+
path: {
|
|
6440
|
+
deploymentId: number;
|
|
6441
|
+
};
|
|
6442
|
+
cookie?: never;
|
|
6443
|
+
};
|
|
6444
|
+
requestBody?: never;
|
|
6445
|
+
responses: {
|
|
6446
|
+
200: {
|
|
6447
|
+
headers: {
|
|
6448
|
+
[name: string]: any;
|
|
6449
|
+
};
|
|
6450
|
+
content: {
|
|
6451
|
+
"application/json": components["schemas"]["DeploymentSettings"];
|
|
6452
|
+
};
|
|
6453
|
+
};
|
|
6454
|
+
};
|
|
6455
|
+
};
|
|
5338
6456
|
"WorkspacePublicController.sharedWorkspaceObjects": {
|
|
5339
6457
|
parameters: {
|
|
5340
6458
|
query?: {
|
|
@@ -5385,6 +6503,30 @@ export interface operations {
|
|
|
5385
6503
|
};
|
|
5386
6504
|
};
|
|
5387
6505
|
};
|
|
6506
|
+
"DeploymentsPublicController.listDeploymentVersions": {
|
|
6507
|
+
parameters: {
|
|
6508
|
+
query?: {
|
|
6509
|
+
after?: string | null;
|
|
6510
|
+
first?: number | null;
|
|
6511
|
+
};
|
|
6512
|
+
header?: never;
|
|
6513
|
+
path: {
|
|
6514
|
+
deploymentId: number;
|
|
6515
|
+
};
|
|
6516
|
+
cookie?: never;
|
|
6517
|
+
};
|
|
6518
|
+
requestBody?: never;
|
|
6519
|
+
responses: {
|
|
6520
|
+
200: {
|
|
6521
|
+
headers: {
|
|
6522
|
+
[name: string]: any;
|
|
6523
|
+
};
|
|
6524
|
+
content: {
|
|
6525
|
+
"application/json": components["schemas"]["DeploymentVersionsResponse"];
|
|
6526
|
+
};
|
|
6527
|
+
};
|
|
6528
|
+
};
|
|
6529
|
+
};
|
|
5388
6530
|
"WorkbooksPublicController.getWorkbooks": {
|
|
5389
6531
|
parameters: {
|
|
5390
6532
|
query?: {
|
|
@@ -5563,33 +6705,6 @@ export interface operations {
|
|
|
5563
6705
|
};
|
|
5564
6706
|
};
|
|
5565
6707
|
};
|
|
5566
|
-
"WorkbooksPublicController.updatePublishedDashboardAiWidgetThread": {
|
|
5567
|
-
parameters: {
|
|
5568
|
-
query?: never;
|
|
5569
|
-
header?: never;
|
|
5570
|
-
path: {
|
|
5571
|
-
deploymentId: number;
|
|
5572
|
-
workbookId: number;
|
|
5573
|
-
};
|
|
5574
|
-
cookie?: never;
|
|
5575
|
-
};
|
|
5576
|
-
/** @description UpdatePublishedAiWidgetThreadInput */
|
|
5577
|
-
requestBody?: {
|
|
5578
|
-
content: {
|
|
5579
|
-
"application/json": components["schemas"]["UpdatePublishedAiWidgetThreadInput"];
|
|
5580
|
-
};
|
|
5581
|
-
};
|
|
5582
|
-
responses: {
|
|
5583
|
-
200: {
|
|
5584
|
-
headers: {
|
|
5585
|
-
[name: string]: any;
|
|
5586
|
-
};
|
|
5587
|
-
content: {
|
|
5588
|
-
"application/json": components["schemas"]["Dashboard"];
|
|
5589
|
-
};
|
|
5590
|
-
};
|
|
5591
|
-
};
|
|
5592
|
-
};
|
|
5593
6708
|
"WorkbooksPublicController.duplicateWorkbook": {
|
|
5594
6709
|
parameters: {
|
|
5595
6710
|
query?: never;
|
|
@@ -6083,13 +7198,9 @@ export interface operations {
|
|
|
6083
7198
|
};
|
|
6084
7199
|
};
|
|
6085
7200
|
};
|
|
6086
|
-
"EmbedTenantAdminPublicController.
|
|
7201
|
+
"EmbedTenantAdminPublicController.provisionEmbedUser": {
|
|
6087
7202
|
parameters: {
|
|
6088
|
-
query?:
|
|
6089
|
-
search?: string | null;
|
|
6090
|
-
after?: string;
|
|
6091
|
-
first?: number;
|
|
6092
|
-
};
|
|
7203
|
+
query?: never;
|
|
6093
7204
|
header?: never;
|
|
6094
7205
|
path: {
|
|
6095
7206
|
/** @description Name of the embed tenant (the `embedTenantName` used to generate embed sessions). */
|
|
@@ -6097,24 +7208,34 @@ export interface operations {
|
|
|
6097
7208
|
};
|
|
6098
7209
|
cookie?: never;
|
|
6099
7210
|
};
|
|
6100
|
-
|
|
7211
|
+
/** @description ProvisionEmbedUserInput */
|
|
7212
|
+
requestBody?: {
|
|
7213
|
+
content: {
|
|
7214
|
+
"application/json": components["schemas"]["ProvisionEmbedUserInput"];
|
|
7215
|
+
};
|
|
7216
|
+
};
|
|
6101
7217
|
responses: {
|
|
6102
7218
|
200: {
|
|
6103
7219
|
headers: {
|
|
6104
7220
|
[name: string]: any;
|
|
6105
7221
|
};
|
|
6106
7222
|
content: {
|
|
6107
|
-
"application/json": components["schemas"]["
|
|
7223
|
+
"application/json": components["schemas"]["EmbedUser"];
|
|
6108
7224
|
};
|
|
6109
7225
|
};
|
|
6110
7226
|
};
|
|
6111
7227
|
};
|
|
6112
|
-
"
|
|
7228
|
+
"EmbedTenantAdminPublicController.listEmbedUsers": {
|
|
6113
7229
|
parameters: {
|
|
6114
|
-
query?:
|
|
7230
|
+
query?: {
|
|
7231
|
+
search?: string | null;
|
|
7232
|
+
after?: string;
|
|
7233
|
+
first?: number;
|
|
7234
|
+
};
|
|
6115
7235
|
header?: never;
|
|
6116
7236
|
path: {
|
|
6117
|
-
|
|
7237
|
+
/** @description Name of the embed tenant (the `embedTenantName` used to generate embed sessions). */
|
|
7238
|
+
embedTenantName: string;
|
|
6118
7239
|
};
|
|
6119
7240
|
cookie?: never;
|
|
6120
7241
|
};
|
|
@@ -6125,24 +7246,25 @@ export interface operations {
|
|
|
6125
7246
|
[name: string]: any;
|
|
6126
7247
|
};
|
|
6127
7248
|
content: {
|
|
6128
|
-
"application/json": components["schemas"]["
|
|
7249
|
+
"application/json": components["schemas"]["EmbedUsersPublicResponse"];
|
|
6129
7250
|
};
|
|
6130
7251
|
};
|
|
6131
7252
|
};
|
|
6132
7253
|
};
|
|
6133
|
-
"
|
|
7254
|
+
"EmbedTenantAdminPublicController.provisionEmbedUsers": {
|
|
6134
7255
|
parameters: {
|
|
6135
7256
|
query?: never;
|
|
6136
7257
|
header?: never;
|
|
6137
7258
|
path: {
|
|
6138
|
-
|
|
7259
|
+
/** @description Name of the embed tenant (the `embedTenantName` used to generate embed sessions). */
|
|
7260
|
+
embedTenantName: string;
|
|
6139
7261
|
};
|
|
6140
7262
|
cookie?: never;
|
|
6141
7263
|
};
|
|
6142
|
-
/** @description
|
|
7264
|
+
/** @description ProvisionEmbedUsersInput */
|
|
6143
7265
|
requestBody?: {
|
|
6144
7266
|
content: {
|
|
6145
|
-
"application/json": components["schemas"]["
|
|
7267
|
+
"application/json": components["schemas"]["ProvisionEmbedUsersInput"];
|
|
6146
7268
|
};
|
|
6147
7269
|
};
|
|
6148
7270
|
responses: {
|
|
@@ -6151,12 +7273,12 @@ export interface operations {
|
|
|
6151
7273
|
[name: string]: any;
|
|
6152
7274
|
};
|
|
6153
7275
|
content: {
|
|
6154
|
-
"application/json": components["schemas"]["
|
|
7276
|
+
"application/json": components["schemas"]["ProvisionEmbedUsersResponse"];
|
|
6155
7277
|
};
|
|
6156
7278
|
};
|
|
6157
7279
|
};
|
|
6158
7280
|
};
|
|
6159
|
-
"EmbedPublicController.
|
|
7281
|
+
"EmbedPublicController.getDashboard": {
|
|
6160
7282
|
parameters: {
|
|
6161
7283
|
query?: never;
|
|
6162
7284
|
header?: never;
|
|
@@ -6165,12 +7287,59 @@ export interface operations {
|
|
|
6165
7287
|
};
|
|
6166
7288
|
cookie?: never;
|
|
6167
7289
|
};
|
|
6168
|
-
|
|
6169
|
-
|
|
6170
|
-
|
|
6171
|
-
|
|
6172
|
-
|
|
6173
|
-
|
|
7290
|
+
requestBody?: never;
|
|
7291
|
+
responses: {
|
|
7292
|
+
200: {
|
|
7293
|
+
headers: {
|
|
7294
|
+
[name: string]: any;
|
|
7295
|
+
};
|
|
7296
|
+
content: {
|
|
7297
|
+
"application/json": components["schemas"]["Dashboard"];
|
|
7298
|
+
};
|
|
7299
|
+
};
|
|
7300
|
+
};
|
|
7301
|
+
};
|
|
7302
|
+
"EmbedPublicController.updateDashboardEmbedding": {
|
|
7303
|
+
parameters: {
|
|
7304
|
+
query?: never;
|
|
7305
|
+
header?: never;
|
|
7306
|
+
path: {
|
|
7307
|
+
publicId: string;
|
|
7308
|
+
};
|
|
7309
|
+
cookie?: never;
|
|
7310
|
+
};
|
|
7311
|
+
/** @description UpdateDashboardEmbeddingInput */
|
|
7312
|
+
requestBody?: {
|
|
7313
|
+
content: {
|
|
7314
|
+
"application/json": components["schemas"]["UpdateDashboardEmbeddingInput"];
|
|
7315
|
+
};
|
|
7316
|
+
};
|
|
7317
|
+
responses: {
|
|
7318
|
+
200: {
|
|
7319
|
+
headers: {
|
|
7320
|
+
[name: string]: any;
|
|
7321
|
+
};
|
|
7322
|
+
content: {
|
|
7323
|
+
"application/json": components["schemas"]["DashboardEmbeddingResponse"];
|
|
7324
|
+
};
|
|
7325
|
+
};
|
|
7326
|
+
};
|
|
7327
|
+
};
|
|
7328
|
+
"EmbedPublicController.postDashboardPythonRun": {
|
|
7329
|
+
parameters: {
|
|
7330
|
+
query?: never;
|
|
7331
|
+
header?: never;
|
|
7332
|
+
path: {
|
|
7333
|
+
publicId: string;
|
|
7334
|
+
};
|
|
7335
|
+
cookie?: never;
|
|
7336
|
+
};
|
|
7337
|
+
/** @description EmbedPythonFilteredRunInput */
|
|
7338
|
+
requestBody?: {
|
|
7339
|
+
content: {
|
|
7340
|
+
"application/json": components["schemas"]["EmbedPythonFilteredRunInput"];
|
|
7341
|
+
};
|
|
7342
|
+
};
|
|
6174
7343
|
responses: {
|
|
6175
7344
|
200: {
|
|
6176
7345
|
headers: {
|
|
@@ -6231,30 +7400,304 @@ export interface operations {
|
|
|
6231
7400
|
};
|
|
6232
7401
|
};
|
|
6233
7402
|
"GitHubPublicController.installations": {
|
|
7403
|
+
parameters: {
|
|
7404
|
+
query?: {
|
|
7405
|
+
after?: string | null;
|
|
7406
|
+
first?: number | null;
|
|
7407
|
+
};
|
|
7408
|
+
header?: never;
|
|
7409
|
+
path?: never;
|
|
7410
|
+
cookie?: never;
|
|
7411
|
+
};
|
|
7412
|
+
requestBody?: never;
|
|
7413
|
+
responses: {
|
|
7414
|
+
200: {
|
|
7415
|
+
headers: {
|
|
7416
|
+
[name: string]: any;
|
|
7417
|
+
};
|
|
7418
|
+
content: {
|
|
7419
|
+
"application/json": components["schemas"]["GitHubInstallationsListResponse"];
|
|
7420
|
+
};
|
|
7421
|
+
};
|
|
7422
|
+
};
|
|
7423
|
+
};
|
|
7424
|
+
"GitHubPublicController.repositories": {
|
|
7425
|
+
parameters: {
|
|
7426
|
+
query?: {
|
|
7427
|
+
after?: string | null;
|
|
7428
|
+
first?: number | null;
|
|
7429
|
+
};
|
|
7430
|
+
header?: never;
|
|
7431
|
+
path: {
|
|
7432
|
+
installationId: number;
|
|
7433
|
+
};
|
|
7434
|
+
cookie?: never;
|
|
7435
|
+
};
|
|
7436
|
+
requestBody?: never;
|
|
7437
|
+
responses: {
|
|
7438
|
+
200: {
|
|
7439
|
+
headers: {
|
|
7440
|
+
[name: string]: any;
|
|
7441
|
+
};
|
|
7442
|
+
content: {
|
|
7443
|
+
"application/json": components["schemas"]["GitHubReposListResponse"];
|
|
7444
|
+
};
|
|
7445
|
+
};
|
|
7446
|
+
};
|
|
7447
|
+
};
|
|
7448
|
+
"GitHubPublicController.branches": {
|
|
7449
|
+
parameters: {
|
|
7450
|
+
query: {
|
|
7451
|
+
installationId: number;
|
|
7452
|
+
after?: string | null;
|
|
7453
|
+
first?: number | null;
|
|
7454
|
+
};
|
|
7455
|
+
header?: never;
|
|
7456
|
+
path: {
|
|
7457
|
+
owner: string;
|
|
7458
|
+
repo: string;
|
|
7459
|
+
};
|
|
7460
|
+
cookie?: never;
|
|
7461
|
+
};
|
|
7462
|
+
requestBody?: never;
|
|
7463
|
+
responses: {
|
|
7464
|
+
200: {
|
|
7465
|
+
headers: {
|
|
7466
|
+
[name: string]: any;
|
|
7467
|
+
};
|
|
7468
|
+
content: {
|
|
7469
|
+
"application/json": components["schemas"]["GitHubBranchesListResponse"];
|
|
7470
|
+
};
|
|
7471
|
+
};
|
|
7472
|
+
};
|
|
7473
|
+
};
|
|
7474
|
+
"GitHubPublicController.status": {
|
|
7475
|
+
parameters: {
|
|
7476
|
+
query?: never;
|
|
7477
|
+
header?: never;
|
|
7478
|
+
path?: never;
|
|
7479
|
+
cookie?: never;
|
|
7480
|
+
};
|
|
7481
|
+
requestBody?: never;
|
|
7482
|
+
responses: {
|
|
7483
|
+
200: {
|
|
7484
|
+
headers: {
|
|
7485
|
+
[name: string]: any;
|
|
7486
|
+
};
|
|
7487
|
+
content: {
|
|
7488
|
+
"application/json": components["schemas"]["GitHubConnectStatusResponse"];
|
|
7489
|
+
};
|
|
7490
|
+
};
|
|
7491
|
+
};
|
|
7492
|
+
};
|
|
7493
|
+
"GroupsPublicController.deleteGroup": {
|
|
7494
|
+
parameters: {
|
|
7495
|
+
query?: never;
|
|
7496
|
+
header?: never;
|
|
7497
|
+
path: {
|
|
7498
|
+
id: number;
|
|
7499
|
+
};
|
|
7500
|
+
cookie?: never;
|
|
7501
|
+
};
|
|
7502
|
+
requestBody?: never;
|
|
7503
|
+
responses: {
|
|
7504
|
+
/** @description Successful response */
|
|
7505
|
+
200: {
|
|
7506
|
+
headers: {
|
|
7507
|
+
[name: string]: any;
|
|
7508
|
+
};
|
|
7509
|
+
content: {
|
|
7510
|
+
"application/json": any;
|
|
7511
|
+
};
|
|
7512
|
+
};
|
|
7513
|
+
};
|
|
7514
|
+
};
|
|
7515
|
+
"MetadataPublicController.getMetadata": {
|
|
7516
|
+
parameters: {
|
|
7517
|
+
query?: never;
|
|
7518
|
+
header?: never;
|
|
7519
|
+
path?: never;
|
|
7520
|
+
cookie?: never;
|
|
7521
|
+
};
|
|
7522
|
+
/** @description MetadataRequest */
|
|
7523
|
+
requestBody?: {
|
|
7524
|
+
content: {
|
|
7525
|
+
"application/json": components["schemas"]["MetadataRequest"];
|
|
7526
|
+
};
|
|
7527
|
+
};
|
|
7528
|
+
responses: {
|
|
7529
|
+
/** @description Successful response */
|
|
7530
|
+
200: {
|
|
7531
|
+
headers: {
|
|
7532
|
+
[name: string]: any;
|
|
7533
|
+
};
|
|
7534
|
+
content: {
|
|
7535
|
+
"application/json": any;
|
|
7536
|
+
};
|
|
7537
|
+
};
|
|
7538
|
+
};
|
|
7539
|
+
};
|
|
7540
|
+
"OAuthIntegrationsPublicController.listOAuthIntegrations": {
|
|
7541
|
+
parameters: {
|
|
7542
|
+
query?: never;
|
|
7543
|
+
header?: never;
|
|
7544
|
+
path?: never;
|
|
7545
|
+
cookie?: never;
|
|
7546
|
+
};
|
|
7547
|
+
requestBody?: never;
|
|
7548
|
+
responses: {
|
|
7549
|
+
200: {
|
|
7550
|
+
headers: {
|
|
7551
|
+
[name: string]: any;
|
|
7552
|
+
};
|
|
7553
|
+
content: {
|
|
7554
|
+
"application/json": components["schemas"]["OAuthIntegration"][];
|
|
7555
|
+
};
|
|
7556
|
+
};
|
|
7557
|
+
};
|
|
7558
|
+
};
|
|
7559
|
+
"OAuthIntegrationsPublicController.createOAuthIntegration": {
|
|
7560
|
+
parameters: {
|
|
7561
|
+
query?: never;
|
|
7562
|
+
header?: never;
|
|
7563
|
+
path?: never;
|
|
7564
|
+
cookie?: never;
|
|
7565
|
+
};
|
|
7566
|
+
/** @description CreateOAuthIntegrationInput */
|
|
7567
|
+
requestBody?: {
|
|
7568
|
+
content: {
|
|
7569
|
+
"application/json": components["schemas"]["CreateOAuthIntegrationInput"];
|
|
7570
|
+
};
|
|
7571
|
+
};
|
|
7572
|
+
responses: {
|
|
7573
|
+
200: {
|
|
7574
|
+
headers: {
|
|
7575
|
+
[name: string]: any;
|
|
7576
|
+
};
|
|
7577
|
+
content: {
|
|
7578
|
+
"application/json": components["schemas"]["OAuthIntegration"];
|
|
7579
|
+
};
|
|
7580
|
+
};
|
|
7581
|
+
};
|
|
7582
|
+
};
|
|
7583
|
+
"OAuthIntegrationsPublicController.getOAuthIntegration": {
|
|
7584
|
+
parameters: {
|
|
7585
|
+
query?: never;
|
|
7586
|
+
header?: never;
|
|
7587
|
+
path: {
|
|
7588
|
+
id: number;
|
|
7589
|
+
};
|
|
7590
|
+
cookie?: never;
|
|
7591
|
+
};
|
|
7592
|
+
requestBody?: never;
|
|
7593
|
+
responses: {
|
|
7594
|
+
200: {
|
|
7595
|
+
headers: {
|
|
7596
|
+
[name: string]: any;
|
|
7597
|
+
};
|
|
7598
|
+
content: {
|
|
7599
|
+
"application/json": components["schemas"]["OAuthIntegration"];
|
|
7600
|
+
};
|
|
7601
|
+
};
|
|
7602
|
+
};
|
|
7603
|
+
};
|
|
7604
|
+
"OAuthIntegrationsPublicController.updateOAuthIntegration": {
|
|
7605
|
+
parameters: {
|
|
7606
|
+
query?: never;
|
|
7607
|
+
header?: never;
|
|
7608
|
+
path: {
|
|
7609
|
+
id: number;
|
|
7610
|
+
};
|
|
7611
|
+
cookie?: never;
|
|
7612
|
+
};
|
|
7613
|
+
/** @description UpdateOAuthIntegrationInput */
|
|
7614
|
+
requestBody?: {
|
|
7615
|
+
content: {
|
|
7616
|
+
"application/json": components["schemas"]["UpdateOAuthIntegrationInput"];
|
|
7617
|
+
};
|
|
7618
|
+
};
|
|
7619
|
+
responses: {
|
|
7620
|
+
200: {
|
|
7621
|
+
headers: {
|
|
7622
|
+
[name: string]: any;
|
|
7623
|
+
};
|
|
7624
|
+
content: {
|
|
7625
|
+
"application/json": components["schemas"]["OAuthIntegration"];
|
|
7626
|
+
};
|
|
7627
|
+
};
|
|
7628
|
+
};
|
|
7629
|
+
};
|
|
7630
|
+
"OAuthIntegrationsPublicController.deleteOAuthIntegration": {
|
|
7631
|
+
parameters: {
|
|
7632
|
+
query?: never;
|
|
7633
|
+
header?: never;
|
|
7634
|
+
path: {
|
|
7635
|
+
id: number;
|
|
7636
|
+
};
|
|
7637
|
+
cookie?: never;
|
|
7638
|
+
};
|
|
7639
|
+
requestBody?: never;
|
|
7640
|
+
responses: {
|
|
7641
|
+
/** @description Successful response */
|
|
7642
|
+
200: {
|
|
7643
|
+
headers: {
|
|
7644
|
+
[name: string]: any;
|
|
7645
|
+
};
|
|
7646
|
+
content: {
|
|
7647
|
+
"application/json": any;
|
|
7648
|
+
};
|
|
7649
|
+
};
|
|
7650
|
+
};
|
|
7651
|
+
};
|
|
7652
|
+
"OidcTokenConfigsPublicController.listOidcTokenConfigs": {
|
|
7653
|
+
parameters: {
|
|
7654
|
+
query?: never;
|
|
7655
|
+
header?: never;
|
|
7656
|
+
path?: never;
|
|
7657
|
+
cookie?: never;
|
|
7658
|
+
};
|
|
7659
|
+
requestBody?: never;
|
|
7660
|
+
responses: {
|
|
7661
|
+
200: {
|
|
7662
|
+
headers: {
|
|
7663
|
+
[name: string]: any;
|
|
7664
|
+
};
|
|
7665
|
+
content: {
|
|
7666
|
+
"application/json": components["schemas"]["OidcTokenConfig"][];
|
|
7667
|
+
};
|
|
7668
|
+
};
|
|
7669
|
+
};
|
|
7670
|
+
};
|
|
7671
|
+
"OidcTokenConfigsPublicController.createOidcTokenConfig": {
|
|
6234
7672
|
parameters: {
|
|
6235
7673
|
query?: never;
|
|
6236
7674
|
header?: never;
|
|
6237
7675
|
path?: never;
|
|
6238
7676
|
cookie?: never;
|
|
6239
7677
|
};
|
|
6240
|
-
|
|
7678
|
+
/** @description CreateOidcTokenConfigInput */
|
|
7679
|
+
requestBody?: {
|
|
7680
|
+
content: {
|
|
7681
|
+
"application/json": components["schemas"]["CreateOidcTokenConfigInput"];
|
|
7682
|
+
};
|
|
7683
|
+
};
|
|
6241
7684
|
responses: {
|
|
6242
7685
|
200: {
|
|
6243
7686
|
headers: {
|
|
6244
7687
|
[name: string]: any;
|
|
6245
7688
|
};
|
|
6246
7689
|
content: {
|
|
6247
|
-
"application/json": components["schemas"]["
|
|
7690
|
+
"application/json": components["schemas"]["OidcTokenConfig"];
|
|
6248
7691
|
};
|
|
6249
7692
|
};
|
|
6250
7693
|
};
|
|
6251
7694
|
};
|
|
6252
|
-
"
|
|
7695
|
+
"OidcTokenConfigsPublicController.getOidcTokenConfig": {
|
|
6253
7696
|
parameters: {
|
|
6254
7697
|
query?: never;
|
|
6255
7698
|
header?: never;
|
|
6256
7699
|
path: {
|
|
6257
|
-
|
|
7700
|
+
id: number;
|
|
6258
7701
|
};
|
|
6259
7702
|
cookie?: never;
|
|
6260
7703
|
};
|
|
@@ -6265,103 +7708,111 @@ export interface operations {
|
|
|
6265
7708
|
[name: string]: any;
|
|
6266
7709
|
};
|
|
6267
7710
|
content: {
|
|
6268
|
-
"application/json": components["schemas"]["
|
|
7711
|
+
"application/json": components["schemas"]["OidcTokenConfig"];
|
|
6269
7712
|
};
|
|
6270
7713
|
};
|
|
6271
7714
|
};
|
|
6272
7715
|
};
|
|
6273
|
-
"
|
|
7716
|
+
"OidcTokenConfigsPublicController.updateOidcTokenConfig": {
|
|
6274
7717
|
parameters: {
|
|
6275
|
-
query?:
|
|
6276
|
-
installationId?: number;
|
|
6277
|
-
};
|
|
7718
|
+
query?: never;
|
|
6278
7719
|
header?: never;
|
|
6279
7720
|
path: {
|
|
6280
|
-
|
|
7721
|
+
id: number;
|
|
6281
7722
|
};
|
|
6282
7723
|
cookie?: never;
|
|
6283
7724
|
};
|
|
6284
|
-
|
|
7725
|
+
/** @description UpdateOidcTokenConfigInput */
|
|
7726
|
+
requestBody?: {
|
|
7727
|
+
content: {
|
|
7728
|
+
"application/json": components["schemas"]["UpdateOidcTokenConfigInput"];
|
|
7729
|
+
};
|
|
7730
|
+
};
|
|
6285
7731
|
responses: {
|
|
6286
7732
|
200: {
|
|
6287
7733
|
headers: {
|
|
6288
7734
|
[name: string]: any;
|
|
6289
7735
|
};
|
|
6290
7736
|
content: {
|
|
6291
|
-
"application/json": components["schemas"]["
|
|
7737
|
+
"application/json": components["schemas"]["OidcTokenConfig"];
|
|
6292
7738
|
};
|
|
6293
7739
|
};
|
|
6294
7740
|
};
|
|
6295
7741
|
};
|
|
6296
|
-
"
|
|
7742
|
+
"OidcTokenConfigsPublicController.deleteOidcTokenConfig": {
|
|
6297
7743
|
parameters: {
|
|
6298
7744
|
query?: never;
|
|
6299
7745
|
header?: never;
|
|
6300
|
-
path
|
|
7746
|
+
path: {
|
|
7747
|
+
id: number;
|
|
7748
|
+
};
|
|
6301
7749
|
cookie?: never;
|
|
6302
7750
|
};
|
|
6303
7751
|
requestBody?: never;
|
|
6304
7752
|
responses: {
|
|
7753
|
+
/** @description Successful response */
|
|
6305
7754
|
200: {
|
|
6306
7755
|
headers: {
|
|
6307
7756
|
[name: string]: any;
|
|
6308
7757
|
};
|
|
6309
7758
|
content: {
|
|
6310
|
-
"application/json":
|
|
7759
|
+
"application/json": any;
|
|
6311
7760
|
};
|
|
6312
7761
|
};
|
|
6313
7762
|
};
|
|
6314
7763
|
};
|
|
6315
|
-
"
|
|
7764
|
+
"RegionsPublicController.listRegions": {
|
|
6316
7765
|
parameters: {
|
|
6317
|
-
query?:
|
|
6318
|
-
|
|
6319
|
-
|
|
6320
|
-
id: number;
|
|
7766
|
+
query?: {
|
|
7767
|
+
after?: string | null;
|
|
7768
|
+
first?: number | null;
|
|
6321
7769
|
};
|
|
7770
|
+
header?: never;
|
|
7771
|
+
path?: never;
|
|
6322
7772
|
cookie?: never;
|
|
6323
7773
|
};
|
|
6324
7774
|
requestBody?: never;
|
|
6325
7775
|
responses: {
|
|
6326
|
-
/** @description Successful response */
|
|
6327
7776
|
200: {
|
|
6328
7777
|
headers: {
|
|
6329
7778
|
[name: string]: any;
|
|
6330
7779
|
};
|
|
6331
7780
|
content: {
|
|
6332
|
-
"application/json":
|
|
7781
|
+
"application/json": components["schemas"]["RegionsListResponse"];
|
|
6333
7782
|
};
|
|
6334
7783
|
};
|
|
6335
7784
|
};
|
|
6336
7785
|
};
|
|
6337
|
-
"
|
|
7786
|
+
"RegionsPublicController.createRegion": {
|
|
6338
7787
|
parameters: {
|
|
6339
7788
|
query?: never;
|
|
6340
7789
|
header?: never;
|
|
6341
7790
|
path?: never;
|
|
6342
7791
|
cookie?: never;
|
|
6343
7792
|
};
|
|
6344
|
-
/** @description
|
|
7793
|
+
/** @description RegionCreateRequest */
|
|
6345
7794
|
requestBody?: {
|
|
6346
7795
|
content: {
|
|
6347
|
-
"application/json": components["schemas"]["
|
|
7796
|
+
"application/json": components["schemas"]["RegionCreateRequest"];
|
|
6348
7797
|
};
|
|
6349
7798
|
};
|
|
6350
7799
|
responses: {
|
|
6351
|
-
/** @description Successful response */
|
|
6352
7800
|
200: {
|
|
6353
7801
|
headers: {
|
|
6354
7802
|
[name: string]: any;
|
|
6355
7803
|
};
|
|
6356
7804
|
content: {
|
|
6357
|
-
"application/json":
|
|
7805
|
+
"application/json": components["schemas"]["ProvisionedRegionResponse"];
|
|
6358
7806
|
};
|
|
6359
7807
|
};
|
|
6360
7808
|
};
|
|
6361
7809
|
};
|
|
6362
|
-
"
|
|
7810
|
+
"RegionsPublicController.listCloudProviderCatalog": {
|
|
6363
7811
|
parameters: {
|
|
6364
|
-
query?:
|
|
7812
|
+
query?: {
|
|
7813
|
+
after?: string | null;
|
|
7814
|
+
first?: number | null;
|
|
7815
|
+
};
|
|
6365
7816
|
header?: never;
|
|
6366
7817
|
path?: never;
|
|
6367
7818
|
cookie?: never;
|
|
@@ -6373,109 +7824,110 @@ export interface operations {
|
|
|
6373
7824
|
[name: string]: any;
|
|
6374
7825
|
};
|
|
6375
7826
|
content: {
|
|
6376
|
-
"application/json": components["schemas"]["
|
|
7827
|
+
"application/json": components["schemas"]["RegionCloudProviderCatalogListResponse"];
|
|
6377
7828
|
};
|
|
6378
7829
|
};
|
|
6379
7830
|
};
|
|
6380
7831
|
};
|
|
6381
|
-
"
|
|
7832
|
+
"RegionsPublicController.getRegion": {
|
|
6382
7833
|
parameters: {
|
|
6383
7834
|
query?: never;
|
|
6384
7835
|
header?: never;
|
|
6385
|
-
path
|
|
6386
|
-
|
|
6387
|
-
};
|
|
6388
|
-
/** @description CreateOAuthIntegrationInput */
|
|
6389
|
-
requestBody?: {
|
|
6390
|
-
content: {
|
|
6391
|
-
"application/json": components["schemas"]["CreateOAuthIntegrationInput"];
|
|
7836
|
+
path: {
|
|
7837
|
+
regionId: number;
|
|
6392
7838
|
};
|
|
7839
|
+
cookie?: never;
|
|
6393
7840
|
};
|
|
7841
|
+
requestBody?: never;
|
|
6394
7842
|
responses: {
|
|
6395
7843
|
200: {
|
|
6396
7844
|
headers: {
|
|
6397
7845
|
[name: string]: any;
|
|
6398
7846
|
};
|
|
6399
7847
|
content: {
|
|
6400
|
-
"application/json": components["schemas"]["
|
|
7848
|
+
"application/json": components["schemas"]["ProvisionedRegionResponse"];
|
|
6401
7849
|
};
|
|
6402
7850
|
};
|
|
6403
7851
|
};
|
|
6404
7852
|
};
|
|
6405
|
-
"
|
|
7853
|
+
"RegionsPublicController.updateRegion": {
|
|
6406
7854
|
parameters: {
|
|
6407
7855
|
query?: never;
|
|
6408
7856
|
header?: never;
|
|
6409
7857
|
path: {
|
|
6410
|
-
|
|
7858
|
+
regionId: number;
|
|
6411
7859
|
};
|
|
6412
7860
|
cookie?: never;
|
|
6413
7861
|
};
|
|
6414
|
-
|
|
7862
|
+
/** @description RegionUpdateRequest */
|
|
7863
|
+
requestBody?: {
|
|
7864
|
+
content: {
|
|
7865
|
+
"application/json": components["schemas"]["RegionUpdateRequest"];
|
|
7866
|
+
};
|
|
7867
|
+
};
|
|
6415
7868
|
responses: {
|
|
6416
7869
|
200: {
|
|
6417
7870
|
headers: {
|
|
6418
7871
|
[name: string]: any;
|
|
6419
7872
|
};
|
|
6420
7873
|
content: {
|
|
6421
|
-
"application/json": components["schemas"]["
|
|
7874
|
+
"application/json": components["schemas"]["ProvisionedRegionResponse"];
|
|
6422
7875
|
};
|
|
6423
7876
|
};
|
|
6424
7877
|
};
|
|
6425
7878
|
};
|
|
6426
|
-
"
|
|
7879
|
+
"RegionsPublicController.destroyRegion": {
|
|
6427
7880
|
parameters: {
|
|
6428
7881
|
query?: never;
|
|
6429
7882
|
header?: never;
|
|
6430
7883
|
path: {
|
|
6431
|
-
|
|
7884
|
+
regionId: number;
|
|
6432
7885
|
};
|
|
6433
7886
|
cookie?: never;
|
|
6434
7887
|
};
|
|
6435
|
-
|
|
6436
|
-
requestBody?: {
|
|
6437
|
-
content: {
|
|
6438
|
-
"application/json": components["schemas"]["UpdateOAuthIntegrationInput"];
|
|
6439
|
-
};
|
|
6440
|
-
};
|
|
7888
|
+
requestBody?: never;
|
|
6441
7889
|
responses: {
|
|
6442
7890
|
200: {
|
|
6443
7891
|
headers: {
|
|
6444
7892
|
[name: string]: any;
|
|
6445
7893
|
};
|
|
6446
7894
|
content: {
|
|
6447
|
-
"application/json": components["schemas"]["
|
|
7895
|
+
"application/json": components["schemas"]["RegionProvisioningRunResponse"];
|
|
6448
7896
|
};
|
|
6449
7897
|
};
|
|
6450
7898
|
};
|
|
6451
7899
|
};
|
|
6452
|
-
"
|
|
7900
|
+
"RegionsPublicController.applyRegion": {
|
|
6453
7901
|
parameters: {
|
|
6454
7902
|
query?: never;
|
|
6455
7903
|
header?: never;
|
|
6456
7904
|
path: {
|
|
6457
|
-
|
|
7905
|
+
regionId: number;
|
|
6458
7906
|
};
|
|
6459
7907
|
cookie?: never;
|
|
6460
7908
|
};
|
|
6461
7909
|
requestBody?: never;
|
|
6462
7910
|
responses: {
|
|
6463
|
-
/** @description Successful response */
|
|
6464
7911
|
200: {
|
|
6465
7912
|
headers: {
|
|
6466
7913
|
[name: string]: any;
|
|
6467
7914
|
};
|
|
6468
7915
|
content: {
|
|
6469
|
-
"application/json":
|
|
7916
|
+
"application/json": components["schemas"]["RegionProvisioningRunResponse"];
|
|
6470
7917
|
};
|
|
6471
7918
|
};
|
|
6472
7919
|
};
|
|
6473
7920
|
};
|
|
6474
|
-
"
|
|
7921
|
+
"RegionPrivateLinksPublicController.listPrivateLinks": {
|
|
6475
7922
|
parameters: {
|
|
6476
|
-
query?:
|
|
7923
|
+
query?: {
|
|
7924
|
+
after?: string | null;
|
|
7925
|
+
first?: number | null;
|
|
7926
|
+
};
|
|
6477
7927
|
header?: never;
|
|
6478
|
-
path
|
|
7928
|
+
path: {
|
|
7929
|
+
regionId: number;
|
|
7930
|
+
};
|
|
6479
7931
|
cookie?: never;
|
|
6480
7932
|
};
|
|
6481
7933
|
requestBody?: never;
|
|
@@ -6485,22 +7937,24 @@ export interface operations {
|
|
|
6485
7937
|
[name: string]: any;
|
|
6486
7938
|
};
|
|
6487
7939
|
content: {
|
|
6488
|
-
"application/json": components["schemas"]["
|
|
7940
|
+
"application/json": components["schemas"]["RegionPrivateLinksListResponse"];
|
|
6489
7941
|
};
|
|
6490
7942
|
};
|
|
6491
7943
|
};
|
|
6492
7944
|
};
|
|
6493
|
-
"
|
|
7945
|
+
"RegionPrivateLinksPublicController.createPrivateLink": {
|
|
6494
7946
|
parameters: {
|
|
6495
7947
|
query?: never;
|
|
6496
7948
|
header?: never;
|
|
6497
|
-
path
|
|
7949
|
+
path: {
|
|
7950
|
+
regionId: number;
|
|
7951
|
+
};
|
|
6498
7952
|
cookie?: never;
|
|
6499
7953
|
};
|
|
6500
|
-
/** @description
|
|
7954
|
+
/** @description RegionPrivateLinkCreateRequest */
|
|
6501
7955
|
requestBody?: {
|
|
6502
7956
|
content: {
|
|
6503
|
-
"application/json": components["schemas"]["
|
|
7957
|
+
"application/json": components["schemas"]["RegionPrivateLinkCreateRequest"];
|
|
6504
7958
|
};
|
|
6505
7959
|
};
|
|
6506
7960
|
responses: {
|
|
@@ -6509,17 +7963,18 @@ export interface operations {
|
|
|
6509
7963
|
[name: string]: any;
|
|
6510
7964
|
};
|
|
6511
7965
|
content: {
|
|
6512
|
-
"application/json": components["schemas"]["
|
|
7966
|
+
"application/json": components["schemas"]["RegionPrivateLinkResponse"];
|
|
6513
7967
|
};
|
|
6514
7968
|
};
|
|
6515
7969
|
};
|
|
6516
7970
|
};
|
|
6517
|
-
"
|
|
7971
|
+
"RegionPrivateLinksPublicController.getPrivateLink": {
|
|
6518
7972
|
parameters: {
|
|
6519
7973
|
query?: never;
|
|
6520
7974
|
header?: never;
|
|
6521
7975
|
path: {
|
|
6522
|
-
|
|
7976
|
+
regionId: number;
|
|
7977
|
+
privateLinkId: number;
|
|
6523
7978
|
};
|
|
6524
7979
|
cookie?: never;
|
|
6525
7980
|
};
|
|
@@ -6530,24 +7985,25 @@ export interface operations {
|
|
|
6530
7985
|
[name: string]: any;
|
|
6531
7986
|
};
|
|
6532
7987
|
content: {
|
|
6533
|
-
"application/json": components["schemas"]["
|
|
7988
|
+
"application/json": components["schemas"]["RegionPrivateLinkResponse"];
|
|
6534
7989
|
};
|
|
6535
7990
|
};
|
|
6536
7991
|
};
|
|
6537
7992
|
};
|
|
6538
|
-
"
|
|
7993
|
+
"RegionPrivateLinksPublicController.updatePrivateLink": {
|
|
6539
7994
|
parameters: {
|
|
6540
7995
|
query?: never;
|
|
6541
7996
|
header?: never;
|
|
6542
7997
|
path: {
|
|
6543
|
-
|
|
7998
|
+
regionId: number;
|
|
7999
|
+
privateLinkId: number;
|
|
6544
8000
|
};
|
|
6545
8001
|
cookie?: never;
|
|
6546
8002
|
};
|
|
6547
|
-
/** @description
|
|
8003
|
+
/** @description RegionPrivateLinkUpdateRequest */
|
|
6548
8004
|
requestBody?: {
|
|
6549
8005
|
content: {
|
|
6550
|
-
"application/json": components["schemas"]["
|
|
8006
|
+
"application/json": components["schemas"]["RegionPrivateLinkUpdateRequest"];
|
|
6551
8007
|
};
|
|
6552
8008
|
};
|
|
6553
8009
|
responses: {
|
|
@@ -6556,38 +8012,40 @@ export interface operations {
|
|
|
6556
8012
|
[name: string]: any;
|
|
6557
8013
|
};
|
|
6558
8014
|
content: {
|
|
6559
|
-
"application/json": components["schemas"]["
|
|
8015
|
+
"application/json": components["schemas"]["RegionPrivateLinkResponse"];
|
|
6560
8016
|
};
|
|
6561
8017
|
};
|
|
6562
8018
|
};
|
|
6563
8019
|
};
|
|
6564
|
-
"
|
|
8020
|
+
"RegionPrivateLinksPublicController.removePrivateLink": {
|
|
6565
8021
|
parameters: {
|
|
6566
8022
|
query?: never;
|
|
6567
8023
|
header?: never;
|
|
6568
8024
|
path: {
|
|
6569
|
-
|
|
8025
|
+
regionId: number;
|
|
8026
|
+
privateLinkId: number;
|
|
6570
8027
|
};
|
|
6571
8028
|
cookie?: never;
|
|
6572
8029
|
};
|
|
6573
8030
|
requestBody?: never;
|
|
6574
8031
|
responses: {
|
|
6575
|
-
/** @description Successful response */
|
|
6576
8032
|
200: {
|
|
6577
8033
|
headers: {
|
|
6578
8034
|
[name: string]: any;
|
|
6579
8035
|
};
|
|
6580
8036
|
content: {
|
|
6581
|
-
"application/json":
|
|
8037
|
+
"application/json": components["schemas"]["RegionPrivateLinkRemoveResponse"];
|
|
6582
8038
|
};
|
|
6583
8039
|
};
|
|
6584
8040
|
};
|
|
6585
8041
|
};
|
|
6586
|
-
"RegionsPublicController.
|
|
8042
|
+
"RegionsPublicController.getRegionProvisioningStatus": {
|
|
6587
8043
|
parameters: {
|
|
6588
8044
|
query?: never;
|
|
6589
8045
|
header?: never;
|
|
6590
|
-
path
|
|
8046
|
+
path: {
|
|
8047
|
+
regionId: number;
|
|
8048
|
+
};
|
|
6591
8049
|
cookie?: never;
|
|
6592
8050
|
};
|
|
6593
8051
|
requestBody?: never;
|
|
@@ -6597,8 +8055,15 @@ export interface operations {
|
|
|
6597
8055
|
[name: string]: any;
|
|
6598
8056
|
};
|
|
6599
8057
|
content: {
|
|
6600
|
-
"application/json": components["schemas"]["
|
|
8058
|
+
"application/json": components["schemas"]["RegionProvisioningStatusResponse"];
|
|
8059
|
+
};
|
|
8060
|
+
};
|
|
8061
|
+
/** @description No provisioning run to report — the region has never been applied, or the provisioner does not manage it. A state, not an error. */
|
|
8062
|
+
204: {
|
|
8063
|
+
headers: {
|
|
8064
|
+
[name: string]: any;
|
|
6601
8065
|
};
|
|
8066
|
+
content?: never;
|
|
6602
8067
|
};
|
|
6603
8068
|
};
|
|
6604
8069
|
};
|
|
@@ -6674,6 +8139,28 @@ export interface operations {
|
|
|
6674
8139
|
};
|
|
6675
8140
|
};
|
|
6676
8141
|
};
|
|
8142
|
+
"OpenApiSpecPublicController.getSpec": {
|
|
8143
|
+
parameters: {
|
|
8144
|
+
query?: never;
|
|
8145
|
+
header?: never;
|
|
8146
|
+
path?: never;
|
|
8147
|
+
cookie?: never;
|
|
8148
|
+
};
|
|
8149
|
+
requestBody?: never;
|
|
8150
|
+
responses: {
|
|
8151
|
+
/** @description The OpenAPI 3.1 document */
|
|
8152
|
+
200: {
|
|
8153
|
+
headers: {
|
|
8154
|
+
[name: string]: any;
|
|
8155
|
+
};
|
|
8156
|
+
content: {
|
|
8157
|
+
"application/json": {
|
|
8158
|
+
[key: string]: any;
|
|
8159
|
+
};
|
|
8160
|
+
};
|
|
8161
|
+
};
|
|
8162
|
+
};
|
|
8163
|
+
};
|
|
6677
8164
|
"TenantSettingsPublicController.getTenantSettings": {
|
|
6678
8165
|
parameters: {
|
|
6679
8166
|
query?: never;
|
|
@@ -6717,6 +8204,25 @@ export interface operations {
|
|
|
6717
8204
|
};
|
|
6718
8205
|
};
|
|
6719
8206
|
};
|
|
8207
|
+
"UsageAnalyticsPublicController.createToken": {
|
|
8208
|
+
parameters: {
|
|
8209
|
+
query?: never;
|
|
8210
|
+
header?: never;
|
|
8211
|
+
path?: never;
|
|
8212
|
+
cookie?: never;
|
|
8213
|
+
};
|
|
8214
|
+
requestBody?: never;
|
|
8215
|
+
responses: {
|
|
8216
|
+
200: {
|
|
8217
|
+
headers: {
|
|
8218
|
+
[name: string]: any;
|
|
8219
|
+
};
|
|
8220
|
+
content: {
|
|
8221
|
+
"application/json": components["schemas"]["UsageAnalyticsTokenResponse"];
|
|
8222
|
+
};
|
|
8223
|
+
};
|
|
8224
|
+
};
|
|
8225
|
+
};
|
|
6720
8226
|
"UserAttributeValuesPublicController.upsertUserAttributeValue": {
|
|
6721
8227
|
parameters: {
|
|
6722
8228
|
query?: never;
|
|
@@ -6769,6 +8275,8 @@ export interface operations {
|
|
|
6769
8275
|
limit?: number | null;
|
|
6770
8276
|
name?: string | null;
|
|
6771
8277
|
type?: components["schemas"]["GetUserAttributesQueryType"] | null;
|
|
8278
|
+
after?: string;
|
|
8279
|
+
first?: number;
|
|
6772
8280
|
};
|
|
6773
8281
|
header?: never;
|
|
6774
8282
|
path?: never;
|
|
@@ -6861,8 +8369,9 @@ export interface operations {
|
|
|
6861
8369
|
"UserGroupsPublicController.listGroups": {
|
|
6862
8370
|
parameters: {
|
|
6863
8371
|
query?: {
|
|
6864
|
-
|
|
6865
|
-
|
|
8372
|
+
search?: string | null;
|
|
8373
|
+
after?: string;
|
|
8374
|
+
first?: number;
|
|
6866
8375
|
};
|
|
6867
8376
|
header?: never;
|
|
6868
8377
|
path?: never;
|
|
@@ -6967,8 +8476,9 @@ export interface operations {
|
|
|
6967
8476
|
"UsersPublicController.getUsers": {
|
|
6968
8477
|
parameters: {
|
|
6969
8478
|
query?: {
|
|
6970
|
-
|
|
6971
|
-
|
|
8479
|
+
search?: string | null;
|
|
8480
|
+
after?: string;
|
|
8481
|
+
first?: number;
|
|
6972
8482
|
};
|
|
6973
8483
|
header?: never;
|
|
6974
8484
|
path?: never;
|
|
@@ -7146,7 +8656,10 @@ export interface operations {
|
|
|
7146
8656
|
};
|
|
7147
8657
|
"DataModelPublicController.listBranches": {
|
|
7148
8658
|
parameters: {
|
|
7149
|
-
query?:
|
|
8659
|
+
query?: {
|
|
8660
|
+
after?: string | null;
|
|
8661
|
+
first?: number | null;
|
|
8662
|
+
};
|
|
7150
8663
|
header?: never;
|
|
7151
8664
|
path: {
|
|
7152
8665
|
deploymentId: number;
|
|
@@ -7191,6 +8704,56 @@ export interface operations {
|
|
|
7191
8704
|
};
|
|
7192
8705
|
};
|
|
7193
8706
|
};
|
|
8707
|
+
"DataModelPublicController.removeBranch": {
|
|
8708
|
+
parameters: {
|
|
8709
|
+
query: {
|
|
8710
|
+
branchName: string;
|
|
8711
|
+
removeOnUpstream?: boolean;
|
|
8712
|
+
};
|
|
8713
|
+
header?: never;
|
|
8714
|
+
path: {
|
|
8715
|
+
deploymentId: number;
|
|
8716
|
+
};
|
|
8717
|
+
cookie?: never;
|
|
8718
|
+
};
|
|
8719
|
+
requestBody?: never;
|
|
8720
|
+
responses: {
|
|
8721
|
+
200: {
|
|
8722
|
+
headers: {
|
|
8723
|
+
[name: string]: any;
|
|
8724
|
+
};
|
|
8725
|
+
content: {
|
|
8726
|
+
"application/json": components["schemas"]["DataModelWriteResponse"];
|
|
8727
|
+
};
|
|
8728
|
+
};
|
|
8729
|
+
};
|
|
8730
|
+
};
|
|
8731
|
+
"DataModelPublicController.setBranchStagingEnvironment": {
|
|
8732
|
+
parameters: {
|
|
8733
|
+
query?: never;
|
|
8734
|
+
header?: never;
|
|
8735
|
+
path: {
|
|
8736
|
+
deploymentId: number;
|
|
8737
|
+
};
|
|
8738
|
+
cookie?: never;
|
|
8739
|
+
};
|
|
8740
|
+
/** @description SetBranchStagingEnvironmentRequest */
|
|
8741
|
+
requestBody?: {
|
|
8742
|
+
content: {
|
|
8743
|
+
"application/json": components["schemas"]["SetBranchStagingEnvironmentRequest"];
|
|
8744
|
+
};
|
|
8745
|
+
};
|
|
8746
|
+
responses: {
|
|
8747
|
+
200: {
|
|
8748
|
+
headers: {
|
|
8749
|
+
[name: string]: any;
|
|
8750
|
+
};
|
|
8751
|
+
content: {
|
|
8752
|
+
"application/json": components["schemas"]["SetBranchStagingEnvironmentResponse"];
|
|
8753
|
+
};
|
|
8754
|
+
};
|
|
8755
|
+
};
|
|
8756
|
+
};
|
|
7194
8757
|
"DataModelPublicController.commitChanges": {
|
|
7195
8758
|
parameters: {
|
|
7196
8759
|
query?: never;
|
|
@@ -7251,6 +8814,8 @@ export interface operations {
|
|
|
7251
8814
|
withContent?: boolean;
|
|
7252
8815
|
branchName?: string;
|
|
7253
8816
|
showLastCLIUpload?: boolean;
|
|
8817
|
+
after?: string | null;
|
|
8818
|
+
first?: number | null;
|
|
7254
8819
|
};
|
|
7255
8820
|
header?: never;
|
|
7256
8821
|
path: {
|
|
@@ -7436,6 +9001,30 @@ export interface operations {
|
|
|
7436
9001
|
};
|
|
7437
9002
|
};
|
|
7438
9003
|
};
|
|
9004
|
+
"DataModelPublicController.validateDataModel": {
|
|
9005
|
+
parameters: {
|
|
9006
|
+
query?: {
|
|
9007
|
+
branchName?: string;
|
|
9008
|
+
devMode?: boolean;
|
|
9009
|
+
};
|
|
9010
|
+
header?: never;
|
|
9011
|
+
path: {
|
|
9012
|
+
deploymentId: 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"]["DataModelValidationResponse"];
|
|
9024
|
+
};
|
|
9025
|
+
};
|
|
9026
|
+
};
|
|
9027
|
+
};
|
|
7439
9028
|
"DataModelPublicController.startDevMode": {
|
|
7440
9029
|
parameters: {
|
|
7441
9030
|
query?: never;
|