@cube-dev/platform-client 0.12.0 → 0.14.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 +41 -1
- package/dist/schema.d.ts +700 -38
- package/dist/schema.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -147,6 +147,42 @@ export interface paths {
|
|
|
147
147
|
patch?: never;
|
|
148
148
|
trace?: never;
|
|
149
149
|
};
|
|
150
|
+
"/api/v1/api-keys/": {
|
|
151
|
+
parameters: {
|
|
152
|
+
query?: never;
|
|
153
|
+
header?: never;
|
|
154
|
+
path?: never;
|
|
155
|
+
cookie?: never;
|
|
156
|
+
};
|
|
157
|
+
/** List api keys */
|
|
158
|
+
get: operations["ApiKeysPublicController.listApiKeys"];
|
|
159
|
+
put?: never;
|
|
160
|
+
/** Create api key */
|
|
161
|
+
post: operations["ApiKeysPublicController.createApiKey"];
|
|
162
|
+
delete?: never;
|
|
163
|
+
options?: never;
|
|
164
|
+
head?: never;
|
|
165
|
+
patch?: never;
|
|
166
|
+
trace?: never;
|
|
167
|
+
};
|
|
168
|
+
"/api/v1/api-keys/{id}": {
|
|
169
|
+
parameters: {
|
|
170
|
+
query?: never;
|
|
171
|
+
header?: never;
|
|
172
|
+
path?: never;
|
|
173
|
+
cookie?: never;
|
|
174
|
+
};
|
|
175
|
+
/** Get api key */
|
|
176
|
+
get: operations["ApiKeysPublicController.getApiKey"];
|
|
177
|
+
put?: never;
|
|
178
|
+
post?: never;
|
|
179
|
+
/** Delete api key */
|
|
180
|
+
delete: operations["ApiKeysPublicController.deleteApiKey"];
|
|
181
|
+
options?: never;
|
|
182
|
+
head?: never;
|
|
183
|
+
patch?: never;
|
|
184
|
+
trace?: never;
|
|
185
|
+
};
|
|
150
186
|
"/api/v1/app-config": {
|
|
151
187
|
parameters: {
|
|
152
188
|
query?: never;
|
|
@@ -724,6 +760,66 @@ export interface paths {
|
|
|
724
760
|
patch?: never;
|
|
725
761
|
trace?: never;
|
|
726
762
|
};
|
|
763
|
+
"/api/v1/deployments/{deploymentId}/evaluations": {
|
|
764
|
+
parameters: {
|
|
765
|
+
query?: never;
|
|
766
|
+
header?: never;
|
|
767
|
+
path?: never;
|
|
768
|
+
cookie?: never;
|
|
769
|
+
};
|
|
770
|
+
get?: never;
|
|
771
|
+
put?: never;
|
|
772
|
+
/**
|
|
773
|
+
* Start an evaluation run
|
|
774
|
+
* @description Queues an eval run for a deployment branch. Poll the returned run with GET /evaluations/{evaluationId}; after it reaches completed, fetch /results for the per-question verdicts. This capability is currently in preview — reach out to the Cube support team to activate it for your account.
|
|
775
|
+
*/
|
|
776
|
+
post: operations["EvaluationsPublicController.startEvaluation"];
|
|
777
|
+
delete?: never;
|
|
778
|
+
options?: never;
|
|
779
|
+
head?: never;
|
|
780
|
+
patch?: never;
|
|
781
|
+
trace?: never;
|
|
782
|
+
};
|
|
783
|
+
"/api/v1/deployments/{deploymentId}/evaluations/{evaluationId}": {
|
|
784
|
+
parameters: {
|
|
785
|
+
query?: never;
|
|
786
|
+
header?: never;
|
|
787
|
+
path?: never;
|
|
788
|
+
cookie?: never;
|
|
789
|
+
};
|
|
790
|
+
/**
|
|
791
|
+
* Get an evaluation run
|
|
792
|
+
* @description This capability is currently in preview — reach out to the Cube support team to activate it for your account.
|
|
793
|
+
*/
|
|
794
|
+
get: operations["EvaluationsPublicController.getEvaluation"];
|
|
795
|
+
put?: never;
|
|
796
|
+
post?: never;
|
|
797
|
+
delete?: never;
|
|
798
|
+
options?: never;
|
|
799
|
+
head?: never;
|
|
800
|
+
patch?: never;
|
|
801
|
+
trace?: never;
|
|
802
|
+
};
|
|
803
|
+
"/api/v1/deployments/{deploymentId}/evaluations/{evaluationId}/results": {
|
|
804
|
+
parameters: {
|
|
805
|
+
query?: never;
|
|
806
|
+
header?: never;
|
|
807
|
+
path?: never;
|
|
808
|
+
cookie?: never;
|
|
809
|
+
};
|
|
810
|
+
/**
|
|
811
|
+
* List results for an evaluation run
|
|
812
|
+
* @description This capability is currently in preview — reach out to the Cube support team to activate it for your account.
|
|
813
|
+
*/
|
|
814
|
+
get: operations["EvaluationsPublicController.getEvaluationResults"];
|
|
815
|
+
put?: never;
|
|
816
|
+
post?: never;
|
|
817
|
+
delete?: never;
|
|
818
|
+
options?: never;
|
|
819
|
+
head?: never;
|
|
820
|
+
patch?: never;
|
|
821
|
+
trace?: never;
|
|
822
|
+
};
|
|
727
823
|
"/api/v1/deployments/{deploymentId}/folders": {
|
|
728
824
|
parameters: {
|
|
729
825
|
query?: never;
|
|
@@ -1389,6 +1485,81 @@ export interface paths {
|
|
|
1389
1485
|
patch?: never;
|
|
1390
1486
|
trace?: never;
|
|
1391
1487
|
};
|
|
1488
|
+
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotion": {
|
|
1489
|
+
parameters: {
|
|
1490
|
+
query?: never;
|
|
1491
|
+
header?: never;
|
|
1492
|
+
path?: never;
|
|
1493
|
+
cookie?: never;
|
|
1494
|
+
};
|
|
1495
|
+
/** Get workbook promotion provenance */
|
|
1496
|
+
get: operations["WorkbookPromotionsPublicController.getWorkbookPromotion"];
|
|
1497
|
+
put?: never;
|
|
1498
|
+
post?: never;
|
|
1499
|
+
delete?: never;
|
|
1500
|
+
options?: never;
|
|
1501
|
+
head?: never;
|
|
1502
|
+
patch?: never;
|
|
1503
|
+
trace?: never;
|
|
1504
|
+
};
|
|
1505
|
+
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotion-links": {
|
|
1506
|
+
parameters: {
|
|
1507
|
+
query?: never;
|
|
1508
|
+
header?: never;
|
|
1509
|
+
path?: never;
|
|
1510
|
+
cookie?: never;
|
|
1511
|
+
};
|
|
1512
|
+
/** List workbook promotion destinations */
|
|
1513
|
+
get: operations["WorkbookPromotionsPublicController.getWorkbookPromotionLinks"];
|
|
1514
|
+
put?: never;
|
|
1515
|
+
post?: never;
|
|
1516
|
+
delete?: never;
|
|
1517
|
+
options?: never;
|
|
1518
|
+
head?: never;
|
|
1519
|
+
patch?: never;
|
|
1520
|
+
trace?: never;
|
|
1521
|
+
};
|
|
1522
|
+
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotion-previews": {
|
|
1523
|
+
parameters: {
|
|
1524
|
+
query?: never;
|
|
1525
|
+
header?: never;
|
|
1526
|
+
path?: never;
|
|
1527
|
+
cookie?: never;
|
|
1528
|
+
};
|
|
1529
|
+
get?: never;
|
|
1530
|
+
put?: never;
|
|
1531
|
+
/**
|
|
1532
|
+
* Preview a workbook promotion
|
|
1533
|
+
* @description Validate promotion of the complete workbook and published dashboard to another deployment. The source slug is preserved so deployment-scoped dashboard links remain stable. Returns content hashes for optimistic concurrency; no preview is stored. Requires access to both deployments.
|
|
1534
|
+
*/
|
|
1535
|
+
post: operations["WorkbookPromotionsPublicController.previewWorkbookPromotion"];
|
|
1536
|
+
delete?: never;
|
|
1537
|
+
options?: never;
|
|
1538
|
+
head?: never;
|
|
1539
|
+
patch?: never;
|
|
1540
|
+
trace?: never;
|
|
1541
|
+
};
|
|
1542
|
+
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/promotions": {
|
|
1543
|
+
parameters: {
|
|
1544
|
+
query?: never;
|
|
1545
|
+
header?: never;
|
|
1546
|
+
path?: never;
|
|
1547
|
+
cookie?: never;
|
|
1548
|
+
};
|
|
1549
|
+
/** List workbook promotion history */
|
|
1550
|
+
get: operations["WorkbookPromotionsPublicController.getWorkbookPromotions"];
|
|
1551
|
+
put?: never;
|
|
1552
|
+
/**
|
|
1553
|
+
* Promote and publish a workbook
|
|
1554
|
+
* @description Promote the current workbook atomically if its source hash still matches the preview. Repeated promotions update the linked copy, including its deployment-scoped slug. Override replaces destination edits, never source validation or permissions. An idempotency key makes retries safe.
|
|
1555
|
+
*/
|
|
1556
|
+
post: operations["WorkbookPromotionsPublicController.promoteWorkbook"];
|
|
1557
|
+
delete?: never;
|
|
1558
|
+
options?: never;
|
|
1559
|
+
head?: never;
|
|
1560
|
+
patch?: never;
|
|
1561
|
+
trace?: never;
|
|
1562
|
+
};
|
|
1392
1563
|
"/api/v1/deployments/{deploymentId}/workbooks/{workbookId}/publish": {
|
|
1393
1564
|
parameters: {
|
|
1394
1565
|
query?: never;
|
|
@@ -1977,6 +2148,34 @@ export interface paths {
|
|
|
1977
2148
|
patch?: never;
|
|
1978
2149
|
trace?: never;
|
|
1979
2150
|
};
|
|
2151
|
+
"/api/v1/external-documents/{externalWorkbookId}/placements": {
|
|
2152
|
+
parameters: {
|
|
2153
|
+
query?: never;
|
|
2154
|
+
header?: never;
|
|
2155
|
+
path?: never;
|
|
2156
|
+
cookie?: never;
|
|
2157
|
+
};
|
|
2158
|
+
/**
|
|
2159
|
+
* List the Cube placements in an external spreadsheet
|
|
2160
|
+
* @description Every block of Cube-written cells in the external document `externalWorkbookId` — a Google Drive file id, or the custom property the Excel add-in writes — across the whole tenant.
|
|
2161
|
+
*
|
|
2162
|
+
* Unlike `GET /api/v1/deployments/{deploymentId}/reports?externalWorkbookId=`, which lists only the reports the caller can read, this endpoint also reports the placements they **cannot**: each entry carries `access`, which is `GRANTED` when the caller may open the exploration and `DENIED` when they may not. It is how a recipient of a shared workbook learns that a block they are looking at is backed by an exploration nobody has shared with them, and who to ask.
|
|
2163
|
+
*
|
|
2164
|
+
* A `DENIED` entry carries only the placement's address (`resultLocation`/`sheetId`/`sheetName`/`anchorCell`/`endResultCell`/`host`), its opaque `reportId`/`placementId`, the owning `deploymentId`, the placement's `placedAt`/`refreshedAt` timestamps, and the exploration's `owner` — including their email address, so the recipient can ask for access. `owner` is `null` for an embed-partition exploration whose owning user record no longer exists — embed report ownership carries no foreign key, so the row can outlive its owner; a main-workspace exploration's owner always exists, since deleting the owner cascades to delete the report. `reportName` is `null` on a denied entry — the name is withheld along with the exploration — and reading the report itself still answers `403`.
|
|
2165
|
+
*
|
|
2166
|
+
* Results are returned in pages using cursor-based pagination: pass `first` to set the page size and `after` (the previous response's `pageInfo.endCursor`) to fetch the next page. Omitting `first` returns every placement in the document.
|
|
2167
|
+
*
|
|
2168
|
+
* A document holding more than 500 placed explorations, or more than 2000 placements in total, is answered with `422` rather than a truncated page — an inventory that looks complete but is not would hide the very placement a recipient needs to see.
|
|
2169
|
+
*/
|
|
2170
|
+
get: operations["ExternalDocumentsPublicController.listExternalDocumentPlacements"];
|
|
2171
|
+
put?: never;
|
|
2172
|
+
post?: never;
|
|
2173
|
+
delete?: never;
|
|
2174
|
+
options?: never;
|
|
2175
|
+
head?: never;
|
|
2176
|
+
patch?: never;
|
|
2177
|
+
trace?: never;
|
|
2178
|
+
};
|
|
1980
2179
|
"/api/v1/github/installations": {
|
|
1981
2180
|
parameters: {
|
|
1982
2181
|
query?: never;
|
|
@@ -3091,19 +3290,10 @@ export interface components {
|
|
|
3091
3290
|
embeddingLlm?: components["schemas"]["AgentLlm"] | null;
|
|
3092
3291
|
embeddingUrl?: string | null;
|
|
3093
3292
|
id: number;
|
|
3094
|
-
integrations?: components["schemas"]["AgentIntegrationsDto"] | null;
|
|
3095
3293
|
name?: string | null;
|
|
3096
3294
|
updatedAt: string;
|
|
3097
3295
|
userId?: number | null;
|
|
3098
3296
|
};
|
|
3099
|
-
AgentIntegrationsDto: {
|
|
3100
|
-
jira?: components["schemas"]["AgentIntegrationsJiraDto"] | null;
|
|
3101
|
-
};
|
|
3102
|
-
AgentIntegrationsJiraDto: {
|
|
3103
|
-
connected?: boolean | null;
|
|
3104
|
-
jiraIssueType?: components["schemas"]["JiraIssueType"] | null;
|
|
3105
|
-
jiraProject?: components["schemas"]["JiraProject"] | null;
|
|
3106
|
-
};
|
|
3107
3297
|
AgentLlm: {
|
|
3108
3298
|
config?: {
|
|
3109
3299
|
[key: string]: any;
|
|
@@ -3147,6 +3337,35 @@ export interface components {
|
|
|
3147
3337
|
scopeDeploymentId?: number | null;
|
|
3148
3338
|
spaceConfigName?: string | null;
|
|
3149
3339
|
};
|
|
3340
|
+
ApiKeyCreatedResponse: {
|
|
3341
|
+
allowedEndpoints?: string[] | null;
|
|
3342
|
+
createdAt: string;
|
|
3343
|
+
deploymentIds?: number[] | null;
|
|
3344
|
+
expiresAt?: (string) | null;
|
|
3345
|
+
id: number;
|
|
3346
|
+
lastUsedAt?: (string) | null;
|
|
3347
|
+
name: string;
|
|
3348
|
+
suffix?: string | null;
|
|
3349
|
+
token: string;
|
|
3350
|
+
updatedAt: string;
|
|
3351
|
+
userId: number;
|
|
3352
|
+
};
|
|
3353
|
+
ApiKeyResponse: {
|
|
3354
|
+
allowedEndpoints?: string[] | null;
|
|
3355
|
+
createdAt: string;
|
|
3356
|
+
deploymentIds?: number[] | null;
|
|
3357
|
+
expiresAt?: (string) | null;
|
|
3358
|
+
id: number;
|
|
3359
|
+
lastUsedAt?: (string) | null;
|
|
3360
|
+
name: string;
|
|
3361
|
+
suffix?: string | null;
|
|
3362
|
+
updatedAt: string;
|
|
3363
|
+
userId: number;
|
|
3364
|
+
};
|
|
3365
|
+
ApiKeysListResponse: {
|
|
3366
|
+
items: components["schemas"]["ApiKeyResponse"][];
|
|
3367
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
3368
|
+
};
|
|
3150
3369
|
AppConfigResponse: {
|
|
3151
3370
|
appTheme?: components["schemas"]["AppTheme"] | null;
|
|
3152
3371
|
applyThemeGlobally: boolean;
|
|
@@ -3230,6 +3449,15 @@ export interface components {
|
|
|
3230
3449
|
fonts: components["schemas"]["ThemeFont"][];
|
|
3231
3450
|
heading: components["schemas"]["AppThemeFontRef"];
|
|
3232
3451
|
};
|
|
3452
|
+
ApplyWorkbookPromotionInput: {
|
|
3453
|
+
expectedDestinationHash?: string | null;
|
|
3454
|
+
expectedSourceHash: string;
|
|
3455
|
+
/** Format: uuid */
|
|
3456
|
+
idempotencyKey: string;
|
|
3457
|
+
override?: boolean | null;
|
|
3458
|
+
targetDeploymentId: number;
|
|
3459
|
+
targetFolderId?: number | null;
|
|
3460
|
+
};
|
|
3233
3461
|
BranchResponse: {
|
|
3234
3462
|
id: number;
|
|
3235
3463
|
isStagingEnvironmentEnabled?: boolean | null;
|
|
@@ -3356,6 +3584,12 @@ export interface components {
|
|
|
3356
3584
|
fontSize?: string | null;
|
|
3357
3585
|
fontWeight?: string | null;
|
|
3358
3586
|
};
|
|
3587
|
+
CreateApiKeyInput: {
|
|
3588
|
+
allowedEndpoints?: string[] | null;
|
|
3589
|
+
deploymentIds?: number[] | null;
|
|
3590
|
+
name: string;
|
|
3591
|
+
ttlHours?: number | null;
|
|
3592
|
+
};
|
|
3359
3593
|
CreateBranchRequest: {
|
|
3360
3594
|
activate?: boolean | null;
|
|
3361
3595
|
from?: string | null;
|
|
@@ -4029,6 +4263,8 @@ export interface components {
|
|
|
4029
4263
|
deletionPolicy?: string | null;
|
|
4030
4264
|
deploymentId: number;
|
|
4031
4265
|
durationMs?: number | null;
|
|
4266
|
+
/** @description How many published views are missing measures the conversion could not represent. A run reports COMPLETED with this above zero, because every view published — so automation that treats COMPLETED as "fully published" should assert this is 0. Read views[].withheldMembers for which measures, and why. */
|
|
4267
|
+
incompleteViewCount: number;
|
|
4032
4268
|
integrationPublicId: string;
|
|
4033
4269
|
progress?: components["schemas"]["DatabricksMetricViewSyncProgressResponse"] | null;
|
|
4034
4270
|
runId: string;
|
|
@@ -4532,6 +4768,34 @@ export interface components {
|
|
|
4532
4768
|
items: components["schemas"]["EnvVariableItem"][];
|
|
4533
4769
|
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
4534
4770
|
};
|
|
4771
|
+
EvaluationResultResponse: {
|
|
4772
|
+
createdAt: string;
|
|
4773
|
+
evaluationId: number;
|
|
4774
|
+
id: number;
|
|
4775
|
+
questionTextSnapshot: string;
|
|
4776
|
+
score?: number | null;
|
|
4777
|
+
updatedAt: string;
|
|
4778
|
+
verdict?: string | null;
|
|
4779
|
+
};
|
|
4780
|
+
EvaluationResultsListResponse: {
|
|
4781
|
+
items: components["schemas"]["EvaluationResultResponse"][];
|
|
4782
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
4783
|
+
};
|
|
4784
|
+
EvaluationRunResponse: {
|
|
4785
|
+
agentName: string;
|
|
4786
|
+
branchName: string;
|
|
4787
|
+
commitHash?: string | null;
|
|
4788
|
+
createdAt: string;
|
|
4789
|
+
deploymentId: number;
|
|
4790
|
+
finishedAt?: string | null;
|
|
4791
|
+
id: number;
|
|
4792
|
+
isDefaultBranch?: boolean | null;
|
|
4793
|
+
questionFile?: string | null;
|
|
4794
|
+
startedAt?: string | null;
|
|
4795
|
+
/** @description Run state: pending, running, completed, or failed. Treat unrecognized values as non-terminal. */
|
|
4796
|
+
status: string;
|
|
4797
|
+
updatedAt: string;
|
|
4798
|
+
};
|
|
4535
4799
|
ExportSubjectInput: {
|
|
4536
4800
|
email?: string | null;
|
|
4537
4801
|
embedTenantName?: string | null;
|
|
@@ -4546,6 +4810,30 @@ export interface components {
|
|
|
4546
4810
|
};
|
|
4547
4811
|
/** @enum {string} */
|
|
4548
4812
|
ExportSubjectInputType: "USER" | "EMBED_USER";
|
|
4813
|
+
ExternalDocumentPlacementResponse: {
|
|
4814
|
+
access: components["schemas"]["ExternalDocumentPlacementResponseAccess"];
|
|
4815
|
+
anchorCell?: string | null;
|
|
4816
|
+
deploymentId: number;
|
|
4817
|
+
endResultCell?: string | null;
|
|
4818
|
+
host?: components["schemas"]["ExternalDocumentPlacementResponseHost"] | null;
|
|
4819
|
+
owner?: components["schemas"]["ResourceOwner"] | null;
|
|
4820
|
+
placedAt?: string | null;
|
|
4821
|
+
placementId?: string | null;
|
|
4822
|
+
refreshedAt?: string | null;
|
|
4823
|
+
reportId: number;
|
|
4824
|
+
reportName?: string | null;
|
|
4825
|
+
resultLocation: string;
|
|
4826
|
+
sheetId?: string | null;
|
|
4827
|
+
sheetName?: string | null;
|
|
4828
|
+
};
|
|
4829
|
+
/** @enum {string} */
|
|
4830
|
+
ExternalDocumentPlacementResponseAccess: "GRANTED" | "DENIED";
|
|
4831
|
+
/** @enum {string} */
|
|
4832
|
+
ExternalDocumentPlacementResponseHost: "GOOGLE_SHEETS" | "EXCEL";
|
|
4833
|
+
ExternalDocumentPlacementsListResponse: {
|
|
4834
|
+
items: components["schemas"]["ExternalDocumentPlacementResponse"][];
|
|
4835
|
+
pageInfo?: components["schemas"]["PageInfo"] | null;
|
|
4836
|
+
};
|
|
4549
4837
|
FileHash: {
|
|
4550
4838
|
hash: string;
|
|
4551
4839
|
};
|
|
@@ -4704,22 +4992,6 @@ export interface components {
|
|
|
4704
4992
|
};
|
|
4705
4993
|
/** @enum {string} */
|
|
4706
4994
|
InheritedUserPolicyDtoAction: "All" | "DeploymentsManage" | "DeploymentCreate" | "DeploymentRead" | "DeploymentUpdate" | "DeploymentDelete" | "SecretsManage" | "DownloadData" | "PlaygroundRead" | "SchemaRead" | "SchemaUpdate" | "SchemaUpdateDevBranches" | "APMRead" | "ChatHistoryRead" | "PreAggregationBuild" | "AlertsCreate" | "AlertsRead" | "AlertsUpdate" | "AlertsDelete" | "AuditLogManage" | "BillingRead" | "SqlRunnerRead" | "DataAssetsRead" | "DataAssetsManage" | "CubeNetworkConnect" | "ReportRead" | "ReportEdit" | "ReportManage" | "WorkbookManage" | "WorkbookRead" | "WorkbookEdit" | "ChatThreadRead" | "AgentManage" | "AgentRead" | "AgentSpaceManage" | "AgentAdmin" | "DeploymentAgentRead" | "OAuthIntegrationsManage" | "OAuthIntegrationsIssueTokens" | "McpToolsManage" | "AIBIDevelop" | "AIBIExplore" | "AIBIView" | "ChartPalettesManage" | "DashboardThemesManage" | "AIBIDeveloper" | "AIBIUser" | "AIBIViewer" | "EmbedDeploymentRead" | "EmbedDashboardRead" | "FolderRead" | "FolderEdit" | "FolderManage";
|
|
4707
|
-
JiraIssueType: {
|
|
4708
|
-
description?: string | null;
|
|
4709
|
-
iconUrl?: string | null;
|
|
4710
|
-
id: string;
|
|
4711
|
-
name: string;
|
|
4712
|
-
};
|
|
4713
|
-
JiraProject: {
|
|
4714
|
-
id: string;
|
|
4715
|
-
key: string;
|
|
4716
|
-
name: string;
|
|
4717
|
-
site: components["schemas"]["JiraSite"];
|
|
4718
|
-
};
|
|
4719
|
-
JiraSite: {
|
|
4720
|
-
host: string;
|
|
4721
|
-
id: string;
|
|
4722
|
-
};
|
|
4723
4995
|
/** @enum {string} */
|
|
4724
4996
|
ListDatabricksMetricViewSyncsQueryStatus: "QUEUED" | "RUNNING" | "CANCELLING" | "COMPLETED" | "PARTIAL" | "FAILED" | "CANCELLED";
|
|
4725
4997
|
LocalEncryptedSecret: {
|
|
@@ -4914,6 +5186,26 @@ export interface components {
|
|
|
4914
5186
|
PostTokenBySessionIdInput: {
|
|
4915
5187
|
sessionId: string;
|
|
4916
5188
|
};
|
|
5189
|
+
PreviewWorkbookPromotionInput: {
|
|
5190
|
+
targetDeploymentId: number;
|
|
5191
|
+
targetFolderId?: number | null;
|
|
5192
|
+
};
|
|
5193
|
+
PromotionActorDto: {
|
|
5194
|
+
apiKeyId?: number | null;
|
|
5195
|
+
authenticationMethod: components["schemas"]["PromotionActorDtoAuthenticationMethod"];
|
|
5196
|
+
displayName: string;
|
|
5197
|
+
userId: number;
|
|
5198
|
+
};
|
|
5199
|
+
/** @enum {string} */
|
|
5200
|
+
PromotionActorDtoAuthenticationMethod: "session" | "apiKey";
|
|
5201
|
+
PromotionReferenceDto: {
|
|
5202
|
+
availability: components["schemas"]["PromotionReferenceDtoAvailability"];
|
|
5203
|
+
deploymentId?: number | null;
|
|
5204
|
+
name?: string | null;
|
|
5205
|
+
workbookId?: number | null;
|
|
5206
|
+
};
|
|
5207
|
+
/** @enum {string} */
|
|
5208
|
+
PromotionReferenceDtoAvailability: "available" | "unavailable";
|
|
4917
5209
|
ProvisionEmbedUserFailure: {
|
|
4918
5210
|
error: components["schemas"]["BulkActionError"];
|
|
4919
5211
|
/** @description The `externalId` of the entry that failed, normalized the same way a successful one is. */
|
|
@@ -5351,6 +5643,11 @@ export interface components {
|
|
|
5351
5643
|
StartDevModeRequest: {
|
|
5352
5644
|
branchName?: string | null;
|
|
5353
5645
|
};
|
|
5646
|
+
StartEvaluationInput: {
|
|
5647
|
+
agentName?: string | null;
|
|
5648
|
+
branchName: string;
|
|
5649
|
+
questionFile?: string | null;
|
|
5650
|
+
};
|
|
5354
5651
|
StartUploadResponse: {
|
|
5355
5652
|
deploymentName: string;
|
|
5356
5653
|
transaction: components["schemas"]["UploadTransaction"];
|
|
@@ -5788,6 +6085,7 @@ export interface components {
|
|
|
5788
6085
|
[key: string]: any;
|
|
5789
6086
|
};
|
|
5790
6087
|
name: string;
|
|
6088
|
+
promotion?: components["schemas"]["WorkbookPromotionSummaryDto"] | null;
|
|
5791
6089
|
publishedDashboard?: components["schemas"]["Dashboard"] | null;
|
|
5792
6090
|
slug?: string | null;
|
|
5793
6091
|
type: components["schemas"]["WorkbookDtoType"];
|
|
@@ -5804,6 +6102,51 @@ export interface components {
|
|
|
5804
6102
|
};
|
|
5805
6103
|
/** @enum {string} */
|
|
5806
6104
|
WorkbookDtoType: "FOLDER" | "WORKBOOK" | "REPORT";
|
|
6105
|
+
WorkbookPromotionDto: {
|
|
6106
|
+
completedAt: string;
|
|
6107
|
+
destinationChangedSincePreview: boolean;
|
|
6108
|
+
destinationWasDiverged: boolean;
|
|
6109
|
+
id: number;
|
|
6110
|
+
linkId: number;
|
|
6111
|
+
outcome: components["schemas"]["WorkbookPromotionDtoOutcome"];
|
|
6112
|
+
overrideRequested: boolean;
|
|
6113
|
+
performedBy: components["schemas"]["PromotionActorDto"];
|
|
6114
|
+
source?: components["schemas"]["PromotionReferenceDto"] | null;
|
|
6115
|
+
target?: components["schemas"]["PromotionReferenceDto"] | null;
|
|
6116
|
+
targetDashboardVersionId: number;
|
|
6117
|
+
};
|
|
6118
|
+
/** @enum {string} */
|
|
6119
|
+
WorkbookPromotionDtoOutcome: "created" | "updated" | "unchanged";
|
|
6120
|
+
WorkbookPromotionLinkDto: {
|
|
6121
|
+
id: number;
|
|
6122
|
+
target: components["schemas"]["PromotionReferenceDto"];
|
|
6123
|
+
};
|
|
6124
|
+
WorkbookPromotionLinksListResponse: {
|
|
6125
|
+
items: components["schemas"]["WorkbookPromotionLinkDto"][];
|
|
6126
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
6127
|
+
};
|
|
6128
|
+
WorkbookPromotionPreviewDto: {
|
|
6129
|
+
destinationHash?: string | null;
|
|
6130
|
+
destinationWasDiverged: boolean;
|
|
6131
|
+
reportCount: number;
|
|
6132
|
+
sourceHash: string;
|
|
6133
|
+
targetDeploymentId: number;
|
|
6134
|
+
targetWorkbookId?: number | null;
|
|
6135
|
+
};
|
|
6136
|
+
WorkbookPromotionSummaryDto: {
|
|
6137
|
+
firstPromotion?: components["schemas"]["WorkbookPromotionDto"] | null;
|
|
6138
|
+
lastPromotion?: components["schemas"]["WorkbookPromotionDto"] | null;
|
|
6139
|
+
linkId: number;
|
|
6140
|
+
origin: components["schemas"]["PromotionReferenceDto"];
|
|
6141
|
+
parent: components["schemas"]["PromotionReferenceDto"];
|
|
6142
|
+
};
|
|
6143
|
+
WorkbookPromotionSummaryResponse: {
|
|
6144
|
+
promotion?: components["schemas"]["WorkbookPromotionSummaryDto"] | null;
|
|
6145
|
+
};
|
|
6146
|
+
WorkbookPromotionsListResponse: {
|
|
6147
|
+
items: components["schemas"]["WorkbookPromotionDto"][];
|
|
6148
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
6149
|
+
};
|
|
5807
6150
|
WorkbooksListResponse: {
|
|
5808
6151
|
count?: number | null;
|
|
5809
6152
|
/**
|
|
@@ -6224,9 +6567,12 @@ export interface operations {
|
|
|
6224
6567
|
};
|
|
6225
6568
|
};
|
|
6226
6569
|
};
|
|
6227
|
-
"
|
|
6570
|
+
"ApiKeysPublicController.listApiKeys": {
|
|
6228
6571
|
parameters: {
|
|
6229
|
-
query?:
|
|
6572
|
+
query?: {
|
|
6573
|
+
after?: string | null;
|
|
6574
|
+
first?: number | null;
|
|
6575
|
+
};
|
|
6230
6576
|
header?: never;
|
|
6231
6577
|
path?: never;
|
|
6232
6578
|
cookie?: never;
|
|
@@ -6238,38 +6584,124 @@ export interface operations {
|
|
|
6238
6584
|
[name: string]: any;
|
|
6239
6585
|
};
|
|
6240
6586
|
content: {
|
|
6241
|
-
"application/json": components["schemas"]["
|
|
6587
|
+
"application/json": components["schemas"]["ApiKeysListResponse"];
|
|
6242
6588
|
};
|
|
6243
6589
|
};
|
|
6244
6590
|
};
|
|
6245
6591
|
};
|
|
6246
|
-
"
|
|
6592
|
+
"ApiKeysPublicController.createApiKey": {
|
|
6247
6593
|
parameters: {
|
|
6248
6594
|
query?: never;
|
|
6249
6595
|
header?: never;
|
|
6250
6596
|
path?: never;
|
|
6251
6597
|
cookie?: never;
|
|
6252
6598
|
};
|
|
6253
|
-
|
|
6599
|
+
/** @description CreateApiKeyInput */
|
|
6600
|
+
requestBody?: {
|
|
6601
|
+
content: {
|
|
6602
|
+
"application/json": components["schemas"]["CreateApiKeyInput"];
|
|
6603
|
+
};
|
|
6604
|
+
};
|
|
6254
6605
|
responses: {
|
|
6255
6606
|
200: {
|
|
6256
6607
|
headers: {
|
|
6257
6608
|
[name: string]: any;
|
|
6258
6609
|
};
|
|
6259
6610
|
content: {
|
|
6260
|
-
"application/json": components["schemas"]["
|
|
6611
|
+
"application/json": components["schemas"]["ApiKeyCreatedResponse"];
|
|
6261
6612
|
};
|
|
6262
6613
|
};
|
|
6263
6614
|
};
|
|
6264
6615
|
};
|
|
6265
|
-
"
|
|
6616
|
+
"ApiKeysPublicController.getApiKey": {
|
|
6266
6617
|
parameters: {
|
|
6267
|
-
query?:
|
|
6268
|
-
|
|
6269
|
-
|
|
6270
|
-
|
|
6271
|
-
|
|
6272
|
-
|
|
6618
|
+
query?: never;
|
|
6619
|
+
header?: never;
|
|
6620
|
+
path: {
|
|
6621
|
+
id: number;
|
|
6622
|
+
};
|
|
6623
|
+
cookie?: never;
|
|
6624
|
+
};
|
|
6625
|
+
requestBody?: never;
|
|
6626
|
+
responses: {
|
|
6627
|
+
200: {
|
|
6628
|
+
headers: {
|
|
6629
|
+
[name: string]: any;
|
|
6630
|
+
};
|
|
6631
|
+
content: {
|
|
6632
|
+
"application/json": components["schemas"]["ApiKeyResponse"];
|
|
6633
|
+
};
|
|
6634
|
+
};
|
|
6635
|
+
};
|
|
6636
|
+
};
|
|
6637
|
+
"ApiKeysPublicController.deleteApiKey": {
|
|
6638
|
+
parameters: {
|
|
6639
|
+
query?: never;
|
|
6640
|
+
header?: never;
|
|
6641
|
+
path: {
|
|
6642
|
+
id: number;
|
|
6643
|
+
};
|
|
6644
|
+
cookie?: never;
|
|
6645
|
+
};
|
|
6646
|
+
requestBody?: never;
|
|
6647
|
+
responses: {
|
|
6648
|
+
/** @description Successful response */
|
|
6649
|
+
200: {
|
|
6650
|
+
headers: {
|
|
6651
|
+
[name: string]: any;
|
|
6652
|
+
};
|
|
6653
|
+
content: {
|
|
6654
|
+
"application/json": any;
|
|
6655
|
+
};
|
|
6656
|
+
};
|
|
6657
|
+
};
|
|
6658
|
+
};
|
|
6659
|
+
"AppThemePublicController.getAppConfig": {
|
|
6660
|
+
parameters: {
|
|
6661
|
+
query?: never;
|
|
6662
|
+
header?: never;
|
|
6663
|
+
path?: never;
|
|
6664
|
+
cookie?: never;
|
|
6665
|
+
};
|
|
6666
|
+
requestBody?: never;
|
|
6667
|
+
responses: {
|
|
6668
|
+
200: {
|
|
6669
|
+
headers: {
|
|
6670
|
+
[name: string]: any;
|
|
6671
|
+
};
|
|
6672
|
+
content: {
|
|
6673
|
+
"application/json": components["schemas"]["AppConfigResponse"];
|
|
6674
|
+
};
|
|
6675
|
+
};
|
|
6676
|
+
};
|
|
6677
|
+
};
|
|
6678
|
+
"AppThemePublicController.getAppTheme": {
|
|
6679
|
+
parameters: {
|
|
6680
|
+
query?: never;
|
|
6681
|
+
header?: never;
|
|
6682
|
+
path?: never;
|
|
6683
|
+
cookie?: never;
|
|
6684
|
+
};
|
|
6685
|
+
requestBody?: never;
|
|
6686
|
+
responses: {
|
|
6687
|
+
200: {
|
|
6688
|
+
headers: {
|
|
6689
|
+
[name: string]: any;
|
|
6690
|
+
};
|
|
6691
|
+
content: {
|
|
6692
|
+
"application/json": components["schemas"]["AppThemeResponse"];
|
|
6693
|
+
};
|
|
6694
|
+
};
|
|
6695
|
+
};
|
|
6696
|
+
};
|
|
6697
|
+
"DeploymentsPublicController.getDeployments": {
|
|
6698
|
+
parameters: {
|
|
6699
|
+
query?: {
|
|
6700
|
+
creationStep?: components["schemas"]["CreationStep"] | components["schemas"]["CreationStep"][];
|
|
6701
|
+
offset?: number | null;
|
|
6702
|
+
limit?: number | null;
|
|
6703
|
+
after?: string;
|
|
6704
|
+
first?: number;
|
|
6273
6705
|
};
|
|
6274
6706
|
header?: never;
|
|
6275
6707
|
path?: never;
|
|
@@ -7169,6 +7601,79 @@ export interface operations {
|
|
|
7169
7601
|
};
|
|
7170
7602
|
};
|
|
7171
7603
|
};
|
|
7604
|
+
"EvaluationsPublicController.startEvaluation": {
|
|
7605
|
+
parameters: {
|
|
7606
|
+
query?: never;
|
|
7607
|
+
header?: never;
|
|
7608
|
+
path: {
|
|
7609
|
+
deploymentId: number;
|
|
7610
|
+
};
|
|
7611
|
+
cookie?: never;
|
|
7612
|
+
};
|
|
7613
|
+
/** @description StartEvaluationInput */
|
|
7614
|
+
requestBody: {
|
|
7615
|
+
content: {
|
|
7616
|
+
"application/json": components["schemas"]["StartEvaluationInput"];
|
|
7617
|
+
};
|
|
7618
|
+
};
|
|
7619
|
+
responses: {
|
|
7620
|
+
202: {
|
|
7621
|
+
headers: {
|
|
7622
|
+
[name: string]: any;
|
|
7623
|
+
};
|
|
7624
|
+
content: {
|
|
7625
|
+
"application/json": components["schemas"]["EvaluationRunResponse"];
|
|
7626
|
+
};
|
|
7627
|
+
};
|
|
7628
|
+
};
|
|
7629
|
+
};
|
|
7630
|
+
"EvaluationsPublicController.getEvaluation": {
|
|
7631
|
+
parameters: {
|
|
7632
|
+
query?: never;
|
|
7633
|
+
header?: never;
|
|
7634
|
+
path: {
|
|
7635
|
+
deploymentId: number;
|
|
7636
|
+
evaluationId: number;
|
|
7637
|
+
};
|
|
7638
|
+
cookie?: never;
|
|
7639
|
+
};
|
|
7640
|
+
requestBody?: never;
|
|
7641
|
+
responses: {
|
|
7642
|
+
200: {
|
|
7643
|
+
headers: {
|
|
7644
|
+
[name: string]: any;
|
|
7645
|
+
};
|
|
7646
|
+
content: {
|
|
7647
|
+
"application/json": components["schemas"]["EvaluationRunResponse"];
|
|
7648
|
+
};
|
|
7649
|
+
};
|
|
7650
|
+
};
|
|
7651
|
+
};
|
|
7652
|
+
"EvaluationsPublicController.getEvaluationResults": {
|
|
7653
|
+
parameters: {
|
|
7654
|
+
query?: {
|
|
7655
|
+
after?: string | null;
|
|
7656
|
+
first?: number | null;
|
|
7657
|
+
};
|
|
7658
|
+
header?: never;
|
|
7659
|
+
path: {
|
|
7660
|
+
deploymentId: number;
|
|
7661
|
+
evaluationId: number;
|
|
7662
|
+
};
|
|
7663
|
+
cookie?: never;
|
|
7664
|
+
};
|
|
7665
|
+
requestBody?: never;
|
|
7666
|
+
responses: {
|
|
7667
|
+
200: {
|
|
7668
|
+
headers: {
|
|
7669
|
+
[name: string]: any;
|
|
7670
|
+
};
|
|
7671
|
+
content: {
|
|
7672
|
+
"application/json": components["schemas"]["EvaluationResultsListResponse"];
|
|
7673
|
+
};
|
|
7674
|
+
};
|
|
7675
|
+
};
|
|
7676
|
+
};
|
|
7172
7677
|
"FoldersPublicController.getFolders": {
|
|
7173
7678
|
parameters: {
|
|
7174
7679
|
query?: {
|
|
@@ -8222,6 +8727,132 @@ export interface operations {
|
|
|
8222
8727
|
};
|
|
8223
8728
|
};
|
|
8224
8729
|
};
|
|
8730
|
+
"WorkbookPromotionsPublicController.getWorkbookPromotion": {
|
|
8731
|
+
parameters: {
|
|
8732
|
+
query?: never;
|
|
8733
|
+
header?: never;
|
|
8734
|
+
path: {
|
|
8735
|
+
deploymentId: number;
|
|
8736
|
+
workbookId: number;
|
|
8737
|
+
};
|
|
8738
|
+
cookie?: never;
|
|
8739
|
+
};
|
|
8740
|
+
requestBody?: never;
|
|
8741
|
+
responses: {
|
|
8742
|
+
200: {
|
|
8743
|
+
headers: {
|
|
8744
|
+
[name: string]: any;
|
|
8745
|
+
};
|
|
8746
|
+
content: {
|
|
8747
|
+
"application/json": components["schemas"]["WorkbookPromotionSummaryResponse"];
|
|
8748
|
+
};
|
|
8749
|
+
};
|
|
8750
|
+
};
|
|
8751
|
+
};
|
|
8752
|
+
"WorkbookPromotionsPublicController.getWorkbookPromotionLinks": {
|
|
8753
|
+
parameters: {
|
|
8754
|
+
query?: {
|
|
8755
|
+
after?: string | null;
|
|
8756
|
+
first?: number | null;
|
|
8757
|
+
};
|
|
8758
|
+
header?: never;
|
|
8759
|
+
path: {
|
|
8760
|
+
deploymentId: number;
|
|
8761
|
+
workbookId: number;
|
|
8762
|
+
};
|
|
8763
|
+
cookie?: never;
|
|
8764
|
+
};
|
|
8765
|
+
requestBody?: never;
|
|
8766
|
+
responses: {
|
|
8767
|
+
200: {
|
|
8768
|
+
headers: {
|
|
8769
|
+
[name: string]: any;
|
|
8770
|
+
};
|
|
8771
|
+
content: {
|
|
8772
|
+
"application/json": components["schemas"]["WorkbookPromotionLinksListResponse"];
|
|
8773
|
+
};
|
|
8774
|
+
};
|
|
8775
|
+
};
|
|
8776
|
+
};
|
|
8777
|
+
"WorkbookPromotionsPublicController.previewWorkbookPromotion": {
|
|
8778
|
+
parameters: {
|
|
8779
|
+
query?: never;
|
|
8780
|
+
header?: never;
|
|
8781
|
+
path: {
|
|
8782
|
+
deploymentId: number;
|
|
8783
|
+
workbookId: number;
|
|
8784
|
+
};
|
|
8785
|
+
cookie?: never;
|
|
8786
|
+
};
|
|
8787
|
+
/** @description PreviewWorkbookPromotionInput */
|
|
8788
|
+
requestBody?: {
|
|
8789
|
+
content: {
|
|
8790
|
+
"application/json": components["schemas"]["PreviewWorkbookPromotionInput"];
|
|
8791
|
+
};
|
|
8792
|
+
};
|
|
8793
|
+
responses: {
|
|
8794
|
+
200: {
|
|
8795
|
+
headers: {
|
|
8796
|
+
[name: string]: any;
|
|
8797
|
+
};
|
|
8798
|
+
content: {
|
|
8799
|
+
"application/json": components["schemas"]["WorkbookPromotionPreviewDto"];
|
|
8800
|
+
};
|
|
8801
|
+
};
|
|
8802
|
+
};
|
|
8803
|
+
};
|
|
8804
|
+
"WorkbookPromotionsPublicController.getWorkbookPromotions": {
|
|
8805
|
+
parameters: {
|
|
8806
|
+
query?: {
|
|
8807
|
+
after?: string | null;
|
|
8808
|
+
first?: number | null;
|
|
8809
|
+
};
|
|
8810
|
+
header?: never;
|
|
8811
|
+
path: {
|
|
8812
|
+
deploymentId: number;
|
|
8813
|
+
workbookId: number;
|
|
8814
|
+
};
|
|
8815
|
+
cookie?: never;
|
|
8816
|
+
};
|
|
8817
|
+
requestBody?: never;
|
|
8818
|
+
responses: {
|
|
8819
|
+
200: {
|
|
8820
|
+
headers: {
|
|
8821
|
+
[name: string]: any;
|
|
8822
|
+
};
|
|
8823
|
+
content: {
|
|
8824
|
+
"application/json": components["schemas"]["WorkbookPromotionsListResponse"];
|
|
8825
|
+
};
|
|
8826
|
+
};
|
|
8827
|
+
};
|
|
8828
|
+
};
|
|
8829
|
+
"WorkbookPromotionsPublicController.promoteWorkbook": {
|
|
8830
|
+
parameters: {
|
|
8831
|
+
query?: never;
|
|
8832
|
+
header?: never;
|
|
8833
|
+
path: {
|
|
8834
|
+
deploymentId: number;
|
|
8835
|
+
workbookId: number;
|
|
8836
|
+
};
|
|
8837
|
+
cookie?: never;
|
|
8838
|
+
};
|
|
8839
|
+
/** @description ApplyWorkbookPromotionInput */
|
|
8840
|
+
requestBody?: {
|
|
8841
|
+
content: {
|
|
8842
|
+
"application/json": components["schemas"]["ApplyWorkbookPromotionInput"];
|
|
8843
|
+
};
|
|
8844
|
+
};
|
|
8845
|
+
responses: {
|
|
8846
|
+
200: {
|
|
8847
|
+
headers: {
|
|
8848
|
+
[name: string]: any;
|
|
8849
|
+
};
|
|
8850
|
+
content: {
|
|
8851
|
+
"application/json": components["schemas"]["WorkbookPromotionDto"];
|
|
8852
|
+
};
|
|
8853
|
+
};
|
|
8854
|
+
};
|
|
8855
|
+
};
|
|
8225
8856
|
"WorkbooksPublicController.publishDashboard": {
|
|
8226
8857
|
parameters: {
|
|
8227
8858
|
query?: never;
|
|
@@ -9026,6 +9657,37 @@ export interface operations {
|
|
|
9026
9657
|
};
|
|
9027
9658
|
};
|
|
9028
9659
|
};
|
|
9660
|
+
"ExternalDocumentsPublicController.listExternalDocumentPlacements": {
|
|
9661
|
+
parameters: {
|
|
9662
|
+
query?: {
|
|
9663
|
+
after?: string | null;
|
|
9664
|
+
first?: number | null;
|
|
9665
|
+
};
|
|
9666
|
+
header?: never;
|
|
9667
|
+
path: {
|
|
9668
|
+
externalWorkbookId: string;
|
|
9669
|
+
};
|
|
9670
|
+
cookie?: never;
|
|
9671
|
+
};
|
|
9672
|
+
requestBody?: never;
|
|
9673
|
+
responses: {
|
|
9674
|
+
200: {
|
|
9675
|
+
headers: {
|
|
9676
|
+
[name: string]: any;
|
|
9677
|
+
};
|
|
9678
|
+
content: {
|
|
9679
|
+
"application/json": components["schemas"]["ExternalDocumentPlacementsListResponse"];
|
|
9680
|
+
};
|
|
9681
|
+
};
|
|
9682
|
+
/** @description The document holds more placements than this endpoint will report on. A state, not a malformed request: the answer is deliberately an error rather than a page that silently omits placements no cursor can reach. */
|
|
9683
|
+
422: {
|
|
9684
|
+
headers: {
|
|
9685
|
+
[name: string]: any;
|
|
9686
|
+
};
|
|
9687
|
+
content?: never;
|
|
9688
|
+
};
|
|
9689
|
+
};
|
|
9690
|
+
};
|
|
9029
9691
|
"GitHubPublicController.installations": {
|
|
9030
9692
|
parameters: {
|
|
9031
9693
|
query?: {
|