@keboola/api-client 25.0.0 → 27.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/AGENTS.md +489 -0
- package/API-SURFACE.md +126 -57
- package/README.md +29 -25
- package/dist/{adminRoles-Cil1lavB.d.cts → adminRoles-BSUPLfNf.d.cts} +1 -7
- package/dist/{adminRoles-Cil1lavB.d.ts → adminRoles-BSUPLfNf.d.ts} +1 -7
- package/dist/ai/index.cjs +4 -4
- package/dist/ai/index.d.cts +5 -2
- package/dist/ai/index.d.ts +5 -2
- package/dist/ai/index.js +3 -3
- package/dist/ai/types.d.cts +2 -2
- package/dist/ai/types.d.ts +2 -2
- package/dist/appLogs-BbgAJ5I8.d.cts +7 -0
- package/dist/appLogs-BbgAJ5I8.d.ts +7 -0
- package/dist/apps/index.cjs +16 -0
- package/dist/apps/index.cjs.map +1 -0
- package/dist/apps/index.d.cts +249 -0
- package/dist/apps/index.d.ts +249 -0
- package/dist/apps/index.js +7 -0
- package/dist/apps/index.js.map +1 -0
- package/dist/apps/types.cjs +4 -0
- package/dist/apps/types.cjs.map +1 -0
- package/dist/apps/types.d.cts +3 -0
- package/dist/apps/types.d.ts +3 -0
- package/dist/apps/types.js +3 -0
- package/dist/apps/types.js.map +1 -0
- package/dist/assets/index.cjs +2 -2
- package/dist/assets/index.js +1 -1
- package/dist/auth/index.cjs +17 -13
- package/dist/auth/index.d.cts +18 -5
- package/dist/auth/index.d.ts +18 -5
- package/dist/auth/index.js +2 -2
- package/dist/auth/types.d.cts +3 -3
- package/dist/auth/types.d.ts +3 -3
- package/dist/backends-UNp_e5y9.d.cts +7 -0
- package/dist/backends-UNp_e5y9.d.ts +7 -0
- package/dist/chat/index.cjs +4 -4
- package/dist/chat/index.d.cts +5 -2
- package/dist/chat/index.d.ts +5 -2
- package/dist/chat/index.js +3 -3
- package/dist/chat/types.d.cts +2 -2
- package/dist/chat/types.d.ts +2 -2
- package/dist/{chunk-LD3JERYP.js → chunk-24YVNNAG.js} +10 -4
- package/dist/chunk-24YVNNAG.js.map +1 -0
- package/dist/{chunk-CV2JGHBN.js → chunk-255CHZ3U.js} +23 -6
- package/dist/chunk-255CHZ3U.js.map +1 -0
- package/dist/{chunk-S4JK7DKM.js → chunk-2BCH2U57.js} +11 -5
- package/dist/chunk-2BCH2U57.js.map +1 -0
- package/dist/{chunk-XHDYLUM4.js → chunk-2BQBKU6E.js} +15 -13
- package/dist/chunk-2BQBKU6E.js.map +1 -0
- package/dist/{chunk-NVQ6LGDO.cjs → chunk-2JKTV7UG.cjs} +6 -6
- package/dist/{chunk-NVQ6LGDO.cjs.map → chunk-2JKTV7UG.cjs.map} +1 -1
- package/dist/chunk-3UBGQFBU.js +29 -0
- package/dist/chunk-3UBGQFBU.js.map +1 -0
- package/dist/chunk-57Q4CY4H.js +190 -0
- package/dist/chunk-57Q4CY4H.js.map +1 -0
- package/dist/{chunk-EDX5D6UY.js → chunk-5A3AQIXR.js} +3 -3
- package/dist/{chunk-EDX5D6UY.js.map → chunk-5A3AQIXR.js.map} +1 -1
- package/dist/{chunk-UABYNGBZ.js → chunk-5HEIR4DC.js} +4 -4
- package/dist/chunk-5HEIR4DC.js.map +1 -0
- package/dist/{chunk-Z3HZ4MP4.cjs → chunk-5SR2L35Y.cjs} +885 -553
- package/dist/chunk-5SR2L35Y.cjs.map +1 -0
- package/dist/{chunk-OUSPQ55W.js → chunk-62LG5KPI.js} +29 -7
- package/dist/chunk-62LG5KPI.js.map +1 -0
- package/dist/{chunk-HMCZUHR7.js → chunk-67P5UI6H.js} +9 -4
- package/dist/{chunk-2CFM7K4U.cjs.map → chunk-67P5UI6H.js.map} +1 -1
- package/dist/{chunk-HY7J3OD3.cjs → chunk-6PVEHUJL.cjs} +39 -29
- package/dist/chunk-6PVEHUJL.cjs.map +1 -0
- package/dist/chunk-6XFXU5N4.js +119 -0
- package/dist/chunk-6XFXU5N4.js.map +1 -0
- package/dist/chunk-6ZQBFK2Y.js +24 -0
- package/dist/chunk-6ZQBFK2Y.js.map +1 -0
- package/dist/{chunk-AFJGNBVM.cjs → chunk-AJ3SCWUB.cjs} +14 -8
- package/dist/chunk-AJ3SCWUB.cjs.map +1 -0
- package/dist/{chunk-GF4XZK5N.cjs → chunk-AXYNFDUI.cjs} +4 -4
- package/dist/chunk-AXYNFDUI.cjs.map +1 -0
- package/dist/{chunk-UP5SEEYZ.js → chunk-B45B4AYG.js} +61 -7
- package/dist/chunk-B45B4AYG.js.map +1 -0
- package/dist/{chunk-4VVF2PIX.js → chunk-B4T4QCLB.js} +10 -4
- package/dist/chunk-B4T4QCLB.js.map +1 -0
- package/dist/{chunk-XIIER7QQ.js → chunk-BGJWHTBJ.js} +10 -4
- package/dist/chunk-BGJWHTBJ.js.map +1 -0
- package/dist/chunk-BVRPZKRE.cjs +147 -0
- package/dist/chunk-BVRPZKRE.cjs.map +1 -0
- package/dist/chunk-BZB4UVQA.cjs +192 -0
- package/dist/chunk-BZB4UVQA.cjs.map +1 -0
- package/dist/{chunk-IAYPOSMM.cjs → chunk-CHRBWCL7.cjs} +8 -8
- package/dist/chunk-CHRBWCL7.cjs.map +1 -0
- package/dist/{chunk-3PVERYSF.js → chunk-CPZME73I.js} +3 -3
- package/dist/{chunk-3PVERYSF.js.map → chunk-CPZME73I.js.map} +1 -1
- package/dist/{chunk-RVBGE2Z4.js → chunk-DVV35AIS.js} +7 -7
- package/dist/chunk-DVV35AIS.js.map +1 -0
- package/dist/{chunk-CWUQ6ZAO.cjs → chunk-E7GGDLAH.cjs} +25 -8
- package/dist/chunk-E7GGDLAH.cjs.map +1 -0
- package/dist/{chunk-J3NLKXQ5.cjs → chunk-EQPBR3BE.cjs} +15 -9
- package/dist/chunk-EQPBR3BE.cjs.map +1 -0
- package/dist/{chunk-SJZ66FD5.js → chunk-ERZEQ5JR.js} +8 -3
- package/dist/chunk-ERZEQ5JR.js.map +1 -0
- package/dist/{chunk-CWCUQACX.cjs → chunk-ES3ADC2G.cjs} +4 -4
- package/dist/{chunk-CWCUQACX.cjs.map → chunk-ES3ADC2G.cjs.map} +1 -1
- package/dist/{chunk-2CFM7K4U.cjs → chunk-FEAE6L3K.cjs} +13 -8
- package/dist/chunk-FEAE6L3K.cjs.map +1 -0
- package/dist/{chunk-IDWGBCSB.cjs → chunk-FVU7WU2H.cjs} +11 -6
- package/dist/chunk-FVU7WU2H.cjs.map +1 -0
- package/dist/{chunk-3BFPNM2J.js → chunk-FW5GBBKL.js} +11 -5
- package/dist/chunk-FW5GBBKL.js.map +1 -0
- package/dist/chunk-G2SWCC3X.js +90 -0
- package/dist/chunk-G2SWCC3X.js.map +1 -0
- package/dist/{chunk-KUYVBCUM.cjs → chunk-G3JHVIDZ.cjs} +63 -8
- package/dist/chunk-G3JHVIDZ.cjs.map +1 -0
- package/dist/{chunk-D4WOOKMI.js → chunk-HGKDXF35.js} +58 -107
- package/dist/chunk-HGKDXF35.js.map +1 -0
- package/dist/chunk-HQO572JW.cjs +34 -0
- package/dist/chunk-HQO572JW.cjs.map +1 -0
- package/dist/{chunk-MMOAH3EH.cjs → chunk-HUQ5ATIL.cjs} +15 -13
- package/dist/chunk-HUQ5ATIL.cjs.map +1 -0
- package/dist/{chunk-XKIENBIE.js → chunk-HZDVMHU6.js} +10 -4
- package/dist/chunk-HZDVMHU6.js.map +1 -0
- package/dist/{chunk-7R22VKV7.cjs → chunk-ICWUR5WA.cjs} +13 -7
- package/dist/chunk-ICWUR5WA.cjs.map +1 -0
- package/dist/{chunk-BR6WZE3O.cjs → chunk-IQFNHQWP.cjs} +9 -4
- package/dist/chunk-IQFNHQWP.cjs.map +1 -0
- package/dist/{chunk-7Z4MU7ZB.js → chunk-IZ4QM7O4.js} +32 -22
- package/dist/chunk-IZ4QM7O4.js.map +1 -0
- package/dist/{chunk-UWQUHP3T.cjs → chunk-J5JCXSAS.cjs} +11 -6
- package/dist/chunk-J5JCXSAS.cjs.map +1 -0
- package/dist/{chunk-LIXSIM3H.cjs → chunk-JI7HLIDL.cjs} +12 -6
- package/dist/chunk-JI7HLIDL.cjs.map +1 -0
- package/dist/chunk-JWISA775.cjs +92 -0
- package/dist/chunk-JWISA775.cjs.map +1 -0
- package/dist/chunk-K3BLXPLA.cjs +16 -0
- package/dist/{chunk-7RO6PKZ4.cjs.map → chunk-K3BLXPLA.cjs.map} +1 -1
- package/dist/{chunk-BZA3FGO6.js → chunk-KATUDT3E.js} +8 -3
- package/dist/chunk-KATUDT3E.js.map +1 -0
- package/dist/chunk-KGBWWS6I.js +32 -0
- package/dist/chunk-KGBWWS6I.js.map +1 -0
- package/dist/chunk-KQENBXPS.cjs +34 -0
- package/dist/chunk-KQENBXPS.cjs.map +1 -0
- package/dist/chunk-KTKJD4DM.js +60 -0
- package/dist/chunk-KTKJD4DM.js.map +1 -0
- package/dist/{chunk-2BOG5U7C.js → chunk-LWQP7OWA.js} +3 -3
- package/dist/{chunk-2BOG5U7C.js.map → chunk-LWQP7OWA.js.map} +1 -1
- package/dist/chunk-NFJKJGXR.js +397 -0
- package/dist/chunk-NFJKJGXR.js.map +1 -0
- package/dist/chunk-NH2TQGRL.cjs +28 -0
- package/dist/chunk-NH2TQGRL.cjs.map +1 -0
- package/dist/{chunk-KEFXOJD7.js → chunk-NHYL5QPM.js} +16 -3
- package/dist/chunk-NHYL5QPM.js.map +1 -0
- package/dist/{chunk-AVH6F5LB.js → chunk-ON4ILCHP.js} +876 -546
- package/dist/chunk-ON4ILCHP.js.map +1 -0
- package/dist/{chunk-T242YFMT.cjs → chunk-PLF4JX5B.cjs} +12 -7
- package/dist/chunk-PLF4JX5B.cjs.map +1 -0
- package/dist/{chunk-77LILJYX.js → chunk-QNF3L4B7.js} +9 -4
- package/dist/chunk-QNF3L4B7.js.map +1 -0
- package/dist/{chunk-NVRVPWNY.js → chunk-RBN3ITTM.js} +9 -4
- package/dist/chunk-RBN3ITTM.js.map +1 -0
- package/dist/{chunk-DRNOCC6W.cjs → chunk-RXYT7EMN.cjs} +31 -8
- package/dist/chunk-RXYT7EMN.cjs.map +1 -0
- package/dist/chunk-S46FMY4G.cjs +64 -0
- package/dist/chunk-S46FMY4G.cjs.map +1 -0
- package/dist/chunk-S6BWQKHJ.cjs +116 -0
- package/dist/chunk-S6BWQKHJ.cjs.map +1 -0
- package/dist/{chunk-3YWQQ3OG.cjs → chunk-SFTI6QFB.cjs} +13 -7
- package/dist/chunk-SFTI6QFB.cjs.map +1 -0
- package/dist/{chunk-7YXL4FKN.cjs → chunk-SNP577FA.cjs} +12 -6
- package/dist/chunk-SNP577FA.cjs.map +1 -0
- package/dist/{chunk-PPQF7LTS.cjs → chunk-SUVM3S2T.cjs} +15 -9
- package/dist/chunk-SUVM3S2T.cjs.map +1 -0
- package/dist/chunk-SYZ5OFNT.js +114 -0
- package/dist/chunk-SYZ5OFNT.js.map +1 -0
- package/dist/{chunk-FRLSKIUI.cjs → chunk-SZBW4EE2.cjs} +6 -6
- package/dist/{chunk-FRLSKIUI.cjs.map → chunk-SZBW4EE2.cjs.map} +1 -1
- package/dist/{chunk-G66EP527.js → chunk-TBHJQCAE.js} +9 -4
- package/dist/chunk-TBHJQCAE.js.map +1 -0
- package/dist/{chunk-EYIPM2XB.cjs → chunk-U3E5YMLO.cjs} +4 -4
- package/dist/{chunk-EYIPM2XB.cjs.map → chunk-U3E5YMLO.cjs.map} +1 -1
- package/dist/{chunk-34GM6NXB.js → chunk-UVX733BX.js} +10 -4
- package/dist/chunk-UVX733BX.js.map +1 -0
- package/dist/{chunk-FMS5PNM2.cjs → chunk-V6FT3RTU.cjs} +8 -3
- package/dist/chunk-V6FT3RTU.cjs.map +1 -0
- package/dist/{chunk-F6ZAYTBX.cjs → chunk-VB56OVFM.cjs} +58 -110
- package/dist/chunk-VB56OVFM.cjs.map +1 -0
- package/dist/{chunk-5XWVWFTC.js → chunk-WQ7NNIJ3.js} +4 -4
- package/dist/{chunk-5XWVWFTC.js.map → chunk-WQ7NNIJ3.js.map} +1 -1
- package/dist/{chunk-DHOVQ2TW.js → chunk-WUFODWZV.js} +3 -3
- package/dist/{chunk-DHOVQ2TW.js.map → chunk-WUFODWZV.js.map} +1 -1
- package/dist/{chunk-FJBP3MRI.cjs → chunk-WUJ53PP7.cjs} +16 -3
- package/dist/chunk-WUJ53PP7.cjs.map +1 -0
- package/dist/chunk-YDOSWWE4.cjs +419 -0
- package/dist/chunk-YDOSWWE4.cjs.map +1 -0
- package/dist/constants/index.cjs +2 -2
- package/dist/constants/index.d.cts +13 -1
- package/dist/constants/index.d.ts +13 -1
- package/dist/constants/index.js +1 -1
- package/dist/createFetchClient-BHAsPDgF.d.cts +86 -0
- package/dist/createFetchClient-CFIwc6Lh.d.ts +86 -0
- package/dist/{createOpenapiFetchClient-BFmiJ9C5.d.cts → createOpenapiFetchClient-CduEua6F.d.cts} +1 -1
- package/dist/{createOpenapiFetchClient-6RX67Hws.d.ts → createOpenapiFetchClient-wLlVgp3k.d.ts} +1 -1
- package/dist/dataScience/index.cjs +6 -5
- package/dist/dataScience/index.d.cts +7 -5
- package/dist/dataScience/index.d.ts +7 -5
- package/dist/dataScience/index.js +4 -3
- package/dist/dataScience/types.d.cts +2172 -2
- package/dist/dataScience/types.d.ts +2172 -2
- package/dist/domain/permissions/index.cjs +3 -3
- package/dist/domain/permissions/index.d.cts +5 -4
- package/dist/domain/permissions/index.d.ts +5 -4
- package/dist/domain/permissions/index.js +1 -1
- package/dist/editor/index.cjs +4 -4
- package/dist/editor/index.d.cts +5 -2
- package/dist/editor/index.d.ts +5 -2
- package/dist/editor/index.js +3 -3
- package/dist/editor/types.d.cts +2 -2
- package/dist/editor/types.d.ts +2 -2
- package/dist/encryption/index.cjs +3 -3
- package/dist/encryption/index.d.cts +5 -3
- package/dist/encryption/index.d.ts +5 -3
- package/dist/encryption/index.js +2 -2
- package/dist/encryption/types.d.cts +4 -3
- package/dist/encryption/types.d.ts +4 -3
- package/dist/import/index.cjs +4 -4
- package/dist/import/index.d.cts +5 -2
- package/dist/import/index.d.ts +5 -2
- package/dist/import/index.js +3 -3
- package/dist/index.cjs +211 -127
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +934 -457
- package/dist/index.d.ts +934 -457
- package/dist/index.js +95 -44
- package/dist/index.js.map +1 -1
- package/dist/management/index.cjs +5 -5
- package/dist/management/index.d.cts +60 -67
- package/dist/management/index.d.ts +60 -67
- package/dist/management/index.js +3 -3
- package/dist/management/types.d.cts +3 -3
- package/dist/management/types.d.ts +3 -3
- package/dist/metastore/index.cjs +4 -4
- package/dist/metastore/index.d.cts +5 -6
- package/dist/metastore/index.d.ts +5 -6
- package/dist/metastore/index.js +3 -3
- package/dist/metastore/types.d.cts +2 -2
- package/dist/metastore/types.d.ts +2 -2
- package/dist/notifications/index.cjs +5 -5
- package/dist/notifications/index.d.cts +3 -2
- package/dist/notifications/index.d.ts +3 -2
- package/dist/notifications/index.js +4 -4
- package/dist/notifications/types.d.cts +2 -2
- package/dist/notifications/types.d.ts +2 -2
- package/dist/oauth/index.cjs +4 -4
- package/dist/oauth/index.d.cts +2 -1
- package/dist/oauth/index.d.ts +2 -1
- package/dist/oauth/index.js +3 -3
- package/dist/oauth/types.d.cts +1 -1
- package/dist/oauth/types.d.ts +1 -1
- package/dist/omnisearch/index.cjs +14 -0
- package/dist/omnisearch/index.cjs.map +1 -0
- package/dist/omnisearch/index.d.cts +32 -0
- package/dist/omnisearch/index.d.ts +32 -0
- package/dist/omnisearch/index.js +5 -0
- package/dist/omnisearch/index.js.map +1 -0
- package/dist/omnisearch/types.cjs +4 -0
- package/dist/omnisearch/types.cjs.map +1 -0
- package/dist/omnisearch/types.d.cts +3 -0
- package/dist/omnisearch/types.d.ts +3 -0
- package/dist/omnisearch/types.js +3 -0
- package/dist/omnisearch/types.js.map +1 -0
- package/dist/{project-CXqPYo4T.d.ts → project-Dmr-zrQG.d.ts} +2 -2
- package/dist/{project-CZPvcxRW.d.cts → project-DstzWVMN.d.cts} +2 -2
- package/dist/queryService/index.cjs +4 -4
- package/dist/queryService/index.d.cts +3 -2
- package/dist/queryService/index.d.ts +3 -2
- package/dist/queryService/index.js +3 -3
- package/dist/queryService/types.d.cts +2 -2
- package/dist/queryService/types.d.ts +2 -2
- package/dist/queue/index.cjs +4 -4
- package/dist/queue/index.d.cts +8 -2
- package/dist/queue/index.d.ts +8 -2
- package/dist/queue/index.js +3 -3
- package/dist/queue/types.d.cts +2 -2
- package/dist/queue/types.d.ts +2 -2
- package/dist/scheduler/index.cjs +5 -5
- package/dist/scheduler/index.d.cts +2 -1
- package/dist/scheduler/index.d.ts +2 -1
- package/dist/scheduler/index.js +4 -4
- package/dist/scheduler/types.d.cts +3 -3
- package/dist/scheduler/types.d.ts +3 -3
- package/dist/sdk/configurations/index.cjs +3 -3
- package/dist/sdk/configurations/index.d.cts +7 -6
- package/dist/sdk/configurations/index.d.ts +7 -6
- package/dist/sdk/configurations/index.js +2 -2
- package/dist/sdk/queryService/index.cjs +16 -0
- package/dist/sdk/queryService/index.cjs.map +1 -0
- package/dist/sdk/queryService/index.d.cts +35 -0
- package/dist/sdk/queryService/index.d.ts +35 -0
- package/dist/sdk/queryService/index.js +7 -0
- package/dist/sdk/queryService/index.js.map +1 -0
- package/dist/sdk/semanticLayer/index.cjs +18 -14
- package/dist/sdk/semanticLayer/index.d.cts +25 -10
- package/dist/sdk/semanticLayer/index.d.ts +25 -10
- package/dist/sdk/semanticLayer/index.js +2 -2
- package/dist/sdk/semanticLayer/types.d.cts +25 -5
- package/dist/sdk/semanticLayer/types.d.ts +25 -5
- package/dist/sdk/storage/index.cjs +12 -11
- package/dist/sdk/storage/index.d.cts +7 -6
- package/dist/sdk/storage/index.d.ts +7 -6
- package/dist/sdk/storage/index.js +2 -1
- package/dist/sdk/tag/index.cjs +3 -3
- package/dist/sdk/tag/index.d.cts +3 -3
- package/dist/sdk/tag/index.d.ts +3 -3
- package/dist/sdk/tag/index.js +2 -2
- package/dist/sdk/tag/types.d.cts +10 -4
- package/dist/sdk/tag/types.d.ts +10 -4
- package/dist/sdk/vault/index.cjs +8 -8
- package/dist/sdk/vault/index.d.cts +5 -4
- package/dist/sdk/vault/index.d.ts +5 -4
- package/dist/sdk/vault/index.js +2 -2
- package/dist/status/index.cjs +2 -2
- package/dist/status/index.js +1 -1
- package/dist/storage/index.cjs +50 -12
- package/dist/storage/index.d.cts +17 -36
- package/dist/storage/index.d.ts +17 -36
- package/dist/storage/index.js +7 -5
- package/dist/storage/types.d.cts +720 -425
- package/dist/storage/types.d.ts +720 -425
- package/dist/{storageClient-Dkcg7hKa.d.cts → storageClient-BAid0vi2.d.cts} +478 -247
- package/dist/{storageClient-Cd4jVt58.d.ts → storageClient-BX50Attd.d.ts} +478 -247
- package/dist/{storageSdk-L6NOdgSJ.d.ts → storageSdk-BS5982c_.d.cts} +22 -15
- package/dist/{storageSdk-15_Fbucc.d.cts → storageSdk-BeJcnEIO.d.ts} +22 -15
- package/dist/stream/index.cjs +4 -4
- package/dist/stream/index.d.cts +3 -2
- package/dist/stream/index.d.ts +3 -2
- package/dist/stream/index.js +3 -3
- package/dist/stream/types.d.cts +2 -2
- package/dist/stream/types.d.ts +2 -2
- package/dist/syncActions/index.cjs +6 -5
- package/dist/syncActions/index.d.cts +31 -76
- package/dist/syncActions/index.d.ts +31 -76
- package/dist/syncActions/index.js +5 -4
- package/dist/syncActions/types.d.cts +334 -18
- package/dist/syncActions/types.d.ts +334 -18
- package/dist/telemetry/index.cjs +4 -4
- package/dist/telemetry/index.js +3 -3
- package/dist/{types-DbAO-Tgk.d.ts → types-BALUbGA5.d.ts} +10 -2
- package/dist/{types-B30y9Lhc.d.ts → types-BCBF_5cU.d.cts} +186 -4
- package/dist/{types-B-vmDlWB.d.cts → types-BPKQRahf.d.cts} +3 -3
- package/dist/types-BcaALDYY.d.cts +2130 -0
- package/dist/{types-BfuVN8Pk.d.cts → types-Bom93Zx2.d.cts} +3 -3
- package/dist/types-Bp8d9PJf.d.cts +607 -0
- package/dist/types-BsejtGjZ.d.ts +2130 -0
- package/dist/{types-DeoA45gz.d.cts → types-BuEkMmKT.d.ts} +491 -308
- package/dist/{types-BqC3U0k0.d.cts → types-C5DdOzx8.d.cts} +1 -1
- package/dist/{types-D-MuJHwl.d.cts → types-CFeOCzzg.d.cts} +3 -2
- package/dist/{types-DpUcInCX.d.ts → types-COti0FGo.d.ts} +3 -3
- package/dist/{types-Dkipk6NN.d.ts → types-C_jxWM7A.d.ts} +1 -1
- package/dist/{types-CM1zHzgm.d.ts → types-Cffam0Nw.d.ts} +856 -36
- package/dist/{types-BieLFMW1.d.cts → types-CfzHhZVG.d.ts} +3 -3
- package/dist/{types-DYnHIm7m.d.cts → types-CniF_D1P.d.cts} +3 -3
- package/dist/{types-BEnE7LHB.d.cts → types-CwAYn1EJ.d.cts} +10 -2
- package/dist/{types-DgSyBwP3.d.cts → types-CxAH36ip.d.cts} +3 -3
- package/dist/{types-DwMezEHT.d.ts → types-D2qGShlS.d.ts} +15 -3
- package/dist/{types-CSZoV4lM.d.cts → types-D6dnnju2.d.ts} +186 -4
- package/dist/{types-CrLjE5xf.d.ts → types-DM1glEQI.d.ts} +3 -3
- package/dist/{types-Hj1CaKtV.d.ts → types-DNyZ0z3L.d.cts} +491 -308
- package/dist/types-DOc5_aYZ.d.ts +607 -0
- package/dist/{types-DHXZZKb3.d.ts → types-Dpwb4dD0.d.ts} +3 -3
- package/dist/{types-YzkNUuYo.d.ts → types-DrGnvgkB.d.ts} +3 -3
- package/dist/{types-00IaLn3S.d.ts → types-EZBBpiFU.d.ts} +695 -82
- package/dist/{types-BX1xr4CX.d.cts → types-Y1ynT2PH.d.cts} +15 -3
- package/dist/{types-sVyfECai.d.cts → types-cxk-0ftN.d.cts} +695 -82
- package/dist/{types-DeS-oVdn.d.ts → types-ebolWqn1.d.ts} +3 -2
- package/dist/{types-gcShAmmi.d.cts → types-f8dUjMX4.d.cts} +1 -1
- package/dist/{types-gcShAmmi.d.ts → types-f8dUjMX4.d.ts} +1 -1
- package/dist/{types-CiJ5ULtS.d.ts → types-nt7I4XNc.d.cts} +3 -3
- package/dist/{types-Cgh3jqrV.d.cts → types-qvle4Ydu.d.cts} +856 -36
- package/dist/vault/index.cjs +4 -4
- package/dist/vault/index.d.cts +2 -1
- package/dist/vault/index.d.ts +2 -1
- package/dist/vault/index.js +3 -3
- package/dist/vault/types.d.cts +3 -3
- package/dist/vault/types.d.ts +3 -3
- package/package.json +71 -3
- package/surface/ai.md +1 -0
- package/surface/apps.md +32 -0
- package/surface/auth.md +6 -4
- package/surface/chat.md +1 -0
- package/surface/dataScience.md +1 -0
- package/surface/editor.md +1 -0
- package/surface/encryption.md +1 -0
- package/surface/import.md +1 -0
- package/surface/kaiAgent.md +1 -0
- package/surface/management.md +17 -16
- package/surface/metastore.md +2 -1
- package/surface/notifications.md +1 -0
- package/surface/oauth.md +1 -0
- package/surface/omnisearch.md +9 -0
- package/surface/queryService.md +1 -0
- package/surface/queue.md +7 -6
- package/surface/scheduler.md +1 -0
- package/surface/sdk.md +16 -16
- package/surface/storage.md +119 -83
- package/surface/stream.md +1 -0
- package/surface/syncActions.md +13 -6
- package/surface/vault.md +1 -0
- package/dist/chunk-34GM6NXB.js.map +0 -1
- package/dist/chunk-3BFPNM2J.js.map +0 -1
- package/dist/chunk-3YWQQ3OG.cjs.map +0 -1
- package/dist/chunk-4VVF2PIX.js.map +0 -1
- package/dist/chunk-77LILJYX.js.map +0 -1
- package/dist/chunk-7R22VKV7.cjs.map +0 -1
- package/dist/chunk-7RO6PKZ4.cjs +0 -16
- package/dist/chunk-7YXL4FKN.cjs.map +0 -1
- package/dist/chunk-7Z4MU7ZB.js.map +0 -1
- package/dist/chunk-AFJGNBVM.cjs.map +0 -1
- package/dist/chunk-AVH6F5LB.js.map +0 -1
- package/dist/chunk-AXEANGGK.js +0 -226
- package/dist/chunk-AXEANGGK.js.map +0 -1
- package/dist/chunk-BR6WZE3O.cjs.map +0 -1
- package/dist/chunk-BZA3FGO6.js.map +0 -1
- package/dist/chunk-CV2JGHBN.js.map +0 -1
- package/dist/chunk-CWUQ6ZAO.cjs.map +0 -1
- package/dist/chunk-D4WOOKMI.js.map +0 -1
- package/dist/chunk-DRNOCC6W.cjs.map +0 -1
- package/dist/chunk-F6ZAYTBX.cjs.map +0 -1
- package/dist/chunk-FJBP3MRI.cjs.map +0 -1
- package/dist/chunk-FMS5PNM2.cjs.map +0 -1
- package/dist/chunk-G66EP527.js.map +0 -1
- package/dist/chunk-GF4XZK5N.cjs.map +0 -1
- package/dist/chunk-HMCZUHR7.js.map +0 -1
- package/dist/chunk-HTVJR5WS.cjs +0 -305
- package/dist/chunk-HTVJR5WS.cjs.map +0 -1
- package/dist/chunk-HY7J3OD3.cjs.map +0 -1
- package/dist/chunk-IAYPOSMM.cjs.map +0 -1
- package/dist/chunk-IDWGBCSB.cjs.map +0 -1
- package/dist/chunk-J3NLKXQ5.cjs.map +0 -1
- package/dist/chunk-KEFXOJD7.js.map +0 -1
- package/dist/chunk-KUYVBCUM.cjs.map +0 -1
- package/dist/chunk-L262THNK.cjs +0 -253
- package/dist/chunk-L262THNK.cjs.map +0 -1
- package/dist/chunk-LD3JERYP.js.map +0 -1
- package/dist/chunk-LIXSIM3H.cjs.map +0 -1
- package/dist/chunk-MMOAH3EH.cjs.map +0 -1
- package/dist/chunk-NVRVPWNY.js.map +0 -1
- package/dist/chunk-OUSPQ55W.js.map +0 -1
- package/dist/chunk-PPQF7LTS.cjs.map +0 -1
- package/dist/chunk-RVBGE2Z4.js.map +0 -1
- package/dist/chunk-S4JK7DKM.js.map +0 -1
- package/dist/chunk-SJZ66FD5.js.map +0 -1
- package/dist/chunk-T242YFMT.cjs.map +0 -1
- package/dist/chunk-UABYNGBZ.js.map +0 -1
- package/dist/chunk-UP5SEEYZ.js.map +0 -1
- package/dist/chunk-UQ5CACMW.js +0 -283
- package/dist/chunk-UQ5CACMW.js.map +0 -1
- package/dist/chunk-UWQUHP3T.cjs.map +0 -1
- package/dist/chunk-XHDYLUM4.js.map +0 -1
- package/dist/chunk-XIIER7QQ.js.map +0 -1
- package/dist/chunk-XKIENBIE.js.map +0 -1
- package/dist/chunk-Z3HZ4MP4.cjs.map +0 -1
- package/dist/utils-B_SOM1XR.d.ts +0 -3051
- package/dist/utils-DK7uJcmR.d.cts +0 -3051
package/dist/storage/types.d.ts
CHANGED
|
@@ -1,8 +1,67 @@
|
|
|
1
|
-
import { c as OpenapiQueryType,
|
|
2
|
-
import { p as paths, c as components } from '../types-
|
|
3
|
-
export { C as CreateTokenBody, b as CreateTokenResponse, P as ProjectId,
|
|
4
|
-
export { A as AdminRole
|
|
1
|
+
import { c as OpenapiQueryType, b as OpenapiReturnType, O as OpenapiBodyType, d as OpenapiPathType, A as ArrayElement } from '../types-f8dUjMX4.js';
|
|
2
|
+
import { p as paths, c as components } from '../types-EZBBpiFU.js';
|
|
3
|
+
export { C as CreateTokenBody, b as CreateTokenRequestSchema, d as CreateTokenResponse, P as ProjectId, e as ShareTokenBody, a as ShareTokenInput, f as ShareTokenRequestSchema, S as StorageToken, T as TokenListItem, g as UpdateTokenBody, U as UpdateTokenInput, h as UpdateTokenRequestSchema } from '../types-EZBBpiFU.js';
|
|
4
|
+
export { A as AdminRole } from '../adminRoles-BSUPLfNf.js';
|
|
5
|
+
export { B as Backend } from '../backends-UNp_e5y9.js';
|
|
5
6
|
|
|
7
|
+
type RegisterBucketSchemaBody = OpenapiBodyType<paths['/v2/storage/buckets/register']['post']>;
|
|
8
|
+
type RegisterBucketSchemaQuery = OpenapiQueryType<paths['/v2/storage/buckets/register']['post']>;
|
|
9
|
+
/**
|
|
10
|
+
* Body for `POST /v2/storage/buckets/register`. The generated schema stubs the request body, so it
|
|
11
|
+
* is hand-authored from the Storage API contract.
|
|
12
|
+
*/
|
|
13
|
+
type RegisterBucketBody = {
|
|
14
|
+
name: string;
|
|
15
|
+
/** Snowflake: `['database', 'schema']`; BigQuery: `['projectId', 'location', 'exchanger', 'listing']`. */
|
|
16
|
+
path: string[];
|
|
17
|
+
stage?: BucketStage;
|
|
18
|
+
description?: string;
|
|
19
|
+
backend?: 'snowflake' | 'bigquery';
|
|
20
|
+
displayName?: string;
|
|
21
|
+
isSnowflakeSharedDatabase?: boolean;
|
|
22
|
+
};
|
|
23
|
+
/** Markdown guide returned by `GET /v2/storage/buckets/register-guide`. */
|
|
24
|
+
type BucketRegistrationGuide = OpenapiReturnType<paths['/v2/storage/buckets/register-guide']['get']>;
|
|
25
|
+
type BucketRegistrationGuideSchemaQuery = OpenapiQueryType<paths['/v2/storage/buckets/register-guide']['get']>;
|
|
26
|
+
/**
|
|
27
|
+
* Query for `GET /v2/storage/buckets/register-guide`.
|
|
28
|
+
*
|
|
29
|
+
* The spec names the repeatable segment `path[]`, brackets and all, which would put a bracketed key
|
|
30
|
+
* in every call site. Only that one field is remapped: `queryArrayFormat: 'brackets'` builds the
|
|
31
|
+
* same wire format from a clean `path`, which is how `files` and `jobs` spell their repeatable
|
|
32
|
+
* fields — and how `RegisterBucketBody` right below already spells this one.
|
|
33
|
+
*/
|
|
34
|
+
type BucketRegistrationGuideQuery = Omit<BucketRegistrationGuideSchemaQuery, 'path[]'> & {
|
|
35
|
+
path: string[];
|
|
36
|
+
};
|
|
37
|
+
/** Optional query for `PUT /v2/storage/buckets/{bucketId}/refresh`. */
|
|
38
|
+
type RefreshExternalBucketQuery = {
|
|
39
|
+
force?: boolean;
|
|
40
|
+
lastChangeDate?: string;
|
|
41
|
+
};
|
|
42
|
+
type RefreshExternalBucketInput = {
|
|
43
|
+
bucketId: string;
|
|
44
|
+
} & RefreshExternalBucketQuery;
|
|
45
|
+
type CreateScheduledRefreshPath = {
|
|
46
|
+
branchId: string;
|
|
47
|
+
bucketId: string;
|
|
48
|
+
};
|
|
49
|
+
type CreateScheduledRefreshBody = {
|
|
50
|
+
cronExpression: string;
|
|
51
|
+
};
|
|
52
|
+
type CreateScheduledRefreshInput = CreateScheduledRefreshPath & CreateScheduledRefreshBody;
|
|
53
|
+
type ScheduledTask = {
|
|
54
|
+
uuid: string;
|
|
55
|
+
job: string;
|
|
56
|
+
relatedEntity: string;
|
|
57
|
+
relatedId: string;
|
|
58
|
+
cronExpression: string;
|
|
59
|
+
createdAt: string;
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
type GetBucketsSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/buckets']['get']>;
|
|
63
|
+
type CreateBucketSchemaBody = OpenapiBodyType<paths['/v2/storage/buckets']['post']>;
|
|
64
|
+
type UpdateBucketOwnerSchemaBody = OpenapiBodyType<paths['/v2/storage/buckets/{bucketId}/owner']['post']>;
|
|
6
65
|
type BucketStage = 'in' | 'out';
|
|
7
66
|
type BucketBackend = 'snowflake' | 'redshift' | 'bigquery' | 'teradata';
|
|
8
67
|
type Bucket = {
|
|
@@ -125,8 +184,11 @@ type BucketDetail = Bucket & {
|
|
|
125
184
|
scheduledTasks?: ScheduledTask[];
|
|
126
185
|
tables: unknown[];
|
|
127
186
|
};
|
|
187
|
+
type GetBucketsInput = {
|
|
188
|
+
branchId: string;
|
|
189
|
+
} & GetBucketsQuery;
|
|
128
190
|
type GetBucketsQuery = {
|
|
129
|
-
include?: ('attributes' | 'metadata')[];
|
|
191
|
+
include?: ('attributes' | 'metadata' | 'linkedBuckets')[];
|
|
130
192
|
};
|
|
131
193
|
type GetBucketQuery = {
|
|
132
194
|
include?: ('columns' | 'metadata' | 'columnMetadata' | 'sourceMetadata')[];
|
|
@@ -149,64 +211,15 @@ type CreateBucketBody = {
|
|
|
149
211
|
type UpdateBucketBody = {
|
|
150
212
|
displayName?: string;
|
|
151
213
|
description?: string;
|
|
214
|
+
color?: string;
|
|
152
215
|
};
|
|
153
|
-
type
|
|
154
|
-
branchId: string;
|
|
216
|
+
type UpdateBucketInput = {
|
|
155
217
|
bucketId: string;
|
|
156
|
-
};
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
};
|
|
160
|
-
type ScheduledTask = {
|
|
161
|
-
uuid: string;
|
|
162
|
-
job: string;
|
|
163
|
-
relatedEntity: string;
|
|
164
|
-
relatedId: string;
|
|
165
|
-
cronExpression: string;
|
|
166
|
-
createdAt: string;
|
|
167
|
-
};
|
|
168
|
-
type Subscriber = {
|
|
169
|
-
type: 'user' | 'group';
|
|
170
|
-
email: string;
|
|
171
|
-
};
|
|
172
|
-
type BucketListing = {
|
|
173
|
-
bucketId: string;
|
|
174
|
-
name: string;
|
|
175
|
-
description: string | null;
|
|
176
|
-
listingId: string;
|
|
177
|
-
subscribers: Subscriber[];
|
|
178
|
-
createdAt: string;
|
|
179
|
-
};
|
|
180
|
-
type RawBucketListingResponse = {
|
|
181
|
-
name: string;
|
|
182
|
-
description: string | null;
|
|
183
|
-
bigquery: {
|
|
184
|
-
listingId: string;
|
|
185
|
-
subscribers: string[];
|
|
186
|
-
};
|
|
187
|
-
createdAt: string;
|
|
188
|
-
};
|
|
189
|
-
type RawBucketListingRow = RawBucketListingResponse & {
|
|
218
|
+
} & UpdateBucketBody;
|
|
219
|
+
/** `force` deletes every table in the bucket before removing it. */
|
|
220
|
+
type DeleteBucketAsyncInput = {
|
|
190
221
|
bucketId: string;
|
|
191
|
-
|
|
192
|
-
type CreateBucketListingInput = {
|
|
193
|
-
name: string;
|
|
194
|
-
description: string | null;
|
|
195
|
-
listingId: string;
|
|
196
|
-
subscribers: Subscriber[];
|
|
197
|
-
};
|
|
198
|
-
type UpdateBucketListingInput = {
|
|
199
|
-
name?: string;
|
|
200
|
-
description?: string | null;
|
|
201
|
-
subscribers?: Subscriber[];
|
|
202
|
-
};
|
|
203
|
-
/** Body for `POST /v2/storage/buckets/{bucketId}/share-to-projects`. */
|
|
204
|
-
type ShareBucketToProjectsBody = {
|
|
205
|
-
targetProjectIds: string[];
|
|
206
|
-
};
|
|
207
|
-
/** Body for `POST /v2/storage/buckets/{bucketId}/share-to-users` — target user IDs or e-mails. */
|
|
208
|
-
type ShareBucketToUsersBody = {
|
|
209
|
-
targetUsers: string[];
|
|
222
|
+
force?: boolean;
|
|
210
223
|
};
|
|
211
224
|
/**
|
|
212
225
|
* Body for `POST /v2/storage/buckets/{bucketId}/owner`. The generated schema stubs the request
|
|
@@ -217,144 +230,105 @@ type UpdateBucketOwnerBody = {
|
|
|
217
230
|
} | {
|
|
218
231
|
id: number;
|
|
219
232
|
};
|
|
233
|
+
type UpdateBucketOwnerInput = {
|
|
234
|
+
bucketId: string;
|
|
235
|
+
} & UpdateBucketOwnerBody;
|
|
236
|
+
/** Owner detail returned by `GET /v2/storage/branch/{branchId}/buckets/{bucketId}/owner`. */
|
|
237
|
+
type BucketOwner = OpenapiReturnType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/owner']['get']>;
|
|
238
|
+
/** Body for `POST /v2/storage/branch/{branchId}/buckets/{bucketId}/metadata`. */
|
|
239
|
+
type SaveBucketMetadataBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/metadata']['post']>;
|
|
240
|
+
/** Metadata items returned by `POST /v2/storage/branch/{branchId}/buckets/{bucketId}/metadata`. */
|
|
241
|
+
type BucketMetadata = OpenapiReturnType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/metadata']['post']>;
|
|
242
|
+
type SaveBucketMetadataInput = {
|
|
243
|
+
branchId: string;
|
|
244
|
+
bucketId: string;
|
|
245
|
+
} & SaveBucketMetadataBody;
|
|
246
|
+
type DeleteBucketMetadataInput = {
|
|
247
|
+
branchId: string;
|
|
248
|
+
bucketId: string;
|
|
249
|
+
metadataId: MetadataId;
|
|
250
|
+
};
|
|
251
|
+
|
|
252
|
+
type LinkBucketSchemaBody = OpenapiBodyType<paths['/v2/storage/buckets']['post']>;
|
|
220
253
|
/**
|
|
221
|
-
*
|
|
222
|
-
*
|
|
254
|
+
* The `LinkBucketRequest` arm of the create-or-link union `POST /v2/storage/buckets` accepts, picked
|
|
255
|
+
* by the discriminating field rather than hand-authored so the stage enum stays spec-derived.
|
|
223
256
|
*/
|
|
224
|
-
type
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
257
|
+
type LinkBucketBody = Extract<LinkBucketSchemaBody, {
|
|
258
|
+
sourceBucketId: string;
|
|
259
|
+
}>;
|
|
260
|
+
type ShareBucketToOrganizationSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-organization']['post']>;
|
|
261
|
+
type ShareBucketToOrganizationInput = OpenapiPathType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-organization']['post']>;
|
|
262
|
+
type ShareBucketToOrganizationProjectSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-organization-project']['post']>;
|
|
263
|
+
type ShareBucketToOrganizationProjectInput = OpenapiPathType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-organization-project']['post']>;
|
|
264
|
+
type ShareBucketToProjectsSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-projects']['post']>;
|
|
265
|
+
type ShareBucketToProjectsSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-projects']['post']>;
|
|
266
|
+
type ShareBucketToProjectsPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-projects']['post']>;
|
|
267
|
+
/** Body for `POST /v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-projects`. */
|
|
268
|
+
type ShareBucketToProjectsBody = {
|
|
269
|
+
targetProjectIds: number[];
|
|
233
270
|
};
|
|
234
|
-
|
|
235
|
-
type
|
|
236
|
-
|
|
237
|
-
|
|
271
|
+
type ShareBucketToProjectsInput = ShareBucketToProjectsPath & ShareBucketToProjectsBody;
|
|
272
|
+
type ShareBucketToUsersSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-users']['post']>;
|
|
273
|
+
type ShareBucketToUsersSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-users']['post']>;
|
|
274
|
+
type ShareBucketToUsersPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-users']['post']>;
|
|
275
|
+
/**
|
|
276
|
+
* Body for `POST /v2/storage/branch/{branchId}/buckets/{bucketId}/share-to-users` — admin ids, which
|
|
277
|
+
* the endpoint also accepts as e-mails.
|
|
278
|
+
*/
|
|
279
|
+
type ShareBucketToUsersBody = {
|
|
280
|
+
targetUsers: (number | string)[];
|
|
281
|
+
};
|
|
282
|
+
type ShareBucketToUsersInput = ShareBucketToUsersPath & ShareBucketToUsersBody;
|
|
283
|
+
type UnshareBucketSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share']['delete']>;
|
|
284
|
+
type UnshareBucketInput = OpenapiPathType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/share']['delete']>;
|
|
285
|
+
type ForceUnlinkBucketSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/links/{linkedProjectId}']['delete']>;
|
|
286
|
+
type ForceUnlinkBucketSchemaPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/links/{linkedProjectId}']['delete']>;
|
|
287
|
+
type ForceUnlinkBucketInput = {
|
|
288
|
+
branchId: string;
|
|
289
|
+
bucketId: string;
|
|
290
|
+
linkedProjectId: string;
|
|
238
291
|
};
|
|
239
|
-
/** Owner detail returned by `GET /v2/storage/branch/{branchId}/buckets/{bucketId}/owner`. */
|
|
240
|
-
type BucketOwner = OpenapiReturnType<paths['/v2/storage/branch/{branchId}/buckets/{bucketId}/owner']['get']>;
|
|
241
|
-
/** Markdown guide returned by `GET /v2/storage/buckets/register-guide`. */
|
|
242
|
-
type BucketRegistrationGuide = OpenapiReturnType<paths['/v2/storage/buckets/register-guide']['get']>;
|
|
243
|
-
/** Query for `GET /v2/storage/buckets/register-guide`. */
|
|
244
|
-
type BucketRegistrationGuideQuery = OpenapiQueryType<paths['/v2/storage/buckets/register-guide']['get']>;
|
|
245
|
-
/** Body for `POST /v2/storage/buckets/{bucketId}/metadata`. */
|
|
246
|
-
type SaveBucketMetadataBody = OpenapiBodyType<paths['/v2/storage/buckets/{bucketId}/metadata']['post']>;
|
|
247
|
-
/** Metadata items returned by `POST /v2/storage/buckets/{bucketId}/metadata`. */
|
|
248
|
-
type BucketMetadata = OpenapiReturnType<paths['/v2/storage/buckets/{bucketId}/metadata']['post']>;
|
|
249
292
|
/** Buckets shared with the current project, returned by `GET /v2/storage/shared-buckets`. */
|
|
250
293
|
type SharedBuckets = OpenapiReturnType<paths['/v2/storage/shared-buckets']['get']>;
|
|
251
294
|
|
|
252
|
-
|
|
253
|
-
type
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
/** Optional query for `DELETE /v2/storage/tables/{id}/columns/{column}`. */
|
|
266
|
-
type DeleteTableColumnQuery = {
|
|
267
|
-
force?: boolean;
|
|
268
|
-
};
|
|
269
|
-
/** Body for `POST /v2/storage/tables/{id}/primary-key`. */
|
|
270
|
-
type CreateTablePrimaryKeyBody = {
|
|
271
|
-
columns: string[];
|
|
272
|
-
/** Skip the duplicate-values check (Snowflake only). */
|
|
273
|
-
skipDuplicatesCheck?: boolean;
|
|
274
|
-
};
|
|
275
|
-
|
|
276
|
-
type EventType = 'info' | 'warn' | 'error' | 'success';
|
|
277
|
-
type CreateEventBody = {
|
|
278
|
-
component: string;
|
|
279
|
-
message: string;
|
|
280
|
-
type?: EventType;
|
|
281
|
-
results?: Record<string, unknown>;
|
|
282
|
-
params?: Record<string, unknown>;
|
|
283
|
-
duration?: number;
|
|
284
|
-
runId?: string;
|
|
285
|
-
configurationId?: string;
|
|
286
|
-
};
|
|
287
|
-
type GetEventsQuery = {
|
|
288
|
-
component?: string;
|
|
289
|
-
runId?: string;
|
|
290
|
-
configurationId?: string;
|
|
291
|
-
q?: string;
|
|
292
|
-
limit?: number;
|
|
293
|
-
offset?: number;
|
|
294
|
-
sinceId?: string | number;
|
|
295
|
-
maxId?: string | number;
|
|
296
|
-
};
|
|
297
|
-
type StorageEvent = {
|
|
298
|
-
id: string | number;
|
|
299
|
-
component: string;
|
|
300
|
-
message: string;
|
|
301
|
-
type: EventType;
|
|
302
|
-
runId?: string;
|
|
303
|
-
configurationId?: string;
|
|
304
|
-
results?: Record<string, unknown>;
|
|
305
|
-
params?: Record<string, unknown>;
|
|
306
|
-
duration?: number;
|
|
307
|
-
createdTime: string;
|
|
295
|
+
type CreateBucketListingPath = OpenapiPathType<paths['/v2/storage/buckets/{bucketId}/listing']['post']>;
|
|
296
|
+
type CreateBucketListingSchemaBody = OpenapiBodyType<paths['/v2/storage/buckets/{bucketId}/listing']['post']>;
|
|
297
|
+
type UpdateBucketListingPath = OpenapiPathType<paths['/v2/storage/buckets/{bucketId}/listing']['patch']>;
|
|
298
|
+
type UpdateBucketListingSchemaBody = OpenapiBodyType<paths['/v2/storage/buckets/{bucketId}/listing']['patch']>;
|
|
299
|
+
type BucketListingDetail = OpenapiReturnType<paths['/v2/storage/buckets/{bucketId}/listing']['get']>;
|
|
300
|
+
type ProjectBucketListing = ArrayElement<OpenapiReturnType<paths['/v2/storage/listings']['get']>>;
|
|
301
|
+
/**
|
|
302
|
+
* A listing subscriber, decoded from the `user:`/`group:`-prefixed IAM principal the API carries in
|
|
303
|
+
* `bigquery.subscribers`. Convert with `toBackendSubscribers` / `fromBackendSubscribers`.
|
|
304
|
+
*/
|
|
305
|
+
type Subscriber = {
|
|
306
|
+
type: 'user' | 'group';
|
|
307
|
+
email: string;
|
|
308
308
|
};
|
|
309
|
-
type
|
|
310
|
-
|
|
309
|
+
type CreateBucketListingBody = {
|
|
310
|
+
name: string;
|
|
311
|
+
description: string | null;
|
|
312
|
+
listingId: string;
|
|
313
|
+
subscribers: Subscriber[];
|
|
311
314
|
};
|
|
312
|
-
type
|
|
313
|
-
type
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
type GetBucketEventsInput = {
|
|
318
|
-
branchId: string;
|
|
319
|
-
bucketId: string;
|
|
320
|
-
} & GetObjectEventsQuery;
|
|
321
|
-
type TableEvent = {
|
|
322
|
-
uuid: string;
|
|
323
|
-
event: string;
|
|
324
|
-
component: string;
|
|
325
|
-
type: EventType;
|
|
326
|
-
message: string;
|
|
327
|
-
description?: string;
|
|
328
|
-
created: string;
|
|
329
|
-
runId?: string | null;
|
|
330
|
-
configurationId?: string | null;
|
|
331
|
-
objectId?: string | number;
|
|
332
|
-
objectName?: string;
|
|
333
|
-
objectType?: string;
|
|
334
|
-
idBranch?: number | null;
|
|
335
|
-
uri?: string;
|
|
336
|
-
attachments?: unknown[];
|
|
337
|
-
context?: {
|
|
338
|
-
remoteAddr: string | null;
|
|
339
|
-
httpReferer: string;
|
|
340
|
-
httpUserAgent: string;
|
|
341
|
-
apiVersion: string;
|
|
342
|
-
};
|
|
343
|
-
token?: {
|
|
344
|
-
id: number;
|
|
345
|
-
name: string;
|
|
346
|
-
};
|
|
347
|
-
params?: Record<string, unknown>;
|
|
348
|
-
results?: {
|
|
349
|
-
rowsCount?: number;
|
|
350
|
-
sizeBytes?: number;
|
|
351
|
-
};
|
|
352
|
-
performance?: {
|
|
353
|
-
importDuration?: number;
|
|
354
|
-
};
|
|
315
|
+
type CreateBucketListingInput = CreateBucketListingPath & CreateBucketListingBody;
|
|
316
|
+
type UpdateBucketListingBody = {
|
|
317
|
+
name?: string;
|
|
318
|
+
description?: string | null;
|
|
319
|
+
subscribers?: Subscriber[];
|
|
355
320
|
};
|
|
321
|
+
type UpdateBucketListingInput = UpdateBucketListingPath & UpdateBucketListingBody;
|
|
356
322
|
|
|
357
|
-
type
|
|
323
|
+
type GetTablesSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/tables']['get']>;
|
|
324
|
+
type GetDataPreviewSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/tables/{tableId}/data-preview']['get']>;
|
|
325
|
+
type DeleteTableRowsSchemaQuery = OpenapiQueryType<paths['/v2/storage/tables/{id}/rows']['delete']>;
|
|
326
|
+
type CreateTableAsyncSchemaBody = OpenapiBodyType<paths['/v2/storage/buckets/{id}/tables-async']['post']>;
|
|
327
|
+
type CreateTableDefinitionSchemaBody = OpenapiBodyType<paths['/v2/storage/buckets/{bucketId}/tables-definition']['post']>;
|
|
328
|
+
type TableImportAsyncBody = OpenapiBodyType<paths['/v2/storage/tables/{id}/import-async']['post']>;
|
|
329
|
+
type UpdateTableDefinitionSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/tables/{tableId}/definition']['put']>;
|
|
330
|
+
type SaveTableMetadataSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/tables/{id}/metadata']['post']>;
|
|
331
|
+
type TableMetadataResponse = OpenapiReturnType<paths['/v2/storage/branch/{branchId}/tables/{id}/metadata']['post']>;
|
|
358
332
|
type FilterOperator = 'eq' | 'ne' | 'gt' | 'lt' | 'ge' | 'le';
|
|
359
333
|
type DataType = 'INTEGER' | 'DOUBLE' | 'BIGINT' | 'REAL' | 'DECIMAL';
|
|
360
334
|
type WhereFilters = {
|
|
@@ -382,14 +356,6 @@ type GetDataPreviewQuery = {
|
|
|
382
356
|
whereFilters?: WhereFilters[];
|
|
383
357
|
orderBy?: OrderBy[];
|
|
384
358
|
};
|
|
385
|
-
type GetDataPreviewInput = {
|
|
386
|
-
branchId: string;
|
|
387
|
-
tableId: string;
|
|
388
|
-
} & GetDataPreviewQuery;
|
|
389
|
-
type GetTableInput = {
|
|
390
|
-
branchId: string;
|
|
391
|
-
tableId: string;
|
|
392
|
-
};
|
|
393
359
|
type GetTablesQuery = {
|
|
394
360
|
include?: ('attributes' | 'buckets' | 'columns' | 'metadata' | 'columnMetadata' | 'bucketsWithoutSourceTables')[];
|
|
395
361
|
};
|
|
@@ -537,7 +503,7 @@ type CreateTableAsyncFromFileBody = {
|
|
|
537
503
|
* from the generated schema with the generated file variant excluded, so new
|
|
538
504
|
* request-body variants in the OpenAPI schema are picked up automatically.
|
|
539
505
|
*/
|
|
540
|
-
type CreateTableAsyncBody = CreateTableAsyncFromFileBody | Exclude<
|
|
506
|
+
type CreateTableAsyncBody = CreateTableAsyncFromFileBody | Exclude<CreateTableAsyncSchemaBody, components['schemas']['CreateTableAsyncFromFileRequest']>;
|
|
541
507
|
/**
|
|
542
508
|
* Body for `POST /v2/storage/buckets/{bucketId}/tables-definition` — creates a typed
|
|
543
509
|
* table from an explicit column definition (no data). Returns a `tableDefinitionCreate` storage job.
|
|
@@ -554,20 +520,15 @@ type CreateTableDefinitionBody = {
|
|
|
554
520
|
};
|
|
555
521
|
}[];
|
|
556
522
|
};
|
|
557
|
-
type
|
|
558
|
-
type UpdateTableDefinitionPath = {
|
|
559
|
-
branchId: string;
|
|
560
|
-
tableId: string;
|
|
561
|
-
};
|
|
562
|
-
/**
|
|
563
|
-
* Body for `PUT /v2/storage/branch/{branchId}/tables/{tableId}/definition`.
|
|
564
|
-
*
|
|
565
|
-
* Server-side validation limits: `description` ≤ 16,384 chars (table),
|
|
566
|
-
* each `columns[].description` ≤ 1,024 chars.
|
|
567
|
-
*/
|
|
568
|
-
type UpdateTableDefinitionBody = {
|
|
523
|
+
type TableDefinitionPatchFields = {
|
|
569
524
|
displayName: string;
|
|
570
|
-
description
|
|
525
|
+
description: string | null;
|
|
526
|
+
/**
|
|
527
|
+
* `false` marks the description user-authored, which stops Output Mapping from
|
|
528
|
+
* overwriting it on the next component run. Tables default to `true`
|
|
529
|
+
* (system-managed).
|
|
530
|
+
*/
|
|
531
|
+
isDescriptionSystemManaged: boolean;
|
|
571
532
|
columns: {
|
|
572
533
|
name: string;
|
|
573
534
|
length?: string;
|
|
@@ -576,10 +537,21 @@ type UpdateTableDefinitionBody = {
|
|
|
576
537
|
description?: string | null;
|
|
577
538
|
}[];
|
|
578
539
|
};
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
540
|
+
/**
|
|
541
|
+
* Body for `PUT /v2/storage/branch/{branchId}/tables/{tableId}/definition`.
|
|
542
|
+
*
|
|
543
|
+
* Every field is a patch — omitted keys are left untouched — and the server
|
|
544
|
+
* rejects a body carrying none of them, so the type requires at least one:
|
|
545
|
+
* it distributes into one variant per field, each pinning that field required
|
|
546
|
+
* and leaving the rest optional. `columns` is positive-only: columns absent from
|
|
547
|
+
* it keep their current definition. Server-side validation caps `description`
|
|
548
|
+
* and each `columns[].description` at 65,535 chars; the value is stored in full
|
|
549
|
+
* and truncated only where the backend is narrower (BigQuery 1,024 / Snowflake
|
|
550
|
+
* 16,384).
|
|
551
|
+
*/
|
|
552
|
+
type UpdateTableDefinitionBody = {
|
|
553
|
+
[K in keyof TableDefinitionPatchFields]: Required<Pick<TableDefinitionPatchFields, K>> & Partial<Omit<TableDefinitionPatchFields, K>>;
|
|
554
|
+
}[keyof TableDefinitionPatchFields];
|
|
583
555
|
/** Body for `PUT /v2/storage/tables/{id}` — synchronous table update (display name). */
|
|
584
556
|
type UpdateTableBody = {
|
|
585
557
|
displayName?: string;
|
|
@@ -601,39 +573,188 @@ type SetAliasTableFilterBody = {
|
|
|
601
573
|
values: string[];
|
|
602
574
|
operator?: 'eq' | 'ne';
|
|
603
575
|
};
|
|
604
|
-
type
|
|
605
|
-
|
|
576
|
+
type SaveMetadataBody = {
|
|
577
|
+
provider: string;
|
|
578
|
+
metadata: {
|
|
579
|
+
key: string;
|
|
580
|
+
value: string;
|
|
581
|
+
}[];
|
|
582
|
+
};
|
|
583
|
+
type GetTablesInput = {
|
|
606
584
|
branchId: string;
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
type GetSnapshotsQuery = NonNullable<OpenapiQueryType<TableSnapshotsOperations['get']>>;
|
|
610
|
-
type LoadTableSnapshotsInput = {
|
|
585
|
+
} & GetTablesQuery;
|
|
586
|
+
type GetTableInput = {
|
|
611
587
|
branchId: string;
|
|
612
588
|
tableId: string;
|
|
613
|
-
}
|
|
589
|
+
};
|
|
614
590
|
/**
|
|
615
|
-
*
|
|
616
|
-
*
|
|
591
|
+
* Input for `POST /v2/storage/branch/{branchId}/tables/{id}/pull`. The branch is the *target* — the
|
|
592
|
+
* table is pulled from the default branch into it — so pass the dev branch you are pulling into; a
|
|
593
|
+
* pull into the default branch is a no-op.
|
|
617
594
|
*/
|
|
618
|
-
type
|
|
619
|
-
|
|
620
|
-
|
|
595
|
+
type PullTableAsyncInput = {
|
|
596
|
+
branchId?: string;
|
|
597
|
+
tableId: string;
|
|
598
|
+
};
|
|
599
|
+
type GetDataPreviewInput = {
|
|
600
|
+
branchId: string;
|
|
601
|
+
tableId: string;
|
|
602
|
+
} & GetDataPreviewQuery;
|
|
603
|
+
type DeleteTableRowsInput = {
|
|
604
|
+
tableId: string;
|
|
605
|
+
} & DeleteTableRows;
|
|
606
|
+
type CreateTableAsyncInput = {
|
|
607
|
+
bucketId: string;
|
|
608
|
+
} & CreateTableAsyncBody;
|
|
609
|
+
type CreateTableDefinitionInput = {
|
|
610
|
+
bucketId: string;
|
|
611
|
+
} & CreateTableDefinitionBody;
|
|
612
|
+
type CreateAliasTableInput = {
|
|
613
|
+
bucketId: string;
|
|
614
|
+
} & CreateAliasTableBody;
|
|
615
|
+
type SetAliasTableFilterInput = {
|
|
616
|
+
tableId: string;
|
|
617
|
+
} & SetAliasTableFilterBody;
|
|
618
|
+
type UpdateTableInput = {
|
|
619
|
+
tableId: string;
|
|
620
|
+
} & UpdateTableBody;
|
|
621
|
+
type ExportAsyncInput = {
|
|
622
|
+
tableId: string;
|
|
623
|
+
} & TableExportAsyncBody;
|
|
624
|
+
type ImportAsyncInput = {
|
|
625
|
+
tableId: string;
|
|
626
|
+
} & TableImportAsyncBody;
|
|
627
|
+
type UpdateTableDefinitionInput = {
|
|
628
|
+
branchId?: string;
|
|
629
|
+
tableId: string;
|
|
630
|
+
} & UpdateTableDefinitionBody;
|
|
631
|
+
type SaveTableMetadataInput = {
|
|
632
|
+
branchId: string;
|
|
633
|
+
tableId: string;
|
|
634
|
+
} & SaveMetadataBody;
|
|
635
|
+
type DeleteTableMetadataInput = {
|
|
636
|
+
branchId: string;
|
|
637
|
+
tableId: string;
|
|
638
|
+
metadataId: MetadataId;
|
|
639
|
+
};
|
|
640
|
+
|
|
641
|
+
type AddTableColumnSchemaBody = OpenapiBodyType<paths['/v2/storage/tables/{id}/columns']['post']>;
|
|
642
|
+
type CreateTablePrimaryKeySchemaBody = OpenapiBodyType<paths['/v2/storage/tables/{tableId}/primary-key']['post']>;
|
|
643
|
+
type AddTableColumnPath = OpenapiPathType<paths['/v2/storage/tables/{id}/columns']['post']>;
|
|
644
|
+
type DeleteTableColumnPath = OpenapiPathType<paths['/v2/storage/tables/{tableId}/columns/{columnName}']['delete']>;
|
|
645
|
+
type DeleteTableColumnQuery = NonNullable<OpenapiQueryType<paths['/v2/storage/tables/{tableId}/columns/{columnName}']['delete']>>;
|
|
646
|
+
type CreateTablePrimaryKeyPath = OpenapiPathType<paths['/v2/storage/tables/{tableId}/primary-key']['post']>;
|
|
647
|
+
/** Body for `POST /v2/storage/tables/{id}/columns`. */
|
|
648
|
+
type AddTableColumnBody = {
|
|
649
|
+
name: string;
|
|
650
|
+
/** Column settings for typed tables. */
|
|
651
|
+
definition?: {
|
|
652
|
+
type: string;
|
|
653
|
+
length?: string;
|
|
654
|
+
nullable?: boolean;
|
|
655
|
+
default?: string;
|
|
656
|
+
};
|
|
657
|
+
/** Base datatype for non-typed tables (e.g. `STRING`, `INTEGER`, `BOOLEAN`). */
|
|
658
|
+
basetype?: string;
|
|
659
|
+
};
|
|
660
|
+
/** Body for `POST /v2/storage/tables/{id}/primary-key`. */
|
|
661
|
+
type CreateTablePrimaryKeyBody = {
|
|
662
|
+
columns: string[];
|
|
663
|
+
/** Skip the duplicate-values check (Snowflake only). */
|
|
664
|
+
skipDuplicatesCheck?: boolean;
|
|
665
|
+
};
|
|
666
|
+
type AddTableColumnInput = AddTableColumnPath & AddTableColumnBody;
|
|
667
|
+
type DeleteTableColumnInput = DeleteTableColumnPath & DeleteTableColumnQuery;
|
|
668
|
+
type CreateTablePrimaryKeyInput = CreateTablePrimaryKeyPath & CreateTablePrimaryKeyBody;
|
|
669
|
+
type SaveColumnMetadataInput = {
|
|
670
|
+
branchId: string;
|
|
671
|
+
columnId: string;
|
|
672
|
+
} & SaveMetadataBody;
|
|
673
|
+
type DeleteColumnMetadataInput = {
|
|
674
|
+
branchId: string;
|
|
675
|
+
columnId: string;
|
|
676
|
+
metadataId: MetadataId;
|
|
677
|
+
};
|
|
678
|
+
|
|
679
|
+
type EventType = 'info' | 'warn' | 'error' | 'success';
|
|
680
|
+
type CreateEventBody = {
|
|
681
|
+
component: string;
|
|
682
|
+
message: string;
|
|
683
|
+
type?: EventType;
|
|
684
|
+
results?: Record<string, unknown>;
|
|
685
|
+
params?: Record<string, unknown>;
|
|
686
|
+
duration?: number;
|
|
687
|
+
runId?: string;
|
|
688
|
+
configurationId?: string;
|
|
689
|
+
};
|
|
690
|
+
type GetEventsQuery = {
|
|
691
|
+
component?: string;
|
|
692
|
+
runId?: string;
|
|
693
|
+
configurationId?: string;
|
|
694
|
+
q?: string;
|
|
695
|
+
limit?: number;
|
|
696
|
+
offset?: number;
|
|
697
|
+
sinceId?: string | number;
|
|
698
|
+
maxId?: string | number;
|
|
699
|
+
};
|
|
700
|
+
type StorageEvent = {
|
|
701
|
+
id: string | number;
|
|
702
|
+
component: string;
|
|
703
|
+
message: string;
|
|
704
|
+
type: EventType;
|
|
705
|
+
runId?: string;
|
|
706
|
+
configurationId?: string;
|
|
707
|
+
results?: Record<string, unknown>;
|
|
708
|
+
params?: Record<string, unknown>;
|
|
709
|
+
duration?: number;
|
|
710
|
+
createdTime: string;
|
|
711
|
+
};
|
|
712
|
+
type EventPath = {
|
|
713
|
+
eventId: string | number;
|
|
714
|
+
};
|
|
715
|
+
type GetObjectEventsQuery = NonNullable<OpenapiQueryType<paths['/v2/storage/branch/{branchId}/tables/{tableId}/events']['get']>>;
|
|
716
|
+
type GetTableEventsInput = {
|
|
717
|
+
branchId: string;
|
|
718
|
+
tableId: string;
|
|
719
|
+
} & GetObjectEventsQuery;
|
|
720
|
+
type GetBucketEventsInput = {
|
|
721
|
+
branchId: string;
|
|
722
|
+
bucketId: string;
|
|
723
|
+
} & GetObjectEventsQuery;
|
|
724
|
+
type TableEvent = {
|
|
725
|
+
uuid: string;
|
|
726
|
+
event: string;
|
|
727
|
+
component: string;
|
|
728
|
+
type: EventType;
|
|
729
|
+
message: string;
|
|
730
|
+
description?: string;
|
|
621
731
|
created: string;
|
|
622
|
-
|
|
732
|
+
runId?: string | null;
|
|
733
|
+
configurationId?: string | null;
|
|
734
|
+
objectId?: string | number;
|
|
735
|
+
objectName?: string;
|
|
736
|
+
objectType?: string;
|
|
737
|
+
idBranch?: number | null;
|
|
738
|
+
uri?: string;
|
|
739
|
+
attachments?: unknown[];
|
|
740
|
+
context?: {
|
|
741
|
+
remoteAddr: string | null;
|
|
742
|
+
httpReferer: string;
|
|
743
|
+
httpUserAgent: string;
|
|
744
|
+
apiVersion: string;
|
|
745
|
+
};
|
|
746
|
+
token?: {
|
|
623
747
|
id: number;
|
|
624
|
-
|
|
748
|
+
name: string;
|
|
749
|
+
};
|
|
750
|
+
params?: Record<string, unknown>;
|
|
751
|
+
results?: {
|
|
752
|
+
rowsCount?: number;
|
|
753
|
+
sizeBytes?: number;
|
|
754
|
+
};
|
|
755
|
+
performance?: {
|
|
756
|
+
importDuration?: number;
|
|
625
757
|
};
|
|
626
|
-
};
|
|
627
|
-
/**
|
|
628
|
-
* Body for the metadata POST endpoints (`.../{id}/metadata`) — a provider plus key/value items.
|
|
629
|
-
* Shared by table and column metadata; hand-authored (the table path is absent from the schema).
|
|
630
|
-
*/
|
|
631
|
-
type SaveMetadataBody = {
|
|
632
|
-
provider: string;
|
|
633
|
-
metadata: {
|
|
634
|
-
key: string;
|
|
635
|
-
value: string;
|
|
636
|
-
}[];
|
|
637
758
|
};
|
|
638
759
|
|
|
639
760
|
type FilePath = {
|
|
@@ -656,13 +777,13 @@ type GetFilesQuery = {
|
|
|
656
777
|
offset?: number;
|
|
657
778
|
showExpired?: boolean;
|
|
658
779
|
};
|
|
659
|
-
type CreatorToken$
|
|
780
|
+
type CreatorToken$1 = {
|
|
660
781
|
id: number;
|
|
661
782
|
description: string;
|
|
662
783
|
};
|
|
663
784
|
type File = {
|
|
664
785
|
created: string;
|
|
665
|
-
creatorToken: CreatorToken$
|
|
786
|
+
creatorToken: CreatorToken$1;
|
|
666
787
|
id: number;
|
|
667
788
|
isExpired: boolean;
|
|
668
789
|
isEncrypted: boolean;
|
|
@@ -728,18 +849,11 @@ type PreparedFile = {
|
|
|
728
849
|
gcsUploadParams?: GcsUploadParams;
|
|
729
850
|
};
|
|
730
851
|
|
|
731
|
-
type BranchMetadataRaw = {
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
};
|
|
737
|
-
type BranchMetadata = {
|
|
738
|
-
id: string;
|
|
739
|
-
key: string;
|
|
740
|
-
timestamp: Date;
|
|
741
|
-
value: string;
|
|
742
|
-
};
|
|
852
|
+
type BranchMetadataRaw = OpenapiReturnType<paths['/v2/storage/branch/{branchId}/metadata']['get']>[number];
|
|
853
|
+
type CreateDevBranchSchemaBody = OpenapiBodyType<paths['/v2/storage/dev-branches']['post']>;
|
|
854
|
+
type UpdateDevBranchSchemaBody = OpenapiBodyType<paths['/v2/storage/dev-branches/{id}']['put']>;
|
|
855
|
+
type SaveDevBranchMetadataPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/metadata']['post']>;
|
|
856
|
+
type DeleteDevBranchMetadataSchemaPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/metadata/{metadataId}']['delete']>;
|
|
743
857
|
type BranchMetadataEntry = {
|
|
744
858
|
key: string;
|
|
745
859
|
value: string;
|
|
@@ -755,17 +869,24 @@ type DevBranch = {
|
|
|
755
869
|
name: string;
|
|
756
870
|
} | [];
|
|
757
871
|
};
|
|
758
|
-
type
|
|
872
|
+
type CreateDevBranchBody = {
|
|
759
873
|
name: string;
|
|
760
874
|
description?: string;
|
|
761
875
|
};
|
|
762
876
|
type DevBranchPath = {
|
|
763
877
|
id: number;
|
|
764
878
|
};
|
|
879
|
+
type UpdateDevBranchInput = DevBranchPath & CreateDevBranchBody;
|
|
880
|
+
type SaveDevBranchMetadataInput = SaveDevBranchMetadataPath & {
|
|
881
|
+
metadata: BranchMetadataEntry[];
|
|
882
|
+
};
|
|
883
|
+
type DeleteDevBranchMetadataPath = Omit<DeleteDevBranchMetadataSchemaPath, 'metadataId'> & {
|
|
884
|
+
metadataId: MetadataId;
|
|
885
|
+
};
|
|
765
886
|
|
|
766
|
-
type BranchId$
|
|
887
|
+
type BranchId$3 = number | string;
|
|
767
888
|
type WorkspacesPath = {
|
|
768
|
-
branchId: BranchId$
|
|
889
|
+
branchId: BranchId$3;
|
|
769
890
|
};
|
|
770
891
|
type WorkspacePath = WorkspacesPath & {
|
|
771
892
|
workspaceId: number;
|
|
@@ -785,7 +906,7 @@ type WorkspaceConnection = {
|
|
|
785
906
|
warehouse: string;
|
|
786
907
|
user: string;
|
|
787
908
|
/**
|
|
788
|
-
* Available only upon creation with `storage.
|
|
909
|
+
* Available only upon creation with `storage.configurationWorkspaces.createConfigurationWorkspace`.
|
|
789
910
|
*/
|
|
790
911
|
password?: string;
|
|
791
912
|
loginType: WorkspaceLoginType;
|
|
@@ -820,7 +941,7 @@ type Workspace = {
|
|
|
820
941
|
readOnlyStorageAccess: boolean;
|
|
821
942
|
};
|
|
822
943
|
type SetWorkspacePublicKeyPath = {
|
|
823
|
-
branchId: BranchId$
|
|
944
|
+
branchId: BranchId$3;
|
|
824
945
|
workspaceId: number;
|
|
825
946
|
};
|
|
826
947
|
type SetWorkspacePublicKeyBody = {
|
|
@@ -829,7 +950,7 @@ type SetWorkspacePublicKeyBody = {
|
|
|
829
950
|
type SetWorkspacePublicInput = SetWorkspacePublicKeyPath & SetWorkspacePublicKeyBody;
|
|
830
951
|
type GetWorkspaceSaml2LoginPath = {
|
|
831
952
|
workspaceId: string;
|
|
832
|
-
branchId: BranchId$
|
|
953
|
+
branchId: BranchId$3;
|
|
833
954
|
};
|
|
834
955
|
type WorkspaceSaml2Login = {
|
|
835
956
|
acsUrl: string;
|
|
@@ -862,78 +983,127 @@ type WorkspaceInputMappingLoadPreviewInput = WorkspacesPath & {
|
|
|
862
983
|
backend?: string;
|
|
863
984
|
};
|
|
864
985
|
|
|
865
|
-
type
|
|
866
|
-
type
|
|
867
|
-
|
|
868
|
-
}
|
|
869
|
-
type
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
type
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
986
|
+
type CreateConfigurationRowPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows']['post']>;
|
|
987
|
+
type CreateConfigurationRowSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows']['post']>;
|
|
988
|
+
type GetConfigurationRowPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}']['get']>;
|
|
989
|
+
type UpdateConfigurationRowPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}']['put']>;
|
|
990
|
+
type UpdateConfigurationRowSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}']['put']>;
|
|
991
|
+
type DeleteConfigurationRowPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}']['delete']>;
|
|
992
|
+
type DeleteConfigurationRowSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}']['delete']>;
|
|
993
|
+
type UpdateConfigurationRowStatePath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}/state']['put']>;
|
|
994
|
+
type UpdateConfigurationRowStateSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}/state']['put']>;
|
|
995
|
+
type RowPayload = {
|
|
996
|
+
isDisabled?: boolean | number;
|
|
997
|
+
configuration?: string | Record<string, unknown>;
|
|
998
|
+
state?: string | Record<string, unknown>;
|
|
999
|
+
};
|
|
1000
|
+
type CreateConfigurationRowBody = RowPayload & {
|
|
1001
|
+
rowId?: string;
|
|
1002
|
+
name?: string;
|
|
1003
|
+
description?: string;
|
|
1004
|
+
changeDescription?: string;
|
|
879
1005
|
};
|
|
880
|
-
type
|
|
881
|
-
|
|
882
|
-
|
|
1006
|
+
type UpdateConfigurationRowBody = RowPayload & {
|
|
1007
|
+
name?: string;
|
|
1008
|
+
description?: string;
|
|
1009
|
+
changeDescription?: string;
|
|
883
1010
|
};
|
|
884
|
-
type
|
|
885
|
-
configId: string;
|
|
886
|
-
} & GetConfigurationsPath<ComponentId>;
|
|
887
|
-
type DeleteConfigurationRowPath<ComponentId extends string = string> = {
|
|
888
|
-
rowId: string;
|
|
889
|
-
configId: string;
|
|
890
|
-
} & GetConfigurationsPath<ComponentId>;
|
|
1011
|
+
type UpdateConfigurationRowStateBody = Pick<RowPayload, 'state'>;
|
|
891
1012
|
type DeleteConfigurationRowBody = {
|
|
892
1013
|
changeDescription?: string;
|
|
893
1014
|
};
|
|
1015
|
+
type CreateConfigurationRowInput = CreateConfigurationRowPath & CreateConfigurationRowBody;
|
|
1016
|
+
type CreateConfigurationRowsInput = CreateConfigurationRowPath & {
|
|
1017
|
+
data: CreateConfigurationRowBody[];
|
|
1018
|
+
};
|
|
1019
|
+
type GetConfigurationRowInput = GetConfigurationRowPath;
|
|
1020
|
+
type UpdateConfigurationRowInput = UpdateConfigurationRowPath & UpdateConfigurationRowBody;
|
|
1021
|
+
type UpdateConfigurationRowStateInput = UpdateConfigurationRowStatePath & UpdateConfigurationRowStateBody;
|
|
894
1022
|
type DeleteConfigurationRowInput = DeleteConfigurationRowPath & DeleteConfigurationRowBody;
|
|
895
|
-
type DeleteConfigurationRowsInput = {
|
|
1023
|
+
type DeleteConfigurationRowsInput = Omit<DeleteConfigurationRowInput, 'rowId' | 'changeDescription'> & {
|
|
896
1024
|
rowIds: string[];
|
|
897
1025
|
changeDescription?: string | ((rowId: string) => string);
|
|
898
|
-
}
|
|
1026
|
+
};
|
|
899
1027
|
type Row = {
|
|
900
1028
|
id: string;
|
|
901
1029
|
name: string;
|
|
902
1030
|
description: string;
|
|
903
1031
|
isDisabled: boolean;
|
|
904
1032
|
created: string;
|
|
905
|
-
creatorToken: CreatorToken
|
|
1033
|
+
creatorToken: CreatorToken;
|
|
906
1034
|
changeDescription: string;
|
|
907
1035
|
versionIdentifier: string;
|
|
908
1036
|
state: Record<string, unknown>;
|
|
909
1037
|
configuration: Record<string, unknown>;
|
|
910
1038
|
};
|
|
911
|
-
type
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
1039
|
+
type WrDbRow = Omit<Row, 'configuration'> & {
|
|
1040
|
+
configuration: {
|
|
1041
|
+
parameters?: {
|
|
1042
|
+
dbName?: string;
|
|
1043
|
+
incremental?: boolean;
|
|
1044
|
+
items?: {
|
|
1045
|
+
name: string;
|
|
1046
|
+
dbName: string;
|
|
1047
|
+
default: string;
|
|
1048
|
+
nullable: boolean;
|
|
1049
|
+
size: string;
|
|
1050
|
+
type: number;
|
|
1051
|
+
}[];
|
|
1052
|
+
primaryKey?: string[];
|
|
1053
|
+
tableId?: string;
|
|
1054
|
+
};
|
|
1055
|
+
storage?: {
|
|
1056
|
+
input?: {
|
|
1057
|
+
tables?: {
|
|
1058
|
+
columns: string[];
|
|
1059
|
+
destination: string;
|
|
1060
|
+
overwrite: boolean;
|
|
1061
|
+
source: string;
|
|
1062
|
+
}[];
|
|
1063
|
+
};
|
|
1064
|
+
};
|
|
1065
|
+
};
|
|
919
1066
|
};
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
1067
|
+
|
|
1068
|
+
type CreateConfigurationSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs']['post']>;
|
|
1069
|
+
type UpdateConfigurationSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}']['put']>;
|
|
1070
|
+
type UpdateConfigurationStateSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/state']['put']>;
|
|
1071
|
+
type RebaseConfigurationSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rebase']['post']>;
|
|
1072
|
+
type SearchComponentConfigurationsSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/search/component-configurations']['get']>;
|
|
1073
|
+
type BranchId$2 = number | string | 'default';
|
|
1074
|
+
type GetSearchComponentConfigurationsPath = {
|
|
1075
|
+
branchId?: BranchId$2;
|
|
924
1076
|
};
|
|
925
|
-
type
|
|
926
|
-
|
|
927
|
-
|
|
1077
|
+
type GetConfigurationsPath<ComponentId extends string = string> = {
|
|
1078
|
+
branchId?: BranchId$2;
|
|
1079
|
+
componentId: ComponentId;
|
|
1080
|
+
};
|
|
1081
|
+
type ConfigurationPath<ComponentId extends string = string> = {
|
|
1082
|
+
configId: string;
|
|
1083
|
+
} & GetConfigurationsPath<ComponentId>;
|
|
1084
|
+
type CreatorToken = {
|
|
1085
|
+
id: number;
|
|
1086
|
+
description: string;
|
|
928
1087
|
};
|
|
929
1088
|
type CreateConfigurationBody<ConfigData extends Record<string, unknown> = Record<string, unknown>> = {
|
|
930
1089
|
name: string;
|
|
931
1090
|
description?: string;
|
|
932
1091
|
changeDescription?: string;
|
|
933
1092
|
isDisabled?: boolean;
|
|
934
|
-
|
|
1093
|
+
/**
|
|
1094
|
+
* Id to create the configuration under. Omit to have Storage generate one — which is what
|
|
1095
|
+
* most callers want; pass it only to mirror an id that already exists somewhere else (the
|
|
1096
|
+
* same configuration in another branch, a fixed id for a first-run flow).
|
|
1097
|
+
*/
|
|
1098
|
+
configurationId?: string;
|
|
1099
|
+
/**
|
|
1100
|
+
* Omit it to have Storage create the configuration empty, which is what a "new configuration"
|
|
1101
|
+
* flow with nothing filled in yet does.
|
|
1102
|
+
*/
|
|
1103
|
+
configuration?: ConfigData;
|
|
935
1104
|
};
|
|
936
1105
|
type CreateConfigurationInput<ComponentId extends string = string, ConfigData extends Record<string, unknown> = Record<string, unknown>> = GetConfigurationsPath<ComponentId> & CreateConfigurationBody<ConfigData>;
|
|
1106
|
+
type UpdateConfigurationSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}']['put']>;
|
|
937
1107
|
type UpdateConfigurationBody<ConfigData extends Record<string, unknown> = Record<string, unknown>> = {
|
|
938
1108
|
name?: string;
|
|
939
1109
|
description?: string;
|
|
@@ -943,30 +1113,44 @@ type UpdateConfigurationBody<ConfigData extends Record<string, unknown> = Record
|
|
|
943
1113
|
state?: Record<string, unknown>;
|
|
944
1114
|
rowsSortOrder?: string[];
|
|
945
1115
|
};
|
|
946
|
-
type UpdateConfigurationInput<ComponentId extends string = string, ConfigData extends Record<string, unknown> = Record<string, unknown>> = ConfigurationPath<ComponentId> & UpdateConfigurationBody<ConfigData
|
|
947
|
-
type
|
|
948
|
-
configuration
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
1116
|
+
type UpdateConfigurationInput<ComponentId extends string = string, ConfigData extends Record<string, unknown> = Record<string, unknown>> = ConfigurationPath<ComponentId> & UpdateConfigurationBody<ConfigData> & UpdateConfigurationSchemaQuery;
|
|
1117
|
+
type UpdateConfigurationResult<T extends ConfigType = 'unknown'> = {
|
|
1118
|
+
/** The updated configuration. This part of the write is complete. */
|
|
1119
|
+
configuration: ComponentConfig<T>;
|
|
1120
|
+
/**
|
|
1121
|
+
* The output-mapping sync job `workspaceId` enqueued, to poll via `jobs.getJob`.
|
|
1122
|
+
*
|
|
1123
|
+
* - `null` whenever no `workspaceId` was sent.
|
|
1124
|
+
* - `null` for components outside Storage's sync allow-list, which ignore `workspaceId`.
|
|
1125
|
+
*/
|
|
1126
|
+
syncJobId: number | null;
|
|
952
1127
|
};
|
|
953
|
-
type
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
1128
|
+
type DeleteConfigurationInput = Required<ConfigurationPath> & {
|
|
1129
|
+
/**
|
|
1130
|
+
* Configuration `version` the delete was decided on, sent as the `If-Match` precondition:
|
|
1131
|
+
* Storage answers 412 when the configuration has moved on since it was read.
|
|
1132
|
+
*/
|
|
1133
|
+
expectedVersion?: number;
|
|
1134
|
+
};
|
|
1135
|
+
type PurgeConfigurationInput = ConfigurationPath & {
|
|
1136
|
+
/** Configuration `version` to purge, from the trash listing. Storage answers 428 without it. */
|
|
1137
|
+
expectedVersion: number;
|
|
1138
|
+
};
|
|
1139
|
+
/** One `concurrent` fan-out over the whole trash, whatever component each configuration belongs to. */
|
|
1140
|
+
type PurgeConfigurationsInput = Pick<ConfigurationPath, 'branchId'> & {
|
|
1141
|
+
configs: {
|
|
1142
|
+
componentId: string;
|
|
1143
|
+
configId: string;
|
|
1144
|
+
expectedVersion: number;
|
|
1145
|
+
}[];
|
|
962
1146
|
};
|
|
963
|
-
type
|
|
964
|
-
|
|
965
|
-
description: string;
|
|
1147
|
+
type UpdateConfigurationStateBody = {
|
|
1148
|
+
state?: string | Record<string, unknown>;
|
|
966
1149
|
};
|
|
1150
|
+
type UpdateConfigurationStateInput<ComponentId extends string = string> = ConfigurationPath<ComponentId> & UpdateConfigurationStateBody;
|
|
967
1151
|
type ConfigurationCurrentVersion = {
|
|
968
1152
|
created: string;
|
|
969
|
-
creatorToken: CreatorToken
|
|
1153
|
+
creatorToken: CreatorToken;
|
|
970
1154
|
changeDescription: string;
|
|
971
1155
|
versionIdentifier: string;
|
|
972
1156
|
};
|
|
@@ -975,7 +1159,7 @@ type BaseComponentConfig<ConfigData extends Record<string, unknown> = Record<str
|
|
|
975
1159
|
name: string;
|
|
976
1160
|
description: string;
|
|
977
1161
|
created: string;
|
|
978
|
-
creatorToken: CreatorToken
|
|
1162
|
+
creatorToken: CreatorToken;
|
|
979
1163
|
changeDescription: string;
|
|
980
1164
|
isDisabled: boolean;
|
|
981
1165
|
isDeleted: boolean;
|
|
@@ -1035,34 +1219,6 @@ type DataAppConfig = Omit<BaseComponentConfig, 'configuration' | 'state'> & {
|
|
|
1035
1219
|
configuration: DataAppConfigConfiguration;
|
|
1036
1220
|
state: DataAppConfigState;
|
|
1037
1221
|
};
|
|
1038
|
-
type WrDbRow = Omit<Row, 'configuration'> & {
|
|
1039
|
-
configuration: {
|
|
1040
|
-
parameters?: {
|
|
1041
|
-
dbName?: string;
|
|
1042
|
-
incremental?: boolean;
|
|
1043
|
-
items?: {
|
|
1044
|
-
name: string;
|
|
1045
|
-
dbName: string;
|
|
1046
|
-
default: string;
|
|
1047
|
-
nullable: boolean;
|
|
1048
|
-
size: string;
|
|
1049
|
-
type: number;
|
|
1050
|
-
}[];
|
|
1051
|
-
primaryKey?: string[];
|
|
1052
|
-
tableId?: string;
|
|
1053
|
-
};
|
|
1054
|
-
storage?: {
|
|
1055
|
-
input?: {
|
|
1056
|
-
tables?: {
|
|
1057
|
-
columns: string[];
|
|
1058
|
-
destination: string;
|
|
1059
|
-
overwrite: boolean;
|
|
1060
|
-
source: string;
|
|
1061
|
-
}[];
|
|
1062
|
-
};
|
|
1063
|
-
};
|
|
1064
|
-
};
|
|
1065
|
-
};
|
|
1066
1222
|
type WrDbConfig = BaseComponentConfig & {
|
|
1067
1223
|
configuration: {
|
|
1068
1224
|
parameters: {
|
|
@@ -1080,9 +1236,6 @@ type ConfigurationDiffPath = {
|
|
|
1080
1236
|
componentId: string;
|
|
1081
1237
|
configId: string;
|
|
1082
1238
|
};
|
|
1083
|
-
type ConfigurationRowDiffPath = ConfigurationDiffPath & {
|
|
1084
|
-
rowId: string;
|
|
1085
|
-
};
|
|
1086
1239
|
type ConfigurationDiffSideContent = {
|
|
1087
1240
|
name: string;
|
|
1088
1241
|
description: string;
|
|
@@ -1110,17 +1263,6 @@ type ConfigurationDiff = {
|
|
|
1110
1263
|
ours: ConfigurationDiffSide | null;
|
|
1111
1264
|
theirs: ConfigurationDiffSide | null;
|
|
1112
1265
|
};
|
|
1113
|
-
type ConfigurationRowDiffSide = {
|
|
1114
|
-
id: string;
|
|
1115
|
-
version: number;
|
|
1116
|
-
isDeleted: boolean;
|
|
1117
|
-
diff: ConfigurationDiffSideContent;
|
|
1118
|
-
};
|
|
1119
|
-
type ConfigurationRowDiff = {
|
|
1120
|
-
base: ConfigurationRowDiffSide | null;
|
|
1121
|
-
ours: ConfigurationRowDiffSide | null;
|
|
1122
|
-
theirs: ConfigurationRowDiffSide | null;
|
|
1123
|
-
};
|
|
1124
1266
|
type RebaseConfigurationPath = ConfigurationDiffPath;
|
|
1125
1267
|
type RebaseConfigurationRow = {
|
|
1126
1268
|
/** Omit to have the backend create a row with a generated id. */
|
|
@@ -1130,9 +1272,7 @@ type RebaseConfigurationRow = {
|
|
|
1130
1272
|
isDisabled: boolean;
|
|
1131
1273
|
configuration: Record<string, unknown>;
|
|
1132
1274
|
};
|
|
1133
|
-
type
|
|
1134
|
-
/** Default-branch version to rebase the dev branch onto. */
|
|
1135
|
-
version: number;
|
|
1275
|
+
type RebaseConfigurationDiff = {
|
|
1136
1276
|
/** Resolved configuration name (head). Required — a configuration always has a name. */
|
|
1137
1277
|
name: string;
|
|
1138
1278
|
/** Resolved configuration description (head, the 3-way diff result). */
|
|
@@ -1151,9 +1291,60 @@ type RebaseConfigurationBody = {
|
|
|
1151
1291
|
*/
|
|
1152
1292
|
rows: RebaseConfigurationRow[];
|
|
1153
1293
|
};
|
|
1294
|
+
type RebaseConfigurationBody = {
|
|
1295
|
+
/** Default-branch version to rebase the dev branch onto. */
|
|
1296
|
+
version: number;
|
|
1297
|
+
/**
|
|
1298
|
+
* Resolved configuration content (the 3-way diff result) wrapped in the same
|
|
1299
|
+
* envelope the /diff endpoint returns its sides in. The API also accepts an
|
|
1300
|
+
* empty `diff` (`{}` or an empty string) to resolve the conflict by deleting
|
|
1301
|
+
* the configuration — not modeled here until the UI exposes delete resolution
|
|
1302
|
+
* (widening the accepted type later is non-breaking).
|
|
1303
|
+
*/
|
|
1304
|
+
diff: RebaseConfigurationDiff;
|
|
1305
|
+
};
|
|
1154
1306
|
type RebaseConfigurationInput = RebaseConfigurationPath & RebaseConfigurationBody;
|
|
1155
1307
|
type ConfigType = 'data-app' | 'wr-db' | 'unknown';
|
|
1156
1308
|
type ComponentConfig<T extends ConfigType = 'unknown'> = T extends 'data-app' ? DataAppConfig : T extends 'wr-db' ? WrDbConfig : BaseComponentConfig;
|
|
1309
|
+
type SearchComponentConfigurationsQuery = {
|
|
1310
|
+
/**
|
|
1311
|
+
* The API's field name, per the spec and what kbc-ui's legacy client sends in production. This
|
|
1312
|
+
* used to be `componentId`, which Storage rejects with "This field was not expected" — the live
|
|
1313
|
+
* nightly caught it, so the previous divergence from the spec was a bug, not a deliberate choice.
|
|
1314
|
+
*/
|
|
1315
|
+
idComponent?: string | null;
|
|
1316
|
+
configurationId?: string | null;
|
|
1317
|
+
/** Comma-joined by the client, which is how the spec types it (`include?: string`). */
|
|
1318
|
+
include?: 'filteredMetadata'[];
|
|
1319
|
+
metadataKeys?: string[];
|
|
1320
|
+
};
|
|
1321
|
+
type SearchComponentConfigurationsInput = GetSearchComponentConfigurationsPath & SearchComponentConfigurationsQuery;
|
|
1322
|
+
type SearchComponentConfiguration = {
|
|
1323
|
+
configurationId: string;
|
|
1324
|
+
idComponent: string;
|
|
1325
|
+
metadata?: {
|
|
1326
|
+
id: string;
|
|
1327
|
+
key: string;
|
|
1328
|
+
timestamp: string;
|
|
1329
|
+
value: string;
|
|
1330
|
+
}[];
|
|
1331
|
+
};
|
|
1332
|
+
|
|
1333
|
+
type GetComponentSchemaPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}']['get']>;
|
|
1334
|
+
type GetComponentsSchemaPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components']['get']>;
|
|
1335
|
+
type GetComponentsSchemaQuery = OpenapiQueryType<paths['/v2/storage/branch/{branchId}/components']['get']>;
|
|
1336
|
+
type BranchId$1 = number | string | 'default';
|
|
1337
|
+
type GetComponentsPath = {
|
|
1338
|
+
branchId?: BranchId$1;
|
|
1339
|
+
};
|
|
1340
|
+
type GetComponentPath = Omit<GetComponentSchemaPath, 'branchId'> & {
|
|
1341
|
+
branchId?: BranchId$1;
|
|
1342
|
+
};
|
|
1343
|
+
type GetComponentsQuery = Pick<GetComponentsSchemaQuery, 'componentType'> & {
|
|
1344
|
+
include?: ('configuration' | 'rows' | 'state')[];
|
|
1345
|
+
isDeleted?: boolean;
|
|
1346
|
+
};
|
|
1347
|
+
type GetComponentsInput = GetComponentsPath & GetComponentsQuery;
|
|
1157
1348
|
type ComponentDefinition = {
|
|
1158
1349
|
type: string;
|
|
1159
1350
|
uri: string;
|
|
@@ -1213,23 +1404,24 @@ type Component = StackComponent & {
|
|
|
1213
1404
|
documentationUrl?: string;
|
|
1214
1405
|
configurations?: ComponentConfig[];
|
|
1215
1406
|
};
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
type
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
key: string;
|
|
1228
|
-
timestamp: string;
|
|
1229
|
-
value: string;
|
|
1230
|
-
}[];
|
|
1407
|
+
|
|
1408
|
+
type GetConfigurationWorkspacesPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/workspaces']['get']>;
|
|
1409
|
+
type CreateConfigurationWorkspacePath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/workspaces']['post']>;
|
|
1410
|
+
type CreateConfigurationWorkspaceSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/workspaces']['post']>;
|
|
1411
|
+
type BackendType = Exclude<NonNullable<CreateConfigurationWorkspaceSchemaBody['backend']>, 'abs'>;
|
|
1412
|
+
type LoginType = NonNullable<CreateConfigurationWorkspaceSchemaBody['loginType']>;
|
|
1413
|
+
type ConfigurationUseCaseType = NonNullable<CreateConfigurationWorkspaceSchemaBody['useCase']>;
|
|
1414
|
+
type CreateConfigurationWorkspaceBody = Omit<CreateConfigurationWorkspaceSchemaBody, 'backend' | 'readOnlyStorageAccess' | 'useCase'> & {
|
|
1415
|
+
backend: BackendType;
|
|
1416
|
+
readOnlyStorageAccess: boolean;
|
|
1417
|
+
useCase: ConfigurationUseCaseType;
|
|
1231
1418
|
};
|
|
1419
|
+
type CreateConfigurationWorkspaceInput = CreateConfigurationWorkspacePath & CreateConfigurationWorkspaceBody;
|
|
1232
1420
|
|
|
1421
|
+
type GetConfigurationMetadataPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/metadata']['get']>;
|
|
1422
|
+
type SaveConfigurationMetadataPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/metadata']['post']>;
|
|
1423
|
+
type SaveConfigurationMetadataSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/metadata']['post']>;
|
|
1424
|
+
type DeleteConfigurationMetadataPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/metadata/{metadataId}']['delete']>;
|
|
1233
1425
|
type ConfigurationMetadataItem = {
|
|
1234
1426
|
id: string;
|
|
1235
1427
|
key: string;
|
|
@@ -1242,35 +1434,38 @@ type SaveConfigurationMetadataBody = {
|
|
|
1242
1434
|
value: string;
|
|
1243
1435
|
}[];
|
|
1244
1436
|
};
|
|
1245
|
-
type SaveConfigurationMetadataInput =
|
|
1437
|
+
type SaveConfigurationMetadataInput = SaveConfigurationMetadataPath & SaveConfigurationMetadataBody;
|
|
1438
|
+
type DeleteConfigurationMetadataInput = DeleteConfigurationMetadataPath;
|
|
1439
|
+
type GetConfigurationMetadataInput = GetConfigurationMetadataPath;
|
|
1246
1440
|
|
|
1441
|
+
type ConfigurationVersionsSchemaPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/versions']['get']>;
|
|
1442
|
+
type ConfigurationVersionSchemaPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/versions/{versionId}']['get']>;
|
|
1443
|
+
type CopyConfigurationFromVersionSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/versions/{versionId}/create']['post']>;
|
|
1444
|
+
type RollbackConfigurationToVersionSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/versions/{versionId}/rollback']['post']>;
|
|
1445
|
+
type ConfigurationRowVersionsSchemaPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}/versions']['get']>;
|
|
1446
|
+
type ConfigurationRowVersionSchemaPath = OpenapiPathType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}/versions/{versionId}']['get']>;
|
|
1447
|
+
type CopyConfigurationRowFromVersionSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}/versions/{versionId}/create']['post']>;
|
|
1448
|
+
type RollbackConfigurationRowToVersionSchemaBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/components/{componentId}/configs/{configurationId}/rows/{rowId}/versions/{versionId}/rollback']['post']>;
|
|
1247
1449
|
type BranchId = number | string | 'default';
|
|
1248
|
-
type
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1450
|
+
type VersionId = number | string;
|
|
1451
|
+
type ConfigurationVersionPath = Omit<ConfigurationVersionsSchemaPath, 'branchId'> & {
|
|
1452
|
+
branchId: BranchId;
|
|
1453
|
+
};
|
|
1454
|
+
type ConfigurationVersionDetailPath = Omit<ConfigurationVersionSchemaPath, 'branchId' | 'versionId'> & {
|
|
1455
|
+
branchId: BranchId;
|
|
1456
|
+
versionId: VersionId;
|
|
1457
|
+
};
|
|
1458
|
+
/** Roll a configuration back to one of its versions. Takes no request body. */
|
|
1459
|
+
type RollbackConfigurationToVersionInput = Omit<ConfigurationVersionSchemaPath, 'branchId' | 'versionId'> & {
|
|
1252
1460
|
branchId?: BranchId;
|
|
1253
|
-
|
|
1254
|
-
configId: string;
|
|
1255
|
-
versionId: number | string;
|
|
1461
|
+
versionId: VersionId;
|
|
1256
1462
|
};
|
|
1463
|
+
type CopyConfigurationFromVersionPath = RollbackConfigurationToVersionInput;
|
|
1257
1464
|
type CopyConfigurationFromVersionBody = {
|
|
1258
1465
|
name: string;
|
|
1259
1466
|
description?: string;
|
|
1260
1467
|
};
|
|
1261
1468
|
type CopyConfigurationFromVersionInput = CopyConfigurationFromVersionPath & CopyConfigurationFromVersionBody;
|
|
1262
|
-
type ConfigurationVersionPath = {
|
|
1263
|
-
branchId: BranchId;
|
|
1264
|
-
componentId: string;
|
|
1265
|
-
configId: string;
|
|
1266
|
-
};
|
|
1267
|
-
type ConfigurationVersionDetailPath = ConfigurationVersionPath & {
|
|
1268
|
-
versionId: number;
|
|
1269
|
-
};
|
|
1270
|
-
type CreatorToken = {
|
|
1271
|
-
id: number;
|
|
1272
|
-
description: string;
|
|
1273
|
-
};
|
|
1274
1469
|
type ConfigurationVersion = {
|
|
1275
1470
|
version: number;
|
|
1276
1471
|
created: string;
|
|
@@ -1280,6 +1475,18 @@ type ConfigurationVersion = {
|
|
|
1280
1475
|
description: string;
|
|
1281
1476
|
versionIdentifier: string;
|
|
1282
1477
|
};
|
|
1478
|
+
/**
|
|
1479
|
+
* What the rollback endpoint answers with — only the new version number, and as a **string**, unlike
|
|
1480
|
+
* the `number` the same field carries on `ConfigurationVersion`. The inconsistency is the API's; it is
|
|
1481
|
+
* mirrored here rather than hidden, and the nightly smoke pins the string-ness.
|
|
1482
|
+
*/
|
|
1483
|
+
type RollbackConfigurationToVersionResult = {
|
|
1484
|
+
version: string;
|
|
1485
|
+
};
|
|
1486
|
+
/** What the copy endpoint answers with — only the new configuration's id. */
|
|
1487
|
+
type CopyConfigurationFromVersionResult = {
|
|
1488
|
+
id: string;
|
|
1489
|
+
};
|
|
1283
1490
|
type ConfigurationVersionDetail = ConfigurationVersion & {
|
|
1284
1491
|
configuration: Record<string, unknown>;
|
|
1285
1492
|
state: Record<string, unknown>;
|
|
@@ -1294,6 +1501,37 @@ type ConfigurationVersionDetail = ConfigurationVersion & {
|
|
|
1294
1501
|
state: Record<string, unknown>;
|
|
1295
1502
|
}[];
|
|
1296
1503
|
};
|
|
1504
|
+
type ConfigurationRowVersionPath = Omit<ConfigurationRowVersionsSchemaPath, 'branchId'> & {
|
|
1505
|
+
branchId: BranchId;
|
|
1506
|
+
};
|
|
1507
|
+
type ConfigurationRowVersionDetailPath = Omit<ConfigurationRowVersionSchemaPath, 'branchId' | 'versionId'> & {
|
|
1508
|
+
branchId: BranchId;
|
|
1509
|
+
versionId: VersionId;
|
|
1510
|
+
};
|
|
1511
|
+
/** Roll a configuration row back to one of its versions. Takes no request body. */
|
|
1512
|
+
type RollbackConfigurationRowToVersionInput = Omit<ConfigurationRowVersionSchemaPath, 'branchId' | 'versionId'> & {
|
|
1513
|
+
branchId?: BranchId;
|
|
1514
|
+
versionId: VersionId;
|
|
1515
|
+
};
|
|
1516
|
+
type CopyConfigurationRowFromVersionInput = Omit<ConfigurationRowVersionSchemaPath, 'branchId' | 'versionId'> & {
|
|
1517
|
+
branchId?: BranchId;
|
|
1518
|
+
versionId: VersionId;
|
|
1519
|
+
};
|
|
1520
|
+
type ConfigurationRowVersion = {
|
|
1521
|
+
version: number;
|
|
1522
|
+
created: string;
|
|
1523
|
+
creatorToken: CreatorToken;
|
|
1524
|
+
changeDescription: string;
|
|
1525
|
+
name: string;
|
|
1526
|
+
description: string;
|
|
1527
|
+
isDisabled: boolean;
|
|
1528
|
+
versionIdentifier: string;
|
|
1529
|
+
};
|
|
1530
|
+
type ConfigurationRowVersionDetail = ConfigurationRowVersion & {
|
|
1531
|
+
id: string;
|
|
1532
|
+
configuration: Record<string, unknown>;
|
|
1533
|
+
state: Record<string, unknown>;
|
|
1534
|
+
};
|
|
1297
1535
|
|
|
1298
1536
|
type CreateMergeRequestParams = OpenapiBodyType<paths['/v2/storage/merge-request']['post']>;
|
|
1299
1537
|
type UpdateMergeRequestParams = OpenapiBodyType<paths['/v2/storage/merge-request/{id}']['put']>;
|
|
@@ -1320,7 +1558,7 @@ type MergeRequestDetailWithActivityLog = MergeRequestDetail & {
|
|
|
1320
1558
|
type MergeRequestConflict = OpenapiReturnType<paths['/v2/storage/merge-request/{id}/conflicts']['get']>[number];
|
|
1321
1559
|
|
|
1322
1560
|
type JobStatus = 'created' | 'waiting' | 'processing' | 'success' | 'error' | 'terminating' | 'terminated' | 'cancelled' | 'warning';
|
|
1323
|
-
type JobOperation = 'bucketDelete' | 'bucketListingCreate' | 'bucketListingUpdate' | 'bucketListingDelete' | 'bucketShareToOrganization' | 'bucketShareToOrganizationProject' | 'bucketShareToProjects' | 'bucketShareToAdmins' | 'bucketRemoveShare' | 'bucketForceUnlink' | 'bucketRegister' | 'bucketRefresh' | 'devBranchCreate' | 'devBranchDelete' | 'workspaceDrop' | 'workspaceCreate' | 'tableDefinitionCreate' | 'tableDefinitionUpdate' | 'tableCreate' | 'tableExport' | 'tableImport' | 'tableSnapshotCreate' | 'aliasCreate' | 'devBranchTablePull' | 'tableColumnAdd' | 'tableColumnDelete' | 'tablePrimaryKeyAdd' | 'tablePrimaryKeyDelete' | '
|
|
1561
|
+
type JobOperation = 'bucketDelete' | 'bucketListingCreate' | 'bucketListingUpdate' | 'bucketListingDelete' | 'bucketShareToOrganization' | 'bucketShareToOrganizationProject' | 'bucketShareToProjects' | 'bucketShareToAdmins' | 'bucketRemoveShare' | 'bucketForceUnlink' | 'bucketLink' | 'bucketRegister' | 'bucketRefresh' | 'devBranchCreate' | 'devBranchDelete' | 'workspaceDrop' | 'workspaceCreate' | 'workspaceOutputMappingSync' | 'tableDefinitionCreate' | 'tableDefinitionUpdate' | 'tableCreate' | 'tableExport' | 'tableImport' | 'tableSnapshotCreate' | 'aliasCreate' | 'devBranchTablePull' | 'tableColumnAdd' | 'tableColumnDelete' | 'tablePrimaryKeyAdd' | 'tablePrimaryKeyDelete' | 'workspaceBatchDeleteObjects';
|
|
1324
1562
|
type JobResult<SuccessData = unknown, ErrorData = null> = {
|
|
1325
1563
|
status: 'success';
|
|
1326
1564
|
results: SuccessData;
|
|
@@ -1373,6 +1611,10 @@ type DeleteDevBranchJob = StorageJob<'devBranchDelete', null, {
|
|
|
1373
1611
|
id: number;
|
|
1374
1612
|
};
|
|
1375
1613
|
}>;
|
|
1614
|
+
type WorkspaceOutputMappingSyncJob = StorageJob<'workspaceOutputMappingSync', unknown, {
|
|
1615
|
+
workspaceId: number;
|
|
1616
|
+
targetConfigurationVersion: number;
|
|
1617
|
+
}>;
|
|
1376
1618
|
type CreateWorkspaceJob = StorageJob<'workspaceCreate', Workspace, {
|
|
1377
1619
|
backend: string;
|
|
1378
1620
|
backendConfiguration: [];
|
|
@@ -1456,8 +1698,17 @@ type ShareBucketToProjectsJob = StorageJob<'bucketShareToProjects', null>;
|
|
|
1456
1698
|
type ShareBucketToAdminsJob = StorageJob<'bucketShareToAdmins', null>;
|
|
1457
1699
|
type RemoveBucketShareJob = StorageJob<'bucketRemoveShare', null>;
|
|
1458
1700
|
type ForceUnlinkBucketJob = StorageJob<'bucketForceUnlink', null>;
|
|
1459
|
-
type
|
|
1460
|
-
type
|
|
1701
|
+
type LinkBucketJob = StorageJob<'bucketLink', BucketDetail>;
|
|
1702
|
+
type ExternalBucketWarning = {
|
|
1703
|
+
message: string;
|
|
1704
|
+
};
|
|
1705
|
+
type RegisterBucketJob = StorageJob<'bucketRegister', {
|
|
1706
|
+
id: string;
|
|
1707
|
+
warnings?: ExternalBucketWarning[];
|
|
1708
|
+
}>;
|
|
1709
|
+
type RefreshBucketJob = StorageJob<'bucketRefresh', {
|
|
1710
|
+
warnings?: ExternalBucketWarning[];
|
|
1711
|
+
}>;
|
|
1461
1712
|
type WorkspaceBatchDeleteObjectResult = {
|
|
1462
1713
|
deleted: {
|
|
1463
1714
|
objectName: string;
|
|
@@ -1467,14 +1718,14 @@ type WorkspaceBatchDeleteObjectResult = {
|
|
|
1467
1718
|
error: string;
|
|
1468
1719
|
}[];
|
|
1469
1720
|
};
|
|
1470
|
-
type DeleteWorkspaceObjectsJob = StorageJob<'
|
|
1721
|
+
type DeleteWorkspaceObjectsJob = StorageJob<'workspaceBatchDeleteObjects', WorkspaceBatchDeleteObjectResult, {
|
|
1471
1722
|
workspaceId: string;
|
|
1472
1723
|
objects: string[];
|
|
1473
1724
|
}, WorkspaceBatchDeleteObjectResult>;
|
|
1474
1725
|
type GetJobPath = {
|
|
1475
1726
|
id: number;
|
|
1476
1727
|
};
|
|
1477
|
-
type JobUnion = CreateDevBranchJob | DeleteDevBranchJob | DeleteBucketJob | BucketListingCreateJob | BucketListingUpdateJob | BucketListingDeleteJob | ShareBucketToOrganizationJob | ShareBucketToOrganizationProjectJob | ShareBucketToProjectsJob | ShareBucketToAdminsJob | RemoveBucketShareJob | ForceUnlinkBucketJob | RegisterBucketJob | RefreshBucketJob | WorkspaceDropJob | CreateWorkspaceJob | TableDefinitionCreateJob | TableDefinitionUpdateJob | TableCreateJob | TableExportJob | TableImportJob | CreateSnapshotJob | PullTableJob | AddTableColumnJob | DeleteTableColumnJob | CreateTablePrimaryKeyJob | RemoveTablePrimaryKeyJob | CreateAliasJob | DeleteWorkspaceObjectsJob;
|
|
1728
|
+
type JobUnion = CreateDevBranchJob | DeleteDevBranchJob | DeleteBucketJob | BucketListingCreateJob | BucketListingUpdateJob | BucketListingDeleteJob | ShareBucketToOrganizationJob | ShareBucketToOrganizationProjectJob | ShareBucketToProjectsJob | ShareBucketToAdminsJob | RemoveBucketShareJob | ForceUnlinkBucketJob | LinkBucketJob | RegisterBucketJob | RefreshBucketJob | WorkspaceDropJob | CreateWorkspaceJob | TableDefinitionCreateJob | TableDefinitionUpdateJob | TableCreateJob | TableExportJob | TableImportJob | CreateSnapshotJob | PullTableJob | AddTableColumnJob | DeleteTableColumnJob | CreateTablePrimaryKeyJob | RemoveTablePrimaryKeyJob | CreateAliasJob | DeleteWorkspaceObjectsJob;
|
|
1478
1729
|
type GetJobsQuery = {
|
|
1479
1730
|
created_time?: string;
|
|
1480
1731
|
created_time_from?: string;
|
|
@@ -1501,12 +1752,14 @@ type JobByOperation = {
|
|
|
1501
1752
|
bucketShareToAdmins: ShareBucketToAdminsJob;
|
|
1502
1753
|
bucketRemoveShare: RemoveBucketShareJob;
|
|
1503
1754
|
bucketForceUnlink: ForceUnlinkBucketJob;
|
|
1755
|
+
bucketLink: LinkBucketJob;
|
|
1504
1756
|
bucketRegister: RegisterBucketJob;
|
|
1505
1757
|
bucketRefresh: RefreshBucketJob;
|
|
1506
1758
|
devBranchCreate: CreateDevBranchJob;
|
|
1507
1759
|
devBranchDelete: DeleteDevBranchJob;
|
|
1508
1760
|
workspaceDrop: WorkspaceDropJob;
|
|
1509
1761
|
workspaceCreate: CreateWorkspaceJob;
|
|
1762
|
+
workspaceOutputMappingSync: WorkspaceOutputMappingSyncJob;
|
|
1510
1763
|
tableDefinitionCreate: TableDefinitionCreateJob;
|
|
1511
1764
|
tableDefinitionUpdate: TableDefinitionUpdateJob;
|
|
1512
1765
|
tableCreate: TableCreateJob;
|
|
@@ -1519,19 +1772,26 @@ type JobByOperation = {
|
|
|
1519
1772
|
tablePrimaryKeyAdd: CreateTablePrimaryKeyJob;
|
|
1520
1773
|
tablePrimaryKeyDelete: RemoveTablePrimaryKeyJob;
|
|
1521
1774
|
aliasCreate: CreateAliasJob;
|
|
1522
|
-
|
|
1775
|
+
workspaceBatchDeleteObjects: DeleteWorkspaceObjectsJob;
|
|
1523
1776
|
};
|
|
1524
1777
|
type Job<T extends JobOperation | string = string> = T extends keyof JobByOperation ? JobByOperation[T] : JobUnion;
|
|
1525
1778
|
|
|
1526
|
-
/** A trigger as returned by the Storage API. */
|
|
1527
1779
|
type Trigger = OpenapiReturnType<paths['/v2/storage/triggers']['get']>[number];
|
|
1528
|
-
|
|
1529
|
-
type ListTriggersQuery = OpenapiQueryType<paths['/v2/storage/triggers']['get']>;
|
|
1530
|
-
/** Body for `POST /v2/storage/triggers`. */
|
|
1780
|
+
type GetTriggersQuery = OpenapiQueryType<paths['/v2/storage/triggers']['get']>;
|
|
1531
1781
|
type CreateTriggerBody = OpenapiBodyType<paths['/v2/storage/triggers']['post']>;
|
|
1532
|
-
|
|
1533
|
-
type UpdateTriggerBody =
|
|
1782
|
+
type UpdateTriggerRequest = OpenapiBodyType<paths['/v2/storage/triggers/{triggerId}']['put']>;
|
|
1783
|
+
type UpdateTriggerBody = Partial<UpdateTriggerRequest>;
|
|
1784
|
+
type UpdateTriggerInput = {
|
|
1785
|
+
triggerId: Trigger['id'];
|
|
1786
|
+
} & UpdateTriggerBody;
|
|
1534
1787
|
|
|
1788
|
+
type GlobalSearchSchemaQuery = OpenapiQueryType<paths['/v2/storage/global-search']['get']>;
|
|
1789
|
+
type SearchTablesSchemaQuery = NonNullable<OpenapiQueryType<paths['/v2/storage/search/tables']['get']>>;
|
|
1790
|
+
/**
|
|
1791
|
+
* Object types the `types` filter accepts, spec-derived so the allow-list can't drift. Narrower than
|
|
1792
|
+
* `GlobalSearchItemType`: the spec has no `component` filter, though a hit can carry that type.
|
|
1793
|
+
*/
|
|
1794
|
+
type GlobalSearchFilterType = NonNullable<GlobalSearchSchemaQuery['types[]']>[number];
|
|
1535
1795
|
/** Result categories returned by global search. */
|
|
1536
1796
|
type GlobalSearchItemType = 'flow' | 'bucket' | 'table' | 'transformation' | 'component' | 'configuration' | 'configuration-row' | 'workspace' | 'shared-code';
|
|
1537
1797
|
/** A single global-search hit. */
|
|
@@ -1571,15 +1831,14 @@ type GlobalSearchItem = {
|
|
|
1571
1831
|
};
|
|
1572
1832
|
};
|
|
1573
1833
|
/**
|
|
1574
|
-
* Query for `GET /v2/storage/global-search`.
|
|
1575
|
-
*
|
|
1834
|
+
* Query for `GET /v2/storage/global-search`. Derived from the spec, minus its `[]` suffixes: the
|
|
1835
|
+
* document names every repeatable filter the way PHP receives it (`types[]`), which is
|
|
1836
|
+
* wire-serialization detail rather than something a caller should have to type — `globalSearch` casts
|
|
1837
|
+
* back. `branchTypes` also stays `string[]` where the spec says `('production' | 'development')[]`,
|
|
1838
|
+
* because callers build it from a set of filter strings.
|
|
1576
1839
|
*/
|
|
1577
|
-
type GlobalSearchQuery = {
|
|
1578
|
-
|
|
1579
|
-
limit?: number;
|
|
1580
|
-
offset?: number;
|
|
1581
|
-
mode?: 'regex';
|
|
1582
|
-
types?: GlobalSearchItemType[];
|
|
1840
|
+
type GlobalSearchQuery = Omit<GlobalSearchSchemaQuery, 'types[]' | 'projectIds[]' | 'branchTypes[]' | 'branchIds[]'> & {
|
|
1841
|
+
types?: GlobalSearchFilterType[];
|
|
1583
1842
|
projectIds?: number[];
|
|
1584
1843
|
branchTypes?: string[];
|
|
1585
1844
|
branchIds?: number[];
|
|
@@ -1592,6 +1851,44 @@ type GlobalSearchResponse = {
|
|
|
1592
1851
|
} & Partial<Record<GlobalSearchItemType, number>>;
|
|
1593
1852
|
byProject: Record<number, string>;
|
|
1594
1853
|
};
|
|
1854
|
+
/**
|
|
1855
|
+
* Query for `GET /v2/storage/search/tables`. Two tightenings on top of the spec: at least one of the
|
|
1856
|
+
* three metadata filters is required (the endpoint answers 400 without one), and `include` narrows
|
|
1857
|
+
* from `string | string[]` to the one documented value, sent comma-joined like every other table read.
|
|
1858
|
+
*/
|
|
1859
|
+
type SearchTablesQuery = Omit<SearchTablesSchemaQuery, 'include' | 'metadataKey' | 'metadataValue' | 'metadataProvider'> & {
|
|
1860
|
+
include?: 'buckets'[];
|
|
1861
|
+
} & ({
|
|
1862
|
+
metadataKey: string;
|
|
1863
|
+
} | {
|
|
1864
|
+
metadataValue: string;
|
|
1865
|
+
} | {
|
|
1866
|
+
metadataProvider: string;
|
|
1867
|
+
});
|
|
1868
|
+
|
|
1869
|
+
type CreateSnapshotBody = OpenapiBodyType<paths['/v2/storage/branch/{branchId}/tables/{id}/snapshots']['post']>;
|
|
1870
|
+
type GetSnapshotsQuery = NonNullable<OpenapiQueryType<paths['/v2/storage/branch/{branchId}/tables/{id}/snapshots']['get']>>;
|
|
1871
|
+
/**
|
|
1872
|
+
* A table snapshot. The schema types the list items as a bare `Record<string, never>` because the
|
|
1873
|
+
* backend OpenAPI declares them as plain objects — this is the real shape.
|
|
1874
|
+
*/
|
|
1875
|
+
type Snapshot = {
|
|
1876
|
+
id: string;
|
|
1877
|
+
description: string;
|
|
1878
|
+
created: string;
|
|
1879
|
+
creatorToken: {
|
|
1880
|
+
id: number;
|
|
1881
|
+
description: string;
|
|
1882
|
+
};
|
|
1883
|
+
};
|
|
1884
|
+
type CreateSnapshotInput = {
|
|
1885
|
+
branchId: string;
|
|
1886
|
+
tableId: string;
|
|
1887
|
+
} & CreateSnapshotBody;
|
|
1888
|
+
type GetTableSnapshotsInput = {
|
|
1889
|
+
branchId: string;
|
|
1890
|
+
tableId: string;
|
|
1891
|
+
} & GetSnapshotsQuery;
|
|
1595
1892
|
|
|
1596
1893
|
/** A table entry in run stats. Consumers currently only count entries; `id` identifies the table. */
|
|
1597
1894
|
type RunIdTableStat = {
|
|
@@ -1611,13 +1908,11 @@ type RunIdStats = {
|
|
|
1611
1908
|
};
|
|
1612
1909
|
};
|
|
1613
1910
|
};
|
|
1614
|
-
type GetRunIdStatsQuery = {
|
|
1615
|
-
runId: string;
|
|
1616
|
-
};
|
|
1617
1911
|
|
|
1618
1912
|
type GetStackInfoQuery = {
|
|
1619
1913
|
exclude: 'componentDetails';
|
|
1620
1914
|
};
|
|
1915
|
+
type MetadataId = string | number;
|
|
1621
1916
|
type ServiceId = 'vault' | 'data-science' | 'encryption' | 'telemetry' | 'ai' | 'editor' | 'import' | 'oauth' | 'query' | 'queue' | 'kai-assistant' | 'kai-agent' | 'sync-actions' | 'stream' | 'notification' | 'scheduler' | 'metastore';
|
|
1622
1917
|
type Service = {
|
|
1623
1918
|
id: ServiceId;
|
|
@@ -1651,4 +1946,4 @@ type StackInfo = {
|
|
|
1651
1946
|
};
|
|
1652
1947
|
type PartialKey<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
1653
1948
|
|
|
1654
|
-
export type { AddFileTagBody, AddTableColumnBody, BackendType, BaseComponentConfig, BranchId$
|
|
1949
|
+
export type { AddFileTagBody, AddTableColumnBody, AddTableColumnInput, AddTableColumnPath, AddTableColumnSchemaBody, BackendType, BaseComponentConfig, BranchId$3 as BranchId, BranchMetadataEntry, BranchMetadataRaw, Bucket, BucketBackend, BucketDetail, BucketListingDetail, BucketMetadata, BucketOwner, BucketRegistrationGuide, BucketRegistrationGuideQuery, BucketRegistrationGuideSchemaQuery, BucketShared, BucketStage, Component, ComponentConfig, ComponentData, ComponentDataTypesConfiguration, ComponentDefinition, ComponentLogging, ComponentProcessorConfiguration, ComponentStagingStorage, ComponentType, ComponentVendor, ConfigType, ConfigurationDiff, ConfigurationDiffContent, ConfigurationDiffPath, ConfigurationDiffRow, ConfigurationDiffSide, ConfigurationDiffSideContent, ConfigurationMetadataItem, ConfigurationPath, ConfigurationRowVersion, ConfigurationRowVersionDetail, ConfigurationRowVersionDetailPath, ConfigurationRowVersionPath, ConfigurationRowVersionSchemaPath, ConfigurationRowVersionsSchemaPath, ConfigurationUseCaseType, ConfigurationVersion, ConfigurationVersionDetail, ConfigurationVersionDetailPath, ConfigurationVersionPath, ConfigurationVersionSchemaPath, ConfigurationVersionsSchemaPath, CopyConfigurationFromVersionBody, CopyConfigurationFromVersionInput, CopyConfigurationFromVersionPath, CopyConfigurationFromVersionResult, CopyConfigurationFromVersionSchemaBody, CopyConfigurationRowFromVersionInput, CopyConfigurationRowFromVersionSchemaBody, CreateAliasTableBody, CreateAliasTableInput, CreateBucketBody, CreateBucketListingBody, CreateBucketListingInput, CreateBucketListingPath, CreateBucketListingSchemaBody, CreateBucketSchemaBody, CreateConfigurationBody, CreateConfigurationInput, CreateConfigurationRowBody, CreateConfigurationRowInput, CreateConfigurationRowPath, CreateConfigurationRowSchemaBody, CreateConfigurationRowsInput, CreateConfigurationSchemaBody, CreateConfigurationWorkspaceBody, CreateConfigurationWorkspaceInput, CreateConfigurationWorkspacePath, CreateConfigurationWorkspaceSchemaBody, CreateDevBranchBody, CreateDevBranchSchemaBody, CreateEventBody, CreateMergeRequestParams, CreateScheduledRefreshBody, CreateScheduledRefreshInput, CreateScheduledRefreshPath, CreateSnapshotBody, CreateSnapshotInput, CreateTableAsyncBody, CreateTableAsyncFromFileBody, CreateTableAsyncInput, CreateTableAsyncSchemaBody, CreateTableDefinitionBody, CreateTableDefinitionInput, CreateTableDefinitionSchemaBody, CreateTablePrimaryKeyBody, CreateTablePrimaryKeyInput, CreateTablePrimaryKeyPath, CreateTablePrimaryKeySchemaBody, CreateTriggerBody, CreatorToken, DeleteBucketAsyncInput, DeleteBucketMetadataInput, DeleteColumnMetadataInput, DeleteConfigurationInput, DeleteConfigurationMetadataInput, DeleteConfigurationMetadataPath, DeleteConfigurationRowBody, DeleteConfigurationRowInput, DeleteConfigurationRowPath, DeleteConfigurationRowSchemaBody, DeleteConfigurationRowsInput, DeleteDevBranchMetadataPath, DeleteDevBranchMetadataSchemaPath, DeleteFileTagPath, DeleteTableColumnInput, DeleteTableColumnPath, DeleteTableColumnQuery, DeleteTableMetadataInput, DeleteTableRows, DeleteTableRowsInput, DeleteTableRowsSchemaQuery, DeleteWorkspaceObjectBody, DeleteWorkspaceObjectInput, DeleteWorkspaceQuery, DevBranch, DevBranchPath, EventPath, EventType, ExportAsyncInput, File, FilePath, FilterOperator, ForceUnlinkBucketInput, ForceUnlinkBucketSchemaPath, ForceUnlinkBucketSchemaQuery, GetBucketEventsInput, GetBucketInput, GetBucketOwnerInput, GetBucketQuery, GetBucketsInput, GetBucketsQuery, GetBucketsSchemaQuery, GetComponentPath, GetComponentSchemaPath, GetComponentsInput, GetComponentsPath, GetComponentsQuery, GetComponentsSchemaPath, GetComponentsSchemaQuery, GetConfigurationMetadataInput, GetConfigurationMetadataPath, GetConfigurationRowInput, GetConfigurationRowPath, GetConfigurationWorkspacesPath, GetConfigurationsPath, GetDataPreviewInput, GetDataPreviewQuery, GetDataPreviewSchemaQuery, GetEventsQuery, GetFilesQuery, GetJobPath, GetJobsQuery, GetObjectEventsQuery, GetSearchComponentConfigurationsPath, GetSnapshotsQuery, GetStackInfoQuery, GetTableEventsInput, GetTableInput, GetTableSnapshotsInput, GetTablesInput, GetTablesQuery, GetTablesSchemaQuery, GetTriggersQuery, GetWorkspaceSaml2LoginPath, GlobalSearchFilterType, GlobalSearchItem, GlobalSearchItemType, GlobalSearchQuery, GlobalSearchResponse, GlobalSearchSchemaQuery, ImportAsyncInput, Job, JobOperation, JobStatus, JobUnion, LinkBucketBody, LinkBucketSchemaBody, LoginType, MergeRequest, MergeRequestActivityEventType, MergeRequestActivityLogEntry, MergeRequestChangeLog, MergeRequestChangeLogEntry, MergeRequestConflict, MergeRequestDetail, MergeRequestDetailWithActivityLog, MergeRequestReviewer, MergeRequestReviewerStatus, Metadata, MetadataId, PartialKey, PrepareFileBody, PreparedFile, PrevieData, PreviewData, ProjectBucketListing, PullTableAsyncInput, PurgeConfigurationInput, PurgeConfigurationsInput, RebaseConfigurationBody, RebaseConfigurationDiff, RebaseConfigurationInput, RebaseConfigurationPath, RebaseConfigurationRow, RebaseConfigurationSchemaBody, RefreshExternalBucketInput, RefreshExternalBucketQuery, RegisterBucketBody, RegisterBucketSchemaBody, RegisterBucketSchemaQuery, ResetWorkspacePassword, RollbackConfigurationRowToVersionInput, RollbackConfigurationRowToVersionSchemaBody, RollbackConfigurationToVersionInput, RollbackConfigurationToVersionResult, RollbackConfigurationToVersionSchemaBody, Row, RunIdStats, RunIdTableStat, SaveBucketMetadataBody, SaveBucketMetadataInput, SaveColumnMetadataInput, SaveConfigurationMetadataBody, SaveConfigurationMetadataInput, SaveConfigurationMetadataPath, SaveConfigurationMetadataSchemaBody, SaveDevBranchMetadataInput, SaveDevBranchMetadataPath, SaveMetadataBody, SaveTableMetadataInput, SaveTableMetadataSchemaBody, ScheduledTask, SearchComponentConfiguration, SearchComponentConfigurationsInput, SearchComponentConfigurationsQuery, SearchComponentConfigurationsSchemaQuery, SearchTablesQuery, SearchTablesSchemaQuery, Service, ServiceId, SetAliasTableFilterBody, SetAliasTableFilterInput, SetWorkspacePublicInput, SetWorkspacePublicKeyBody, SetWorkspacePublicKeyPath, ShareBucketToOrganizationInput, ShareBucketToOrganizationProjectInput, ShareBucketToOrganizationProjectSchemaQuery, ShareBucketToOrganizationSchemaQuery, ShareBucketToProjectsBody, ShareBucketToProjectsInput, ShareBucketToProjectsPath, ShareBucketToProjectsSchemaBody, ShareBucketToProjectsSchemaQuery, ShareBucketToUsersBody, ShareBucketToUsersInput, ShareBucketToUsersPath, ShareBucketToUsersSchemaBody, ShareBucketToUsersSchemaQuery, SharedBuckets, Snapshot, StackComponent, StackInfo, StorageEvent, Subscriber, Table, TableCreateJob, TableDetail, TableEvent, TableExportAsyncBody, TableExportJob, TableImportAsyncBody, TableImportJob, TableMetadataResponse, Trigger, UnloadWorkspaceInput, UnloadWorkspacePath, UnloadWorkspaceQuery, UnshareBucketInput, UnshareBucketSchemaQuery, UpdateBucketBody, UpdateBucketInput, UpdateBucketListingBody, UpdateBucketListingInput, UpdateBucketListingPath, UpdateBucketListingSchemaBody, UpdateBucketOwnerBody, UpdateBucketOwnerInput, UpdateBucketOwnerSchemaBody, UpdateConfigurationBody, UpdateConfigurationInput, UpdateConfigurationResult, UpdateConfigurationRowBody, UpdateConfigurationRowInput, UpdateConfigurationRowPath, UpdateConfigurationRowSchemaBody, UpdateConfigurationRowStateBody, UpdateConfigurationRowStateInput, UpdateConfigurationRowStatePath, UpdateConfigurationRowStateSchemaBody, UpdateConfigurationSchemaBody, UpdateConfigurationSchemaQuery, UpdateConfigurationStateBody, UpdateConfigurationStateInput, UpdateConfigurationStateSchemaBody, UpdateDevBranchInput, UpdateDevBranchSchemaBody, UpdateMergeRequestParams, UpdateTableBody, UpdateTableDefinitionBody, UpdateTableDefinitionInput, UpdateTableDefinitionSchemaBody, UpdateTableInput, UpdateTriggerBody, UpdateTriggerInput, UpdateTriggerRequest, WhereFilters, Workspace, WorkspaceConnection, WorkspaceInputMappingLoadPreviewBody, WorkspaceInputMappingLoadPreviewInput, WorkspaceInputMappingLoadPreviewResponse, WorkspaceLoginType, WorkspaceObject, WorkspacePath, WorkspaceSaml2Login, WorkspacesPath, WrDbRow };
|