@keboola/api-client 53.0.0 → 55.0.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/API-SURFACE.md +2 -1
- package/CHANGELOG.md +68 -0
- package/README.md +1 -1
- package/dist/{admin-Di-MmGFP.cjs → admin-BZ7knTd0.cjs} +18 -2
- package/dist/admin-BZ7knTd0.cjs.map +1 -0
- package/dist/{admin-CbMOsfgs.js → admin-xFfHSZHQ.js} +13 -3
- package/dist/admin-xFfHSZHQ.js.map +1 -0
- package/dist/{componentId-DZP1rBix.js → componentId-Ba4gsJ9O.js} +3 -2
- package/dist/componentId-Ba4gsJ9O.js.map +1 -0
- package/dist/{componentId-olp0tltf.cjs → componentId-Ba_1Gv_A.cjs} +3 -2
- package/dist/componentId-Ba_1Gv_A.cjs.map +1 -0
- package/dist/{configurations-WI8H4zLk.cjs → configurations-BM63ep1s.cjs} +2 -2
- package/dist/{configurations-WI8H4zLk.cjs.map → configurations-BM63ep1s.cjs.map} +1 -1
- package/dist/{configurations-Cd6Nsox-.js → configurations-BqvtIQm4.js} +2 -2
- package/dist/{configurations-Cd6Nsox-.js.map → configurations-BqvtIQm4.js.map} +1 -1
- package/dist/constants/index.cjs +3 -2
- package/dist/constants/index.d.cts +2 -2
- package/dist/constants/index.d.ts +2 -2
- package/dist/constants/index.js +3 -3
- package/dist/{constants-DLPkpnGv.js → constants-HccvU5kx.js} +9 -2
- package/dist/constants-HccvU5kx.js.map +1 -0
- package/dist/{constants-Day8CU5i.cjs → constants-V9hAyPTo.cjs} +14 -1
- package/dist/constants-V9hAyPTo.cjs.map +1 -0
- package/dist/domain/permissions/index.cjs +4 -3
- package/dist/domain/permissions/index.d.cts +9 -1
- package/dist/domain/permissions/index.d.ts +9 -1
- package/dist/domain/permissions/index.js +4 -4
- package/dist/encryption/index.d.cts +1 -1
- package/dist/encryption/index.d.ts +1 -1
- package/dist/encryption/types.d.cts +1 -1
- package/dist/encryption/types.d.ts +1 -1
- package/dist/{index-B0prazAi.d.cts → index-BE6qM0vu.d.cts} +551 -30
- package/dist/{index-BoKrc8wy.d.ts → index-BGsP2QBc.d.ts} +2 -2
- package/dist/{index-BxgHNJ3Q.d.ts → index-CQPs3hrp.d.ts} +25 -40
- package/dist/{index-BL7uXOiY.d.cts → index-CWowDl63.d.cts} +2 -2
- package/dist/{index-BNwo-zaJ.d.cts → index-CYk7Aa8u.d.cts} +11 -3
- package/dist/{index-BUKMdbKh.d.cts → index-CmyFWQXn.d.cts} +25 -40
- package/dist/{index-CwUurckF.d.ts → index-D3hWR_e4.d.ts} +11 -3
- package/dist/{index-D0Gnp2QM.d.ts → index-DeWeUUfE.d.ts} +551 -30
- package/dist/index.cjs +12 -17
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +11 -16
- package/dist/index.js.map +1 -1
- package/dist/management/index.cjs +1 -1
- package/dist/management/index.d.cts +1 -1
- package/dist/management/index.d.ts +1 -1
- package/dist/management/index.js +1 -1
- package/dist/management/types.d.cts +2 -2
- package/dist/management/types.d.ts +2 -2
- package/dist/{management-CmgsWmf0.js → management-BlMQnPNS.js} +40 -19
- package/dist/management-BlMQnPNS.js.map +1 -0
- package/dist/{management-Drs5G-hf.cjs → management-dIMrTTpI.cjs} +40 -19
- package/dist/management-dIMrTTpI.cjs.map +1 -0
- package/dist/metaObject-CSGF3d-o.js +53 -0
- package/dist/metaObject-CSGF3d-o.js.map +1 -0
- package/dist/metaObject-Ciyow2gr.cjs +64 -0
- package/dist/metaObject-Ciyow2gr.cjs.map +1 -0
- package/dist/metaObject-ClvW342q.d.ts +35 -0
- package/dist/metaObject-D7oudegV.d.cts +35 -0
- package/dist/oauth/index.cjs +2 -1
- package/dist/oauth/index.d.cts +41 -2
- package/dist/oauth/index.d.ts +41 -2
- package/dist/oauth/index.js +1 -1
- package/dist/oauth/types.d.cts +2 -2
- package/dist/oauth/types.d.ts +2 -2
- package/dist/{oauth-CSBChWuf.cjs → oauth-CEW2AvDV.cjs} +55 -1
- package/dist/oauth-CEW2AvDV.cjs.map +1 -0
- package/dist/{oauth-DOveZKUv.js → oauth-Fri6IthS.js} +51 -3
- package/dist/oauth-Fri6IthS.js.map +1 -0
- package/dist/{project-Onf-IcPW.cjs → project-BQ2oD6IW.cjs} +2 -2
- package/dist/{project-Onf-IcPW.cjs.map → project-BQ2oD6IW.cjs.map} +1 -1
- package/dist/{project-DmuC0bMK.js → project-aAVAOcmx.js} +2 -2
- package/dist/{project-DmuC0bMK.js.map → project-aAVAOcmx.js.map} +1 -1
- package/dist/queryService/index.d.cts +1 -1
- package/dist/queryService/index.d.ts +1 -1
- package/dist/queryService/types.d.cts +1 -1
- package/dist/queryService/types.d.ts +1 -1
- package/dist/queryService-B4h1Ez44.cjs +117 -0
- package/dist/queryService-B4h1Ez44.cjs.map +1 -0
- package/dist/queryService-DE_yE_S4.js +106 -0
- package/dist/queryService-DE_yE_S4.js.map +1 -0
- package/dist/queue/index.d.cts +1 -1
- package/dist/queue/index.d.ts +1 -1
- package/dist/sdk/configurations/index.cjs +48 -3
- package/dist/sdk/configurations/index.cjs.map +1 -1
- package/dist/sdk/configurations/index.d.cts +230 -2
- package/dist/sdk/configurations/index.d.ts +230 -2
- package/dist/sdk/configurations/index.js +48 -3
- package/dist/sdk/configurations/index.js.map +1 -1
- package/dist/sdk/dataAppServer/index.cjs +4 -40
- package/dist/sdk/dataAppServer/index.cjs.map +1 -1
- package/dist/sdk/dataAppServer/index.d.cts +1 -1
- package/dist/sdk/dataAppServer/index.d.ts +1 -1
- package/dist/sdk/dataAppServer/index.js +2 -38
- package/dist/sdk/dataAppServer/index.js.map +1 -1
- package/dist/sdk/queryService/index.cjs +3 -70
- package/dist/sdk/queryService/index.d.cts +2 -2
- package/dist/sdk/queryService/index.d.ts +2 -2
- package/dist/sdk/queryService/index.js +1 -70
- package/dist/sdk/securityPolicy/index.cjs +365 -0
- package/dist/sdk/securityPolicy/index.cjs.map +1 -0
- package/dist/sdk/securityPolicy/index.d.cts +110 -0
- package/dist/sdk/securityPolicy/index.d.ts +110 -0
- package/dist/sdk/securityPolicy/index.js +350 -0
- package/dist/sdk/securityPolicy/index.js.map +1 -0
- package/dist/sdk/securityPolicy/types.cjs +0 -0
- package/dist/sdk/securityPolicy/types.d.cts +2 -0
- package/dist/sdk/securityPolicy/types.d.ts +2 -0
- package/dist/sdk/securityPolicy/types.js +1 -0
- package/dist/sdk/semanticLayer/index.cjs +3 -2
- package/dist/sdk/semanticLayer/index.d.cts +3 -3
- package/dist/sdk/semanticLayer/index.d.ts +3 -3
- package/dist/sdk/semanticLayer/index.js +3 -1
- package/dist/sdk/semanticLayer/types.d.cts +1 -1
- package/dist/sdk/semanticLayer/types.d.ts +1 -1
- package/dist/sdk/vault/index.cjs +3 -12
- package/dist/sdk/vault/index.cjs.map +1 -1
- package/dist/sdk/vault/index.d.cts +1 -1
- package/dist/sdk/vault/index.d.ts +1 -1
- package/dist/sdk/vault/index.js +3 -12
- package/dist/sdk/vault/index.js.map +1 -1
- package/dist/{semanticLayer-D8D_3hk-.cjs → semanticLayer-BVpdWKJn.cjs} +4 -52
- package/dist/semanticLayer-BVpdWKJn.cjs.map +1 -0
- package/dist/{semanticLayer-CfjDnmsY.js → semanticLayer-Btj1Qy9O.js} +5 -47
- package/dist/semanticLayer-Btj1Qy9O.js.map +1 -0
- package/dist/storage/index.cjs +1 -1
- package/dist/storage/index.d.cts +2 -2
- package/dist/storage/index.d.ts +2 -2
- package/dist/storage/index.js +1 -1
- package/dist/storage/types.d.cts +2 -2
- package/dist/storage/types.d.ts +2 -2
- package/dist/{storage-BMrYlyLB.cjs → storage-BL-TfHp8.cjs} +2 -2
- package/dist/storage-BL-TfHp8.cjs.map +1 -0
- package/dist/{storage--2FvvLAw.js → storage-DEJN8sw-.js} +2 -2
- package/dist/storage-DEJN8sw-.js.map +1 -0
- package/dist/syncActions/index.cjs +1 -1
- package/dist/syncActions/index.js +1 -1
- package/dist/{syncActions-DToUhyP3.cjs → syncActions-B9JTiSao.cjs} +2 -2
- package/dist/{syncActions-DToUhyP3.cjs.map → syncActions-B9JTiSao.cjs.map} +1 -1
- package/dist/{syncActions-DV_aObTQ.js → syncActions-W98Jme2Z.js} +2 -2
- package/dist/{syncActions-DV_aObTQ.js.map → syncActions-W98Jme2Z.js.map} +1 -1
- package/dist/{types-iU1Sc1IM.d.ts → types-BDgOF2WN.d.ts} +6 -29
- package/dist/types-BXKL0wTI.d.cts +85 -0
- package/dist/{types-CsRfoHQw.d.cts → types-Bwvss_gW.d.cts} +1111 -412
- package/dist/{types-BljDxuWG.d.cts → types-DCARsJWs.d.cts} +6 -29
- package/dist/types-DK1bSUNr.d.ts +85 -0
- package/dist/{types-DjWubjvP.d.cts → types-DMhgKHCP.d.cts} +309 -74
- package/dist/{types-DNldEa7i.d.ts → types-J_dgwMjP.d.ts} +1111 -412
- package/dist/{types-CsVRsObb.d.ts → types-p_lWvuQJ.d.ts} +309 -74
- package/package.json +29 -3
- package/surface/management.md +29 -25
- package/dist/admin-CbMOsfgs.js.map +0 -1
- package/dist/admin-Di-MmGFP.cjs.map +0 -1
- package/dist/componentId-DZP1rBix.js.map +0 -1
- package/dist/componentId-olp0tltf.cjs.map +0 -1
- package/dist/constants-DLPkpnGv.js.map +0 -1
- package/dist/constants-Day8CU5i.cjs.map +0 -1
- package/dist/management-CmgsWmf0.js.map +0 -1
- package/dist/management-Drs5G-hf.cjs.map +0 -1
- package/dist/oauth-CSBChWuf.cjs.map +0 -1
- package/dist/oauth-DOveZKUv.js.map +0 -1
- package/dist/sdk/queryService/index.cjs.map +0 -1
- package/dist/sdk/queryService/index.js.map +0 -1
- package/dist/semanticLayer-CfjDnmsY.js.map +0 -1
- package/dist/semanticLayer-D8D_3hk-.cjs.map +0 -1
- package/dist/storage--2FvvLAw.js.map +0 -1
- package/dist/storage-BMrYlyLB.cjs.map +0 -1
|
@@ -625,7 +625,7 @@ type paths = {
|
|
|
625
625
|
};
|
|
626
626
|
/**
|
|
627
627
|
* List Azure Blob Storage
|
|
628
|
-
* @description Returns all registered Azure Blob Storages.
|
|
628
|
+
* @description Returns all registered Azure Blob Storages. A super admin, or an admin with the "can-manage-maintainers" feature, may call this.
|
|
629
629
|
*/
|
|
630
630
|
get: operations['get_/manage/file-storage-abs::FileStorageAbsListAction'];
|
|
631
631
|
put?: never;
|
|
@@ -752,7 +752,7 @@ type paths = {
|
|
|
752
752
|
};
|
|
753
753
|
/**
|
|
754
754
|
* List Google Cloud Storage
|
|
755
|
-
* @description Returns all registered Google Cloud Storages.
|
|
755
|
+
* @description Returns all registered Google Cloud Storages. A super admin, or an admin with the "can-manage-maintainers" feature, may call this.
|
|
756
756
|
*/
|
|
757
757
|
get: operations['get_/manage/file-storage-gcs::FileStorageGcsListAction'];
|
|
758
758
|
put?: never;
|
|
@@ -818,7 +818,7 @@ type paths = {
|
|
|
818
818
|
};
|
|
819
819
|
/**
|
|
820
820
|
* List storages
|
|
821
|
-
* @description Returns all registered AWS S3 storages.
|
|
821
|
+
* @description Returns all registered AWS S3 storages. A super admin, or an admin with the "can-manage-maintainers" feature, may call this.
|
|
822
822
|
*/
|
|
823
823
|
get: operations['get_/manage/file-storage-s3::FileStorageS3ListAction'];
|
|
824
824
|
put?: never;
|
|
@@ -1000,7 +1000,7 @@ type paths = {
|
|
|
1000
1000
|
put?: never;
|
|
1001
1001
|
/**
|
|
1002
1002
|
* Create a maintainer
|
|
1003
|
-
* @description Creates a new maintainer. The user associated with the token
|
|
1003
|
+
* @description Creates a new maintainer. A super admin may set every field. An admin with the "can-manage-maintainers" feature may set only name, defaultConnectionSnowflakeId and defaultFileStorageId. The user associated with the token becomes an admin of the maintainer.
|
|
1004
1004
|
*/
|
|
1005
1005
|
post: operations['post_/manage/maintainers::MaintainerCreateAction'];
|
|
1006
1006
|
delete?: never;
|
|
@@ -1080,7 +1080,7 @@ type paths = {
|
|
|
1080
1080
|
head?: never;
|
|
1081
1081
|
/**
|
|
1082
1082
|
* Update a maintainer
|
|
1083
|
-
* @description A partial update of a maintainer.
|
|
1083
|
+
* @description A partial update of a maintainer. A super admin may change every field. A maintainer member without can-manage-maintainers may change name. An admin with that feature may change name, defaultConnectionSnowflakeId and defaultFileStorageId on any active maintainer.
|
|
1084
1084
|
*/
|
|
1085
1085
|
patch: operations['patch_/manage/maintainers/{id}::MaintainerUpdateAction'];
|
|
1086
1086
|
trace?: never;
|
|
@@ -2070,6 +2070,26 @@ type paths = {
|
|
|
2070
2070
|
patch?: never;
|
|
2071
2071
|
trace?: never;
|
|
2072
2072
|
};
|
|
2073
|
+
'/manage/projects/{projectId}/restorable-objects': {
|
|
2074
|
+
parameters: {
|
|
2075
|
+
query?: never;
|
|
2076
|
+
header?: never;
|
|
2077
|
+
path?: never;
|
|
2078
|
+
cookie?: never;
|
|
2079
|
+
};
|
|
2080
|
+
/**
|
|
2081
|
+
* List restorable tables and buckets of a project
|
|
2082
|
+
* @description Lists the tables and buckets dropped from the default branch of a Snowflake project that are still in Snowflake Time Travel and can be restored. Every dropped version is listed, newest first; `droppedOn` identifies the version. The tables of a dropped bucket are listed only once the bucket is restored. Snowflake lists at most 10 000 objects of a database, so a very large project can be listed per bucket with `bucketId`. Read-only. Allowed to a super admin or an admin with the `can-restore-tables` feature.
|
|
2083
|
+
*/
|
|
2084
|
+
get: operations['get_/manage/projects/{projectId}/restorable-objects::ProjectListRestorableObjectsAction'];
|
|
2085
|
+
put?: never;
|
|
2086
|
+
post?: never;
|
|
2087
|
+
delete?: never;
|
|
2088
|
+
options?: never;
|
|
2089
|
+
head?: never;
|
|
2090
|
+
patch?: never;
|
|
2091
|
+
trace?: never;
|
|
2092
|
+
};
|
|
2073
2093
|
'/manage/projects/{projectId}/workspaces': {
|
|
2074
2094
|
parameters: {
|
|
2075
2095
|
query?: never;
|
|
@@ -2273,6 +2293,66 @@ type paths = {
|
|
|
2273
2293
|
patch: operations['patch_/manage/projects/{projectId}/users/{userId}::ProjectUpdateAdministratorAction'];
|
|
2274
2294
|
trace?: never;
|
|
2275
2295
|
};
|
|
2296
|
+
'/manage/search': {
|
|
2297
|
+
parameters: {
|
|
2298
|
+
query?: never;
|
|
2299
|
+
header?: never;
|
|
2300
|
+
path?: never;
|
|
2301
|
+
cookie?: never;
|
|
2302
|
+
};
|
|
2303
|
+
/**
|
|
2304
|
+
* Search projects, organizations, maintainers and users
|
|
2305
|
+
* @description Looks up the entities an admin navigates to across the whole stack, by name (and email for users).
|
|
2306
|
+
*
|
|
2307
|
+
* #### Access
|
|
2308
|
+
*
|
|
2309
|
+
* Each type is searched only when the caller may read it; a type it may not read is **absent** from the
|
|
2310
|
+
* response, not an empty collection, so "not allowed" and "no hits" can be told apart.
|
|
2311
|
+
*
|
|
2312
|
+
* * super admin — every type
|
|
2313
|
+
* * `project`, `organization`, `maintainer` — any L1 support feature (such as `can-manage-features`
|
|
2314
|
+
* or `can-disable-projects`)
|
|
2315
|
+
* * `user` — feature `can-manage-users` (the rule of `GET /manage/users`)
|
|
2316
|
+
*
|
|
2317
|
+
* Any other admin gets 403; membership in a project, organization or maintainer grants nothing here.
|
|
2318
|
+
* Admin and session tokens are accepted.
|
|
2319
|
+
*
|
|
2320
|
+
* #### Matching
|
|
2321
|
+
*
|
|
2322
|
+
* * *q* - required, trimmed, 2 to 255 characters. Matched as a case-insensitive substring of the name,
|
|
2323
|
+
* and of the email for users. `%` and `_` match themselves. An all-digit `q` also matches the row with
|
|
2324
|
+
* that exact `id`.
|
|
2325
|
+
* * Deleted projects, organizations and maintainers and anonymized users are never found. Disabled
|
|
2326
|
+
* projects are found and carry `isDisabled: true`.
|
|
2327
|
+
* * *filter[types]* - comma-separated subset of `project`, `organization`, `maintainer`, `user`;
|
|
2328
|
+
* omitted, every type the caller may read is searched. A listed type the caller may not read is
|
|
2329
|
+
* left out like an unlisted one.
|
|
2330
|
+
*
|
|
2331
|
+
* #### Ranking and pagination
|
|
2332
|
+
*
|
|
2333
|
+
* Each type is its own cursor-paginated collection (`data`, `meta`, `links`). Every item carries its
|
|
2334
|
+
* `rank`: `0` exact id match, `1` the name (or user email) starts with `q`, `2` any other match.
|
|
2335
|
+
* Items are ordered `rank ASC, id DESC`.
|
|
2336
|
+
*
|
|
2337
|
+
* * *page[limit]* - items returned per type; default value: 10, maximum: 50
|
|
2338
|
+
* * *page[after]* - cursor of the last item already read, for a single type: it requires exactly one
|
|
2339
|
+
* type in `filter[types]`. It is the base64url (padding optional) of `{"rank": <integer>, "id": <integer>}`
|
|
2340
|
+
* copied from that item, e.g. `{"rank":2,"id":4088}` → `eyJyYW5rIjoyLCJpZCI6NDA4OH0`.
|
|
2341
|
+
* Each type's `links.next` already carries its next page, with `filter[types]` narrowed to that type.
|
|
2342
|
+
*
|
|
2343
|
+
* A `q` that is missing or too short or long, an unknown or repeated type, an undecodable cursor,
|
|
2344
|
+
* `page[after]` without exactly one type, and bare `limit` / `offset` or `page[offset]` are rejected
|
|
2345
|
+
* with a validation error.
|
|
2346
|
+
*/
|
|
2347
|
+
get: operations['get_/manage/search::SearchAction'];
|
|
2348
|
+
put?: never;
|
|
2349
|
+
post?: never;
|
|
2350
|
+
delete?: never;
|
|
2351
|
+
options?: never;
|
|
2352
|
+
head?: never;
|
|
2353
|
+
patch?: never;
|
|
2354
|
+
trace?: never;
|
|
2355
|
+
};
|
|
2276
2356
|
'/manage/storage-backend/{backendId}/activate': {
|
|
2277
2357
|
parameters: {
|
|
2278
2358
|
query?: never;
|
|
@@ -2382,10 +2462,18 @@ type paths = {
|
|
|
2382
2462
|
put?: never;
|
|
2383
2463
|
/**
|
|
2384
2464
|
* Create a new BigQuery backend
|
|
2385
|
-
* @description You must create a new project and service account in a folder in your organization
|
|
2386
|
-
* this service account must have the right to create new projects (roles/resourcemanager.projectCreator) in this folder (only in this folder)
|
|
2465
|
+
* @description You must create a new project and service account in a folder in your organization
|
|
2387
2466
|
* and use the generated json [keyFile](https://cloud.google.com/iam/docs/creating-managing-service-account-keys)
|
|
2388
2467
|
* for this `service account` in the `credentials` parameter, the folder id then as `folderId`.
|
|
2468
|
+
*
|
|
2469
|
+
* The service account needs, as effective access (direct, inherited or through a group):
|
|
2470
|
+
* - on the folder (only this folder): `roles/resourcemanager.projectCreator` and `roles/browser`;
|
|
2471
|
+
* - on its own project: `roles/owner` and `roles/storage.objectAdmin`;
|
|
2472
|
+
* - on the billing account of its project: `roles/billing.user`;
|
|
2473
|
+
* - on the bucket of every GCS file storage used with this backend: `roles/storage.admin`.
|
|
2474
|
+
*
|
|
2475
|
+
* The registration checks all but the bucket and lists every grant as held or missing; project
|
|
2476
|
+
* creation checks the bucket before it creates anything.
|
|
2389
2477
|
*/
|
|
2390
2478
|
post: operations['post_/manage/storage-backend/bigquery::StorageBackendCreateBigqueryAction'];
|
|
2391
2479
|
delete?: never;
|
|
@@ -2496,9 +2584,9 @@ type paths = {
|
|
|
2496
2584
|
};
|
|
2497
2585
|
/**
|
|
2498
2586
|
* BigQuery policy-tag enablement guide
|
|
2499
|
-
* @description Returns what the customer sets up in Google Cloud before Keboola can enable BigQuery policy tags on this backend: the custom
|
|
2587
|
+
* @description Returns what the customer sets up in Google Cloud before Keboola can enable BigQuery policy tags on this backend: the custom setter role, its bindings on the taxonomy for the root service account and for the principal set of the backend folder, the probe tag, and the enable command with the values filled in. `format=markdown` returns a document, `format=terraform` a module that creates the same resources.
|
|
2500
2588
|
*
|
|
2501
|
-
* A backend uses one taxonomy. Pass the existing one as the single item of `resourceScopes`, or `createTaxonomy=true` for a new one in `roleProject`; a second taxonomy is refused. The taxonomy must be in the backend region, and in `roleProject`: the custom
|
|
2589
|
+
* A backend uses one taxonomy. Pass the existing one as the single item of `resourceScopes`, or `createTaxonomy=true` for a new one in `roleProject`; a second taxonomy is refused. The taxonomy must be in the backend region, and in `roleProject`: the custom role is project-level and can be granted only on resources of its own project.
|
|
2502
2590
|
*
|
|
2503
2591
|
* Available to a super admin only, the same as creating a BigQuery backend.
|
|
2504
2592
|
*/
|
|
@@ -2633,7 +2721,7 @@ type paths = {
|
|
|
2633
2721
|
*
|
|
2634
2722
|
* With `includeInactive=true` it returns every registered application instead, including
|
|
2635
2723
|
* those that have no active version — their `version`, `basePath`, `type` and `commitSha`
|
|
2636
|
-
* are then null and `scripts`/`styles` empty. That variant requires a super admin.
|
|
2724
|
+
* are then null and `scripts`/`styles`/`preloads` empty. That variant requires a super admin.
|
|
2637
2725
|
*/
|
|
2638
2726
|
get: operations['get_/manage/ui-apps::UiAppsListAction'];
|
|
2639
2727
|
put?: never;
|
|
@@ -2719,6 +2807,9 @@ type paths = {
|
|
|
2719
2807
|
* @description It will completely remove user from everywhere (projects, organizations and maintainers).
|
|
2720
2808
|
* Removes also personal data of user (e-mail and name).
|
|
2721
2809
|
*
|
|
2810
|
+
* A holder of the `can-manage-users` feature can delete any user except a super admin, including users
|
|
2811
|
+
* in organizations, projects and maintainers the holder is not a member of.
|
|
2812
|
+
*
|
|
2722
2813
|
* The path parameter accepts an integer user ID or an email address.
|
|
2723
2814
|
*/
|
|
2724
2815
|
delete: operations['delete_/manage/users/{idOrEmail}::UserDeleteAction'];
|
|
@@ -3093,6 +3184,26 @@ type paths = {
|
|
|
3093
3184
|
patch?: never;
|
|
3094
3185
|
trace?: never;
|
|
3095
3186
|
};
|
|
3187
|
+
'/pay-as-you-go/x402/projects/{projectId}/credits': {
|
|
3188
|
+
parameters: {
|
|
3189
|
+
query?: never;
|
|
3190
|
+
header?: never;
|
|
3191
|
+
path?: never;
|
|
3192
|
+
cookie?: never;
|
|
3193
|
+
};
|
|
3194
|
+
get?: never;
|
|
3195
|
+
put?: never;
|
|
3196
|
+
/**
|
|
3197
|
+
* Buy pay-as-you-go credits with x402
|
|
3198
|
+
* @description Buys credits for a pay-as-you-go project with a USDC payment over the x402 V2 protocol. Without the `PAYMENT-SIGNATURE` header the call answers `402` with the payment requirements in the base64 JSON `PAYMENT-REQUIRED` header. Repeat the same request with a signed payment in `PAYMENT-SIGNATURE`; it answers `200` with the credit row and the base64 JSON settlement in `PAYMENT-RESPONSE`. The payment must carry the required `payment-identifier` extension: a retry with the same identifier returns the stored result instead of paying again. Authenticated by a Manage API token (admin or session type) or a programmatic bearer token; the browser session cookie and personal access tokens are refused.
|
|
3199
|
+
*/
|
|
3200
|
+
post: operations['post_/pay-as-you-go/x402/projects/{projectId}/credits::X402TopUpAction'];
|
|
3201
|
+
delete?: never;
|
|
3202
|
+
options?: never;
|
|
3203
|
+
head?: never;
|
|
3204
|
+
patch?: never;
|
|
3205
|
+
trace?: never;
|
|
3206
|
+
};
|
|
3096
3207
|
'/integration/partners/gcp/project/{projectId}/set-up/big-query': {
|
|
3097
3208
|
parameters: {
|
|
3098
3209
|
query?: never;
|
|
@@ -3271,7 +3382,7 @@ type components = {
|
|
|
3271
3382
|
*/
|
|
3272
3383
|
accountKey: string;
|
|
3273
3384
|
};
|
|
3274
|
-
|
|
3385
|
+
FileStorageProjectListRequest: Record<string, never>;
|
|
3275
3386
|
/** @description Partial update of a file storage; at least one of `owner`, `region` must be supplied. */
|
|
3276
3387
|
FileStorageUpdateRequest: {
|
|
3277
3388
|
/**
|
|
@@ -3804,6 +3915,7 @@ type components = {
|
|
|
3804
3915
|
/** @description Project time zone (e.g., “America/New_York”, “Europe/London”). Only supported with the BigQuery backend. */
|
|
3805
3916
|
timezone?: string | null;
|
|
3806
3917
|
};
|
|
3918
|
+
SearchRequest: Record<string, never>;
|
|
3807
3919
|
CreateSnowflakeBackendWithCertRequest: {
|
|
3808
3920
|
/**
|
|
3809
3921
|
* @description Snowflake host name.
|
|
@@ -3964,7 +4076,7 @@ type components = {
|
|
|
3964
4076
|
*/
|
|
3965
4077
|
format?: 'markdown' | 'terraform' | null;
|
|
3966
4078
|
/**
|
|
3967
|
-
* @description GCP project ID that holds the custom
|
|
4079
|
+
* @description GCP project ID that holds the custom setter role (and the new taxonomy when `createTaxonomy` is true).
|
|
3968
4080
|
* @example acme-data-governance
|
|
3969
4081
|
*/
|
|
3970
4082
|
roleProject: string;
|
|
@@ -4164,6 +4276,17 @@ type components = {
|
|
|
4164
4276
|
/** @description Identifier of the project to top up. Must be a positive integer. */
|
|
4165
4277
|
idProject: number;
|
|
4166
4278
|
};
|
|
4279
|
+
X402TopUpQueryRequest: {
|
|
4280
|
+
/**
|
|
4281
|
+
* @description The amount to pay in USD, tax-inclusive, with at most two decimals and within the stack's minimum and maximum. The credits are the amount divided by the stack's credit price.
|
|
4282
|
+
* @example 25.00
|
|
4283
|
+
*/
|
|
4284
|
+
amountUsd: string;
|
|
4285
|
+
};
|
|
4286
|
+
X402TopUpHeaderRequest: {
|
|
4287
|
+
/** @description Base64 JSON x402 V2 `PaymentPayload`. */
|
|
4288
|
+
'payment-signature'?: string | null;
|
|
4289
|
+
};
|
|
4167
4290
|
SetUpBigQueryRequest: {
|
|
4168
4291
|
/** @description GCP service account credentials. */
|
|
4169
4292
|
serviceAccountKey: {
|
|
@@ -4713,6 +4836,31 @@ type components = {
|
|
|
4713
4836
|
/** @description Projects awaiting purge whose scheduled purge time has passed; a subset of `deleted`. */
|
|
4714
4837
|
overdue: number;
|
|
4715
4838
|
};
|
|
4839
|
+
/**
|
|
4840
|
+
* @example {
|
|
4841
|
+
* "id": 1,
|
|
4842
|
+
* "name": "Test user",
|
|
4843
|
+
* "email": "test@example.com"
|
|
4844
|
+
* }
|
|
4845
|
+
*/
|
|
4846
|
+
FeatureAdminResponse: {
|
|
4847
|
+
/**
|
|
4848
|
+
* @description Admin identifier.
|
|
4849
|
+
* @example 1
|
|
4850
|
+
*/
|
|
4851
|
+
id: number;
|
|
4852
|
+
/**
|
|
4853
|
+
* @description Admin name.
|
|
4854
|
+
* @example Test user
|
|
4855
|
+
*/
|
|
4856
|
+
name: string;
|
|
4857
|
+
/**
|
|
4858
|
+
* @description Admin email address.
|
|
4859
|
+
* @example test@example.com
|
|
4860
|
+
*/
|
|
4861
|
+
email: string;
|
|
4862
|
+
};
|
|
4863
|
+
FeatureAdminListResponse: components['schemas']['FeatureAdminResponse'][];
|
|
4716
4864
|
/**
|
|
4717
4865
|
* @example {
|
|
4718
4866
|
* "id": 1,
|
|
@@ -4723,7 +4871,7 @@ type components = {
|
|
|
4723
4871
|
* "canBeManageByAdmin": false,
|
|
4724
4872
|
* "canBeManagedByAdmin": false,
|
|
4725
4873
|
* "canBeManagedViaAPI": true,
|
|
4726
|
-
* "created": "2016-04-28T15:24:51
|
|
4874
|
+
* "created": "2016-04-28T15:24:51+0200"
|
|
4727
4875
|
* }
|
|
4728
4876
|
*/
|
|
4729
4877
|
FeatureResponse: {
|
|
@@ -4742,7 +4890,7 @@ type components = {
|
|
|
4742
4890
|
* @example admin
|
|
4743
4891
|
* @enum {string}
|
|
4744
4892
|
*/
|
|
4745
|
-
type: 'admin' | 'project';
|
|
4893
|
+
type: 'admin' | 'project' | 'global';
|
|
4746
4894
|
/**
|
|
4747
4895
|
* @description Feature title.
|
|
4748
4896
|
* @example Show new design
|
|
@@ -4770,9 +4918,8 @@ type components = {
|
|
|
4770
4918
|
*/
|
|
4771
4919
|
canBeManagedViaAPI: boolean;
|
|
4772
4920
|
/**
|
|
4773
|
-
*
|
|
4774
|
-
* @
|
|
4775
|
-
* @example 2016-04-28T15:24:51.620Z
|
|
4921
|
+
* @description Feature creation time in ISO 8601 with a UTC offset and no fraction (`Y-m-d\TH:i:sO`); an empty string when the time is not recorded.
|
|
4922
|
+
* @example 2016-04-28T15:24:51+0200
|
|
4776
4923
|
*/
|
|
4777
4924
|
created: string;
|
|
4778
4925
|
};
|
|
@@ -5303,7 +5450,7 @@ type components = {
|
|
|
5303
5450
|
* @example 2016-02-29T08:01:13+0200
|
|
5304
5451
|
*/
|
|
5305
5452
|
created: string | null;
|
|
5306
|
-
/** @description User who invited this user; null when the user was not invited. */
|
|
5453
|
+
/** @description User who invited this user; null when the user was not invited or the inviting user was deleted. */
|
|
5307
5454
|
invitor: {
|
|
5308
5455
|
/** @example 124 */
|
|
5309
5456
|
id: number;
|
|
@@ -5506,6 +5653,14 @@ type components = {
|
|
|
5506
5653
|
/** @description Organizations belonging to this maintainer. */
|
|
5507
5654
|
organizations: components['schemas']['OrganizationResponse'][];
|
|
5508
5655
|
};
|
|
5656
|
+
OrganizationAdministratorReferenceResponse: {
|
|
5657
|
+
/** @example 23423 */
|
|
5658
|
+
id: number;
|
|
5659
|
+
/** @example Martin Halamicek */
|
|
5660
|
+
name: string;
|
|
5661
|
+
/** @example martin@keboola.com */
|
|
5662
|
+
email: string;
|
|
5663
|
+
};
|
|
5509
5664
|
/**
|
|
5510
5665
|
* @example {
|
|
5511
5666
|
* "id": 88,
|
|
@@ -5797,6 +5952,67 @@ type components = {
|
|
|
5797
5952
|
};
|
|
5798
5953
|
};
|
|
5799
5954
|
OrganizationsListResponse: components['schemas']['OrganizationListResponse'][];
|
|
5955
|
+
/**
|
|
5956
|
+
* @example {
|
|
5957
|
+
* "id": 123,
|
|
5958
|
+
* "key": "KBC.SomeEnity.metadataKey",
|
|
5959
|
+
* "value": "Some value",
|
|
5960
|
+
* "provider": "user",
|
|
5961
|
+
* "timestamp": "2021-02-17T15:05:21+0100"
|
|
5962
|
+
* }
|
|
5963
|
+
*/
|
|
5964
|
+
OrganizationMetadataResponse: {
|
|
5965
|
+
/**
|
|
5966
|
+
* @description Metadata identifier.
|
|
5967
|
+
* @example 123
|
|
5968
|
+
*/
|
|
5969
|
+
id: number;
|
|
5970
|
+
/**
|
|
5971
|
+
* @description Metadata key.
|
|
5972
|
+
* @example KBC.SomeEnity.metadataKey
|
|
5973
|
+
*/
|
|
5974
|
+
key: string;
|
|
5975
|
+
/**
|
|
5976
|
+
* @description Metadata value; null only for a row written outside the API.
|
|
5977
|
+
* @example Some value
|
|
5978
|
+
*/
|
|
5979
|
+
value: string | null;
|
|
5980
|
+
/**
|
|
5981
|
+
* @description Metadata provider.
|
|
5982
|
+
* @example user
|
|
5983
|
+
*/
|
|
5984
|
+
provider: string;
|
|
5985
|
+
/**
|
|
5986
|
+
* Format: date-time
|
|
5987
|
+
* @description Time of the last change.
|
|
5988
|
+
* @example 2021-02-17T15:05:21+0100
|
|
5989
|
+
*/
|
|
5990
|
+
timestamp: string;
|
|
5991
|
+
};
|
|
5992
|
+
/**
|
|
5993
|
+
* @example {
|
|
5994
|
+
* "id": 123,
|
|
5995
|
+
* "name": "test user",
|
|
5996
|
+
* "email": "martin@keboola.com"
|
|
5997
|
+
* }
|
|
5998
|
+
*/
|
|
5999
|
+
OrganizationProjectUserResponse: {
|
|
6000
|
+
/**
|
|
6001
|
+
* @description User identifier.
|
|
6002
|
+
* @example 123
|
|
6003
|
+
*/
|
|
6004
|
+
id: number;
|
|
6005
|
+
/**
|
|
6006
|
+
* @description User name.
|
|
6007
|
+
* @example test user
|
|
6008
|
+
*/
|
|
6009
|
+
name: string;
|
|
6010
|
+
/**
|
|
6011
|
+
* @description User e-mail.
|
|
6012
|
+
* @example martin@keboola.com
|
|
6013
|
+
*/
|
|
6014
|
+
email: string;
|
|
6015
|
+
};
|
|
5800
6016
|
ProgrammaticProjectClaimDetailResponse: {
|
|
5801
6017
|
/** @description Whether the browser carries a parked claim. */
|
|
5802
6018
|
present: boolean;
|
|
@@ -5860,6 +6076,25 @@ type components = {
|
|
|
5860
6076
|
confirmUrl: string;
|
|
5861
6077
|
/** @description Identifier of the claim, safe to log. Correlates the provisioning audit record with the later confirmation without exposing the token. */
|
|
5862
6078
|
claimId: string;
|
|
6079
|
+
/** @description How to buy more credits for this project with USDC over x402, or null when this stack does not offer it or the card credit price cannot be read right now. Send `method` to `urlTemplate` with `{amountUsd}` replaced by the amount in USD (at most two decimals, between `minAmountUsd` and `maxAmountUsd`); the first call answers 402 with the payment requirements. The endpoint refuses the project until a human confirms it through `confirmUrl`, and confirming revokes `accessToken`, so the call is authenticated by a Manage API token (admin or session type) or a programmatic bearer token of a project admin, such as the confirming human's session. */
|
|
6080
|
+
x402TopUp: {
|
|
6081
|
+
/** @example POST */
|
|
6082
|
+
method: string;
|
|
6083
|
+
/**
|
|
6084
|
+
* @description Absolute URL with an RFC 6570 `{amountUsd}` placeholder.
|
|
6085
|
+
* @example https://connection.keboola.com/pay-as-you-go/x402/projects/1234/credits?amountUsd={amountUsd}
|
|
6086
|
+
*/
|
|
6087
|
+
urlTemplate: string;
|
|
6088
|
+
/** @example 1.00 */
|
|
6089
|
+
minAmountUsd: string;
|
|
6090
|
+
/** @example 1000.00 */
|
|
6091
|
+
maxAmountUsd: string;
|
|
6092
|
+
/**
|
|
6093
|
+
* @description USD per credit, the same as the card credit price; the top-up buys `amountUsd / creditPriceUsd` credits.
|
|
6094
|
+
* @example 8.40
|
|
6095
|
+
*/
|
|
6096
|
+
creditPriceUsd: string;
|
|
6097
|
+
} | null;
|
|
5863
6098
|
};
|
|
5864
6099
|
/**
|
|
5865
6100
|
* @example {
|
|
@@ -6004,8 +6239,8 @@ type components = {
|
|
|
6004
6239
|
* @example temporary test
|
|
6005
6240
|
*/
|
|
6006
6241
|
reason: string | null;
|
|
6007
|
-
/** @description User who created the join request
|
|
6008
|
-
user
|
|
6242
|
+
/** @description User who created the join request, with the name and email stored when the request was made. */
|
|
6243
|
+
user: {
|
|
6009
6244
|
/** @example 1 */
|
|
6010
6245
|
id: number;
|
|
6011
6246
|
/** @example admin 1 */
|
|
@@ -6170,6 +6405,130 @@ type components = {
|
|
|
6170
6405
|
};
|
|
6171
6406
|
};
|
|
6172
6407
|
};
|
|
6408
|
+
/**
|
|
6409
|
+
* @example {
|
|
6410
|
+
* "id": 123,
|
|
6411
|
+
* "key": "KBC.SomeEnity.metadataKey",
|
|
6412
|
+
* "value": "Some value",
|
|
6413
|
+
* "provider": "user",
|
|
6414
|
+
* "timestamp": "2021-02-17T15:05:21+0100"
|
|
6415
|
+
* }
|
|
6416
|
+
*/
|
|
6417
|
+
ProjectMetadataResponse: {
|
|
6418
|
+
/**
|
|
6419
|
+
* @description Metadata identifier.
|
|
6420
|
+
* @example 123
|
|
6421
|
+
*/
|
|
6422
|
+
id: number;
|
|
6423
|
+
/**
|
|
6424
|
+
* @description Metadata key.
|
|
6425
|
+
* @example KBC.SomeEnity.metadataKey
|
|
6426
|
+
*/
|
|
6427
|
+
key: string;
|
|
6428
|
+
/**
|
|
6429
|
+
* @description Metadata value; null only for a row written outside the API.
|
|
6430
|
+
* @example Some value
|
|
6431
|
+
*/
|
|
6432
|
+
value: string | null;
|
|
6433
|
+
/**
|
|
6434
|
+
* @description Metadata provider.
|
|
6435
|
+
* @example user
|
|
6436
|
+
*/
|
|
6437
|
+
provider: string;
|
|
6438
|
+
/**
|
|
6439
|
+
* Format: date-time
|
|
6440
|
+
* @description Time of the last change.
|
|
6441
|
+
* @example 2021-02-17T15:05:21+0100
|
|
6442
|
+
*/
|
|
6443
|
+
timestamp: string;
|
|
6444
|
+
};
|
|
6445
|
+
RestorableTableResponse: {
|
|
6446
|
+
/**
|
|
6447
|
+
* @description Bucket the table was dropped from.
|
|
6448
|
+
* @example in.c-sales
|
|
6449
|
+
*/
|
|
6450
|
+
bucketId: string;
|
|
6451
|
+
/**
|
|
6452
|
+
* @description Name of the dropped table.
|
|
6453
|
+
* @example orders
|
|
6454
|
+
*/
|
|
6455
|
+
tableName: string;
|
|
6456
|
+
/**
|
|
6457
|
+
* @description Identifier the table had.
|
|
6458
|
+
* @example in.c-sales.orders
|
|
6459
|
+
*/
|
|
6460
|
+
tableId: string;
|
|
6461
|
+
/**
|
|
6462
|
+
* @description When this version was dropped, in UTC with nanoseconds. Identifies the version to restore; pass it back unchanged.
|
|
6463
|
+
* @example 2026-10-25T08:00:00.123456789Z
|
|
6464
|
+
*/
|
|
6465
|
+
droppedOn: string;
|
|
6466
|
+
/**
|
|
6467
|
+
* Format: date-time
|
|
6468
|
+
* @description End of the Time Travel retention of this version; it cannot be restored after that.
|
|
6469
|
+
* @example 2026-11-01T08:00:00+0000
|
|
6470
|
+
*/
|
|
6471
|
+
restorableUntil: string;
|
|
6472
|
+
/**
|
|
6473
|
+
* @description Time Travel retention of the table in days.
|
|
6474
|
+
* @example 7
|
|
6475
|
+
*/
|
|
6476
|
+
retentionTimeDays: number;
|
|
6477
|
+
/**
|
|
6478
|
+
* @description Rows of the table when it was dropped.
|
|
6479
|
+
* @example 1234
|
|
6480
|
+
*/
|
|
6481
|
+
rowsCount: number;
|
|
6482
|
+
/**
|
|
6483
|
+
* @description Size of the table when it was dropped.
|
|
6484
|
+
* @example 56789
|
|
6485
|
+
*/
|
|
6486
|
+
dataSizeBytes: number;
|
|
6487
|
+
/**
|
|
6488
|
+
* @description A table or alias with the same name exists in the bucket today, so the version can only be restored under another name.
|
|
6489
|
+
* @example false
|
|
6490
|
+
*/
|
|
6491
|
+
liveTableExists: boolean;
|
|
6492
|
+
/**
|
|
6493
|
+
* @description The bucket of the table does not exist today; it is listed under `buckets` and has to be restored first.
|
|
6494
|
+
* @example false
|
|
6495
|
+
*/
|
|
6496
|
+
bucketDropped: boolean;
|
|
6497
|
+
};
|
|
6498
|
+
RestorableBucketResponse: {
|
|
6499
|
+
/**
|
|
6500
|
+
* @description Identifier the dropped bucket had.
|
|
6501
|
+
* @example in.c-sales
|
|
6502
|
+
*/
|
|
6503
|
+
bucketId: string;
|
|
6504
|
+
/**
|
|
6505
|
+
* @description When this version was dropped, in UTC with nanoseconds. Identifies the version to restore; pass it back unchanged.
|
|
6506
|
+
* @example 2026-10-25T08:00:00.123456789Z
|
|
6507
|
+
*/
|
|
6508
|
+
droppedOn: string;
|
|
6509
|
+
/**
|
|
6510
|
+
* Format: date-time
|
|
6511
|
+
* @description End of the Time Travel retention of this version; it cannot be restored after that.
|
|
6512
|
+
* @example 2026-11-01T08:00:00+0000
|
|
6513
|
+
*/
|
|
6514
|
+
restorableUntil: string;
|
|
6515
|
+
/**
|
|
6516
|
+
* @description Time Travel retention of the bucket in days.
|
|
6517
|
+
* @example 7
|
|
6518
|
+
*/
|
|
6519
|
+
retentionTimeDays: number;
|
|
6520
|
+
/**
|
|
6521
|
+
* @description A bucket with the same identifier exists today, so the version can only be restored under another name.
|
|
6522
|
+
* @example false
|
|
6523
|
+
*/
|
|
6524
|
+
liveBucketExists: boolean;
|
|
6525
|
+
};
|
|
6526
|
+
RestorableObjectsResponse: {
|
|
6527
|
+
/** @description Dropped table versions, ordered by bucket, table and newest drop first. */
|
|
6528
|
+
tables: components['schemas']['RestorableTableResponse'][];
|
|
6529
|
+
/** @description Dropped bucket versions, ordered by bucket and newest drop first. The tables of a dropped bucket are listed only once the bucket is restored. */
|
|
6530
|
+
buckets: components['schemas']['RestorableBucketResponse'][];
|
|
6531
|
+
};
|
|
6173
6532
|
ProjectRetentionWorkspaceResponse: {
|
|
6174
6533
|
/**
|
|
6175
6534
|
* @description Workspace identifier.
|
|
@@ -6228,6 +6587,92 @@ type components = {
|
|
|
6228
6587
|
email: string;
|
|
6229
6588
|
} | null;
|
|
6230
6589
|
};
|
|
6590
|
+
ProjectSearchItem: {
|
|
6591
|
+
/**
|
|
6592
|
+
* @description Match rank: `0` exact id, `1` name prefix, `2` name substring.
|
|
6593
|
+
* @enum {integer}
|
|
6594
|
+
*/
|
|
6595
|
+
rank: 0 | 1 | 2;
|
|
6596
|
+
/** @example 4088 */
|
|
6597
|
+
id: number;
|
|
6598
|
+
/** @example Sales reporting */
|
|
6599
|
+
name: string;
|
|
6600
|
+
organization: {
|
|
6601
|
+
/** @example 123 */
|
|
6602
|
+
id: number;
|
|
6603
|
+
/** @example Acme */
|
|
6604
|
+
name: string;
|
|
6605
|
+
};
|
|
6606
|
+
/** @description The project is disabled; it is still found. */
|
|
6607
|
+
isDisabled: boolean;
|
|
6608
|
+
};
|
|
6609
|
+
OrganizationSearchItem: {
|
|
6610
|
+
/**
|
|
6611
|
+
* @description Match rank: `0` exact id, `1` name prefix, `2` name substring.
|
|
6612
|
+
* @enum {integer}
|
|
6613
|
+
*/
|
|
6614
|
+
rank: 0 | 1 | 2;
|
|
6615
|
+
/** @example 123 */
|
|
6616
|
+
id: number;
|
|
6617
|
+
/** @example Acme */
|
|
6618
|
+
name: string;
|
|
6619
|
+
maintainer: {
|
|
6620
|
+
/** @example 1 */
|
|
6621
|
+
id: number;
|
|
6622
|
+
/** @example Keboola */
|
|
6623
|
+
name: string | null;
|
|
6624
|
+
};
|
|
6625
|
+
};
|
|
6626
|
+
MaintainerSearchItem: {
|
|
6627
|
+
/**
|
|
6628
|
+
* @description Match rank: `0` exact id, `1` name prefix, `2` name substring.
|
|
6629
|
+
* @enum {integer}
|
|
6630
|
+
*/
|
|
6631
|
+
rank: 0 | 1 | 2;
|
|
6632
|
+
/** @example 1 */
|
|
6633
|
+
id: number;
|
|
6634
|
+
/** @example Keboola */
|
|
6635
|
+
name: string | null;
|
|
6636
|
+
};
|
|
6637
|
+
UserSearchItem: {
|
|
6638
|
+
/**
|
|
6639
|
+
* @description Match rank: `0` exact id, `1` name or email prefix, `2` name or email substring.
|
|
6640
|
+
* @enum {integer}
|
|
6641
|
+
*/
|
|
6642
|
+
rank: 0 | 1 | 2;
|
|
6643
|
+
/** @example 42 */
|
|
6644
|
+
id: number;
|
|
6645
|
+
/** @example John Doe */
|
|
6646
|
+
name: string;
|
|
6647
|
+
/** @example john.doe@keboola.com */
|
|
6648
|
+
email: string;
|
|
6649
|
+
};
|
|
6650
|
+
SearchResponse: {
|
|
6651
|
+
/** @description Projects matching `q`; absent when the caller may not read projects or `filter[types]` leaves them out. */
|
|
6652
|
+
project?: {
|
|
6653
|
+
data: components['schemas']['ProjectSearchItem'][];
|
|
6654
|
+
meta: components['schemas']['PaginationMeta'];
|
|
6655
|
+
links: components['schemas']['PaginationLinks'];
|
|
6656
|
+
};
|
|
6657
|
+
/** @description Organizations matching `q`; absent when the caller may not read organizations or `filter[types]` leaves them out. */
|
|
6658
|
+
organization?: {
|
|
6659
|
+
data: components['schemas']['OrganizationSearchItem'][];
|
|
6660
|
+
meta: components['schemas']['PaginationMeta'];
|
|
6661
|
+
links: components['schemas']['PaginationLinks'];
|
|
6662
|
+
};
|
|
6663
|
+
/** @description Maintainers matching `q`; absent when the caller may not read maintainers or `filter[types]` leaves them out. */
|
|
6664
|
+
maintainer?: {
|
|
6665
|
+
data: components['schemas']['MaintainerSearchItem'][];
|
|
6666
|
+
meta: components['schemas']['PaginationMeta'];
|
|
6667
|
+
links: components['schemas']['PaginationLinks'];
|
|
6668
|
+
};
|
|
6669
|
+
/** @description Users matching `q`; absent when the caller may not read users or `filter[types]` leaves them out. */
|
|
6670
|
+
user?: {
|
|
6671
|
+
data: components['schemas']['UserSearchItem'][];
|
|
6672
|
+
meta: components['schemas']['PaginationMeta'];
|
|
6673
|
+
links: components['schemas']['PaginationLinks'];
|
|
6674
|
+
};
|
|
6675
|
+
};
|
|
6231
6676
|
StorageBackendResponse: {
|
|
6232
6677
|
/** @description Root credentials identifier. */
|
|
6233
6678
|
id: number;
|
|
@@ -6418,6 +6863,44 @@ type components = {
|
|
|
6418
6863
|
serviceAccountEmail?: string | null;
|
|
6419
6864
|
/** @description Detail endpoint only (absent on the list endpoint). Whether the BigQuery policy-tag capability is enabled on the backend. BigQuery backends only; absent otherwise. */
|
|
6420
6865
|
policyTagsEnabled?: boolean;
|
|
6866
|
+
/** @description Detail endpoint only (absent on the list endpoint). The stored BigQuery policy-tag capability, as `manage:storage-backend:policy-tags --status` prints it without its live taxonomy read. Always present on a BigQuery backend and absent on every other backend. Null when the capability was never configured; `policyTagsEnabled` is false both then and when it is disabled. Every key of the object is always present. */
|
|
6867
|
+
policyTagCapability?: {
|
|
6868
|
+
/** @enum {string} */
|
|
6869
|
+
state: 'enabled' | 'disabled';
|
|
6870
|
+
/**
|
|
6871
|
+
* @description Custom role the customer granted for setting policy tags.
|
|
6872
|
+
* @example projects/my-gov-project/roles/kbcPolicyTagSetter
|
|
6873
|
+
*/
|
|
6874
|
+
roleName: string;
|
|
6875
|
+
/**
|
|
6876
|
+
* @description Taxonomy the role is granted on.
|
|
6877
|
+
* @example projects/123456789/locations/us/taxonomies/987654321
|
|
6878
|
+
*/
|
|
6879
|
+
resourceScope: string;
|
|
6880
|
+
/**
|
|
6881
|
+
* @description Policy tag the enablement probe attaches.
|
|
6882
|
+
* @example projects/123456789/locations/us/taxonomies/987654321/policyTags/111
|
|
6883
|
+
*/
|
|
6884
|
+
probeTag: string;
|
|
6885
|
+
/**
|
|
6886
|
+
* Format: date-time
|
|
6887
|
+
* @description When the capability was enabled; null while it is disabled.
|
|
6888
|
+
*/
|
|
6889
|
+
enabledAt: string | null;
|
|
6890
|
+
/**
|
|
6891
|
+
* Format: date-time
|
|
6892
|
+
* @description Last probe run, successful or not; null when it never ran.
|
|
6893
|
+
*/
|
|
6894
|
+
verifiedAt: string | null;
|
|
6895
|
+
/** @description Operator of the last probe run. */
|
|
6896
|
+
verifiedBy: string | null;
|
|
6897
|
+
/** @description Error of the last probe run; null when it succeeded or never ran. */
|
|
6898
|
+
lastVerificationError: string | null;
|
|
6899
|
+
/** @description Whether the taxonomy enforces fine-grained access, as stored by the last enablement; null when not recorded. */
|
|
6900
|
+
fineGrainedAccessEnforced: boolean | null;
|
|
6901
|
+
/** @description Projects on this backend holding the `bigquery-policy-tags` feature. */
|
|
6902
|
+
projectsWithFeature: number;
|
|
6903
|
+
} | null;
|
|
6421
6904
|
};
|
|
6422
6905
|
StorageBackendListResponse: components['schemas']['StorageBackendDetailResponse'][];
|
|
6423
6906
|
StorageBackendMaintainerListResponse: {
|
|
@@ -6611,6 +7094,8 @@ type components = {
|
|
|
6611
7094
|
scripts: string[];
|
|
6612
7095
|
/** @description List of style URLs. */
|
|
6613
7096
|
styles: string[];
|
|
7097
|
+
/** @description List of module URLs the entry script imports, for `<link rel="modulepreload">`. */
|
|
7098
|
+
preloads: string[];
|
|
6614
7099
|
/** @description Whether the application is marked as critical. */
|
|
6615
7100
|
isCritical: boolean;
|
|
6616
7101
|
/** @description Git commit SHA that produced this build. */
|
|
@@ -6626,6 +7111,7 @@ type components = {
|
|
|
6626
7111
|
type: string | null;
|
|
6627
7112
|
scripts: string[];
|
|
6628
7113
|
styles: string[];
|
|
7114
|
+
preloads: string[];
|
|
6629
7115
|
isCritical: boolean;
|
|
6630
7116
|
commitSha: string | null;
|
|
6631
7117
|
}[];
|
|
@@ -6664,13 +7150,49 @@ type components = {
|
|
|
6664
7150
|
name: string | null;
|
|
6665
7151
|
};
|
|
6666
7152
|
}[];
|
|
6667
|
-
|
|
6668
|
-
|
|
6669
|
-
|
|
6670
|
-
|
|
6671
|
-
|
|
6672
|
-
|
|
6673
|
-
|
|
7153
|
+
/**
|
|
7154
|
+
* @example {
|
|
7155
|
+
* "id": 123,
|
|
7156
|
+
* "key": "KBC.SomeEnity.metadataKey",
|
|
7157
|
+
* "value": "Some value",
|
|
7158
|
+
* "provider": "user",
|
|
7159
|
+
* "timestamp": "2021-02-17T15:05:21+0100"
|
|
7160
|
+
* }
|
|
7161
|
+
*/
|
|
7162
|
+
UserMetadataResponse: {
|
|
7163
|
+
/**
|
|
7164
|
+
* @description Metadata identifier.
|
|
7165
|
+
* @example 123
|
|
7166
|
+
*/
|
|
7167
|
+
id: number;
|
|
7168
|
+
/**
|
|
7169
|
+
* @description Metadata key.
|
|
7170
|
+
* @example KBC.SomeEnity.metadataKey
|
|
7171
|
+
*/
|
|
7172
|
+
key: string;
|
|
7173
|
+
/**
|
|
7174
|
+
* @description Metadata value; null only for a value stored outside the API.
|
|
7175
|
+
* @example Some value
|
|
7176
|
+
*/
|
|
7177
|
+
value: string | null;
|
|
7178
|
+
/**
|
|
7179
|
+
* @description Metadata provider.
|
|
7180
|
+
* @example user
|
|
7181
|
+
*/
|
|
7182
|
+
provider: string;
|
|
7183
|
+
/**
|
|
7184
|
+
* @description Last update timestamp (ISO 8601 with `+HHMM` offset).
|
|
7185
|
+
* @example 2021-02-17T15:05:21+0100
|
|
7186
|
+
*/
|
|
7187
|
+
timestamp: string;
|
|
7188
|
+
};
|
|
7189
|
+
UserListOrganizationsResponse: {
|
|
7190
|
+
organization: {
|
|
7191
|
+
/** @example 1 */
|
|
7192
|
+
id: number;
|
|
7193
|
+
/** @example Keboola Tests */
|
|
7194
|
+
name: string;
|
|
7195
|
+
};
|
|
6674
7196
|
/**
|
|
6675
7197
|
* Format: date-time
|
|
6676
7198
|
* @example 2014-11-11T08:40:51+00:00
|
|
@@ -6740,6 +7262,25 @@ type components = {
|
|
|
6740
7262
|
*/
|
|
6741
7263
|
state: string;
|
|
6742
7264
|
};
|
|
7265
|
+
X402TopUpQuoteResponse: {
|
|
7266
|
+
/** @example payment_required */
|
|
7267
|
+
error: string;
|
|
7268
|
+
/**
|
|
7269
|
+
* @description The quoted amount in USD.
|
|
7270
|
+
* @example 42.00
|
|
7271
|
+
*/
|
|
7272
|
+
amountUsd: string;
|
|
7273
|
+
/**
|
|
7274
|
+
* @description The credits the payment buys.
|
|
7275
|
+
* @example 5
|
|
7276
|
+
*/
|
|
7277
|
+
credits: number;
|
|
7278
|
+
/**
|
|
7279
|
+
* @description USD per credit: the card credit price, the credits are `amountUsd / creditPriceUsd`.
|
|
7280
|
+
* @example 8.40
|
|
7281
|
+
*/
|
|
7282
|
+
creditPriceUsd: string;
|
|
7283
|
+
};
|
|
6743
7284
|
SetUpBigQueryResponse: {
|
|
6744
7285
|
/** @description Job ID. */
|
|
6745
7286
|
id: number;
|
|
@@ -8373,7 +8914,7 @@ interface operations {
|
|
|
8373
8914
|
};
|
|
8374
8915
|
requestBody?: never;
|
|
8375
8916
|
responses: {
|
|
8376
|
-
/** @description List of admins with the feature assigned. */
|
|
8917
|
+
/** @description List of admins with the feature assigned, ordered by admin ID. */
|
|
8377
8918
|
200: {
|
|
8378
8919
|
headers: {
|
|
8379
8920
|
[name: string]: unknown;
|
|
@@ -8388,23 +8929,7 @@ interface operations {
|
|
|
8388
8929
|
* }
|
|
8389
8930
|
* ]
|
|
8390
8931
|
*/
|
|
8391
|
-
'application/json':
|
|
8392
|
-
/**
|
|
8393
|
-
* @description Admin identifier.
|
|
8394
|
-
* @example 1
|
|
8395
|
-
*/
|
|
8396
|
-
id: number;
|
|
8397
|
-
/**
|
|
8398
|
-
* @description Admin name.
|
|
8399
|
-
* @example Test user
|
|
8400
|
-
*/
|
|
8401
|
-
name: string;
|
|
8402
|
-
/**
|
|
8403
|
-
* @description Admin email address.
|
|
8404
|
-
* @example test@example.com
|
|
8405
|
-
*/
|
|
8406
|
-
email: string;
|
|
8407
|
-
}[];
|
|
8932
|
+
'application/json': components['schemas']['FeatureAdminListResponse'];
|
|
8408
8933
|
};
|
|
8409
8934
|
};
|
|
8410
8935
|
/** @description Returned when the Manage token is missing or invalid. */
|
|
@@ -8459,22 +8984,22 @@ interface operations {
|
|
|
8459
8984
|
* "type": "admin",
|
|
8460
8985
|
* "title": "Show new design",
|
|
8461
8986
|
* "description": "Users with this feature will see new UI",
|
|
8462
|
-
* "created": "2016-04-28T15:24:51
|
|
8987
|
+
* "created": "2016-04-28T15:24:51+0200"
|
|
8463
8988
|
* }
|
|
8464
8989
|
* ]
|
|
8465
8990
|
*/
|
|
8466
8991
|
'application/json': components['schemas']['FeatureListResponse'];
|
|
8467
8992
|
};
|
|
8468
8993
|
};
|
|
8469
|
-
/** @description Returned when
|
|
8470
|
-
|
|
8994
|
+
/** @description Returned when request parameters are invalid. */
|
|
8995
|
+
400: {
|
|
8471
8996
|
headers: {
|
|
8472
8997
|
[name: string]: unknown;
|
|
8473
8998
|
};
|
|
8474
8999
|
content?: never;
|
|
8475
9000
|
};
|
|
8476
|
-
/** @description Returned when
|
|
8477
|
-
|
|
9001
|
+
/** @description Returned when the Manage token is missing or invalid. */
|
|
9002
|
+
401: {
|
|
8478
9003
|
headers: {
|
|
8479
9004
|
[name: string]: unknown;
|
|
8480
9005
|
};
|
|
@@ -8510,7 +9035,7 @@ interface operations {
|
|
|
8510
9035
|
* "description": "Users with this feature will see new UI",
|
|
8511
9036
|
* "canBeManageByAdmin": false,
|
|
8512
9037
|
* "canBeManagedViaAPI": true,
|
|
8513
|
-
* "created": "2016-04-28T15:24:51
|
|
9038
|
+
* "created": "2016-04-28T15:24:51+0200"
|
|
8514
9039
|
* }
|
|
8515
9040
|
*/
|
|
8516
9041
|
'application/json': components['schemas']['FeatureResponse'];
|
|
@@ -8567,7 +9092,7 @@ interface operations {
|
|
|
8567
9092
|
* "type": "admin",
|
|
8568
9093
|
* "title": "Show new design",
|
|
8569
9094
|
* "description": "Users with this feature will see new UI",
|
|
8570
|
-
* "created": "2016-04-28T15:24:51
|
|
9095
|
+
* "created": "2016-04-28T15:24:51+0200"
|
|
8571
9096
|
* }
|
|
8572
9097
|
*/
|
|
8573
9098
|
'application/json': components['schemas']['FeatureResponse'];
|
|
@@ -8668,7 +9193,7 @@ interface operations {
|
|
|
8668
9193
|
* "description": "Users with this feature will see new UI",
|
|
8669
9194
|
* "canBeManageByAdmin": false,
|
|
8670
9195
|
* "canBeManagedViaAPI": true,
|
|
8671
|
-
* "created": "2016-04-28T15:24:51
|
|
9196
|
+
* "created": "2016-04-28T15:24:51+0200"
|
|
8672
9197
|
* }
|
|
8673
9198
|
*/
|
|
8674
9199
|
'application/json': components['schemas']['FeatureResponse'];
|
|
@@ -8813,7 +9338,7 @@ interface operations {
|
|
|
8813
9338
|
};
|
|
8814
9339
|
content?: never;
|
|
8815
9340
|
};
|
|
8816
|
-
/** @description Returned when the
|
|
9341
|
+
/** @description Returned when the caller is not a super admin and does not hold can-manage-maintainers. */
|
|
8817
9342
|
403: {
|
|
8818
9343
|
headers: {
|
|
8819
9344
|
[name: string]: unknown;
|
|
@@ -9268,7 +9793,7 @@ interface operations {
|
|
|
9268
9793
|
};
|
|
9269
9794
|
content?: never;
|
|
9270
9795
|
};
|
|
9271
|
-
/** @description Returned when the
|
|
9796
|
+
/** @description Returned when the caller is not a super admin and does not hold can-manage-maintainers. */
|
|
9272
9797
|
403: {
|
|
9273
9798
|
headers: {
|
|
9274
9799
|
[name: string]: unknown;
|
|
@@ -9339,7 +9864,7 @@ interface operations {
|
|
|
9339
9864
|
};
|
|
9340
9865
|
content?: never;
|
|
9341
9866
|
};
|
|
9342
|
-
/** @description Returned when the Manage token does not have admin privileges. Superuser credentials are not required for
|
|
9867
|
+
/** @description Returned when the Manage token does not have admin privileges, or when a session token belongs to an admin who is not a super admin. Superuser credentials are not required for registration with a personal access token. */
|
|
9343
9868
|
403: {
|
|
9344
9869
|
headers: {
|
|
9345
9870
|
[name: string]: unknown;
|
|
@@ -9486,7 +10011,7 @@ interface operations {
|
|
|
9486
10011
|
};
|
|
9487
10012
|
content?: never;
|
|
9488
10013
|
};
|
|
9489
|
-
/** @description Returned when the
|
|
10014
|
+
/** @description Returned when the caller is not a super admin and does not hold can-manage-maintainers. */
|
|
9490
10015
|
403: {
|
|
9491
10016
|
headers: {
|
|
9492
10017
|
[name: string]: unknown;
|
|
@@ -9684,7 +10209,23 @@ interface operations {
|
|
|
9684
10209
|
path?: never;
|
|
9685
10210
|
cookie?: never;
|
|
9686
10211
|
};
|
|
9687
|
-
|
|
10212
|
+
/** @description Optional, display-only. A missing, malformed or unusable body never fails the exchange; the name is then simply not stored. */
|
|
10213
|
+
requestBody?: {
|
|
10214
|
+
content: {
|
|
10215
|
+
'application/json': {
|
|
10216
|
+
/**
|
|
10217
|
+
* @description OAuth client row of the app the login is for. The name is stored only for the active `local-mcp-client` row with loopback-only callbacks.
|
|
10218
|
+
* @example local-mcp-client
|
|
10219
|
+
*/
|
|
10220
|
+
app_client_id?: string;
|
|
10221
|
+
/**
|
|
10222
|
+
* @description Name the local MCP client reported for itself; not verified by Keboola. Sanitised and capped at 48 characters, returned as `reportedClientName` by `GET /v1/auth/sessions`.
|
|
10223
|
+
* @example Codex
|
|
10224
|
+
*/
|
|
10225
|
+
reported_client_name?: string;
|
|
10226
|
+
};
|
|
10227
|
+
};
|
|
10228
|
+
};
|
|
9688
10229
|
responses: {
|
|
9689
10230
|
/** @description Programmatic session issued. */
|
|
9690
10231
|
200: {
|
|
@@ -11209,14 +11750,7 @@ interface operations {
|
|
|
11209
11750
|
* }
|
|
11210
11751
|
* ]
|
|
11211
11752
|
*/
|
|
11212
|
-
'application/json': (components['schemas']['UserMembershipResponse'] |
|
|
11213
|
-
/** @example 23423 */
|
|
11214
|
-
id: number;
|
|
11215
|
-
/** @example Martin Halamicek */
|
|
11216
|
-
name: string;
|
|
11217
|
-
/** @example martin@keboola.com */
|
|
11218
|
-
email: string;
|
|
11219
|
-
})[];
|
|
11753
|
+
'application/json': (components['schemas']['UserMembershipResponse'] | components['schemas']['OrganizationAdministratorReferenceResponse'])[];
|
|
11220
11754
|
};
|
|
11221
11755
|
};
|
|
11222
11756
|
/** @description Returned when MFA is required. */
|
|
@@ -12195,42 +12729,13 @@ interface operations {
|
|
|
12195
12729
|
};
|
|
12196
12730
|
requestBody?: never;
|
|
12197
12731
|
responses: {
|
|
12198
|
-
/** @description List of organization metadata. */
|
|
12732
|
+
/** @description List of organization metadata, ordered by provider, then key. */
|
|
12199
12733
|
200: {
|
|
12200
12734
|
headers: {
|
|
12201
12735
|
[name: string]: unknown;
|
|
12202
12736
|
};
|
|
12203
12737
|
content: {
|
|
12204
|
-
|
|
12205
|
-
* @example [
|
|
12206
|
-
* {
|
|
12207
|
-
* "id": 123,
|
|
12208
|
-
* "provider": "user",
|
|
12209
|
-
* "timestamp": "2021-02-17T15:05:21+0100",
|
|
12210
|
-
* "key": "KBC.SomeEnity.metadataKey",
|
|
12211
|
-
* "value": "Some value"
|
|
12212
|
-
* },
|
|
12213
|
-
* {
|
|
12214
|
-
* "id": 124,
|
|
12215
|
-
* "provider": "user",
|
|
12216
|
-
* "timestamp": "2021-02-17T15:05:21+0100",
|
|
12217
|
-
* "key": "someMetadataKey",
|
|
12218
|
-
* "value": "Some value"
|
|
12219
|
-
* }
|
|
12220
|
-
* ]
|
|
12221
|
-
*/
|
|
12222
|
-
'application/json': {
|
|
12223
|
-
/** @example 123 */
|
|
12224
|
-
id: number;
|
|
12225
|
-
/** @example user */
|
|
12226
|
-
provider: string;
|
|
12227
|
-
/** @example 2021-02-17T15:05:21+0100 */
|
|
12228
|
-
timestamp: string;
|
|
12229
|
-
/** @example KBC.SomeEnity.metadataKey */
|
|
12230
|
-
key: string;
|
|
12231
|
-
/** @example Some value */
|
|
12232
|
-
value: string;
|
|
12233
|
-
}[];
|
|
12738
|
+
'application/json': components['schemas']['OrganizationMetadataResponse'][];
|
|
12234
12739
|
};
|
|
12235
12740
|
};
|
|
12236
12741
|
/** @description Returned when the organization requires MFA and the current user does not have MFA enabled. */
|
|
@@ -12380,7 +12885,7 @@ interface operations {
|
|
|
12380
12885
|
};
|
|
12381
12886
|
requestBody?: never;
|
|
12382
12887
|
responses: {
|
|
12383
|
-
/** @description
|
|
12888
|
+
/** @description Users who are members of at least one not deleted project in the organization, one entry per user, ordered by e-mail. */
|
|
12384
12889
|
200: {
|
|
12385
12890
|
headers: {
|
|
12386
12891
|
[name: string]: unknown;
|
|
@@ -12400,14 +12905,7 @@ interface operations {
|
|
|
12400
12905
|
* }
|
|
12401
12906
|
* ]
|
|
12402
12907
|
*/
|
|
12403
|
-
'application/json':
|
|
12404
|
-
/** @example 123 */
|
|
12405
|
-
id: number;
|
|
12406
|
-
/** @example test user */
|
|
12407
|
-
name: string;
|
|
12408
|
-
/** @example martin@keboola.com */
|
|
12409
|
-
email: string;
|
|
12410
|
-
}[];
|
|
12908
|
+
'application/json': components['schemas']['OrganizationProjectUserResponse'][];
|
|
12411
12909
|
};
|
|
12412
12910
|
};
|
|
12413
12911
|
/** @description Returned when the organization requires MFA and the current user does not have MFA enabled. */
|
|
@@ -12424,7 +12922,7 @@ interface operations {
|
|
|
12424
12922
|
};
|
|
12425
12923
|
content?: never;
|
|
12426
12924
|
};
|
|
12427
|
-
/** @description Returned when the
|
|
12925
|
+
/** @description Returned when the user has no access to the organization, or has access only as a super admin or a maintainer member and is not a member of the organization. */
|
|
12428
12926
|
403: {
|
|
12429
12927
|
headers: {
|
|
12430
12928
|
[name: string]: unknown;
|
|
@@ -13186,7 +13684,13 @@ interface operations {
|
|
|
13186
13684
|
[name: string]: unknown;
|
|
13187
13685
|
};
|
|
13188
13686
|
content: {
|
|
13189
|
-
'application/json': components['schemas']['ProjectResponse']
|
|
13687
|
+
'application/json': components['schemas']['ProjectResponse'] & {
|
|
13688
|
+
/** @description Present only when the feature was added but needs attention: `bigquery-policy-tags` in a project of a taxonomy that enforces fine-grained access, whose service account cannot read the protected data (`manage.feature.policyTagsReaderMissing`) or could not be checked (`manage.feature.policyTagsReaderNotVerified`). */
|
|
13689
|
+
warnings?: {
|
|
13690
|
+
code?: string;
|
|
13691
|
+
message?: string;
|
|
13692
|
+
}[];
|
|
13693
|
+
};
|
|
13190
13694
|
};
|
|
13191
13695
|
};
|
|
13192
13696
|
/** @description Returned when the Manage token is missing or invalid. */
|
|
@@ -13248,6 +13752,13 @@ interface operations {
|
|
|
13248
13752
|
'application/json': components['schemas']['ProjectJoinRequestDetailResponse'];
|
|
13249
13753
|
};
|
|
13250
13754
|
};
|
|
13755
|
+
/** @description Returned when the project requires MFA and the current user does not have MFA enabled. */
|
|
13756
|
+
400: {
|
|
13757
|
+
headers: {
|
|
13758
|
+
[name: string]: unknown;
|
|
13759
|
+
};
|
|
13760
|
+
content?: never;
|
|
13761
|
+
};
|
|
13251
13762
|
/** @description Returned when the Manage token is missing or invalid. */
|
|
13252
13763
|
401: {
|
|
13253
13764
|
headers: {
|
|
@@ -13539,6 +14050,13 @@ interface operations {
|
|
|
13539
14050
|
'application/json': components['schemas']['ProjectInvitationDetailResponse'];
|
|
13540
14051
|
};
|
|
13541
14052
|
};
|
|
14053
|
+
/** @description Returned when the project requires MFA and the current user does not have MFA enabled. */
|
|
14054
|
+
400: {
|
|
14055
|
+
headers: {
|
|
14056
|
+
[name: string]: unknown;
|
|
14057
|
+
};
|
|
14058
|
+
content?: never;
|
|
14059
|
+
};
|
|
13542
14060
|
/** @description Returned when the Manage token is missing or invalid. */
|
|
13543
14061
|
401: {
|
|
13544
14062
|
headers: {
|
|
@@ -13837,6 +14355,13 @@ interface operations {
|
|
|
13837
14355
|
'application/json': components['schemas']['ProjectInvitationDetailResponse'][];
|
|
13838
14356
|
};
|
|
13839
14357
|
};
|
|
14358
|
+
/** @description Returned when the project requires MFA and the current user does not have MFA enabled. */
|
|
14359
|
+
400: {
|
|
14360
|
+
headers: {
|
|
14361
|
+
[name: string]: unknown;
|
|
14362
|
+
};
|
|
14363
|
+
content?: never;
|
|
14364
|
+
};
|
|
13840
14365
|
/** @description Returned when the Manage token is missing or invalid. */
|
|
13841
14366
|
401: {
|
|
13842
14367
|
headers: {
|
|
@@ -14572,6 +15097,13 @@ interface operations {
|
|
|
14572
15097
|
'application/json': components['schemas']['ProjectJoinRequestDetailResponse'][];
|
|
14573
15098
|
};
|
|
14574
15099
|
};
|
|
15100
|
+
/** @description Returned when the project requires MFA and the current user does not have MFA enabled. */
|
|
15101
|
+
400: {
|
|
15102
|
+
headers: {
|
|
15103
|
+
[name: string]: unknown;
|
|
15104
|
+
};
|
|
15105
|
+
content?: never;
|
|
15106
|
+
};
|
|
14575
15107
|
/** @description Returned when the Manage token is missing or invalid. */
|
|
14576
15108
|
401: {
|
|
14577
15109
|
headers: {
|
|
@@ -14610,43 +15142,21 @@ interface operations {
|
|
|
14610
15142
|
};
|
|
14611
15143
|
requestBody?: never;
|
|
14612
15144
|
responses: {
|
|
14613
|
-
/** @description List of project metadata. */
|
|
15145
|
+
/** @description List of project metadata, ordered by provider, then key. */
|
|
14614
15146
|
200: {
|
|
14615
15147
|
headers: {
|
|
14616
15148
|
[name: string]: unknown;
|
|
14617
15149
|
};
|
|
14618
15150
|
content: {
|
|
14619
|
-
|
|
14620
|
-
|
|
14621
|
-
|
|
14622
|
-
|
|
14623
|
-
|
|
14624
|
-
|
|
14625
|
-
|
|
14626
|
-
* "value": "Some value"
|
|
14627
|
-
* },
|
|
14628
|
-
* {
|
|
14629
|
-
* "id": 124,
|
|
14630
|
-
* "provider": "user",
|
|
14631
|
-
* "timestamp": "2021-02-17T15:05:21+0100",
|
|
14632
|
-
* "key": "someMetadataKey",
|
|
14633
|
-
* "value": "Some value"
|
|
14634
|
-
* }
|
|
14635
|
-
* ]
|
|
14636
|
-
*/
|
|
14637
|
-
'application/json': {
|
|
14638
|
-
/** @example 123 */
|
|
14639
|
-
id: number;
|
|
14640
|
-
/** @example user */
|
|
14641
|
-
provider: string;
|
|
14642
|
-
/** @example 2021-02-17T15:05:21+0100 */
|
|
14643
|
-
timestamp: string;
|
|
14644
|
-
/** @example KBC.SomeEnity.metadataKey */
|
|
14645
|
-
key: string;
|
|
14646
|
-
/** @example Some value */
|
|
14647
|
-
value: string;
|
|
14648
|
-
}[];
|
|
15151
|
+
'application/json': components['schemas']['ProjectMetadataResponse'][];
|
|
15152
|
+
};
|
|
15153
|
+
};
|
|
15154
|
+
/** @description Returned when the project requires MFA and the current user does not have MFA enabled. */
|
|
15155
|
+
400: {
|
|
15156
|
+
headers: {
|
|
15157
|
+
[name: string]: unknown;
|
|
14649
15158
|
};
|
|
15159
|
+
content?: never;
|
|
14650
15160
|
};
|
|
14651
15161
|
/** @description Returned when the Manage token is missing or invalid. */
|
|
14652
15162
|
401: {
|
|
@@ -14773,6 +15283,66 @@ interface operations {
|
|
|
14773
15283
|
};
|
|
14774
15284
|
};
|
|
14775
15285
|
};
|
|
15286
|
+
'get_/manage/projects/{projectId}/restorable-objects::ProjectListRestorableObjectsAction': {
|
|
15287
|
+
parameters: {
|
|
15288
|
+
query?: {
|
|
15289
|
+
/**
|
|
15290
|
+
* @description Only list the dropped tables of this existing bucket. Dropped buckets are then not listed. Linked, external-schema and non-Snowflake buckets have nothing in Time Travel and return 404.
|
|
15291
|
+
* @example in.c-sales
|
|
15292
|
+
*/
|
|
15293
|
+
bucketId?: string;
|
|
15294
|
+
};
|
|
15295
|
+
header?: never;
|
|
15296
|
+
path: {
|
|
15297
|
+
/**
|
|
15298
|
+
* @description Identifier of the project.
|
|
15299
|
+
* @example 4088
|
|
15300
|
+
*/
|
|
15301
|
+
projectId: number;
|
|
15302
|
+
};
|
|
15303
|
+
cookie?: never;
|
|
15304
|
+
};
|
|
15305
|
+
requestBody?: never;
|
|
15306
|
+
responses: {
|
|
15307
|
+
/** @description Dropped tables and buckets that can be restored. */
|
|
15308
|
+
200: {
|
|
15309
|
+
headers: {
|
|
15310
|
+
[name: string]: unknown;
|
|
15311
|
+
};
|
|
15312
|
+
content: {
|
|
15313
|
+
'application/json': components['schemas']['RestorableObjectsResponse'];
|
|
15314
|
+
};
|
|
15315
|
+
};
|
|
15316
|
+
/** @description Returned when the project has no Snowflake storage. */
|
|
15317
|
+
400: {
|
|
15318
|
+
headers: {
|
|
15319
|
+
[name: string]: unknown;
|
|
15320
|
+
};
|
|
15321
|
+
content?: never;
|
|
15322
|
+
};
|
|
15323
|
+
/** @description Returned when the Manage token is missing or invalid. */
|
|
15324
|
+
401: {
|
|
15325
|
+
headers: {
|
|
15326
|
+
[name: string]: unknown;
|
|
15327
|
+
};
|
|
15328
|
+
content?: never;
|
|
15329
|
+
};
|
|
15330
|
+
/** @description Returned when the current admin is neither a super admin nor holds the can-restore-tables feature. */
|
|
15331
|
+
403: {
|
|
15332
|
+
headers: {
|
|
15333
|
+
[name: string]: unknown;
|
|
15334
|
+
};
|
|
15335
|
+
content?: never;
|
|
15336
|
+
};
|
|
15337
|
+
/** @description Returned when the project, or the bucket given in `bucketId`, does not exist. */
|
|
15338
|
+
404: {
|
|
15339
|
+
headers: {
|
|
15340
|
+
[name: string]: unknown;
|
|
15341
|
+
};
|
|
15342
|
+
content?: never;
|
|
15343
|
+
};
|
|
15344
|
+
};
|
|
15345
|
+
};
|
|
14776
15346
|
'get_/manage/projects/{projectId}/workspaces::ProjectListRetentionWorkspacesAction': {
|
|
14777
15347
|
parameters: {
|
|
14778
15348
|
query?: {
|
|
@@ -15094,7 +15664,7 @@ interface operations {
|
|
|
15094
15664
|
* }
|
|
15095
15665
|
* }
|
|
15096
15666
|
*/
|
|
15097
|
-
'application/json': components['schemas']['
|
|
15667
|
+
'application/json': components['schemas']['ProjectJoinRequestResponse'];
|
|
15098
15668
|
};
|
|
15099
15669
|
};
|
|
15100
15670
|
/** @description Returned when the request body is invalid or the user is not activated. */
|
|
@@ -15448,26 +16018,137 @@ interface operations {
|
|
|
15448
16018
|
};
|
|
15449
16019
|
};
|
|
15450
16020
|
};
|
|
15451
|
-
'
|
|
16021
|
+
'get_/manage/search::SearchAction': {
|
|
15452
16022
|
parameters: {
|
|
15453
|
-
query
|
|
15454
|
-
header?: never;
|
|
15455
|
-
path: {
|
|
16023
|
+
query: {
|
|
15456
16024
|
/**
|
|
15457
|
-
* @description
|
|
15458
|
-
* @example
|
|
16025
|
+
* @description Search term: 2 to 255 characters after trimming. An all-digit term also matches by exact `id`.
|
|
16026
|
+
* @example acme
|
|
15459
16027
|
*/
|
|
15460
|
-
|
|
15461
|
-
|
|
15462
|
-
|
|
15463
|
-
|
|
15464
|
-
|
|
15465
|
-
|
|
15466
|
-
|
|
15467
|
-
|
|
15468
|
-
|
|
15469
|
-
|
|
15470
|
-
|
|
16028
|
+
q: string;
|
|
16029
|
+
/**
|
|
16030
|
+
* @description Pagination: `page[limit]` (default 10, maximum 50) and `page[after]`, the cursor of the last row read — base64url(json) of `{"rank": integer, "id": integer}`, rows ordered `rank ASC, id DESC`. Omit `page[after]` for the first page; `links.next` carries the next one.
|
|
16031
|
+
* @example {
|
|
16032
|
+
* "limit": 10
|
|
16033
|
+
* }
|
|
16034
|
+
*/
|
|
16035
|
+
page?: {
|
|
16036
|
+
/** @description base64url(json) of `{"rank": integer, "id": integer}`. */
|
|
16037
|
+
after?: string;
|
|
16038
|
+
/** @default 10 */
|
|
16039
|
+
limit?: number;
|
|
16040
|
+
};
|
|
16041
|
+
/** @description Filters, JSON:API style: `filter[<name>]=<value>`. Filters combine with AND. */
|
|
16042
|
+
filter?: {
|
|
16043
|
+
/**
|
|
16044
|
+
* @description Comma-separated subset of `project`, `organization`, `maintainer`, `user`; omitted, every type the caller may read.
|
|
16045
|
+
* @example project,organization
|
|
16046
|
+
*/
|
|
16047
|
+
types?: string;
|
|
16048
|
+
};
|
|
16049
|
+
};
|
|
16050
|
+
header?: never;
|
|
16051
|
+
path?: never;
|
|
16052
|
+
cookie?: never;
|
|
16053
|
+
};
|
|
16054
|
+
requestBody?: never;
|
|
16055
|
+
responses: {
|
|
16056
|
+
/** @description Hits grouped by type; only the types the caller may read and asked for are present. */
|
|
16057
|
+
200: {
|
|
16058
|
+
headers: {
|
|
16059
|
+
[name: string]: unknown;
|
|
16060
|
+
};
|
|
16061
|
+
content: {
|
|
16062
|
+
/**
|
|
16063
|
+
* @example {
|
|
16064
|
+
* "project": {
|
|
16065
|
+
* "data": [
|
|
16066
|
+
* {
|
|
16067
|
+
* "rank": 1,
|
|
16068
|
+
* "id": 4088,
|
|
16069
|
+
* "name": "Acme reporting",
|
|
16070
|
+
* "organization": {
|
|
16071
|
+
* "id": 123,
|
|
16072
|
+
* "name": "Acme"
|
|
16073
|
+
* },
|
|
16074
|
+
* "isDisabled": false
|
|
16075
|
+
* }
|
|
16076
|
+
* ],
|
|
16077
|
+
* "meta": {
|
|
16078
|
+
* "total": 1,
|
|
16079
|
+
* "limit": 10,
|
|
16080
|
+
* "cursor": {
|
|
16081
|
+
* "param": "page[after]",
|
|
16082
|
+
* "encoding": "base64url(json)",
|
|
16083
|
+
* "fields": [
|
|
16084
|
+
* {
|
|
16085
|
+
* "name": "rank",
|
|
16086
|
+
* "type": "integer",
|
|
16087
|
+
* "nullable": false
|
|
16088
|
+
* },
|
|
16089
|
+
* {
|
|
16090
|
+
* "name": "id",
|
|
16091
|
+
* "type": "integer",
|
|
16092
|
+
* "nullable": false
|
|
16093
|
+
* }
|
|
16094
|
+
* ],
|
|
16095
|
+
* "order": "rank ASC, id DESC"
|
|
16096
|
+
* }
|
|
16097
|
+
* },
|
|
16098
|
+
* "links": {
|
|
16099
|
+
* "self": "https://connection.keboola.com/manage/search?q=acme&filter[types]=project&page[limit]=10",
|
|
16100
|
+
* "first": "https://connection.keboola.com/manage/search?q=acme&filter[types]=project&page[limit]=10",
|
|
16101
|
+
* "next": null
|
|
16102
|
+
* }
|
|
16103
|
+
* }
|
|
16104
|
+
* }
|
|
16105
|
+
*/
|
|
16106
|
+
'application/json': components['schemas']['SearchResponse'];
|
|
16107
|
+
};
|
|
16108
|
+
};
|
|
16109
|
+
/** @description Returned when `q`, `filter[types]` or the `page` parameters are invalid. */
|
|
16110
|
+
400: {
|
|
16111
|
+
headers: {
|
|
16112
|
+
[name: string]: unknown;
|
|
16113
|
+
};
|
|
16114
|
+
content?: never;
|
|
16115
|
+
};
|
|
16116
|
+
/** @description Returned when the Manage token is missing or invalid. */
|
|
16117
|
+
401: {
|
|
16118
|
+
headers: {
|
|
16119
|
+
[name: string]: unknown;
|
|
16120
|
+
};
|
|
16121
|
+
content?: never;
|
|
16122
|
+
};
|
|
16123
|
+
/** @description Returned when the token is not an admin or session token, or its admin may search no type. */
|
|
16124
|
+
403: {
|
|
16125
|
+
headers: {
|
|
16126
|
+
[name: string]: unknown;
|
|
16127
|
+
};
|
|
16128
|
+
content?: never;
|
|
16129
|
+
};
|
|
16130
|
+
};
|
|
16131
|
+
};
|
|
16132
|
+
'post_/manage/storage-backend/{backendId}/activate::StorageBackendActivateAction': {
|
|
16133
|
+
parameters: {
|
|
16134
|
+
query?: never;
|
|
16135
|
+
header?: never;
|
|
16136
|
+
path: {
|
|
16137
|
+
/**
|
|
16138
|
+
* @description Backend ID.
|
|
16139
|
+
* @example 123
|
|
16140
|
+
*/
|
|
16141
|
+
backendId: number;
|
|
16142
|
+
};
|
|
16143
|
+
cookie?: never;
|
|
16144
|
+
};
|
|
16145
|
+
requestBody?: never;
|
|
16146
|
+
responses: {
|
|
16147
|
+
/** @description Snowflake storage backend activated successfully. The backend is now ready for use. */
|
|
16148
|
+
200: {
|
|
16149
|
+
headers: {
|
|
16150
|
+
[name: string]: unknown;
|
|
16151
|
+
};
|
|
15471
16152
|
content: {
|
|
15472
16153
|
/**
|
|
15473
16154
|
* @example {
|
|
@@ -15948,7 +16629,7 @@ interface operations {
|
|
|
15948
16629
|
/** @description Guide format. */
|
|
15949
16630
|
format?: 'markdown' | 'terraform';
|
|
15950
16631
|
/**
|
|
15951
|
-
* @description GCP project ID that holds the custom
|
|
16632
|
+
* @description GCP project ID that holds the custom setter role, and the new taxonomy when `createTaxonomy` is true.
|
|
15952
16633
|
* @example acme-data-governance
|
|
15953
16634
|
*/
|
|
15954
16635
|
roleProject: string;
|
|
@@ -16028,7 +16709,7 @@ interface operations {
|
|
|
16028
16709
|
};
|
|
16029
16710
|
content?: never;
|
|
16030
16711
|
};
|
|
16031
|
-
/** @description Returned when the backend has no valid stored service account or
|
|
16712
|
+
/** @description Returned when the backend has no valid stored service account, region or BigQuery folder to render the guide from. */
|
|
16032
16713
|
409: {
|
|
16033
16714
|
headers: {
|
|
16034
16715
|
[name: string]: unknown;
|
|
@@ -16376,6 +17057,7 @@ interface operations {
|
|
|
16376
17057
|
* "https://kbc-uis.s3.amazonaws.com/kbc.manageApps/0.0.3-33-ga6bc947/styles/libs.css",
|
|
16377
17058
|
* "https://kbc-uis.s3.amazonaws.com/kbc.manageApps/0.0.3-33-ga6bc947/styles/select2.png"
|
|
16378
17059
|
* ],
|
|
17060
|
+
* "preloads": [],
|
|
16379
17061
|
* "isCritical": false,
|
|
16380
17062
|
* "commitSha": "a6bc947f1e2d3c4b5a6bc947f1e2d3c4b5a6bc94"
|
|
16381
17063
|
* }
|
|
@@ -16619,14 +17301,14 @@ interface operations {
|
|
|
16619
17301
|
};
|
|
16620
17302
|
content?: never;
|
|
16621
17303
|
};
|
|
16622
|
-
/** @description Returned when the current admin
|
|
17304
|
+
/** @description Returned with code `manage.users.cannotAccessOtherUsers` when the current admin is neither a super admin nor has the `can-manage-users` feature, also for their own user and for an unknown one. */
|
|
16623
17305
|
403: {
|
|
16624
17306
|
headers: {
|
|
16625
17307
|
[name: string]: unknown;
|
|
16626
17308
|
};
|
|
16627
17309
|
content?: never;
|
|
16628
17310
|
};
|
|
16629
|
-
/** @description Returned when the user does not exist. */
|
|
17311
|
+
/** @description Returned with code `manage.user.notFound` when the user does not exist. */
|
|
16630
17312
|
404: {
|
|
16631
17313
|
headers: {
|
|
16632
17314
|
[name: string]: unknown;
|
|
@@ -16739,6 +17421,13 @@ interface operations {
|
|
|
16739
17421
|
};
|
|
16740
17422
|
content?: never;
|
|
16741
17423
|
};
|
|
17424
|
+
/** @description Returned when the user cannot be removed from one of their organizations or maintainers (its last member), or when the current admin is not activated and the user has a project invitation. */
|
|
17425
|
+
400: {
|
|
17426
|
+
headers: {
|
|
17427
|
+
[name: string]: unknown;
|
|
17428
|
+
};
|
|
17429
|
+
content?: never;
|
|
17430
|
+
};
|
|
16742
17431
|
/** @description Returned when the Manage token is missing or invalid. */
|
|
16743
17432
|
401: {
|
|
16744
17433
|
headers: {
|
|
@@ -16746,7 +17435,7 @@ interface operations {
|
|
|
16746
17435
|
};
|
|
16747
17436
|
content?: never;
|
|
16748
17437
|
};
|
|
16749
|
-
/** @description Returned when the current admin has no privilege to delete other users. */
|
|
17438
|
+
/** @description Returned when the current admin has no privilege to delete other users, or when a non-super-admin deletes a super admin. */
|
|
16750
17439
|
403: {
|
|
16751
17440
|
headers: {
|
|
16752
17441
|
[name: string]: unknown;
|
|
@@ -16951,47 +17640,21 @@ interface operations {
|
|
|
16951
17640
|
* @example [
|
|
16952
17641
|
* {
|
|
16953
17642
|
* "id": 123,
|
|
16954
|
-
* "provider": "user",
|
|
16955
|
-
* "timestamp": "2021-02-17T15:05:21+0100",
|
|
16956
17643
|
* "key": "KBC.SomeEnity.metadataKey",
|
|
16957
|
-
* "value": "Some value"
|
|
17644
|
+
* "value": "Some value",
|
|
17645
|
+
* "provider": "user",
|
|
17646
|
+
* "timestamp": "2021-02-17T15:05:21+0100"
|
|
16958
17647
|
* },
|
|
16959
17648
|
* {
|
|
16960
17649
|
* "id": 124,
|
|
16961
|
-
* "provider": "user",
|
|
16962
|
-
* "timestamp": "2021-02-17T15:05:21+0100",
|
|
16963
17650
|
* "key": "someMetadataKey",
|
|
16964
|
-
* "value": "Some value"
|
|
17651
|
+
* "value": "Some value",
|
|
17652
|
+
* "provider": "user",
|
|
17653
|
+
* "timestamp": "2021-02-17T15:05:21+0100"
|
|
16965
17654
|
* }
|
|
16966
17655
|
* ]
|
|
16967
17656
|
*/
|
|
16968
|
-
'application/json':
|
|
16969
|
-
/**
|
|
16970
|
-
* @description Metadata identifier.
|
|
16971
|
-
* @example 123
|
|
16972
|
-
*/
|
|
16973
|
-
id: number;
|
|
16974
|
-
/**
|
|
16975
|
-
* @description Metadata provider.
|
|
16976
|
-
* @example user
|
|
16977
|
-
*/
|
|
16978
|
-
provider: string;
|
|
16979
|
-
/**
|
|
16980
|
-
* @description Last update timestamp.
|
|
16981
|
-
* @example 2021-02-17T15:05:21+0100
|
|
16982
|
-
*/
|
|
16983
|
-
timestamp: string;
|
|
16984
|
-
/**
|
|
16985
|
-
* @description Metadata key.
|
|
16986
|
-
* @example KBC.SomeEnity.metadataKey
|
|
16987
|
-
*/
|
|
16988
|
-
key: string;
|
|
16989
|
-
/**
|
|
16990
|
-
* @description Metadata value.
|
|
16991
|
-
* @example Some value
|
|
16992
|
-
*/
|
|
16993
|
-
value: string;
|
|
16994
|
-
}[];
|
|
17657
|
+
'application/json': components['schemas']['UserMetadataResponse'][];
|
|
16995
17658
|
};
|
|
16996
17659
|
};
|
|
16997
17660
|
/** @description Returned when the Manage token is missing or invalid. */
|
|
@@ -17001,7 +17664,7 @@ interface operations {
|
|
|
17001
17664
|
};
|
|
17002
17665
|
content?: never;
|
|
17003
17666
|
};
|
|
17004
|
-
/** @description Returned when the user does not exist. */
|
|
17667
|
+
/** @description Returned with code `manage.user.notFound` when the user does not exist, or when the token may not access the user. */
|
|
17005
17668
|
404: {
|
|
17006
17669
|
headers: {
|
|
17007
17670
|
[name: string]: unknown;
|
|
@@ -17482,6 +18145,15 @@ interface operations {
|
|
|
17482
18145
|
description: string | null;
|
|
17483
18146
|
invoiceTopUpType: string | null;
|
|
17484
18147
|
stripeInvoiceStatus: string | null;
|
|
18148
|
+
/** @description Provider of a non-Stripe-invoice payment, `x402-base` for an x402 top-up; null otherwise. */
|
|
18149
|
+
paymentProvider: string | null;
|
|
18150
|
+
/**
|
|
18151
|
+
* @description State of an x402 top-up; only `settled` rows count as purchased credits. Null on other rows.
|
|
18152
|
+
* @enum {string|null}
|
|
18153
|
+
*/
|
|
18154
|
+
paymentStatus: 'pending' | 'settled' | 'expired' | null;
|
|
18155
|
+
/** @description On-chain transaction hash of a settled x402 top-up; null otherwise. */
|
|
18156
|
+
externalPaymentId: string | null;
|
|
17485
18157
|
/** Format: date-time */
|
|
17486
18158
|
created: string;
|
|
17487
18159
|
}[];
|
|
@@ -17919,6 +18591,129 @@ interface operations {
|
|
|
17919
18591
|
};
|
|
17920
18592
|
};
|
|
17921
18593
|
};
|
|
18594
|
+
'post_/pay-as-you-go/x402/projects/{projectId}/credits::X402TopUpAction': {
|
|
18595
|
+
parameters: {
|
|
18596
|
+
query: {
|
|
18597
|
+
/**
|
|
18598
|
+
* @description The amount to pay in USD, tax-inclusive, with at most two decimals and within the stack's minimum and maximum. The credits are the amount divided by the stack's credit price.
|
|
18599
|
+
* @example 25.00
|
|
18600
|
+
*/
|
|
18601
|
+
amountUsd: string;
|
|
18602
|
+
};
|
|
18603
|
+
header?: {
|
|
18604
|
+
/** @description Base64 JSON x402 V2 `PaymentPayload` of an `exact` EVM payment for exactly the requirements from `PAYMENT-REQUIRED`, with the `payment-identifier` extension. Omit it to get the payment requirements. */
|
|
18605
|
+
'PAYMENT-SIGNATURE'?: string;
|
|
18606
|
+
};
|
|
18607
|
+
path: {
|
|
18608
|
+
/** @description The pay-as-you-go project to credit. */
|
|
18609
|
+
projectId: number;
|
|
18610
|
+
};
|
|
18611
|
+
cookie?: never;
|
|
18612
|
+
};
|
|
18613
|
+
requestBody?: never;
|
|
18614
|
+
responses: {
|
|
18615
|
+
/** @description The payment is settled and the credits are added. */
|
|
18616
|
+
200: {
|
|
18617
|
+
headers: {
|
|
18618
|
+
/** @description Base64 JSON x402 `SettlementResponse` with `success`, `transaction` and `network`. */
|
|
18619
|
+
'PAYMENT-RESPONSE'?: string;
|
|
18620
|
+
[name: string]: unknown;
|
|
18621
|
+
};
|
|
18622
|
+
content: {
|
|
18623
|
+
'application/json': {
|
|
18624
|
+
id: number;
|
|
18625
|
+
idProject: number;
|
|
18626
|
+
creditsAmount: number;
|
|
18627
|
+
/** @description The amount paid in USD cents. */
|
|
18628
|
+
moneyAmount: number;
|
|
18629
|
+
idStripeInvoice: string | null;
|
|
18630
|
+
urlStripeInvoice: string | null;
|
|
18631
|
+
description: string | null;
|
|
18632
|
+
/** @example x402 */
|
|
18633
|
+
invoiceTopUpType: string;
|
|
18634
|
+
stripeInvoiceStatus: string | null;
|
|
18635
|
+
/** @example x402-base */
|
|
18636
|
+
paymentProvider: string;
|
|
18637
|
+
/** @example settled */
|
|
18638
|
+
paymentStatus: string;
|
|
18639
|
+
/** @description On-chain transaction hash of the settled payment. */
|
|
18640
|
+
externalPaymentId: string;
|
|
18641
|
+
/** Format: date-time */
|
|
18642
|
+
created: string;
|
|
18643
|
+
};
|
|
18644
|
+
};
|
|
18645
|
+
};
|
|
18646
|
+
/** @description Invalid `amountUsd` (`x402.invalidAmount`), a `PAYMENT-SIGNATURE` that does not decode or does not match the requirements (`x402.invalidPaymentSignature`), a missing `payment-identifier` (`x402.paymentIdentifierMissing`), or a project without pay-as-you-go. */
|
|
18647
|
+
400: {
|
|
18648
|
+
headers: {
|
|
18649
|
+
[name: string]: unknown;
|
|
18650
|
+
};
|
|
18651
|
+
content?: never;
|
|
18652
|
+
};
|
|
18653
|
+
/** @description Payment required: the call carried no payment (`error: payment_required`), or the facilitator rejected the payment or it expired (`x402.paymentRejected`, reason in `params.reason`). Sign a new payment for the requirements in `PAYMENT-REQUIRED`. */
|
|
18654
|
+
402: {
|
|
18655
|
+
headers: {
|
|
18656
|
+
/** @description Base64 JSON x402 V2 `PaymentRequired`: the resource, one `exact` requirement (network, USDC asset, amount in atomic units, recipient) and the required `payment-identifier` extension. */
|
|
18657
|
+
'PAYMENT-REQUIRED'?: string;
|
|
18658
|
+
[name: string]: unknown;
|
|
18659
|
+
};
|
|
18660
|
+
content: {
|
|
18661
|
+
'application/json': components['schemas']['X402TopUpQuoteResponse'] | {
|
|
18662
|
+
/** @description The error message. */
|
|
18663
|
+
error: string;
|
|
18664
|
+
/** @example x402.paymentRejected */
|
|
18665
|
+
code: string;
|
|
18666
|
+
/** @description Includes `reason`, the facilitator reason or `expired`. */
|
|
18667
|
+
params?: Record<string, never>;
|
|
18668
|
+
};
|
|
18669
|
+
};
|
|
18670
|
+
};
|
|
18671
|
+
/** @description No valid token credential, a browser session cookie or a personal access token, or no access to the project. */
|
|
18672
|
+
403: {
|
|
18673
|
+
headers: {
|
|
18674
|
+
[name: string]: unknown;
|
|
18675
|
+
};
|
|
18676
|
+
content?: never;
|
|
18677
|
+
};
|
|
18678
|
+
/** @description The project does not exist, or pay-as-you-go or the x402 top-up is not enabled on this stack. */
|
|
18679
|
+
404: {
|
|
18680
|
+
headers: {
|
|
18681
|
+
[name: string]: unknown;
|
|
18682
|
+
};
|
|
18683
|
+
content?: never;
|
|
18684
|
+
};
|
|
18685
|
+
/** @description The project is an unconfirmed agent project (`x402.agentProjectUnclaimed`), the `payment-identifier` or the authorization is recorded for another payment (`x402.paymentIdentifierConflict`), or another top-up of the project is in progress (`x402.topUpInProgress`). */
|
|
18686
|
+
409: {
|
|
18687
|
+
headers: {
|
|
18688
|
+
[name: string]: unknown;
|
|
18689
|
+
};
|
|
18690
|
+
content?: never;
|
|
18691
|
+
};
|
|
18692
|
+
/** @description Too many x402 top-up requests by the admin or for the project (`x402.rateLimited`). */
|
|
18693
|
+
429: {
|
|
18694
|
+
headers: {
|
|
18695
|
+
'Retry-After'?: number;
|
|
18696
|
+
[name: string]: unknown;
|
|
18697
|
+
};
|
|
18698
|
+
content?: never;
|
|
18699
|
+
};
|
|
18700
|
+
/** @description The facilitator failed to verify the payment (`x402.facilitatorUnavailable`). Nothing was recorded and no money moved; a retry is safe. */
|
|
18701
|
+
502: {
|
|
18702
|
+
headers: {
|
|
18703
|
+
[name: string]: unknown;
|
|
18704
|
+
};
|
|
18705
|
+
content?: never;
|
|
18706
|
+
};
|
|
18707
|
+
/** @description The settlement outcome is not known yet (`x402.settlementPending`). Retry the same request with the same `payment-identifier` after `Retry-After`; do not sign a new payment. Also answered when the card credit price cannot be read (`x402.creditPriceUnavailable`): for a quote, for the first request with a payment whose identifier has nothing recorded, or for the 402 of an expired payment, whose `PAYMENT-REQUIRED` needs the current price. Nothing was recorded and no money moved; retry the same request, with the same `payment-identifier` if it carried a payment, after `Retry-After`. */
|
|
18708
|
+
503: {
|
|
18709
|
+
headers: {
|
|
18710
|
+
'Retry-After'?: number;
|
|
18711
|
+
[name: string]: unknown;
|
|
18712
|
+
};
|
|
18713
|
+
content?: never;
|
|
18714
|
+
};
|
|
18715
|
+
};
|
|
18716
|
+
};
|
|
17922
18717
|
post_keboola_integration_partners_gcp_project_bigquery_bigquerysetupaction__invoke: {
|
|
17923
18718
|
parameters: {
|
|
17924
18719
|
query?: never;
|
|
@@ -18225,237 +19020,93 @@ type CreatePaymentRequestBody = OpenapiBodyType<paths['/pay-as-you-go/billing/cr
|
|
|
18225
19020
|
type ProgrammaticProjectClaim = OpenapiReturnType<paths['/manage/programmatic-projects/claim']['get']>;
|
|
18226
19021
|
type ConfirmProgrammaticProjectBody = OpenapiBodyType<paths['/manage/programmatic-projects/confirm']['post']>;
|
|
18227
19022
|
type ConfirmProgrammaticProjectResult = OpenapiReturnType<paths['/manage/programmatic-projects/confirm']['post']>;
|
|
18228
|
-
type AddUserFeaturePath = {
|
|
18229
|
-
userIdOrMail: string;
|
|
18230
|
-
};
|
|
18231
|
-
type AddUserFeatureBody = {
|
|
18232
|
-
feature: string;
|
|
18233
|
-
};
|
|
18234
|
-
type RemoveUserFeaturePath = {
|
|
18235
|
-
userIdOrMail: string;
|
|
18236
|
-
feature: string;
|
|
18237
|
-
};
|
|
18238
|
-
type ProjectUsersResponse = OpenapiReturnType<paths['/manage/projects/{projectId}/users']['get']>;
|
|
18239
|
-
type User = {
|
|
18240
|
-
id: number;
|
|
18241
|
-
name: string;
|
|
18242
|
-
email: string;
|
|
18243
|
-
mfaEnabled: boolean;
|
|
18244
|
-
features: string[];
|
|
18245
|
-
canAccessLogs: boolean;
|
|
18246
|
-
role: 'guest' | 'readOnly' | 'admin' | 'share' | 'productionManager' | 'developer' | 'reviewer';
|
|
18247
|
-
isSuperAdmin: boolean;
|
|
18248
|
-
canApproveMergeRequests: boolean;
|
|
18249
|
-
/** Project users only; older stacks and other user endpoints omit this field. */
|
|
18250
|
-
isOrganizationMember?: ProjectUsersResponse[number]['isOrganizationMember'];
|
|
18251
|
-
};
|
|
18252
|
-
type UserDetail = components['schemas']['UserResponse'];
|
|
18253
|
-
type UserListItem = components['schemas']['UserListResponse'][number];
|
|
18254
|
-
type UserOrganizationMembership = components['schemas']['UserListOrganizationsResponse'][number];
|
|
18255
|
-
type UserProjectMembership = components['schemas']['UserListProjectsResponse'][number];
|
|
18256
|
-
type UserMaintainerMembership = components['schemas']['UserListMaintainersResponse'][number];
|
|
18257
|
-
type GetUsersQuery = NonNullable<operations['get_/manage/users::UserListAction']['parameters']['query']>;
|
|
18258
|
-
/** The schema path parameter is `idOrEmail`; these methods take a numeric `id`, as their neighbours do. */
|
|
18259
|
-
type UserPath = {
|
|
18260
|
-
id: number;
|
|
18261
|
-
};
|
|
18262
|
-
type UpdateUserBody = OpenapiBodyType<paths['/manage/users/{idOrEmail}']['put']>;
|
|
18263
|
-
type UpdateUserInput = UserPath & UpdateUserBody;
|
|
18264
|
-
type SetUserMetadataBody = components['schemas']['MetadataRequest'];
|
|
18265
|
-
type SetUserMetadataInput = UserPath & SetUserMetadataBody;
|
|
18266
|
-
type DeleteUserMetadataPath = UserPath & {
|
|
18267
|
-
metadataId: number;
|
|
18268
|
-
};
|
|
18269
|
-
type UpdateProjectBody = components['schemas']['ProjectUpdateRequest'];
|
|
18270
|
-
type ProjectTemplate = components['schemas']['ProjectTemplateResponse'];
|
|
18271
|
-
type MoveProjectBody = paths['/manage/projects/{projectId}/organizations']['post']['requestBody']['content']['application/json'];
|
|
18272
|
-
/** Body for POST /manage/projects/{projectId}/disabled — hand-written, no schema entry.
|
|
18273
|
-
* The backend 400s without `disableReason` when disabling. */
|
|
18274
|
-
type SetProjectDisabledBody = {
|
|
18275
|
-
isDisabled: true;
|
|
18276
|
-
disableReason: string;
|
|
18277
|
-
estimatedEndTime?: string;
|
|
18278
|
-
} | {
|
|
18279
|
-
isDisabled: false;
|
|
18280
|
-
};
|
|
18281
|
-
/** Super admins may set any limit; `can-manage-project-limits` admins only a whitelisted subset. */
|
|
18282
|
-
type SetProjectLimitsBody = {
|
|
18283
|
-
limits: {
|
|
18284
|
-
name: string;
|
|
18285
|
-
value: number;
|
|
18286
|
-
}[];
|
|
18287
|
-
};
|
|
18288
19023
|
type GetProjectPath = {
|
|
18289
19024
|
projectId: number | string;
|
|
18290
19025
|
};
|
|
19026
|
+
type Project = OpenapiReturnType<paths['/manage/projects/{projectId}']['get']>;
|
|
19027
|
+
type UpdateProjectPath = OpenapiPathType<paths['/manage/projects/{projectId}']['put']>;
|
|
19028
|
+
type UpdateProjectBody = OpenapiBodyType<paths['/manage/projects/{projectId}']['put']>;
|
|
19029
|
+
type UpdateProjectInput = UpdateProjectPath & UpdateProjectBody;
|
|
19030
|
+
type MoveProjectPath = OpenapiPathType<paths['/manage/projects/{projectId}/organizations']['post']>;
|
|
19031
|
+
type MoveProjectBody = OpenapiBodyType<paths['/manage/projects/{projectId}/organizations']['post']>;
|
|
19032
|
+
type MoveProjectInput = MoveProjectPath & MoveProjectBody;
|
|
19033
|
+
type SetProjectDisabledPath = OpenapiPathType<paths['/manage/projects/{projectId}/disabled']['post']>;
|
|
19034
|
+
type SetProjectDisabledBody = OpenapiBodyType<paths['/manage/projects/{projectId}/disabled']['post']>;
|
|
19035
|
+
type SetProjectDisabledInput = SetProjectDisabledPath & SetProjectDisabledBody;
|
|
19036
|
+
type SetProjectLimitsPath = OpenapiPathType<paths['/manage/projects/{projectId}/limits']['post']>;
|
|
19037
|
+
/** Super admins may set any limit; `can-manage-project-limits` admins only a whitelisted subset. */
|
|
19038
|
+
type SetProjectLimitsBody = OpenapiBodyType<paths['/manage/projects/{projectId}/limits']['post']>;
|
|
19039
|
+
type SetProjectLimitsInput = SetProjectLimitsPath & SetProjectLimitsBody;
|
|
19040
|
+
type RemoveProjectLimitPath = OpenapiPathType<paths['/manage/projects/{projectId}/limits/{limitName}']['delete']>;
|
|
19041
|
+
type CreateProjectFeaturePath = OpenapiPathType<paths['/manage/projects/{projectId}/features']['post']>;
|
|
19042
|
+
type CreateProjectFeatureBody = OpenapiBodyType<paths['/manage/projects/{projectId}/features']['post']>;
|
|
19043
|
+
type CreateProjectFeatureInput = CreateProjectFeaturePath & CreateProjectFeatureBody;
|
|
19044
|
+
type ProjectFeatureWarning = NonNullable<OpenapiReturnType<paths['/manage/projects/{projectId}/features']['post']>['warnings']>[number];
|
|
19045
|
+
type RemoveProjectFeaturePath = OpenapiPathType<paths['/manage/projects/{projectId}/features/{feature}']['delete']>;
|
|
18291
19046
|
type ListProjectUsersPath = {
|
|
18292
19047
|
projectId: number | string;
|
|
18293
19048
|
};
|
|
18294
|
-
type
|
|
18295
|
-
|
|
18296
|
-
}
|
|
18297
|
-
type
|
|
18298
|
-
|
|
18299
|
-
};
|
|
18300
|
-
type RemoveProjectFeaturePath = {
|
|
18301
|
-
projectId: number;
|
|
18302
|
-
feature: string;
|
|
18303
|
-
};
|
|
18304
|
-
type ProjectLimit = {
|
|
18305
|
-
name: string;
|
|
18306
|
-
value: number;
|
|
18307
|
-
};
|
|
18308
|
-
type ProjectOrganization = {
|
|
18309
|
-
id: number;
|
|
18310
|
-
name: string;
|
|
18311
|
-
created: string;
|
|
18312
|
-
allowAutoJoin: boolean;
|
|
18313
|
-
crmId: string;
|
|
18314
|
-
activityCenterProjectId: number | null;
|
|
18315
|
-
mfaRequired: boolean;
|
|
18316
|
-
};
|
|
18317
|
-
type ProjectFileStorage = {
|
|
18318
|
-
id: number;
|
|
18319
|
-
accountName: string;
|
|
18320
|
-
region: string;
|
|
18321
|
-
containerName: string;
|
|
18322
|
-
provider: string;
|
|
18323
|
-
owner: string;
|
|
18324
|
-
isDefault: boolean;
|
|
18325
|
-
created: string;
|
|
18326
|
-
creator: {
|
|
18327
|
-
id: number;
|
|
18328
|
-
name: string;
|
|
18329
|
-
};
|
|
18330
|
-
};
|
|
18331
|
-
type ProjectBackends = Record<string, {
|
|
18332
|
-
id: number;
|
|
18333
|
-
host: string;
|
|
18334
|
-
region: string;
|
|
18335
|
-
owner: string;
|
|
18336
|
-
}>;
|
|
18337
|
-
type GetProjectMetadataPath = {
|
|
18338
|
-
projectId: number;
|
|
18339
|
-
};
|
|
18340
|
-
type SetProjectMetadataPath = {
|
|
18341
|
-
projectId: number;
|
|
18342
|
-
};
|
|
18343
|
-
type ProjectMetadataItem = OpenapiReturnType<paths['/manage/projects/{projectId}/metadata']['get']>[number];
|
|
18344
|
-
type SetProjectMetadataBody = components['schemas']['MetadataRequest'];
|
|
18345
|
-
type ProjectMetadataInput = SetProjectMetadataBody['metadata'][number];
|
|
18346
|
-
type GetProjectReviewersPath = {
|
|
18347
|
-
projectId: number;
|
|
18348
|
-
};
|
|
18349
|
-
type Reviewer = {
|
|
18350
|
-
id: number;
|
|
18351
|
-
name: string;
|
|
18352
|
-
email: string;
|
|
18353
|
-
};
|
|
18354
|
-
type SetProjectReviewersPath = {
|
|
19049
|
+
type ProjectMember = OpenapiReturnType<paths['/manage/projects/{projectId}/users']['get']>[number];
|
|
19050
|
+
type AddProjectUserPath = OpenapiPathType<paths['/manage/projects/{projectId}/users']['post']>;
|
|
19051
|
+
type AddProjectUserBody = OpenapiBodyType<paths['/manage/projects/{projectId}/users']['post']>;
|
|
19052
|
+
type AddProjectUserInput = AddProjectUserPath & AddProjectUserBody;
|
|
19053
|
+
type RemoveProjectUserPath = {
|
|
18355
19054
|
projectId: number;
|
|
19055
|
+
idOrEmail: number | string;
|
|
18356
19056
|
};
|
|
18357
|
-
type
|
|
18358
|
-
|
|
18359
|
-
|
|
18360
|
-
type ListProjectInvitationsPath = {
|
|
18361
|
-
projectId: number | string;
|
|
18362
|
-
};
|
|
18363
|
-
type ProjectInvitationDetail = components['schemas']['ProjectInvitationDetailResponse'];
|
|
19057
|
+
type ChangeProjectUserRolePath = OpenapiPathType<paths['/manage/projects/{projectId}/users/{userId}']['patch']>;
|
|
19058
|
+
type ChangeProjectUserRoleBody = OpenapiBodyType<paths['/manage/projects/{projectId}/users/{userId}']['patch']>;
|
|
19059
|
+
type ChangeProjectUserRoleInput = ChangeProjectUserRolePath & ChangeProjectUserRoleBody;
|
|
18364
19060
|
/** The roles a non-SOX project offers on invite / add; a SOX project offers
|
|
18365
19061
|
* `productionManager`, `developer` and `reviewer` instead. */
|
|
18366
|
-
type ProjectInvitableRole = '
|
|
18367
|
-
type
|
|
18368
|
-
projectId: number;
|
|
18369
|
-
};
|
|
18370
|
-
type CreateProjectInvitationBody = {
|
|
18371
|
-
email: string;
|
|
18372
|
-
role?: User['role'];
|
|
18373
|
-
/** Seconds until the invitation and the resulting membership expire. */
|
|
18374
|
-
expirationSeconds?: number;
|
|
18375
|
-
/** `ui_apps` key the invitation leads to instead of the project; honoured only with the
|
|
18376
|
-
* matching project feature, else (and on stacks unaware of it) the ordinary email is sent. */
|
|
18377
|
-
landingApp?: 'business-workspace';
|
|
18378
|
-
};
|
|
18379
|
-
type DeleteProjectInvitationPath = {
|
|
18380
|
-
projectId: number;
|
|
18381
|
-
invitationId: number;
|
|
18382
|
-
};
|
|
18383
|
-
type AddProjectUserPath = {
|
|
18384
|
-
projectId: number;
|
|
18385
|
-
};
|
|
18386
|
-
type AddProjectUserBody = {
|
|
18387
|
-
email: string;
|
|
18388
|
-
role?: ProjectInvitableRole;
|
|
18389
|
-
};
|
|
18390
|
-
type RemoveProjectUserPath = {
|
|
18391
|
-
projectId: number;
|
|
18392
|
-
idOrEmail: number | string;
|
|
19062
|
+
type ProjectInvitableRole = Exclude<NonNullable<AddProjectUserBody['role']>, 'productionManager' | 'developer' | 'reviewer'>;
|
|
19063
|
+
type ListProjectInvitationsPath = {
|
|
19064
|
+
projectId: number | string;
|
|
18393
19065
|
};
|
|
19066
|
+
type CreateProjectInvitationPath = OpenapiPathType<paths['/manage/projects/{projectId}/invitations']['post']>;
|
|
19067
|
+
type CreateProjectInvitationBody = OpenapiBodyType<paths['/manage/projects/{projectId}/invitations']['post']>;
|
|
19068
|
+
type CreateProjectInvitationInput = CreateProjectInvitationPath & CreateProjectInvitationBody;
|
|
19069
|
+
type GetProjectInvitationPath = OpenapiPathType<paths['/manage/projects/{projectId}/invitations/{invitationId}']['get']>;
|
|
19070
|
+
type ProjectInvitationDetail = OpenapiReturnType<paths['/manage/projects/{projectId}/invitations/{invitationId}']['get']>;
|
|
19071
|
+
type DeleteProjectInvitationPath = OpenapiPathType<paths['/manage/projects/{projectId}/invitations/{invitationId}']['delete']>;
|
|
18394
19072
|
type ListProjectJoinRequestsPath = {
|
|
18395
19073
|
projectId: number | string;
|
|
18396
19074
|
};
|
|
18397
|
-
type
|
|
18398
|
-
type
|
|
18399
|
-
|
|
18400
|
-
|
|
18401
|
-
}
|
|
18402
|
-
/** Returned by `updateProject`, `moveProject` and `setProjectDisabled`;
|
|
18403
|
-
* the detail and `setProjectLimits` return the richer {@link Project}. */
|
|
18404
|
-
type ProjectBase = Omit<components['schemas']['ProjectResponse'], 'limits' | 'metrics'> & {
|
|
18405
|
-
limits: Record<string, ProjectLimit>;
|
|
18406
|
-
metrics: Record<string, unknown>;
|
|
18407
|
-
};
|
|
18408
|
-
/** A warning the API attaches to a feature it added but that needs attention. */
|
|
18409
|
-
type ProjectFeatureWarning = {
|
|
18410
|
-
code?: string;
|
|
18411
|
-
message?: string;
|
|
18412
|
-
};
|
|
18413
|
-
/**
|
|
18414
|
-
* Returned by `addProjectFeature`: the project, plus `warnings` when the added feature needs attention.
|
|
18415
|
-
*
|
|
18416
|
-
* - `warnings` is in the live manage OpenAPI (connection #9057) but not yet in the committed schema.
|
|
18417
|
-
* - Drop this overlay once a schema regen brings it in.
|
|
18418
|
-
*/
|
|
18419
|
-
type ProjectWithFeatureWarnings = ProjectBase & {
|
|
18420
|
-
warnings?: ProjectFeatureWarning[];
|
|
18421
|
-
};
|
|
18422
|
-
/**
|
|
18423
|
-
* `ProjectDetailResponse` with the parts the swagger under-models replaced:
|
|
18424
|
-
* - `fileStorage` is documented S3-only, so ABS/GCS projects don't fit it
|
|
18425
|
-
* - `backends` is documented as `{ snowflake }` only
|
|
18426
|
-
* - `organization` is missing `mfaRequired`
|
|
18427
|
-
* - `usersCount` isn't documented
|
|
18428
|
-
*/
|
|
18429
|
-
type Project = Omit<components['schemas']['ProjectDetailResponse'], 'organization' | 'fileStorage' | 'backends' | 'limits' | 'metrics'> & {
|
|
18430
|
-
organization: ProjectOrganization;
|
|
18431
|
-
fileStorage: ProjectFileStorage;
|
|
18432
|
-
backends: ProjectBackends;
|
|
18433
|
-
limits: Record<string, ProjectLimit>;
|
|
18434
|
-
metrics: Record<string, unknown>;
|
|
18435
|
-
usersCount?: number;
|
|
18436
|
-
};
|
|
18437
|
-
type ProjectTemplatePath = OpenapiPathType<paths['/manage/project-templates/{templateId}']['get']>;
|
|
18438
|
-
type AssignFeatureBody = components['schemas']['AssignFeatureRequest'];
|
|
18439
|
-
type AssignProjectTemplateFeatureInput = ProjectTemplatePath & AssignFeatureBody;
|
|
18440
|
-
type RemoveProjectTemplateFeaturePath = OpenapiPathType<paths['/manage/project-templates/{templateId}/features/{featureName}']['delete']>;
|
|
18441
|
-
type ProjectPath = OpenapiPathType<paths['/manage/projects/{projectId}']['put']>;
|
|
19075
|
+
type GetProjectJoinRequestPath = OpenapiPathType<paths['/manage/projects/{projectId}/join-requests/{joinRequestId}']['get']>;
|
|
19076
|
+
type ProjectJoinRequestDetail = OpenapiReturnType<paths['/manage/projects/{projectId}/join-requests/{joinRequestId}']['get']>;
|
|
19077
|
+
type ApproveProjectJoinRequestPath = OpenapiPathType<paths['/manage/projects/{projectId}/join-requests/{joinRequestId}']['put']>;
|
|
19078
|
+
type RejectProjectJoinRequestPath = OpenapiPathType<paths['/manage/projects/{projectId}/join-requests/{joinRequestId}']['delete']>;
|
|
19079
|
+
type JoinProjectPath = OpenapiPathType<paths['/manage/projects/{projectId}/join-project']['post']>;
|
|
18442
19080
|
type JoinProjectBody = OpenapiBodyType<paths['/manage/projects/{projectId}/join-project']['post']>;
|
|
18443
|
-
type JoinProjectInput =
|
|
19081
|
+
type JoinProjectInput = JoinProjectPath & JoinProjectBody;
|
|
19082
|
+
type RequestProjectAccessPath = OpenapiPathType<paths['/manage/projects/{projectId}/request-access']['post']>;
|
|
18444
19083
|
type RequestProjectAccessBody = OpenapiBodyType<paths['/manage/projects/{projectId}/request-access']['post']>;
|
|
18445
|
-
type RequestProjectAccessInput =
|
|
18446
|
-
type
|
|
19084
|
+
type RequestProjectAccessInput = RequestProjectAccessPath & RequestProjectAccessBody;
|
|
19085
|
+
type GetProjectMetadataPath = OpenapiPathType<paths['/manage/projects/{projectId}/metadata']['get']>;
|
|
19086
|
+
type ProjectMetadataItem = OpenapiReturnType<paths['/manage/projects/{projectId}/metadata']['get']>[number];
|
|
19087
|
+
type SetProjectMetadataPath = OpenapiPathType<paths['/manage/projects/{projectId}/metadata']['post']>;
|
|
19088
|
+
type SetProjectMetadataBody = OpenapiBodyType<paths['/manage/projects/{projectId}/metadata']['post']>;
|
|
19089
|
+
type SetProjectMetadataInput = SetProjectMetadataPath & SetProjectMetadataBody;
|
|
19090
|
+
type ProjectMetadataInput = SetProjectMetadataBody['metadata'][number];
|
|
18447
19091
|
type DeleteProjectMetadataPath = OpenapiPathType<paths['/manage/projects/{projectId}/metadata/{metadataId}']['delete']>;
|
|
18448
|
-
type
|
|
18449
|
-
type
|
|
18450
|
-
type
|
|
18451
|
-
type
|
|
18452
|
-
type
|
|
18453
|
-
|
|
18454
|
-
}
|
|
18455
|
-
type
|
|
18456
|
-
|
|
18457
|
-
}
|
|
18458
|
-
|
|
19092
|
+
type GetProjectReviewersPath = OpenapiPathType<paths['/manage/projects/{projectId}/reviewers']['get']>;
|
|
19093
|
+
type SetProjectReviewersPath = OpenapiPathType<paths['/manage/projects/{projectId}/reviewers']['put']>;
|
|
19094
|
+
type SetProjectReviewersBody = OpenapiBodyType<paths['/manage/projects/{projectId}/reviewers']['put']>;
|
|
19095
|
+
type SetProjectReviewersInput = SetProjectReviewersPath & SetProjectReviewersBody;
|
|
19096
|
+
type ProjectTemplate = OpenapiReturnType<paths['/manage/project-templates']['get']>[number];
|
|
19097
|
+
type ProjectTemplatePath = OpenapiPathType<paths['/manage/project-templates/{templateId}']['get']>;
|
|
19098
|
+
type AssignProjectTemplateFeaturePath = OpenapiPathType<paths['/manage/project-templates/{templateId}/features']['post']>;
|
|
19099
|
+
type AssignFeatureBody = OpenapiBodyType<paths['/manage/project-templates/{templateId}/features']['post']>;
|
|
19100
|
+
type AssignProjectTemplateFeatureInput = AssignProjectTemplateFeaturePath & AssignFeatureBody;
|
|
19101
|
+
type RemoveProjectTemplateFeaturePath = OpenapiPathType<paths['/manage/project-templates/{templateId}/features/{featureName}']['delete']>;
|
|
19102
|
+
/** Query parameters of `GET /manage/search`: `q` plus the `filter[types]` and `page` deep objects. */
|
|
19103
|
+
type SearchQuery = OpenapiQueryType<paths['/manage/search']['get']>;
|
|
19104
|
+
/** `GET /manage/search`: one cursor-paginated collection per type the caller may read and asked for. */
|
|
19105
|
+
type SearchResult = OpenapiReturnType<paths['/manage/search']['get']>;
|
|
19106
|
+
type ProjectSearchItem = components['schemas']['ProjectSearchItem'];
|
|
19107
|
+
type OrganizationSearchItem = components['schemas']['OrganizationSearchItem'];
|
|
19108
|
+
type MaintainerSearchItem = components['schemas']['MaintainerSearchItem'];
|
|
19109
|
+
type UserSearchItem = components['schemas']['UserSearchItem'];
|
|
18459
19110
|
/**
|
|
18460
19111
|
* A storage backend as returned by `GET /manage/storage-backend/{id}`.
|
|
18461
19112
|
*
|
|
@@ -18475,6 +19126,9 @@ type StorageBackend = Omit<components['schemas']['StorageBackendDetailResponse']
|
|
|
18475
19126
|
/** BigQuery detail only; `null` = never configured. Overlay until connection#9129 deploys and
|
|
18476
19127
|
* the schema is regenerated. */
|
|
18477
19128
|
policyTagCapability?: PolicyTagCapability | null;
|
|
19129
|
+
/** BigQuery only, on detail and list: the GCP folder id, `null` when the backend has none.
|
|
19130
|
+
* Overlay until connection#9187 deploys and the schema is regenerated. */
|
|
19131
|
+
folderId?: string | null;
|
|
18478
19132
|
};
|
|
18479
19133
|
/** The stored policy-tag capability of a BigQuery backend, as the console `--status` shows it. */
|
|
18480
19134
|
type PolicyTagCapability = {
|
|
@@ -18529,6 +19183,47 @@ type PolicyTagEnablementGuideQuery = Omit<PolicyTagEnablementGuideSchemaQuery, '
|
|
|
18529
19183
|
};
|
|
18530
19184
|
type PolicyTagEnablementGuideInput = PolicyTagEnablementGuidePath & PolicyTagEnablementGuideQuery;
|
|
18531
19185
|
type PolicyTagEnablementGuide = components['schemas']['PolicyTagEnablementGuideResponse'];
|
|
19186
|
+
type AddUserFeaturePath = {
|
|
19187
|
+
userIdOrMail: string;
|
|
19188
|
+
};
|
|
19189
|
+
type AddUserFeatureBody = {
|
|
19190
|
+
feature: string;
|
|
19191
|
+
};
|
|
19192
|
+
type RemoveUserFeaturePath = {
|
|
19193
|
+
userIdOrMail: string;
|
|
19194
|
+
feature: string;
|
|
19195
|
+
};
|
|
19196
|
+
type ProjectUsersResponse = OpenapiReturnType<paths['/manage/projects/{projectId}/users']['get']>;
|
|
19197
|
+
type User = {
|
|
19198
|
+
id: number;
|
|
19199
|
+
name: string;
|
|
19200
|
+
email: string;
|
|
19201
|
+
mfaEnabled: boolean;
|
|
19202
|
+
features: string[];
|
|
19203
|
+
canAccessLogs: boolean;
|
|
19204
|
+
role: 'guest' | 'readOnly' | 'admin' | 'share' | 'productionManager' | 'developer' | 'reviewer';
|
|
19205
|
+
isSuperAdmin: boolean;
|
|
19206
|
+
canApproveMergeRequests: boolean;
|
|
19207
|
+
/** Project users only; older stacks and other user endpoints omit this field. */
|
|
19208
|
+
isOrganizationMember?: ProjectUsersResponse[number]['isOrganizationMember'];
|
|
19209
|
+
};
|
|
19210
|
+
type UserDetail = components['schemas']['UserResponse'];
|
|
19211
|
+
type UserListItem = components['schemas']['UserListResponse'][number];
|
|
19212
|
+
type UserOrganizationMembership = components['schemas']['UserListOrganizationsResponse'][number];
|
|
19213
|
+
type UserProjectMembership = components['schemas']['UserListProjectsResponse'][number];
|
|
19214
|
+
type UserMaintainerMembership = components['schemas']['UserListMaintainersResponse'][number];
|
|
19215
|
+
type GetUsersQuery = NonNullable<operations['get_/manage/users::UserListAction']['parameters']['query']>;
|
|
19216
|
+
/** The schema path parameter is `idOrEmail`; these methods take a numeric `id`, as their neighbours do. */
|
|
19217
|
+
type UserPath = {
|
|
19218
|
+
id: number;
|
|
19219
|
+
};
|
|
19220
|
+
type UpdateUserBody = OpenapiBodyType<paths['/manage/users/{idOrEmail}']['put']>;
|
|
19221
|
+
type UpdateUserInput = UserPath & UpdateUserBody;
|
|
19222
|
+
type SetUserMetadataBody = components['schemas']['MetadataRequest'];
|
|
19223
|
+
type SetUserMetadataInput = UserPath & SetUserMetadataBody;
|
|
19224
|
+
type DeleteUserMetadataPath = UserPath & {
|
|
19225
|
+
metadataId: number;
|
|
19226
|
+
};
|
|
18532
19227
|
/**
|
|
18533
19228
|
* One entry of the UI-application listing.
|
|
18534
19229
|
*
|
|
@@ -18589,5 +19284,9 @@ type ProjectRetentionWorkspace = {
|
|
|
18589
19284
|
} | null;
|
|
18590
19285
|
};
|
|
18591
19286
|
type ManagementToken = components['schemas']['ManageTokenVerifyResponse'];
|
|
18592
|
-
|
|
18593
|
-
|
|
19287
|
+
/** A Manage token Connection minted for an admin's session: it always carries `user`. */
|
|
19288
|
+
type ManagementSessionToken = ManagementToken & {
|
|
19289
|
+
user: NonNullable<ManagementToken['user']>;
|
|
19290
|
+
};
|
|
19291
|
+
export { SearchResult as $, UpdateMaintainerBody as $n, DeletedProjectsListQuery as $r, SetProjectDisabledPath as $t, CreateBigqueryStorageBackendBody as A, CompleteSamlSetupInput as An, FileStorageGcs as Ar, MoveProjectBody as At, StorageBackend as B, MaintainerDetail as Bn, RotateFileStorageGcsPath as Br, ProjectMetadataItem as Bt, UserDetail as C, UpdateTopUpSettingBody as Cn, UpdateOrganizationInput as Cr, GetProjectReviewersPath as Ct, UserPath as D, AddMaintainerUserBody as Dn, CreateFileStorageS3Body as Dr, ListProjectInvitationsPath as Dt, UserOrganizationMembership as E, X402_TOP_UP_TYPE as En, CreateFileStorageGcsBody as Er, JoinProjectPath as Et, PolicyTagEnablementGuide as F, CreateMaintainerOrganizationInput as Fn, RotateFileStorageAbsBody as Fr, ProjectInvitableRole as Ft, UpdateBigqueryStorageBackendBody as G, MaintainerUser as Gn, Feature as Gr, RemoveProjectLimitPath as Gt, StorageBackendMaintainer as H, MaintainerInvitationPath as Hn, RotateFileStorageS3Input as Hr, ProjectTemplatePath as Ht, PolicyTagEnablementGuideInput as I, CreateSamlConfigBody as In, RotateFileStorageAbsInput as Ir, ProjectInvitationDetail as It, UpdateStorageBackendInput as J, SamlConfigDetail as Jn, FeatureType as Jr, RequestProjectAccessBody as Jt, UpdateBigqueryStorageBackendInput as K, MaintainerUserPath as Kn, FeatureAdmin as Kr, RemoveProjectTemplateFeaturePath as Kt, PolicyTagEnablementGuidePath as L, CreateSamlConfigInput as Ln, RotateFileStorageAbsPath as Lr, ProjectJoinRequestDetail as Lt, CreateSnowflakeStorageBackendResponse as M, CreateMaintainerInvitationBody as Mn, FileStorageProjectsPage as Mr, MoveProjectPath as Mt, GetStorageBackendProjectsQuery as N, CreateMaintainerInvitationInput as Nn, FileStorageProjectsQuery as Nr, Project as Nt, UserProjectMembership as O, AddMaintainerUserInput as On, FileStorage as Or, ListProjectJoinRequestsPath as Ot, PolicyTagCapability as P, CreateMaintainerOrganizationBody as Pn, FileStorageS3 as Pr, ProjectFeatureWarning as Pt, SearchQuery as Q, SetMaintainerMetadataInput as Qn, DeletedProjectsListFilter as Qr, SetProjectDisabledInput as Qt, PolicyTagEnablementGuideQuery as R, CreateSamlConfigPath as Rn, RotateFileStorageGcsBody as Rr, ProjectMember as Rt, User as S, UpdateStripeCustomerBody as Sn, UpdateOrganizationBody as Sr, GetProjectPath as St, UserMaintainerMembership as T, X402_PAYMENT_STATUS as Tn, CreateFileStorageAbsBody as Tr, JoinProjectInput as Tt, StorageBackendPath as U, MaintainerMetadataItemPath as Un, RotateFileStorageS3Path as Ur, RejectProjectJoinRequestPath as Ut, StorageBackendBigquery as V, MaintainerInvitationDetail as Vn, RotateFileStorageS3Body as Vr, ProjectTemplate as Vt, StorageBackendProject as W, MaintainerPath as Wn, UpdateFileStorageBody as Wr, RemoveProjectFeaturePath as Wt, OrganizationSearchItem as X, SamlConfigSummary as Xn, DeletedProject as Xr, RequestProjectAccessPath as Xt, MaintainerSearchItem as Y, SamlConfigPath as Yn, GetAllFeaturesQuery as Yr, RequestProjectAccessInput as Yt, ProjectSearchItem as Z, SetMaintainerMetadataBody as Zn, DeletedProjectPurgeResult as Zr, SetProjectDisabledBody as Zt, RemoveUserFeaturePath as _, CreditPurchase as _n, OrganizationPath as _r, DeleteProjectInvitationPath as _t, ReactivateWorkspaceResult as a, ProjectInvitation as ai, SetProjectMetadataPath as an, AdminUser as ar, AssignFeatureBody as at, UpdateUserBody as b, StripeCustomerCard as bn, SetOrganizationMetadataBody as br, GetProjectJoinRequestPath as bt, RenameUiAppBody as c, ApplicationTokenScope as ci, SetProjectReviewersPath as cn, CreateOrganizationProjectBody as cr, ChangeProjectUserRoleBody as ct, UiAppRegistrationResult as d, components as di, UpdateProjectPath as dn, OrganizationDetail as dr, CreateProjectFeatureBody as dt, DeletedProjectsPage as ei, SetProjectLimitsBody as en, UpdateMaintainerInput as er, UserSearchItem as et, UiAppVersion as f, paths as fi, ConfirmProgrammaticProjectBody as fn, OrganizationInvitationDetail as fr, CreateProjectFeatureInput as ft, GetUsersQuery as g, CreditPaymentRequest as gn, OrganizationMetadataItemPath as gr, CreateProjectInvitationPath as gt, DeleteUserMetadataPath as h, CreatePaymentRequestBody as hn, OrganizationMaintainer as hr, CreateProjectInvitationInput as ht, ProjectRetentionWorkspaceState as i, OrganizationInvitation as ii, SetProjectMetadataInput as in, AddOrganizationUserInput as ir, ApproveProjectJoinRequestPath as it, CreateSnowflakeStorageBackendBody as j, CreateMaintainerBody as jn, FileStorageProject as jr, MoveProjectInput as jt, CreateBigqueryServerSideStorageBackendBody as k, CompleteSamlSetupBody as kn, FileStorageAbs as kr, ListProjectUsersPath as kt, UiApp as l, CreateApplicationTokenBody as li, UpdateProjectBody as ln, CreateOrganizationProjectInput as lr, ChangeProjectUserRoleInput as lt, AddUserFeaturePath as m, ProgrammaticProjectClaim as mn, OrganizationListItem as mr, CreateProjectInvitationBody as mt, ManagementToken as n, DeletedProjectsStatus as ni, SetProjectLimitsPath as nn, UpdateSamlConfigInput as nr, AddProjectUserInput as nt, GetUiAppsQuery as o, ProjectJoinRequest as oi, SetProjectReviewersBody as on, CreateOrganizationInvitationBody as or, AssignProjectTemplateFeatureInput as ot, AddUserFeatureBody as p, ConfirmProgrammaticProjectResult as pn, OrganizationInvitationPath as pr, CreateProjectFeaturePath as pt, UpdateStorageBackendBody as q, MetadataItem as qn, FeatureProject as qr, RemoveProjectUserPath as qt, ProjectRetentionWorkspace as r, MaintainerInvitation as ri, SetProjectMetadataBody as rn, AddOrganizationUserBody as rr, AddProjectUserPath as rt, RegisterUiAppBody as s, ApplicationToken as si, SetProjectReviewersInput as sn, CreateOrganizationInvitationInput as sr, AssignProjectTemplateFeaturePath as st, ManagementSessionToken as t, DeletedProjectsStats as ti, SetProjectLimitsInput as tn, UpdateSamlConfigBody as tr, AddProjectUserBody as tt, UiAppDetail as u, CreatedApplicationToken as ui, UpdateProjectInput as un, Organization as ur, ChangeProjectUserRolePath as ut, SetUserMetadataBody as v, PayAsYouGoBillingConfiguration as vn, OrganizationProject as vr, DeleteProjectMetadataPath as vt, UserListItem as w, X402PaymentStatus as wn, SetUpBigQueryBody as wr, JoinProjectBody as wt, UpdateUserInput as x, TopUpSetting as xn, SetOrganizationMetadataInput as xr, GetProjectMetadataPath as xt, SetUserMetadataInput as y, StripeCustomer as yn, OrganizationUserPath as yr, GetProjectInvitationPath as yt, PolicyTagEnablementGuideSchemaQuery as z, Maintainer as zn, RotateFileStorageGcsInput as zr, ProjectMetadataInput as zt };
|
|
19292
|
+
//# sourceMappingURL=types-Bwvss_gW.d.cts.map
|