@keboola/api-client 53.0.0 → 54.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 +23 -0
- 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-Cps6WBy1.js} +1 -2
- package/dist/{componentId-DZP1rBix.js.map → componentId-Cps6WBy1.js.map} +1 -1
- package/dist/{componentId-olp0tltf.cjs → componentId-_tRhEv6W.cjs} +1 -2
- package/dist/{componentId-olp0tltf.cjs.map → componentId-_tRhEv6W.cjs.map} +1 -1
- 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 +1 -1
- package/dist/constants/index.d.cts +1 -1
- package/dist/constants/index.d.ts +1 -1
- package/dist/constants/index.js +1 -1
- 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-BL7uXOiY.d.cts → index-B04rWq_0.d.cts} +2 -2
- package/dist/{index-BUKMdbKh.d.cts → index-BtvWJBYh.d.cts} +15 -7
- package/dist/{index-BNwo-zaJ.d.cts → index-Cd0naVic.d.cts} +1 -2
- package/dist/{index-BoKrc8wy.d.ts → index-DCfumWzq.d.ts} +2 -2
- package/dist/{index-B0prazAi.d.cts → index-DX7qciZA.d.cts} +27 -2
- package/dist/{index-CwUurckF.d.ts → index-DbStyQKc.d.ts} +1 -2
- package/dist/{index-BxgHNJ3Q.d.ts → index-Df30jjpZ.d.ts} +15 -7
- package/dist/{index-D0Gnp2QM.d.ts → index-DzqHh0lE.d.ts} +27 -2
- package/dist/index.cjs +7 -7
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +6 -6
- 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-BAfg8BmK.js} +31 -4
- package/dist/management-BAfg8BmK.js.map +1 -0
- package/dist/{management-Drs5G-hf.cjs → management-BuNIc7Mr.cjs} +31 -4
- package/dist/management-BuNIc7Mr.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 +34 -2
- package/dist/oauth/index.d.ts +34 -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-CXcrilOp.cjs} +47 -1
- package/dist/oauth-CXcrilOp.cjs.map +1 -0
- package/dist/{oauth-DOveZKUv.js → oauth-Ci0qeaS2.js} +43 -3
- package/dist/oauth-Ci0qeaS2.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 +2 -2
- package/dist/sdk/configurations/index.d.cts +2 -2
- package/dist/sdk/configurations/index.d.ts +2 -2
- package/dist/sdk/configurations/index.js +2 -2
- package/dist/sdk/dataAppServer/index.cjs +3 -39
- 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 +1 -37
- 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 +355 -0
- package/dist/sdk/securityPolicy/index.cjs.map +1 -0
- package/dist/sdk/securityPolicy/index.d.cts +100 -0
- package/dist/sdk/securityPolicy/index.d.ts +100 -0
- package/dist/sdk/securityPolicy/index.js +342 -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.d.cts +1 -1
- package/dist/sdk/vault/index.d.ts +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.d.cts +2 -2
- package/dist/storage/index.d.ts +2 -2
- package/dist/storage/types.d.cts +2 -2
- package/dist/storage/types.d.ts +2 -2
- package/dist/syncActions/index.cjs +1 -1
- package/dist/syncActions/index.js +1 -1
- package/dist/{syncActions-DToUhyP3.cjs → syncActions-CR7xvuIv.cjs} +2 -2
- package/dist/{syncActions-DToUhyP3.cjs.map → syncActions-CR7xvuIv.cjs.map} +1 -1
- package/dist/{syncActions-DV_aObTQ.js → syncActions-CU4cIGRf.js} +2 -2
- package/dist/{syncActions-DV_aObTQ.js.map → syncActions-CU4cIGRf.js.map} +1 -1
- package/dist/{types-CsRfoHQw.d.cts → types-B7FKoyfy.d.cts} +270 -2
- package/dist/{types-iU1Sc1IM.d.ts → types-BDgOF2WN.d.ts} +6 -29
- package/dist/types-BXKL0wTI.d.cts +85 -0
- package/dist/{types-DNldEa7i.d.ts → types-COb2O9c1.d.ts} +270 -2
- package/dist/{types-DjWubjvP.d.cts → types-CaBcgsT2.d.cts} +121 -53
- package/dist/{types-BljDxuWG.d.cts → types-DCARsJWs.d.cts} +6 -29
- package/dist/{types-CsVRsObb.d.ts → types-DFcj9YyQ.d.ts} +121 -53
- package/dist/types-DK1bSUNr.d.ts +85 -0
- package/package.json +27 -1
- package/surface/management.md +4 -0
- package/dist/admin-CbMOsfgs.js.map +0 -1
- package/dist/admin-Di-MmGFP.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
|
@@ -2273,6 +2273,66 @@ type paths = {
|
|
|
2273
2273
|
patch: operations['patch_/manage/projects/{projectId}/users/{userId}::ProjectUpdateAdministratorAction'];
|
|
2274
2274
|
trace?: never;
|
|
2275
2275
|
};
|
|
2276
|
+
'/manage/search': {
|
|
2277
|
+
parameters: {
|
|
2278
|
+
query?: never;
|
|
2279
|
+
header?: never;
|
|
2280
|
+
path?: never;
|
|
2281
|
+
cookie?: never;
|
|
2282
|
+
};
|
|
2283
|
+
/**
|
|
2284
|
+
* Search projects, organizations, maintainers and users
|
|
2285
|
+
* @description Looks up the entities an admin navigates to across the whole stack, by name (and email for users).
|
|
2286
|
+
*
|
|
2287
|
+
* #### Access
|
|
2288
|
+
*
|
|
2289
|
+
* Each type is searched only when the caller may read it; a type it may not read is **absent** from the
|
|
2290
|
+
* response, not an empty collection, so "not allowed" and "no hits" can be told apart.
|
|
2291
|
+
*
|
|
2292
|
+
* * super admin — every type
|
|
2293
|
+
* * `project`, `organization`, `maintainer` — any L1 support feature (such as `can-manage-features`
|
|
2294
|
+
* or `can-disable-projects`)
|
|
2295
|
+
* * `user` — feature `can-manage-users` (the rule of `GET /manage/users`)
|
|
2296
|
+
*
|
|
2297
|
+
* Any other admin gets 403; membership in a project, organization or maintainer grants nothing here.
|
|
2298
|
+
* Admin and session tokens are accepted.
|
|
2299
|
+
*
|
|
2300
|
+
* #### Matching
|
|
2301
|
+
*
|
|
2302
|
+
* * *q* - required, trimmed, 2 to 255 characters. Matched as a case-insensitive substring of the name,
|
|
2303
|
+
* and of the email for users. `%` and `_` match themselves. An all-digit `q` also matches the row with
|
|
2304
|
+
* that exact `id`.
|
|
2305
|
+
* * Deleted projects, organizations and maintainers and anonymized users are never found. Disabled
|
|
2306
|
+
* projects are found and carry `isDisabled: true`.
|
|
2307
|
+
* * *filter[types]* - comma-separated subset of `project`, `organization`, `maintainer`, `user`;
|
|
2308
|
+
* omitted, every type the caller may read is searched. A listed type the caller may not read is
|
|
2309
|
+
* left out like an unlisted one.
|
|
2310
|
+
*
|
|
2311
|
+
* #### Ranking and pagination
|
|
2312
|
+
*
|
|
2313
|
+
* Each type is its own cursor-paginated collection (`data`, `meta`, `links`). Every item carries its
|
|
2314
|
+
* `rank`: `0` exact id match, `1` the name (or user email) starts with `q`, `2` any other match.
|
|
2315
|
+
* Items are ordered `rank ASC, id DESC`.
|
|
2316
|
+
*
|
|
2317
|
+
* * *page[limit]* - items returned per type; default value: 10, maximum: 50
|
|
2318
|
+
* * *page[after]* - cursor of the last item already read, for a single type: it requires exactly one
|
|
2319
|
+
* type in `filter[types]`. It is the base64url (padding optional) of `{"rank": <integer>, "id": <integer>}`
|
|
2320
|
+
* copied from that item, e.g. `{"rank":2,"id":4088}` → `eyJyYW5rIjoyLCJpZCI6NDA4OH0`.
|
|
2321
|
+
* Each type's `links.next` already carries its next page, with `filter[types]` narrowed to that type.
|
|
2322
|
+
*
|
|
2323
|
+
* A `q` that is missing or too short or long, an unknown or repeated type, an undecodable cursor,
|
|
2324
|
+
* `page[after]` without exactly one type, and bare `limit` / `offset` or `page[offset]` are rejected
|
|
2325
|
+
* with a validation error.
|
|
2326
|
+
*/
|
|
2327
|
+
get: operations['get_/manage/search::SearchAction'];
|
|
2328
|
+
put?: never;
|
|
2329
|
+
post?: never;
|
|
2330
|
+
delete?: never;
|
|
2331
|
+
options?: never;
|
|
2332
|
+
head?: never;
|
|
2333
|
+
patch?: never;
|
|
2334
|
+
trace?: never;
|
|
2335
|
+
};
|
|
2276
2336
|
'/manage/storage-backend/{backendId}/activate': {
|
|
2277
2337
|
parameters: {
|
|
2278
2338
|
query?: never;
|
|
@@ -6228,6 +6288,92 @@ type components = {
|
|
|
6228
6288
|
email: string;
|
|
6229
6289
|
} | null;
|
|
6230
6290
|
};
|
|
6291
|
+
ProjectSearchItem: {
|
|
6292
|
+
/**
|
|
6293
|
+
* @description Match rank: `0` exact id, `1` name prefix, `2` name substring.
|
|
6294
|
+
* @enum {integer}
|
|
6295
|
+
*/
|
|
6296
|
+
rank: 0 | 1 | 2;
|
|
6297
|
+
/** @example 4088 */
|
|
6298
|
+
id: number;
|
|
6299
|
+
/** @example Sales reporting */
|
|
6300
|
+
name: string;
|
|
6301
|
+
organization: {
|
|
6302
|
+
/** @example 123 */
|
|
6303
|
+
id: number;
|
|
6304
|
+
/** @example Acme */
|
|
6305
|
+
name: string;
|
|
6306
|
+
};
|
|
6307
|
+
/** @description The project is disabled; it is still found. */
|
|
6308
|
+
isDisabled: boolean;
|
|
6309
|
+
};
|
|
6310
|
+
OrganizationSearchItem: {
|
|
6311
|
+
/**
|
|
6312
|
+
* @description Match rank: `0` exact id, `1` name prefix, `2` name substring.
|
|
6313
|
+
* @enum {integer}
|
|
6314
|
+
*/
|
|
6315
|
+
rank: 0 | 1 | 2;
|
|
6316
|
+
/** @example 123 */
|
|
6317
|
+
id: number;
|
|
6318
|
+
/** @example Acme */
|
|
6319
|
+
name: string;
|
|
6320
|
+
maintainer: {
|
|
6321
|
+
/** @example 1 */
|
|
6322
|
+
id: number;
|
|
6323
|
+
/** @example Keboola */
|
|
6324
|
+
name: string | null;
|
|
6325
|
+
};
|
|
6326
|
+
};
|
|
6327
|
+
MaintainerSearchItem: {
|
|
6328
|
+
/**
|
|
6329
|
+
* @description Match rank: `0` exact id, `1` name prefix, `2` name substring.
|
|
6330
|
+
* @enum {integer}
|
|
6331
|
+
*/
|
|
6332
|
+
rank: 0 | 1 | 2;
|
|
6333
|
+
/** @example 1 */
|
|
6334
|
+
id: number;
|
|
6335
|
+
/** @example Keboola */
|
|
6336
|
+
name: string | null;
|
|
6337
|
+
};
|
|
6338
|
+
UserSearchItem: {
|
|
6339
|
+
/**
|
|
6340
|
+
* @description Match rank: `0` exact id, `1` name or email prefix, `2` name or email substring.
|
|
6341
|
+
* @enum {integer}
|
|
6342
|
+
*/
|
|
6343
|
+
rank: 0 | 1 | 2;
|
|
6344
|
+
/** @example 42 */
|
|
6345
|
+
id: number;
|
|
6346
|
+
/** @example John Doe */
|
|
6347
|
+
name: string;
|
|
6348
|
+
/** @example john.doe@keboola.com */
|
|
6349
|
+
email: string;
|
|
6350
|
+
};
|
|
6351
|
+
SearchResponse: {
|
|
6352
|
+
/** @description Projects matching `q`; absent when the caller may not read projects or `filter[types]` leaves them out. */
|
|
6353
|
+
project?: {
|
|
6354
|
+
data: components['schemas']['ProjectSearchItem'][];
|
|
6355
|
+
meta: components['schemas']['PaginationMeta'];
|
|
6356
|
+
links: components['schemas']['PaginationLinks'];
|
|
6357
|
+
};
|
|
6358
|
+
/** @description Organizations matching `q`; absent when the caller may not read organizations or `filter[types]` leaves them out. */
|
|
6359
|
+
organization?: {
|
|
6360
|
+
data: components['schemas']['OrganizationSearchItem'][];
|
|
6361
|
+
meta: components['schemas']['PaginationMeta'];
|
|
6362
|
+
links: components['schemas']['PaginationLinks'];
|
|
6363
|
+
};
|
|
6364
|
+
/** @description Maintainers matching `q`; absent when the caller may not read maintainers or `filter[types]` leaves them out. */
|
|
6365
|
+
maintainer?: {
|
|
6366
|
+
data: components['schemas']['MaintainerSearchItem'][];
|
|
6367
|
+
meta: components['schemas']['PaginationMeta'];
|
|
6368
|
+
links: components['schemas']['PaginationLinks'];
|
|
6369
|
+
};
|
|
6370
|
+
/** @description Users matching `q`; absent when the caller may not read users or `filter[types]` leaves them out. */
|
|
6371
|
+
user?: {
|
|
6372
|
+
data: components['schemas']['UserSearchItem'][];
|
|
6373
|
+
meta: components['schemas']['PaginationMeta'];
|
|
6374
|
+
links: components['schemas']['PaginationLinks'];
|
|
6375
|
+
};
|
|
6376
|
+
};
|
|
6231
6377
|
StorageBackendResponse: {
|
|
6232
6378
|
/** @description Root credentials identifier. */
|
|
6233
6379
|
id: number;
|
|
@@ -15448,6 +15594,117 @@ interface operations {
|
|
|
15448
15594
|
};
|
|
15449
15595
|
};
|
|
15450
15596
|
};
|
|
15597
|
+
'get_/manage/search::SearchAction': {
|
|
15598
|
+
parameters: {
|
|
15599
|
+
query: {
|
|
15600
|
+
/**
|
|
15601
|
+
* @description Search term: 2 to 255 characters after trimming. An all-digit term also matches by exact `id`.
|
|
15602
|
+
* @example acme
|
|
15603
|
+
*/
|
|
15604
|
+
q: string;
|
|
15605
|
+
/**
|
|
15606
|
+
* @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.
|
|
15607
|
+
* @example {
|
|
15608
|
+
* "limit": 10
|
|
15609
|
+
* }
|
|
15610
|
+
*/
|
|
15611
|
+
page?: {
|
|
15612
|
+
/** @description base64url(json) of `{"rank": integer, "id": integer}`. */
|
|
15613
|
+
after?: string;
|
|
15614
|
+
/** @default 10 */
|
|
15615
|
+
limit?: number;
|
|
15616
|
+
};
|
|
15617
|
+
/** @description Filters, JSON:API style: `filter[<name>]=<value>`. Filters combine with AND. */
|
|
15618
|
+
filter?: {
|
|
15619
|
+
/**
|
|
15620
|
+
* @description Comma-separated subset of `project`, `organization`, `maintainer`, `user`; omitted, every type the caller may read.
|
|
15621
|
+
* @example project,organization
|
|
15622
|
+
*/
|
|
15623
|
+
types?: string;
|
|
15624
|
+
};
|
|
15625
|
+
};
|
|
15626
|
+
header?: never;
|
|
15627
|
+
path?: never;
|
|
15628
|
+
cookie?: never;
|
|
15629
|
+
};
|
|
15630
|
+
requestBody?: never;
|
|
15631
|
+
responses: {
|
|
15632
|
+
/** @description Hits grouped by type; only the types the caller may read and asked for are present. */
|
|
15633
|
+
200: {
|
|
15634
|
+
headers: {
|
|
15635
|
+
[name: string]: unknown;
|
|
15636
|
+
};
|
|
15637
|
+
content: {
|
|
15638
|
+
/**
|
|
15639
|
+
* @example {
|
|
15640
|
+
* "project": {
|
|
15641
|
+
* "data": [
|
|
15642
|
+
* {
|
|
15643
|
+
* "rank": 1,
|
|
15644
|
+
* "id": 4088,
|
|
15645
|
+
* "name": "Acme reporting",
|
|
15646
|
+
* "organization": {
|
|
15647
|
+
* "id": 123,
|
|
15648
|
+
* "name": "Acme"
|
|
15649
|
+
* },
|
|
15650
|
+
* "isDisabled": false
|
|
15651
|
+
* }
|
|
15652
|
+
* ],
|
|
15653
|
+
* "meta": {
|
|
15654
|
+
* "total": 1,
|
|
15655
|
+
* "limit": 10,
|
|
15656
|
+
* "cursor": {
|
|
15657
|
+
* "param": "page[after]",
|
|
15658
|
+
* "encoding": "base64url(json)",
|
|
15659
|
+
* "fields": [
|
|
15660
|
+
* {
|
|
15661
|
+
* "name": "rank",
|
|
15662
|
+
* "type": "integer",
|
|
15663
|
+
* "nullable": false
|
|
15664
|
+
* },
|
|
15665
|
+
* {
|
|
15666
|
+
* "name": "id",
|
|
15667
|
+
* "type": "integer",
|
|
15668
|
+
* "nullable": false
|
|
15669
|
+
* }
|
|
15670
|
+
* ],
|
|
15671
|
+
* "order": "rank ASC, id DESC"
|
|
15672
|
+
* }
|
|
15673
|
+
* },
|
|
15674
|
+
* "links": {
|
|
15675
|
+
* "self": "https://connection.keboola.com/manage/search?q=acme&filter[types]=project&page[limit]=10",
|
|
15676
|
+
* "first": "https://connection.keboola.com/manage/search?q=acme&filter[types]=project&page[limit]=10",
|
|
15677
|
+
* "next": null
|
|
15678
|
+
* }
|
|
15679
|
+
* }
|
|
15680
|
+
* }
|
|
15681
|
+
*/
|
|
15682
|
+
'application/json': components['schemas']['SearchResponse'];
|
|
15683
|
+
};
|
|
15684
|
+
};
|
|
15685
|
+
/** @description Returned when `q`, `filter[types]` or the `page` parameters are invalid. */
|
|
15686
|
+
400: {
|
|
15687
|
+
headers: {
|
|
15688
|
+
[name: string]: unknown;
|
|
15689
|
+
};
|
|
15690
|
+
content?: never;
|
|
15691
|
+
};
|
|
15692
|
+
/** @description Returned when the Manage token is missing or invalid. */
|
|
15693
|
+
401: {
|
|
15694
|
+
headers: {
|
|
15695
|
+
[name: string]: unknown;
|
|
15696
|
+
};
|
|
15697
|
+
content?: never;
|
|
15698
|
+
};
|
|
15699
|
+
/** @description Returned when the token is not an admin or session token, or its admin may search no type. */
|
|
15700
|
+
403: {
|
|
15701
|
+
headers: {
|
|
15702
|
+
[name: string]: unknown;
|
|
15703
|
+
};
|
|
15704
|
+
content?: never;
|
|
15705
|
+
};
|
|
15706
|
+
};
|
|
15707
|
+
};
|
|
15451
15708
|
'post_/manage/storage-backend/{backendId}/activate::StorageBackendActivateAction': {
|
|
15452
15709
|
parameters: {
|
|
15453
15710
|
query?: never;
|
|
@@ -18456,6 +18713,14 @@ type ChangeProjectUserRoleBody = {
|
|
|
18456
18713
|
role: User['role'];
|
|
18457
18714
|
};
|
|
18458
18715
|
type ChangeProjectUserRoleInput = ChangeProjectUserRolePath & ChangeProjectUserRoleBody;
|
|
18716
|
+
/** Query parameters of `GET /manage/search`: `q` plus the `filter[types]` and `page` deep objects. */
|
|
18717
|
+
type SearchQuery = OpenapiQueryType<paths['/manage/search']['get']>;
|
|
18718
|
+
/** `GET /manage/search`: one cursor-paginated collection per type the caller may read and asked for. */
|
|
18719
|
+
type SearchResult = OpenapiReturnType<paths['/manage/search']['get']>;
|
|
18720
|
+
type ProjectSearchItem = components['schemas']['ProjectSearchItem'];
|
|
18721
|
+
type OrganizationSearchItem = components['schemas']['OrganizationSearchItem'];
|
|
18722
|
+
type MaintainerSearchItem = components['schemas']['MaintainerSearchItem'];
|
|
18723
|
+
type UserSearchItem = components['schemas']['UserSearchItem'];
|
|
18459
18724
|
/**
|
|
18460
18725
|
* A storage backend as returned by `GET /manage/storage-backend/{id}`.
|
|
18461
18726
|
*
|
|
@@ -18475,6 +18740,9 @@ type StorageBackend = Omit<components['schemas']['StorageBackendDetailResponse']
|
|
|
18475
18740
|
/** BigQuery detail only; `null` = never configured. Overlay until connection#9129 deploys and
|
|
18476
18741
|
* the schema is regenerated. */
|
|
18477
18742
|
policyTagCapability?: PolicyTagCapability | null;
|
|
18743
|
+
/** BigQuery only, on detail and list: the GCP folder id, `null` when the backend has none.
|
|
18744
|
+
* Overlay until connection#9187 deploys and the schema is regenerated. */
|
|
18745
|
+
folderId?: string | null;
|
|
18478
18746
|
};
|
|
18479
18747
|
/** The stored policy-tag capability of a BigQuery backend, as the console `--status` shows it. */
|
|
18480
18748
|
type PolicyTagCapability = {
|
|
@@ -18589,5 +18857,5 @@ type ProjectRetentionWorkspace = {
|
|
|
18589
18857
|
} | null;
|
|
18590
18858
|
};
|
|
18591
18859
|
type ManagementToken = components['schemas']['ManageTokenVerifyResponse'];
|
|
18592
|
-
export {
|
|
18593
|
-
//# sourceMappingURL=types-
|
|
18860
|
+
export { GetProjectReviewersPath as $, OrganizationInvitationDetail as $n, paths as $r, ConfirmProgrammaticProjectBody as $t, UpdateStorageBackendBody as A, MaintainerMetadataItemPath as An, RotateFileStorageS3Path as Ar, SetProjectLimitsInput as At, AssignFeatureBody as B, UpdateMaintainerBody as Bn, DeletedProjectsListQuery as Br, GetUsersQuery as Bt, StorageBackend as C, CreateSamlConfigBody as Cn, RotateFileStorageAbsInput as Cr, RemoveProjectUserPath as Ct, StorageBackendProject as D, MaintainerDetail as Dn, RotateFileStorageGcsPath as Dr, SetProjectDisabledBody as Dt, StorageBackendPath as E, Maintainer as En, RotateFileStorageGcsInput as Er, Reviewer as Et, SearchQuery as F, SamlConfigDetail as Fn, FeatureType as Fr, UpdateProjectBody as Ft, CreateProjectFeatureBody as G, AddOrganizationUserInput as Gn, OrganizationInvitation as Gr, UpdateUserInput as Gt, ChangeProjectUserRoleBody as H, UpdateSamlConfigBody as Hn, DeletedProjectsStats as Hr, SetUserMetadataBody as Ht, SearchResult as I, SamlConfigPath as In, GetAllFeaturesQuery as Ir, UpdateProjectInput as It, CreateProjectInvitationPath as J, CreateOrganizationInvitationInput as Jn, ApplicationToken as Jr, UserListItem as Jt, CreateProjectFeaturePath as K, AdminUser as Kn, ProjectInvitation as Kr, User as Kt, UserSearchItem as L, SamlConfigSummary as Ln, DeletedProject as Lr, AddUserFeatureBody as Lt, MaintainerSearchItem as M, MaintainerUser as Mn, Feature as Mr, SetProjectMetadataPath as Mt, OrganizationSearchItem as N, MaintainerUserPath as Nn, FeatureAdmin as Nr, SetProjectReviewersBody as Nt, UpdateBigqueryStorageBackendBody as O, MaintainerInvitationDetail as On, RotateFileStorageS3Body as Or, SetProjectDisabledInput as Ot, ProjectSearchItem as P, MetadataItem as Pn, FeatureProject as Pr, SetProjectReviewersPath as Pt, GetProjectPath as Q, OrganizationDetail as Qn, components as Qr, UserProjectMembership as Qt, AddProjectUserBody as R, SetMaintainerMetadataBody as Rn, DeletedProjectPurgeResult as Rr, AddUserFeaturePath as Rt, PolicyTagEnablementGuideSchemaQuery as S, CreateMaintainerOrganizationInput as Sn, RotateFileStorageAbsBody as Sr, RemoveProjectTemplateFeaturePath as St, StorageBackendMaintainer as T, CreateSamlConfigPath as Tn, RotateFileStorageGcsBody as Tr, RequestProjectAccessInput as Tt, ChangeProjectUserRoleInput as U, UpdateSamlConfigInput as Un, DeletedProjectsStatus as Ur, SetUserMetadataInput as Ut, AssignProjectTemplateFeatureInput as V, UpdateMaintainerInput as Vn, DeletedProjectsPage as Vr, RemoveUserFeaturePath as Vt, ChangeProjectUserRolePath as W, AddOrganizationUserBody as Wn, MaintainerInvitation as Wr, UpdateUserBody as Wt, DeleteProjectMetadataPath as X, CreateOrganizationProjectInput as Xn, CreateApplicationTokenBody as Xr, UserOrganizationMembership as Xt, DeleteProjectInvitationPath as Y, CreateOrganizationProjectBody as Yn, ApplicationTokenScope as Yr, UserMaintainerMembership as Yt, GetProjectMetadataPath as Z, Organization as Zn, CreatedApplicationToken as Zr, UserPath as Zt, PolicyTagCapability as _, CompleteSamlSetupInput as _n, FileStorageGcs as _r, ProjectTemplate as _t, GetUiAppsQuery as a, PayAsYouGoBillingConfiguration as an, OrganizationProject as ar, MoveProjectBody as at, PolicyTagEnablementGuidePath as b, CreateMaintainerInvitationInput as bn, FileStorageProjectsQuery as br, RemoveProjectFeaturePath as bt, UiApp as c, TopUpSetting as cn, SetOrganizationMetadataInput as cr, ProjectBase as ct, UiAppVersion as d, X402PaymentStatus as dn, SetUpBigQueryBody as dr, ProjectInvitationDetail as dt, ConfirmProgrammaticProjectResult as en, OrganizationInvitationPath as er, JoinProjectBody as et, CreateBigqueryServerSideStorageBackendBody as f, X402_PAYMENT_STATUS as fn, CreateFileStorageAbsBody as fr, ProjectJoinRequestDetail as ft, GetStorageBackendProjectsQuery as g, CompleteSamlSetupBody as gn, FileStorageAbs as gr, ProjectPath as gt, CreateSnowflakeStorageBackendResponse as h, AddMaintainerUserInput as hn, FileStorage as hr, ProjectMetadataItem as ht, ReactivateWorkspaceResult as i, CreditPurchase as in, OrganizationPath as ir, ListProjectUsersPath as it, UpdateStorageBackendInput as j, MaintainerPath as jn, UpdateFileStorageBody as jr, SetProjectMetadataBody as jt, UpdateBigqueryStorageBackendInput as k, MaintainerInvitationPath as kn, RotateFileStorageS3Input as kr, SetProjectLimitsBody as kt, UiAppDetail as l, UpdateStripeCustomerBody as ln, UpdateOrganizationBody as lr, ProjectFeatureWarning as lt, CreateSnowflakeStorageBackendBody as m, AddMaintainerUserBody as mn, CreateFileStorageS3Body as mr, ProjectMetadataInput as mt, ProjectRetentionWorkspace as n, CreatePaymentRequestBody as nn, OrganizationMaintainer as nr, ListProjectInvitationsPath as nt, RegisterUiAppBody as o, StripeCustomer as on, OrganizationUserPath as or, MoveProjectInput as ot, CreateBigqueryStorageBackendBody as p, X402_TOP_UP_TYPE as pn, CreateFileStorageGcsBody as pr, ProjectJoinRequestPath as pt, CreateProjectInvitationBody as q, CreateOrganizationInvitationBody as qn, ProjectJoinRequest as qr, UserDetail as qt, ProjectRetentionWorkspaceState as r, CreditPaymentRequest as rn, OrganizationMetadataItemPath as rr, ListProjectJoinRequestsPath as rt, RenameUiAppBody as s, StripeCustomerCard as sn, SetOrganizationMetadataBody as sr, Project as st, ManagementToken as t, ProgrammaticProjectClaim as tn, OrganizationListItem as tr, JoinProjectInput as tt, UiAppRegistrationResult as u, UpdateTopUpSettingBody as un, UpdateOrganizationInput as ur, ProjectInvitableRole as ut, PolicyTagEnablementGuide as v, CreateMaintainerBody as vn, FileStorageProject as vr, ProjectTemplatePath as vt, StorageBackendBigquery as w, CreateSamlConfigInput as wn, RotateFileStorageAbsPath as wr, RequestProjectAccessBody as wt, PolicyTagEnablementGuideQuery as x, CreateMaintainerOrganizationBody as xn, FileStorageS3 as xr, RemoveProjectLimitPath as xt, PolicyTagEnablementGuideInput as y, CreateMaintainerInvitationBody as yn, FileStorageProjectsPage as yr, ProjectWithFeatureWarnings as yt, AddProjectUserPath as z, SetMaintainerMetadataInput as zn, DeletedProjectsListFilter as zr, DeleteUserMetadataPath as zt };
|
|
18861
|
+
//# sourceMappingURL=types-B7FKoyfy.d.cts.map
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { i as CreateMetaObjectInput } from "./types-Bp8G9yta.js";
|
|
2
2
|
import { n as createMetastoreClient } from "./index-BVe4S2CK.js";
|
|
3
|
+
import { n as MetastoreObjectMeta, t as MetastoreObject } from "./metaObject-ClvW342q.js";
|
|
3
4
|
/**
|
|
4
5
|
* The closed value sets the metastore accepts on a semantic object.
|
|
5
6
|
*
|
|
@@ -133,34 +134,10 @@ type SemanticChildObjectDataMap = {
|
|
|
133
134
|
type SemanticChildObjectType = keyof SemanticChildObjectDataMap;
|
|
134
135
|
type SemanticObjectType = SemanticChildObjectType | 'semantic-model';
|
|
135
136
|
type SemanticObjectScope = (typeof SEMANTIC_OBJECT_SCOPES)[number];
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
organizationId?: string;
|
|
141
|
-
revision?: number;
|
|
142
|
-
schemaVersion?: string;
|
|
143
|
-
createdAt?: string;
|
|
144
|
-
lastUpdated?: string;
|
|
145
|
-
revisionCreatedAt?: string;
|
|
146
|
-
scope?: SemanticObjectScope;
|
|
147
|
-
sourceProjectId?: number;
|
|
148
|
-
/** The projects a `targeted` object is shared with, read-only. */
|
|
149
|
-
targetProjectIds?: number[];
|
|
150
|
-
/** Set while a `project`-scope object awaits an org-admin decision. Cleared by promoting
|
|
151
|
-
* (PATCH `{scope:"organization"}`) or withdrawing the request. */
|
|
152
|
-
scopeElevationRequestedAt?: string;
|
|
153
|
-
};
|
|
154
|
-
/**
|
|
155
|
-
* Normalized metastore object as returned by this SDK. Matches the live metastore
|
|
156
|
-
* envelope ({ type, id, attributes: <data payload>, meta: {...} }), which differs
|
|
157
|
-
* from the legacy wrapper types in clients/metastore/repository/types.ts.
|
|
158
|
-
*/
|
|
159
|
-
type SemanticObject<TData> = {
|
|
160
|
-
uuid: string;
|
|
161
|
-
data: TData;
|
|
162
|
-
meta: SemanticObjectMeta;
|
|
163
|
-
};
|
|
137
|
+
/** The metastore envelope's `meta`; shared with every metastore object family. */
|
|
138
|
+
type SemanticObjectMeta = MetastoreObjectMeta;
|
|
139
|
+
/** A semantic-layer object as this SDK returns it, in the shared metastore envelope. */
|
|
140
|
+
type SemanticObject<TData> = MetastoreObject<TData>;
|
|
164
141
|
type CreateSemanticObjectMeta = Omit<CreateMetaObjectInput, 'data' | 'objectType'>;
|
|
165
142
|
/**
|
|
166
143
|
* Meta for a CONTENT update. `scope` is deliberately absent: a scope change is a separate PATCH
|
|
@@ -195,4 +172,4 @@ type SemanticUnreadableObjectRef = {
|
|
|
195
172
|
modelUUID: string | null;
|
|
196
173
|
};
|
|
197
174
|
export { CONSTRAINT_TYPES as A, SemanticRuleExpression as C, UpdateSemanticObjectMeta as D, SemanticValidationQuery as E, SQL_DIALECTS as F, RELATIONSHIP_JOIN_TYPES as M, RULE_OPERATORS as N, CONSTRAINT_SCOPES as O, SEMANTIC_OBJECT_SCOPES as P, SemanticRelationshipJoinType as S, SemanticUnreadableObjectRef as T, SemanticObject as _, SemanticChildObjectType as a, SemanticObjectType as b, SemanticConstraintSeverity as c, SemanticFieldData as d, SemanticFieldRole as f, SemanticModelData as g, SemanticModelChildRef as h, SemanticChildObjectDataMap as i, FIELD_ROLES as j, CONSTRAINT_SEVERITIES as k, SemanticConstraintType as l, SemanticMetricData as m, MetastoreClient as n, SemanticConstraintData as o, SemanticGlossaryData as p, SemanticAiMetadata as r, SemanticConstraintScope as s, CreateSemanticObjectMeta as t, SemanticDatasetData as u, SemanticObjectMeta as v, SemanticRuleOperator as w, SemanticRelationshipData as x, SemanticObjectScope as y };
|
|
198
|
-
//# sourceMappingURL=types-
|
|
175
|
+
//# sourceMappingURL=types-BDgOF2WN.d.ts.map
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { n as createMetastoreClient } from "./index-CNJBmCHM.cjs";
|
|
2
|
+
import { t as MetastoreObject } from "./metaObject-D7oudegV.cjs";
|
|
3
|
+
/**
|
|
4
|
+
* The metastore's row- and column-level security vocabulary, schema version 1.2.0.
|
|
5
|
+
*
|
|
6
|
+
* - Each list is the one place a value is added; the types in `./types` derive from it.
|
|
7
|
+
*/
|
|
8
|
+
declare const SECURITY_POLICY_TYPES: readonly ['rls-policy', 'cls-policy'];
|
|
9
|
+
declare const POLICY_SQL_DIALECTS: readonly ['snowflake', 'bigquery'];
|
|
10
|
+
declare const RLS_COMPARISON_OPS: readonly ['eq', 'ne', 'gt', 'gte', 'lt', 'lte'];
|
|
11
|
+
declare const RLS_LIST_OPS: readonly ['in', 'not_in'];
|
|
12
|
+
declare const RLS_NULL_OPS: readonly ['is_null', 'is_not_null'];
|
|
13
|
+
type MetastoreClient = ReturnType<typeof createMetastoreClient>;
|
|
14
|
+
type SecurityPolicyType = (typeof SECURITY_POLICY_TYPES)[number];
|
|
15
|
+
type PolicyDialect = (typeof POLICY_SQL_DIALECTS)[number];
|
|
16
|
+
/** `{"$identity": "email"}`: the reading identity's email, bound as a query parameter. */
|
|
17
|
+
type RlsIdentityEmail = {
|
|
18
|
+
$identity: 'email';
|
|
19
|
+
};
|
|
20
|
+
/** `{"$identity": "groups"}`: the reading identity's IdP groups, bound as a list. */
|
|
21
|
+
type RlsIdentityGroups = {
|
|
22
|
+
$identity: 'groups';
|
|
23
|
+
};
|
|
24
|
+
type RlsLiteral = string | number | boolean | null;
|
|
25
|
+
type RlsCondition = {
|
|
26
|
+
true: true;
|
|
27
|
+
} | {
|
|
28
|
+
false: true;
|
|
29
|
+
} | {
|
|
30
|
+
and: RlsCondition[];
|
|
31
|
+
} | {
|
|
32
|
+
or: RlsCondition[];
|
|
33
|
+
} | {
|
|
34
|
+
column: string;
|
|
35
|
+
op: (typeof RLS_COMPARISON_OPS)[number];
|
|
36
|
+
value: RlsLiteral | RlsIdentityEmail;
|
|
37
|
+
} | {
|
|
38
|
+
column: string;
|
|
39
|
+
op: (typeof RLS_LIST_OPS)[number];
|
|
40
|
+
values: RlsLiteral[] | RlsIdentityGroups;
|
|
41
|
+
} | {
|
|
42
|
+
column: string;
|
|
43
|
+
op: (typeof RLS_NULL_OPS)[number];
|
|
44
|
+
};
|
|
45
|
+
/** One selector kind per rule: IdP `groups` or `<idp>|<sub>` `subjects`. `["*"]` is everyone. */
|
|
46
|
+
type PolicySelector = {
|
|
47
|
+
subjects: string[];
|
|
48
|
+
} | {
|
|
49
|
+
groups: string[];
|
|
50
|
+
};
|
|
51
|
+
type RlsRule = PolicySelector & {
|
|
52
|
+
condition: RlsCondition;
|
|
53
|
+
};
|
|
54
|
+
type ClsRule = PolicySelector & {
|
|
55
|
+
visible_columns: string[];
|
|
56
|
+
};
|
|
57
|
+
type RlsPolicyData = {
|
|
58
|
+
table: string;
|
|
59
|
+
dialect?: PolicyDialect;
|
|
60
|
+
rules: RlsRule[];
|
|
61
|
+
default?: RlsCondition;
|
|
62
|
+
};
|
|
63
|
+
type ClsPolicyData = {
|
|
64
|
+
table: string;
|
|
65
|
+
dialect?: PolicyDialect;
|
|
66
|
+
rules: ClsRule[];
|
|
67
|
+
};
|
|
68
|
+
type SecurityPolicyDataMap = {
|
|
69
|
+
'rls-policy': RlsPolicyData;
|
|
70
|
+
'cls-policy': ClsPolicyData;
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* What a read hands back.
|
|
74
|
+
*
|
|
75
|
+
* - Rules stay untyped: policies written under schema 1.0.0 or 1.1.0 (`principal`) list too.
|
|
76
|
+
*/
|
|
77
|
+
type SecurityPolicyReadData = {
|
|
78
|
+
table: string;
|
|
79
|
+
dialect?: PolicyDialect;
|
|
80
|
+
rules: Record<string, unknown>[];
|
|
81
|
+
default?: unknown;
|
|
82
|
+
};
|
|
83
|
+
type SecurityPolicy = MetastoreObject<SecurityPolicyReadData>;
|
|
84
|
+
export { RLS_COMPARISON_OPS as _, PolicySelector as a, SECURITY_POLICY_TYPES as b, RlsIdentityGroups as c, RlsRule as d, SecurityPolicy as f, POLICY_SQL_DIALECTS as g, SecurityPolicyType as h, PolicyDialect as i, RlsLiteral as l, SecurityPolicyReadData as m, ClsRule as n, RlsCondition as o, SecurityPolicyDataMap as p, MetastoreClient as r, RlsIdentityEmail as s, ClsPolicyData as t, RlsPolicyData as u, RLS_LIST_OPS as v, RLS_NULL_OPS as y };
|
|
85
|
+
//# sourceMappingURL=types-BXKL0wTI.d.cts.map
|