alchemy 0.69.0 → 0.70.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.
Files changed (314) hide show
  1. package/bin/alchemy.js +3810 -3889
  2. package/bin/commands/init.ts +41 -55
  3. package/bin/trpc.ts +4 -9
  4. package/lib/alchemy.d.ts +3 -3
  5. package/lib/alchemy.d.ts.map +1 -1
  6. package/lib/alchemy.js +2 -15
  7. package/lib/alchemy.js.map +1 -1
  8. package/lib/apply.js +24 -9
  9. package/lib/apply.js.map +1 -1
  10. package/lib/aws/utils.d.ts +2 -1
  11. package/lib/aws/utils.d.ts.map +1 -1
  12. package/lib/aws/utils.js.map +1 -1
  13. package/lib/clickhouse/api/client.gen.d.ts +13 -0
  14. package/lib/clickhouse/api/client.gen.d.ts.map +1 -0
  15. package/lib/clickhouse/api/client.gen.js +7 -0
  16. package/lib/clickhouse/api/client.gen.js.map +1 -0
  17. package/lib/clickhouse/api/sdk.gen.d.ts +322 -0
  18. package/lib/clickhouse/api/sdk.gen.d.ts.map +1 -0
  19. package/lib/clickhouse/api/sdk.gen.js +683 -0
  20. package/lib/clickhouse/api/sdk.gen.js.map +1 -0
  21. package/lib/clickhouse/api/types.gen.d.ts +5030 -0
  22. package/lib/clickhouse/api/types.gen.d.ts.map +1 -0
  23. package/lib/clickhouse/api/types.gen.js +2 -0
  24. package/lib/clickhouse/api/types.gen.js.map +1 -0
  25. package/lib/clickhouse/api-key.d.ts +29 -0
  26. package/lib/clickhouse/api-key.d.ts.map +1 -0
  27. package/lib/clickhouse/api-key.js +83 -0
  28. package/lib/clickhouse/api-key.js.map +1 -0
  29. package/lib/clickhouse/api.d.ts +36 -0
  30. package/lib/clickhouse/api.d.ts.map +1 -0
  31. package/lib/clickhouse/api.js +48 -0
  32. package/lib/clickhouse/api.js.map +1 -0
  33. package/lib/clickhouse/index.d.ts +4 -0
  34. package/lib/clickhouse/index.d.ts.map +1 -0
  35. package/lib/clickhouse/index.js +4 -0
  36. package/lib/clickhouse/index.js.map +1 -0
  37. package/lib/clickhouse/organization.d.ts +16 -0
  38. package/lib/clickhouse/organization.d.ts.map +1 -0
  39. package/lib/clickhouse/organization.js +21 -0
  40. package/lib/clickhouse/organization.js.map +1 -0
  41. package/lib/clickhouse/service.d.ts +275 -0
  42. package/lib/clickhouse/service.d.ts.map +1 -0
  43. package/lib/clickhouse/service.js +274 -0
  44. package/lib/clickhouse/service.js.map +1 -0
  45. package/lib/cloudflare/account-api-token.d.ts.map +1 -1
  46. package/lib/cloudflare/account-api-token.js +1 -1
  47. package/lib/cloudflare/account-api-token.js.map +1 -1
  48. package/lib/cloudflare/bucket-object.d.ts +5 -0
  49. package/lib/cloudflare/bucket-object.d.ts.map +1 -1
  50. package/lib/cloudflare/bucket-object.js +1 -1
  51. package/lib/cloudflare/bucket-object.js.map +1 -1
  52. package/lib/cloudflare/bucket.d.ts +6 -3
  53. package/lib/cloudflare/bucket.d.ts.map +1 -1
  54. package/lib/cloudflare/bucket.js +60 -8
  55. package/lib/cloudflare/bucket.js.map +1 -1
  56. package/lib/cloudflare/bun-spa/bun-spa.d.ts +15 -0
  57. package/lib/cloudflare/bun-spa/bun-spa.d.ts.map +1 -0
  58. package/lib/cloudflare/bun-spa/bun-spa.js +95 -0
  59. package/lib/cloudflare/bun-spa/bun-spa.js.map +1 -0
  60. package/lib/cloudflare/compatibility-date.gen.d.ts +1 -1
  61. package/lib/cloudflare/compatibility-date.gen.js +1 -1
  62. package/lib/cloudflare/container.d.ts +11 -1
  63. package/lib/cloudflare/container.d.ts.map +1 -1
  64. package/lib/cloudflare/container.js +1 -1
  65. package/lib/cloudflare/container.js.map +1 -1
  66. package/lib/cloudflare/index.d.ts +1 -0
  67. package/lib/cloudflare/index.d.ts.map +1 -1
  68. package/lib/cloudflare/index.js +1 -0
  69. package/lib/cloudflare/index.js.map +1 -1
  70. package/lib/cloudflare/miniflare/build-worker-options.d.ts.map +1 -1
  71. package/lib/cloudflare/miniflare/build-worker-options.js +3 -3
  72. package/lib/cloudflare/miniflare/build-worker-options.js.map +1 -1
  73. package/lib/cloudflare/miniflare/miniflare-controller.d.ts.map +1 -1
  74. package/lib/cloudflare/miniflare/miniflare-controller.js +2 -0
  75. package/lib/cloudflare/miniflare/miniflare-controller.js.map +1 -1
  76. package/lib/cloudflare/miniflare/miniflare-worker-proxy.d.ts +1 -1
  77. package/lib/cloudflare/miniflare/miniflare-worker-proxy.d.ts.map +1 -1
  78. package/lib/cloudflare/miniflare/miniflare-worker-proxy.js +33 -14
  79. package/lib/cloudflare/miniflare/miniflare-worker-proxy.js.map +1 -1
  80. package/lib/cloudflare/permission-groups.d.ts +2 -3
  81. package/lib/cloudflare/permission-groups.d.ts.map +1 -1
  82. package/lib/cloudflare/permission-groups.js +10 -15
  83. package/lib/cloudflare/permission-groups.js.map +1 -1
  84. package/lib/cloudflare/redwood/redwood.d.ts +1 -1
  85. package/lib/cloudflare/redwood/redwood.js +1 -1
  86. package/lib/cloudflare/tanstack-start/plugin.d.ts +2 -15
  87. package/lib/cloudflare/tanstack-start/plugin.d.ts.map +1 -1
  88. package/lib/cloudflare/tanstack-start/plugin.js +5 -25
  89. package/lib/cloudflare/tanstack-start/plugin.js.map +1 -1
  90. package/lib/cloudflare/tanstack-start/tanstack-start.d.ts.map +1 -1
  91. package/lib/cloudflare/tanstack-start/tanstack-start.js +15 -4
  92. package/lib/cloudflare/tanstack-start/tanstack-start.js.map +1 -1
  93. package/lib/cloudflare/util/filter-env-bindings.d.ts +62 -0
  94. package/lib/cloudflare/util/filter-env-bindings.d.ts.map +1 -0
  95. package/lib/cloudflare/util/filter-env-bindings.js +81 -0
  96. package/lib/cloudflare/util/filter-env-bindings.js.map +1 -0
  97. package/lib/cloudflare/website.d.ts +2 -2
  98. package/lib/cloudflare/website.d.ts.map +1 -1
  99. package/lib/cloudflare/website.js +7 -18
  100. package/lib/cloudflare/website.js.map +1 -1
  101. package/lib/cloudflare/worker-metadata.d.ts +5 -1
  102. package/lib/cloudflare/worker-metadata.d.ts.map +1 -1
  103. package/lib/cloudflare/worker-metadata.js +3 -0
  104. package/lib/cloudflare/worker-metadata.js.map +1 -1
  105. package/lib/cloudflare/worker.d.ts +17 -1
  106. package/lib/cloudflare/worker.d.ts.map +1 -1
  107. package/lib/cloudflare/worker.js +1 -0
  108. package/lib/cloudflare/worker.js.map +1 -1
  109. package/lib/cloudflare/wrangler.json.d.ts +15 -1
  110. package/lib/cloudflare/wrangler.json.d.ts.map +1 -1
  111. package/lib/cloudflare/wrangler.json.js +12 -4
  112. package/lib/cloudflare/wrangler.json.js.map +1 -1
  113. package/lib/coinbase/client.d.ts +54 -0
  114. package/lib/coinbase/client.d.ts.map +1 -0
  115. package/lib/coinbase/client.js +89 -0
  116. package/lib/coinbase/client.js.map +1 -0
  117. package/lib/coinbase/evm-account.d.ts +118 -0
  118. package/lib/coinbase/evm-account.d.ts.map +1 -0
  119. package/lib/coinbase/evm-account.js +198 -0
  120. package/lib/coinbase/evm-account.js.map +1 -0
  121. package/lib/coinbase/evm-smart-account.d.ts +122 -0
  122. package/lib/coinbase/evm-smart-account.d.ts.map +1 -0
  123. package/lib/coinbase/evm-smart-account.js +213 -0
  124. package/lib/coinbase/evm-smart-account.js.map +1 -0
  125. package/lib/coinbase/faucet.d.ts +11 -0
  126. package/lib/coinbase/faucet.d.ts.map +1 -0
  127. package/lib/coinbase/faucet.js +146 -0
  128. package/lib/coinbase/faucet.js.map +1 -0
  129. package/lib/coinbase/index.d.ts +4 -0
  130. package/lib/coinbase/index.d.ts.map +1 -0
  131. package/lib/coinbase/index.js +4 -0
  132. package/lib/coinbase/index.js.map +1 -0
  133. package/lib/coinbase/types.d.ts +28 -0
  134. package/lib/coinbase/types.d.ts.map +1 -0
  135. package/lib/coinbase/types.js +4 -0
  136. package/lib/{util/telemetry → coinbase}/types.js.map +1 -1
  137. package/lib/coinbase/utils.d.ts +13 -0
  138. package/lib/coinbase/utils.d.ts.map +1 -0
  139. package/lib/coinbase/utils.js +17 -0
  140. package/lib/coinbase/utils.js.map +1 -0
  141. package/lib/docker/api.d.ts +22 -1
  142. package/lib/docker/api.d.ts.map +1 -1
  143. package/lib/docker/api.js +64 -2
  144. package/lib/docker/api.js.map +1 -1
  145. package/lib/docker/container.d.ts +88 -0
  146. package/lib/docker/container.d.ts.map +1 -1
  147. package/lib/docker/container.js +36 -0
  148. package/lib/docker/container.js.map +1 -1
  149. package/lib/neon/api/types.gen.d.ts +7 -2
  150. package/lib/neon/api/types.gen.d.ts.map +1 -1
  151. package/lib/planetscale/api/types.gen.d.ts +20 -4
  152. package/lib/planetscale/api/types.gen.d.ts.map +1 -1
  153. package/lib/planetscale/api.d.ts.map +1 -1
  154. package/lib/planetscale/api.js +1 -0
  155. package/lib/planetscale/api.js.map +1 -1
  156. package/lib/planetscale/password.d.ts.map +1 -1
  157. package/lib/planetscale/password.js +1 -13
  158. package/lib/planetscale/password.js.map +1 -1
  159. package/lib/resource.d.ts.map +1 -1
  160. package/lib/resource.js +7 -3
  161. package/lib/resource.js.map +1 -1
  162. package/lib/scope.d.ts +4 -9
  163. package/lib/scope.d.ts.map +1 -1
  164. package/lib/scope.js +16 -37
  165. package/lib/scope.js.map +1 -1
  166. package/lib/state/instrumented-state-store.d.ts +1 -3
  167. package/lib/state/instrumented-state-store.d.ts.map +1 -1
  168. package/lib/state/instrumented-state-store.js +19 -21
  169. package/lib/state/instrumented-state-store.js.map +1 -1
  170. package/lib/test/bun.d.ts.map +1 -1
  171. package/lib/test/bun.js +1 -2
  172. package/lib/test/bun.js.map +1 -1
  173. package/lib/test/vitest.d.ts.map +1 -1
  174. package/lib/test/vitest.js +1 -2
  175. package/lib/test/vitest.js.map +1 -1
  176. package/lib/util/diff.d.ts +5 -0
  177. package/lib/util/diff.d.ts.map +1 -0
  178. package/lib/util/diff.js +14 -0
  179. package/lib/util/diff.js.map +1 -0
  180. package/lib/util/telemetry.d.ts +52 -0
  181. package/lib/util/telemetry.d.ts.map +1 -0
  182. package/lib/util/telemetry.js +191 -0
  183. package/lib/util/telemetry.js.map +1 -0
  184. package/package.json +19 -1
  185. package/src/alchemy.ts +5 -20
  186. package/src/apply.ts +29 -12
  187. package/src/aws/utils.ts +2 -1
  188. package/src/clickhouse/api/client.gen.ts +28 -0
  189. package/src/clickhouse/api/sdk.gen.ts +1286 -0
  190. package/src/clickhouse/api/types.gen.ts +5898 -0
  191. package/src/clickhouse/api-key.ts +136 -0
  192. package/src/clickhouse/api.ts +84 -0
  193. package/src/clickhouse/index.ts +3 -0
  194. package/src/clickhouse/organization.ts +31 -0
  195. package/src/clickhouse/service.ts +668 -0
  196. package/src/cloudflare/account-api-token.ts +1 -4
  197. package/src/cloudflare/bucket-object.ts +11 -1
  198. package/src/cloudflare/bucket.ts +72 -6
  199. package/src/cloudflare/bun-spa/bun-spa.ts +139 -0
  200. package/src/cloudflare/compatibility-date.gen.ts +1 -1
  201. package/src/cloudflare/container.ts +22 -3
  202. package/src/cloudflare/index.ts +1 -0
  203. package/src/cloudflare/miniflare/build-worker-options.ts +6 -4
  204. package/src/cloudflare/miniflare/miniflare-controller.ts +2 -0
  205. package/src/cloudflare/miniflare/miniflare-worker-proxy.ts +42 -15
  206. package/src/cloudflare/permission-groups.ts +21 -49
  207. package/src/cloudflare/redwood/redwood.ts +1 -1
  208. package/src/cloudflare/tanstack-start/plugin.ts +7 -28
  209. package/src/cloudflare/tanstack-start/tanstack-start.ts +15 -4
  210. package/src/cloudflare/util/filter-env-bindings.ts +96 -0
  211. package/src/cloudflare/website.ts +12 -24
  212. package/src/cloudflare/worker-metadata.ts +8 -1
  213. package/src/cloudflare/worker.ts +19 -1
  214. package/src/cloudflare/wrangler.json.ts +27 -9
  215. package/src/coinbase/client.ts +146 -0
  216. package/src/coinbase/evm-account.ts +317 -0
  217. package/src/coinbase/evm-smart-account.ts +339 -0
  218. package/src/coinbase/faucet.ts +173 -0
  219. package/src/coinbase/index.ts +3 -0
  220. package/src/coinbase/types.ts +33 -0
  221. package/src/coinbase/utils.ts +19 -0
  222. package/src/docker/api.ts +86 -2
  223. package/src/docker/container.ts +97 -0
  224. package/src/neon/api/types.gen.ts +13 -1
  225. package/src/planetscale/api/types.gen.ts +22 -2
  226. package/src/planetscale/api.ts +1 -0
  227. package/src/planetscale/password.ts +1 -14
  228. package/src/resource.ts +11 -4
  229. package/src/scope.ts +22 -45
  230. package/src/state/instrumented-state-store.ts +27 -26
  231. package/src/test/bun.ts +1 -2
  232. package/src/test/vitest.ts +1 -2
  233. package/src/util/diff.ts +14 -0
  234. package/src/util/telemetry.ts +297 -0
  235. package/templates/tanstack-start/.cta.json +13 -0
  236. package/templates/tanstack-start/README.md +267 -49
  237. package/templates/tanstack-start/_gitignore +9 -18
  238. package/templates/tanstack-start/alchemy.run.ts +2 -2
  239. package/templates/tanstack-start/package.json +24 -19
  240. package/templates/tanstack-start/public/favicon.ico +0 -0
  241. package/templates/tanstack-start/public/logo192.png +0 -0
  242. package/templates/tanstack-start/public/logo512.png +0 -0
  243. package/templates/tanstack-start/public/manifest.json +25 -0
  244. package/templates/tanstack-start/public/robots.txt +3 -0
  245. package/templates/tanstack-start/src/components/Header.tsx +21 -0
  246. package/templates/tanstack-start/src/logo.svg +12 -0
  247. package/templates/tanstack-start/src/router.tsx +7 -16
  248. package/templates/tanstack-start/src/routes/__root.tsx +13 -114
  249. package/templates/tanstack-start/src/routes/api.demo-names.ts +15 -0
  250. package/templates/tanstack-start/src/routes/demo.start.api-request.tsx +44 -0
  251. package/templates/tanstack-start/src/routes/demo.start.server-funcs.tsx +97 -0
  252. package/templates/tanstack-start/src/routes/index.tsx +31 -4
  253. package/templates/tanstack-start/src/styles.css +15 -0
  254. package/templates/tanstack-start/tsconfig.json +19 -22
  255. package/templates/tanstack-start/types/env.d.ts +2 -2
  256. package/templates/tanstack-start/vite.config.ts +16 -25
  257. package/workers/tunnel-proxy.js +1 -1
  258. package/lib/util/telemetry/client.d.ts +0 -31
  259. package/lib/util/telemetry/client.d.ts.map +0 -1
  260. package/lib/util/telemetry/client.js +0 -121
  261. package/lib/util/telemetry/client.js.map +0 -1
  262. package/lib/util/telemetry/constants.d.ts +0 -5
  263. package/lib/util/telemetry/constants.d.ts.map +0 -1
  264. package/lib/util/telemetry/constants.js +0 -8
  265. package/lib/util/telemetry/constants.js.map +0 -1
  266. package/lib/util/telemetry/context.d.ts +0 -15
  267. package/lib/util/telemetry/context.d.ts.map +0 -1
  268. package/lib/util/telemetry/context.js +0 -128
  269. package/lib/util/telemetry/context.js.map +0 -1
  270. package/lib/util/telemetry/index.d.ts +0 -3
  271. package/lib/util/telemetry/index.d.ts.map +0 -1
  272. package/lib/util/telemetry/index.js +0 -3
  273. package/lib/util/telemetry/index.js.map +0 -1
  274. package/lib/util/telemetry/types.d.ts +0 -68
  275. package/lib/util/telemetry/types.d.ts.map +0 -1
  276. package/lib/util/telemetry/types.js +0 -1
  277. package/src/util/telemetry/client.ts +0 -156
  278. package/src/util/telemetry/constants.ts +0 -13
  279. package/src/util/telemetry/context.ts +0 -154
  280. package/src/util/telemetry/index.ts +0 -2
  281. package/src/util/telemetry/types.ts +0 -105
  282. package/templates/tanstack-start/_prettierignore +0 -4
  283. package/templates/tanstack-start/public/android-chrome-192x192.png +0 -0
  284. package/templates/tanstack-start/public/android-chrome-512x512.png +0 -0
  285. package/templates/tanstack-start/public/apple-touch-icon.png +0 -0
  286. package/templates/tanstack-start/public/favicon-16x16.png +0 -0
  287. package/templates/tanstack-start/public/favicon-32x32.png +0 -0
  288. package/templates/tanstack-start/public/favicon.png +0 -0
  289. package/templates/tanstack-start/public/site.webmanifest +0 -19
  290. package/templates/tanstack-start/src/components/DefaultCatchBoundary.tsx +0 -53
  291. package/templates/tanstack-start/src/components/NotFound.tsx +0 -25
  292. package/templates/tanstack-start/src/components/PostError.tsx +0 -5
  293. package/templates/tanstack-start/src/components/UserError.tsx +0 -5
  294. package/templates/tanstack-start/src/routes/_pathlessLayout/_nested-layout/route-a.tsx +0 -10
  295. package/templates/tanstack-start/src/routes/_pathlessLayout/_nested-layout/route-b.tsx +0 -10
  296. package/templates/tanstack-start/src/routes/_pathlessLayout/_nested-layout.tsx +0 -34
  297. package/templates/tanstack-start/src/routes/_pathlessLayout.tsx +0 -16
  298. package/templates/tanstack-start/src/routes/api/users.$userId.ts +0 -28
  299. package/templates/tanstack-start/src/routes/api/users.ts +0 -59
  300. package/templates/tanstack-start/src/routes/customScript[.]js.ts +0 -10
  301. package/templates/tanstack-start/src/routes/deferred.tsx +0 -62
  302. package/templates/tanstack-start/src/routes/posts.$postId.tsx +0 -34
  303. package/templates/tanstack-start/src/routes/posts.index.tsx +0 -8
  304. package/templates/tanstack-start/src/routes/posts.tsx +0 -38
  305. package/templates/tanstack-start/src/routes/posts_.$postId.deep.tsx +0 -29
  306. package/templates/tanstack-start/src/routes/redirect.tsx +0 -9
  307. package/templates/tanstack-start/src/routes/users.$userId.tsx +0 -44
  308. package/templates/tanstack-start/src/routes/users.index.tsx +0 -18
  309. package/templates/tanstack-start/src/routes/users.tsx +0 -49
  310. package/templates/tanstack-start/src/styles/app.css +0 -12
  311. package/templates/tanstack-start/src/utils/loggingMiddleware.tsx +0 -41
  312. package/templates/tanstack-start/src/utils/posts.tsx +0 -40
  313. package/templates/tanstack-start/src/utils/seo.ts +0 -33
  314. package/templates/tanstack-start/src/utils/users.tsx +0 -5
@@ -0,0 +1,5030 @@
1
+ export type ClientOptions = {
2
+ baseUrl: "https://api.clickhouse.cloud" | (string & {});
3
+ };
4
+ export type Plain = {
5
+ /**
6
+ * Username.
7
+ */
8
+ username?: string;
9
+ /**
10
+ * Password.
11
+ */
12
+ password?: string;
13
+ };
14
+ export type MskIamUser = {
15
+ /**
16
+ * IAM access key ID.
17
+ */
18
+ accessKeyId?: string;
19
+ /**
20
+ * IAM secret key.
21
+ */
22
+ secretKey?: string;
23
+ };
24
+ export type ClickPipeKafkaOffset = {
25
+ /**
26
+ * Offset strategy.
27
+ */
28
+ strategy?: "from_beginning" | "from_latest" | "from_timestamp";
29
+ /**
30
+ * A minute precision UTC timestamp to start from. Required for "from_timestamp" strategy.
31
+ */
32
+ timestamp?: string | null;
33
+ };
34
+ export type ClickPipeKafkaSchemaRegistry = {
35
+ /**
36
+ * Schema URL. HTTPS required.
37
+ */
38
+ url?: string;
39
+ /**
40
+ * Authentication type of the schema registry.
41
+ */
42
+ authentication?: "PLAIN";
43
+ /**
44
+ * PEM encoded CA certificates to validate the schema registry's certificate.
45
+ */
46
+ caCertificate?: string | null;
47
+ };
48
+ export type ClickPipeKafkaSchemaRegistryCredentials = {
49
+ /**
50
+ * Username for the schema registry.
51
+ */
52
+ username?: string;
53
+ /**
54
+ * Password for the schema registry.
55
+ */
56
+ password?: string;
57
+ };
58
+ export type ClickPipeMutateKafkaSchemaRegistry = {
59
+ /**
60
+ * Schema URL. HTTPS required.
61
+ */
62
+ url?: string;
63
+ /**
64
+ * Authentication type of the schema registry.
65
+ */
66
+ authentication?: "PLAIN";
67
+ /**
68
+ * PEM encoded CA certificates to validate the schema registry's certificate.
69
+ */
70
+ caCertificate?: string | null;
71
+ credentials?: ClickPipeKafkaSchemaRegistryCredentials;
72
+ };
73
+ export type AzureEventHub = {
74
+ /**
75
+ * Connection string for Azure EventHub source.
76
+ */
77
+ connectionString?: string;
78
+ };
79
+ export type ClickPipeKafkaSource = {
80
+ /**
81
+ * Type of the Kafka source.
82
+ */
83
+ type?: "kafka" | "redpanda" | "msk" | "confluent" | "warpstream" | "azureeventhub" | "dokafka";
84
+ /**
85
+ * Format of the Kafka source.
86
+ */
87
+ format?: "JSONEachRow" | "Avro" | "AvroConfluent";
88
+ /**
89
+ * Brokers of the Kafka source.
90
+ */
91
+ brokers?: string;
92
+ /**
93
+ * Topics of the Kafka source.
94
+ */
95
+ topics?: string;
96
+ /**
97
+ * Consumer group of the Kafka source. If not provided "clickpipes-<<ID>>" will be used.
98
+ */
99
+ consumerGroup?: string | null;
100
+ /**
101
+ * Authentication method of the Kafka source. Supported authentication methods: kafka: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS, msk: SCRAM-SHA-512, IAM_ROLE, IAM_USER, MUTUAL_TLS, confluent: PLAIN, MUTUAL_TLS, warpstream: PLAIN, azureeventhub: PLAIN, redpanda: SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS, dokafka: SCRAM-SHA-256, MUTUAL_TLS
102
+ */
103
+ authentication?: "PLAIN" | "SCRAM-SHA-256" | "SCRAM-SHA-512" | "IAM_ROLE" | "IAM_USER" | "MUTUAL_TLS";
104
+ /**
105
+ * IAM role for the Kafka source. Use with IAM role authentication. Read more in ClickPipes documentation: https://clickhouse.com/docs/en/integrations/clickpipes/kafka#iam
106
+ */
107
+ iamRole?: string | null;
108
+ offset?: ClickPipeKafkaOffset | null;
109
+ schemaRegistry?: ClickPipeKafkaSchemaRegistry | null;
110
+ /**
111
+ * PEM encoded CA certificates to validate the broker's certificate.
112
+ */
113
+ caCertificate?: string | null;
114
+ /**
115
+ * Reverse private endpoint UUIDs used for a secure private connection to the Kafka source.
116
+ */
117
+ reversePrivateEndpointIds?: Array<string>;
118
+ };
119
+ export type ClickPipePostKafkaSource = {
120
+ /**
121
+ * Type of the Kafka source.
122
+ */
123
+ type?: "kafka" | "redpanda" | "msk" | "confluent" | "warpstream" | "azureeventhub" | "dokafka";
124
+ /**
125
+ * Format of the Kafka source.
126
+ */
127
+ format?: "JSONEachRow" | "Avro" | "AvroConfluent";
128
+ /**
129
+ * Brokers of the Kafka source.
130
+ */
131
+ brokers?: string;
132
+ /**
133
+ * Topics of the Kafka source.
134
+ */
135
+ topics?: string;
136
+ /**
137
+ * Consumer group of the Kafka source. If not provided "clickpipes-<<ID>>" will be used.
138
+ */
139
+ consumerGroup?: string | null;
140
+ /**
141
+ * Authentication method of the Kafka source. Supported authentication methods: kafka: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS, msk: SCRAM-SHA-512, IAM_ROLE, IAM_USER, MUTUAL_TLS, confluent: PLAIN, MUTUAL_TLS, warpstream: PLAIN, azureeventhub: PLAIN, redpanda: SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS, dokafka: SCRAM-SHA-256, MUTUAL_TLS
142
+ */
143
+ authentication?: "PLAIN" | "SCRAM-SHA-256" | "SCRAM-SHA-512" | "IAM_ROLE" | "IAM_USER" | "MUTUAL_TLS";
144
+ /**
145
+ * IAM role for the Kafka source. Use with IAM role authentication. Read more in ClickPipes documentation: https://clickhouse.com/docs/en/integrations/clickpipes/kafka#iam
146
+ */
147
+ iamRole?: string | null;
148
+ offset?: ClickPipeKafkaOffset | null;
149
+ schemaRegistry?: ClickPipeMutateKafkaSchemaRegistry | null;
150
+ /**
151
+ * PEM encoded CA certificates to validate the broker's certificate.
152
+ */
153
+ caCertificate?: string | null;
154
+ /**
155
+ * Reverse private endpoint UUIDs used for a secure private connection to the Kafka source.
156
+ */
157
+ reversePrivateEndpointIds?: Array<string>;
158
+ /**
159
+ * Credentials for Kafka source. Chose one of that is supported by the authentication method.
160
+ */
161
+ credentials?: Plain | MskIamUser | AzureEventHub | null;
162
+ };
163
+ export type ClickPipePatchKafkaSource = {
164
+ /**
165
+ * Authentication method of the Kafka source. Supported authentication methods: kafka: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS, msk: SCRAM-SHA-512, IAM_ROLE, IAM_USER, MUTUAL_TLS, confluent: PLAIN, MUTUAL_TLS, warpstream: PLAIN, azureeventhub: PLAIN, redpanda: SCRAM-SHA-256, SCRAM-SHA-512, MUTUAL_TLS, dokafka: SCRAM-SHA-256, MUTUAL_TLS
166
+ */
167
+ authentication?: "PLAIN" | "SCRAM-SHA-256" | "SCRAM-SHA-512" | "IAM_ROLE" | "IAM_USER" | "MUTUAL_TLS";
168
+ /**
169
+ * IAM role for the Kafka source. Use with IAM role authentication. Read more in ClickPipes documentation: https://clickhouse.com/docs/en/integrations/clickpipes/kafka#iam
170
+ */
171
+ iamRole?: string | null;
172
+ /**
173
+ * PEM encoded CA certificates to validate the broker's certificate.
174
+ */
175
+ caCertificate?: string | null;
176
+ /**
177
+ * Reverse private endpoint UUIDs used for a secure private connection to the Kafka source.
178
+ */
179
+ reversePrivateEndpointIds?: Array<string>;
180
+ /**
181
+ * Credentials for Kafka source. Chose one of that is supported by the authentication method.
182
+ */
183
+ credentials?: Plain | MskIamUser | AzureEventHub | null;
184
+ };
185
+ export type ClickPipeKinesisSource = {
186
+ /**
187
+ * Format of the Kinesis stream.
188
+ */
189
+ format?: "JSONEachRow" | "Avro" | "AvroConfluent";
190
+ /**
191
+ * Name of the Kinesis stream.
192
+ */
193
+ streamName?: string;
194
+ /**
195
+ * AWS region of the Kinesis stream.
196
+ */
197
+ region?: string;
198
+ /**
199
+ * Use enhanced fan-out for the Kinesis stream.
200
+ */
201
+ useEnhancedFanOut?: boolean | null;
202
+ /**
203
+ * Type of iterator to use when reading from the Kinesis stream. If AT_TIMESTAMP is used, the timestamp field must be provided.
204
+ */
205
+ iteratorType?: "TRIM_HORIZON" | "LATEST" | "AT_TIMESTAMP";
206
+ /**
207
+ * UNIX timestamp to start reading from the Kinesis stream. Required if iteratorType is AT_TIMESTAMP.
208
+ */
209
+ timestamp?: number | null;
210
+ /**
211
+ * Authentication method to use with the Kinesis stream.
212
+ */
213
+ authentication?: "IAM_ROLE" | "IAM_USER";
214
+ /**
215
+ * IAM role to use for authentication. Required if IAM_ROLE is used.
216
+ */
217
+ iamRole?: string | null;
218
+ };
219
+ export type ClickPipePostKinesisSource = {
220
+ /**
221
+ * Format of the Kinesis stream.
222
+ */
223
+ format?: "JSONEachRow" | "Avro" | "AvroConfluent";
224
+ /**
225
+ * Name of the Kinesis stream.
226
+ */
227
+ streamName?: string;
228
+ /**
229
+ * AWS region of the Kinesis stream.
230
+ */
231
+ region?: string;
232
+ /**
233
+ * Use enhanced fan-out for the Kinesis stream.
234
+ */
235
+ useEnhancedFanOut?: boolean | null;
236
+ /**
237
+ * Type of iterator to use when reading from the Kinesis stream. If AT_TIMESTAMP is used, the timestamp field must be provided.
238
+ */
239
+ iteratorType?: "TRIM_HORIZON" | "LATEST" | "AT_TIMESTAMP";
240
+ /**
241
+ * UNIX timestamp to start reading from the Kinesis stream. Required if iteratorType is AT_TIMESTAMP.
242
+ */
243
+ timestamp?: number | null;
244
+ /**
245
+ * Authentication method to use with the Kinesis stream.
246
+ */
247
+ authentication?: "IAM_ROLE" | "IAM_USER";
248
+ /**
249
+ * IAM role to use for authentication. Required if IAM_ROLE is used.
250
+ */
251
+ iamRole?: string | null;
252
+ accessKey?: MskIamUser | null;
253
+ };
254
+ export type ClickPipePatchKinesisSource = {
255
+ /**
256
+ * Authentication method to use with the Kinesis stream.
257
+ */
258
+ authentication?: "IAM_ROLE" | "IAM_USER";
259
+ /**
260
+ * IAM role to use for authentication. Required if IAM_ROLE is used.
261
+ */
262
+ iamRole?: string | null;
263
+ accessKey?: MskIamUser | null;
264
+ };
265
+ export type ClickPipeObjectStorageSource = {
266
+ /**
267
+ * Type of the ObjectStorage source.
268
+ */
269
+ type?: "s3" | "gcs" | "dospaces" | "azureblobstorage";
270
+ /**
271
+ * Format of the files.
272
+ */
273
+ format?: "JSONEachRow" | "JSONAsObject" | "CSV" | "CSVWithNames" | "Parquet" | "Avro";
274
+ /**
275
+ * Provide a path to the file(s) you want to ingest. You can specify multiple files using bash-like wildcards. For more information, see the documentation on using wildcards in path: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations
276
+ */
277
+ url?: string;
278
+ /**
279
+ * Delimiter used in the files.
280
+ */
281
+ delimiter?: string | null;
282
+ /**
283
+ * Compression algorithm used for the files.
284
+ */
285
+ compression?: "gzip" | "gz" | "brotli" | "br" | "xz" | "LZMA" | "zstd" | "auto";
286
+ /**
287
+ * If set to true, the pipe will continuously read new files from the source. If set to false, the pipe will read the files only once. New files have to be uploaded lexically order.
288
+ */
289
+ isContinuous?: boolean | null;
290
+ /**
291
+ * Authentication method. CONNECTION_STRING is for Azure Blob Storage. IAM_ROLE and IAM_USER are for AWS S3/GCS/DigitalOcean. If not provided, no authentication is used.
292
+ */
293
+ authentication?: "IAM_ROLE" | "IAM_USER" | "CONNECTION_STRING";
294
+ /**
295
+ * IAM role to be used with IAM role authentication. Read more in ClickPipes documentation: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#authentication
296
+ */
297
+ iamRole?: string | null;
298
+ /**
299
+ * Connection string for Azure Blob Storage authentication. Required when authentication is CONNECTION_STRING.
300
+ */
301
+ connectionString?: string | null;
302
+ /**
303
+ * Path to the file(s) within the Azure container. Used for Azure Blob Storage sources. You can specify multiple files using bash-like wildcards. For more information, see the documentation on using wildcards in path: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations
304
+ */
305
+ path?: string | null;
306
+ /**
307
+ * Container name for Azure Blob Storage. Required when type is azureblobstorage.
308
+ */
309
+ azureContainerName?: string | null;
310
+ };
311
+ export type ClickPipePostObjectStorageSource = {
312
+ /**
313
+ * Type of the ObjectStorage source.
314
+ */
315
+ type?: "s3" | "gcs" | "dospaces" | "azureblobstorage";
316
+ /**
317
+ * Format of the files.
318
+ */
319
+ format?: "JSONEachRow" | "JSONAsObject" | "CSV" | "CSVWithNames" | "Parquet" | "Avro";
320
+ /**
321
+ * Provide a path to the file(s) you want to ingest. You can specify multiple files using bash-like wildcards. For more information, see the documentation on using wildcards in path: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations
322
+ */
323
+ url?: string;
324
+ /**
325
+ * Delimiter used in the files.
326
+ */
327
+ delimiter?: string | null;
328
+ /**
329
+ * Compression algorithm used for the files.
330
+ */
331
+ compression?: "gzip" | "gz" | "brotli" | "br" | "xz" | "LZMA" | "zstd" | "auto";
332
+ /**
333
+ * If set to true, the pipe will continuously read new files from the source. If set to false, the pipe will read the files only once. New files have to be uploaded lexically order.
334
+ */
335
+ isContinuous?: boolean | null;
336
+ /**
337
+ * Authentication method. CONNECTION_STRING is for Azure Blob Storage. IAM_ROLE and IAM_USER are for AWS S3/GCS/DigitalOcean. If not provided, no authentication is used.
338
+ */
339
+ authentication?: "IAM_ROLE" | "IAM_USER" | "CONNECTION_STRING";
340
+ /**
341
+ * IAM role to be used with IAM role authentication. Read more in ClickPipes documentation: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#authentication
342
+ */
343
+ iamRole?: string | null;
344
+ /**
345
+ * Connection string for Azure Blob Storage authentication. Required when authentication is CONNECTION_STRING.
346
+ */
347
+ connectionString?: string | null;
348
+ /**
349
+ * Path to the file(s) within the Azure container. Used for Azure Blob Storage sources. You can specify multiple files using bash-like wildcards. For more information, see the documentation on using wildcards in path: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations
350
+ */
351
+ path?: string | null;
352
+ /**
353
+ * Container name for Azure Blob Storage. Required when type is azureblobstorage.
354
+ */
355
+ azureContainerName?: string | null;
356
+ accessKey?: MskIamUser | null;
357
+ };
358
+ export type ClickPipePatchObjectStorageSource = {
359
+ /**
360
+ * Authentication method. CONNECTION_STRING is for Azure Blob Storage. IAM_ROLE and IAM_USER are for AWS S3/GCS/DigitalOcean. If not provided, no authentication is used.
361
+ */
362
+ authentication?: "IAM_ROLE" | "IAM_USER" | "CONNECTION_STRING";
363
+ /**
364
+ * IAM role to be used with IAM role authentication. Read more in ClickPipes documentation: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#authentication
365
+ */
366
+ iamRole?: string | null;
367
+ /**
368
+ * Connection string for Azure Blob Storage authentication. Required when authentication is CONNECTION_STRING.
369
+ */
370
+ connectionString?: string | null;
371
+ /**
372
+ * Path to the file(s) within the Azure container. Used for Azure Blob Storage sources. You can specify multiple files using bash-like wildcards. For more information, see the documentation on using wildcards in path: https://clickhouse.com/docs/en/integrations/clickpipes/object-storage#limitations
373
+ */
374
+ path?: string | null;
375
+ /**
376
+ * Container name for Azure Blob Storage. Required when type is azureblobstorage.
377
+ */
378
+ azureContainerName?: string | null;
379
+ accessKey?: MskIamUser | null;
380
+ };
381
+ export type ClickPipePostgresPipeSettings = {
382
+ /**
383
+ * Interval in seconds to sync data from Postgres.
384
+ */
385
+ syncIntervalSeconds?: number;
386
+ /**
387
+ * Number of rows to pull in each batch.
388
+ */
389
+ pullBatchSize?: number;
390
+ /**
391
+ * Publication name to use for replication.
392
+ */
393
+ publicationName?: string;
394
+ /**
395
+ * Replication mode to use for the pipe.
396
+ */
397
+ replicationMode?: "cdc" | "snapshot" | "cdc_only";
398
+ /**
399
+ * Replication slot name to use for replication.
400
+ */
401
+ replicationSlotName?: string;
402
+ /**
403
+ * Allow nullable columns in the destination table.
404
+ */
405
+ allowNullableColumns?: boolean;
406
+ /**
407
+ * Number of parallel tables to sync during initial load.
408
+ */
409
+ initialLoadParallelism?: number;
410
+ /**
411
+ * Number of rows to snapshot per partition.
412
+ */
413
+ snapshotNumRowsPerPartition?: number;
414
+ /**
415
+ * Number of parallel tables to snapshot.
416
+ */
417
+ snapshotNumberOfParallelTables?: number;
418
+ /**
419
+ * Enable failover for created replication slot. Requires a replication slot to NOT be set.
420
+ */
421
+ enableFailoverSlots?: boolean;
422
+ };
423
+ export type ClickPipePatchPostgresPipeSettings = {
424
+ /**
425
+ * Interval in seconds to sync data from Postgres.
426
+ */
427
+ syncIntervalSeconds?: number | null;
428
+ /**
429
+ * Number of rows to pull in each batch.
430
+ */
431
+ pullBatchSize?: number | null;
432
+ };
433
+ export type ClickPipePostgresPipeTableMapping = {
434
+ /**
435
+ * Source schema name.
436
+ */
437
+ sourceSchemaName?: string;
438
+ /**
439
+ * Source table name.
440
+ */
441
+ sourceTable?: string;
442
+ /**
443
+ * Target table name.
444
+ */
445
+ targetTable?: string;
446
+ /**
447
+ * Columns to exclude from the target table.
448
+ */
449
+ excludedColumns?: Array<string>;
450
+ /**
451
+ * Whether to use a custom sorting key for the target table.
452
+ */
453
+ useCustomSortingKey?: boolean;
454
+ /**
455
+ * Ordered list of columns to use as sorting key for the target table.
456
+ */
457
+ sortingKeys?: Array<string>;
458
+ /**
459
+ * Table engine to use for the target table.
460
+ */
461
+ tableEngine?: "MergeTree" | "ReplacingMergeTree" | "Null";
462
+ };
463
+ export type ClickPipePatchPostgresPipeRemoveTableMapping = {
464
+ /**
465
+ * Source schema name.
466
+ */
467
+ sourceSchemaName?: string | null;
468
+ /**
469
+ * Source table name.
470
+ */
471
+ sourceTable?: string | null;
472
+ /**
473
+ * Target table name.
474
+ */
475
+ targetTable?: string | null;
476
+ /**
477
+ * Table engine to use for the target table.
478
+ */
479
+ tableEngine?: "MergeTree" | "ReplacingMergeTree" | "Null";
480
+ };
481
+ export type ClickPipePostgresSource = {
482
+ /**
483
+ * Host of the Postgres instance to connect to.
484
+ */
485
+ host?: string;
486
+ /**
487
+ * Port of the Postgres instance to connect to.
488
+ */
489
+ port?: number;
490
+ /**
491
+ * Database of the Postgres instance to connect to.
492
+ */
493
+ database?: string;
494
+ settings?: ClickPipePostgresPipeSettings;
495
+ /**
496
+ * Table mappings for Postgres pipe.
497
+ */
498
+ tableMappings?: Array<ClickPipePostgresPipeTableMapping>;
499
+ };
500
+ export type ClickPipeMutatePostgresSource = {
501
+ /**
502
+ * Host of the Postgres instance to connect to.
503
+ */
504
+ host?: string;
505
+ /**
506
+ * Port of the Postgres instance to connect to.
507
+ */
508
+ port?: number;
509
+ /**
510
+ * Database of the Postgres instance to connect to.
511
+ */
512
+ database?: string;
513
+ settings?: ClickPipePostgresPipeSettings;
514
+ /**
515
+ * Table mappings for Postgres pipe.
516
+ */
517
+ tableMappings?: Array<ClickPipePostgresPipeTableMapping>;
518
+ credentials?: Plain;
519
+ };
520
+ export type ClickPipePatchPostgresSource = {
521
+ /**
522
+ * Host of the Postgres instance to connect to.
523
+ */
524
+ host?: string | null;
525
+ /**
526
+ * Port of the Postgres instance to connect to.
527
+ */
528
+ port?: number | null;
529
+ /**
530
+ * Database of the Postgres instance to connect to.
531
+ */
532
+ database?: string | null;
533
+ credentials?: Plain | null;
534
+ settings?: ClickPipePatchPostgresPipeSettings;
535
+ /**
536
+ * Table mappings to add to Postgres pipe.
537
+ */
538
+ tableMappingsToAdd?: Array<ClickPipePostgresPipeTableMapping>;
539
+ /**
540
+ * Table mappings to remove from Postgres pipe.
541
+ */
542
+ tableMappingsToRemove?: Array<ClickPipePatchPostgresPipeRemoveTableMapping>;
543
+ };
544
+ export type ClickPipeScaling = {
545
+ /**
546
+ * Desired number of replicas. Only for scalable pipes.
547
+ */
548
+ replicas?: number;
549
+ /**
550
+ * Desired number of concurrency. Only for S3 pipes. If set to 0, concurrency is auto-scaled based on the cluster memory.
551
+ */
552
+ concurrency?: number;
553
+ /**
554
+ * CPU in millicores for each replica. Only for streaming pipes.
555
+ */
556
+ replicaCpuMillicores?: number;
557
+ /**
558
+ * Memory in GB for each replica. Only for streaming pipes.
559
+ */
560
+ replicaMemoryGb?: number;
561
+ };
562
+ export type ClickPipeSource = {
563
+ kafka?: ClickPipeKafkaSource | null;
564
+ objectStorage?: ClickPipeObjectStorageSource | null;
565
+ kinesis?: ClickPipeKinesisSource | null;
566
+ postgres?: ClickPipePostgresSource | null;
567
+ };
568
+ export type ClickPipeDestinationColumn = {
569
+ /**
570
+ * Name of the column.
571
+ */
572
+ name?: string;
573
+ /**
574
+ * Type of the column.
575
+ */
576
+ type?: string;
577
+ };
578
+ export type ClickPipeDestinationTableEngine = {
579
+ /**
580
+ * Engine type of the destination table.
581
+ */
582
+ type?: "MergeTree" | "ReplacingMergeTree" | "SummingMergeTree" | "Null";
583
+ /**
584
+ * Column name to use as version for ReplacingMergeTree engine.
585
+ */
586
+ versionColumnId?: string | null;
587
+ /**
588
+ * Column names to sum for SummingMergeTree engine.
589
+ */
590
+ columnIds?: Array<string>;
591
+ };
592
+ export type ClickPipeDestinationTableDefinition = {
593
+ engine?: ClickPipeDestinationTableEngine;
594
+ /**
595
+ * Sorting key of the destination table. List of columns.
596
+ */
597
+ sortingKey?: Array<string>;
598
+ /**
599
+ * Partition key SQL expression.
600
+ */
601
+ partitionBy?: string;
602
+ /**
603
+ * Primary key of SQL expression.
604
+ */
605
+ primaryKey?: string;
606
+ };
607
+ export type ClickPipeDestination = {
608
+ /**
609
+ * Destination database.
610
+ */
611
+ database?: string;
612
+ /**
613
+ * Destination table. Required field for all pipe types except Postgres.
614
+ */
615
+ table?: string;
616
+ /**
617
+ * Is the table managed by ClickPipes? Required field for all pipe types except Postgres.
618
+ */
619
+ managedTable?: boolean;
620
+ tableDefinition?: ClickPipeDestinationTableDefinition;
621
+ /**
622
+ * Columns of the destination table. Required field for all pipe types except Postgres.
623
+ */
624
+ columns?: Array<ClickPipeDestinationColumn>;
625
+ };
626
+ export type ClickPipeFieldMapping = {
627
+ /**
628
+ * Source field name.
629
+ */
630
+ sourceField?: string;
631
+ /**
632
+ * Destination field name.
633
+ */
634
+ destinationField?: string;
635
+ };
636
+ export type ClickPipeSettings = {
637
+ /**
638
+ * Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse.
639
+ */
640
+ streaming_max_insert_wait_ms?: number | null;
641
+ /**
642
+ * Object storage concurrency. Number of concurrent file processing threads
643
+ */
644
+ object_storage_concurrency?: number | null;
645
+ /**
646
+ * Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data
647
+ */
648
+ object_storage_polling_interval_ms?: number | null;
649
+ /**
650
+ * Max insert bytes. Number of bytes to process in a single insert batch
651
+ */
652
+ object_storage_max_insert_bytes?: number | null;
653
+ /**
654
+ * Max file count. Maximum number of files to process in a single insert batch
655
+ */
656
+ object_storage_max_file_count?: number | null;
657
+ /**
658
+ * Max threads. Maximum number of concurrent threads for file processing
659
+ */
660
+ clickhouse_max_threads?: number | null;
661
+ /**
662
+ * Max insert threads. Maximum number of concurrent insert threads
663
+ */
664
+ clickhouse_max_insert_threads?: number | null;
665
+ /**
666
+ * Min insert block size bytes. Minimum size of data block for insert (in bytes)
667
+ */
668
+ clickhouse_min_insert_block_size_bytes?: number | null;
669
+ /**
670
+ * Max download threads. Maximum number of concurrent download threads
671
+ */
672
+ clickhouse_max_download_threads?: number | null;
673
+ /**
674
+ * Parallel distributed insert select. Parallel distributed insert select setting
675
+ */
676
+ clickhouse_parallel_distributed_insert_select?: number | null;
677
+ /**
678
+ * use cluster function. Whether to use ClickHouse cluster function for distributed processing
679
+ */
680
+ object_storage_use_cluster_function?: boolean | null;
681
+ /**
682
+ * parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially
683
+ */
684
+ clickhouse_parallel_view_processing?: boolean | null;
685
+ };
686
+ export type ClickPipe = {
687
+ /**
688
+ * Unique ClickPipe ID.
689
+ */
690
+ id?: string;
691
+ /**
692
+ * ID of the service this ClickPipe belongs to.
693
+ */
694
+ serviceId?: string;
695
+ /**
696
+ * Name of the ClickPipe.
697
+ */
698
+ name?: string;
699
+ /**
700
+ * Current state of the ClickPipe.
701
+ */
702
+ state?: string;
703
+ scaling?: ClickPipeScaling;
704
+ source?: ClickPipeSource;
705
+ destination?: ClickPipeDestination;
706
+ /**
707
+ * Field mappings of the ClickPipe. Note that all destination columns must be included in the mappings.
708
+ */
709
+ fieldMappings?: Array<ClickPipeFieldMapping>;
710
+ settings?: ClickPipeSettings;
711
+ /**
712
+ * Creation date of the ClickPipe.
713
+ */
714
+ createdAt?: string;
715
+ /**
716
+ * Last update date of the ClickPipe.
717
+ */
718
+ updatedAt?: string;
719
+ };
720
+ export type ClickPipePostSource = {
721
+ kafka?: ClickPipePostKafkaSource | null;
722
+ objectStorage?: ClickPipePostObjectStorageSource | null;
723
+ kinesis?: ClickPipePostKinesisSource | null;
724
+ postgres?: ClickPipeMutatePostgresSource;
725
+ /**
726
+ * Validate data samples received from data source. It will validate the connection and data availability and correctness. If not enabled, only connection will be validated. This has no effect on Postgres pipes, they always only validate the connection and table definitions. This is experimental and can be removed in the future.
727
+ */
728
+ validateSamples?: boolean;
729
+ };
730
+ export type ClickPipePatchSource = {
731
+ kafka?: ClickPipePatchKafkaSource | null;
732
+ objectStorage?: ClickPipePatchObjectStorageSource | null;
733
+ kinesis?: ClickPipePatchKinesisSource | null;
734
+ postgres?: ClickPipePatchPostgresSource;
735
+ /**
736
+ * Validate data samples received from data source. It will validate the connection and data availability and correctness. If not enabled, only connection will be validated. This has no effect on Postgres pipes, they always only validate the connection and table definitions. This is experimental and can be removed in the future.
737
+ */
738
+ validateSamples?: boolean;
739
+ };
740
+ export type ClickPipeMutateDestination = {
741
+ /**
742
+ * Destination database.
743
+ */
744
+ database?: string;
745
+ /**
746
+ * Destination table. Required field for all pipe types except Postgres.
747
+ */
748
+ table?: string;
749
+ /**
750
+ * Is the table managed by ClickPipes? Required field for all pipe types except Postgres.
751
+ */
752
+ managedTable?: boolean;
753
+ tableDefinition?: ClickPipeDestinationTableDefinition;
754
+ /**
755
+ * Columns of the destination table. Required field for all pipe types except Postgres.
756
+ */
757
+ columns?: Array<ClickPipeDestinationColumn>;
758
+ /**
759
+ * ClickPipe will create a ClickHouse user with these roles. Add your custom roles here if required.
760
+ */
761
+ roles?: Array<string>;
762
+ };
763
+ export type ClickPipePatchDestination = {
764
+ /**
765
+ * Columns of the destination table. This will not update the table schema, only the ClickPipe configuration.
766
+ */
767
+ columns?: Array<ClickPipeDestinationColumn>;
768
+ };
769
+ export type ClickPipesCdcScaling = {
770
+ /**
771
+ * CPU in millicores for DB ClickPipes.
772
+ */
773
+ replicaCpuMillicores?: number;
774
+ /**
775
+ * Memory in GiB for DB ClickPipes. Must be 4× the CPU core count.
776
+ */
777
+ replicaMemoryGb?: number;
778
+ };
779
+ export type ClickPipeSettingsGetResponse = {
780
+ /**
781
+ * Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse.
782
+ */
783
+ streaming_max_insert_wait_ms?: number | null;
784
+ /**
785
+ * Object storage concurrency. Number of concurrent file processing threads
786
+ */
787
+ object_storage_concurrency?: number | null;
788
+ /**
789
+ * Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data
790
+ */
791
+ object_storage_polling_interval_ms?: number | null;
792
+ /**
793
+ * Max insert bytes. Number of bytes to process in a single insert batch
794
+ */
795
+ object_storage_max_insert_bytes?: number | null;
796
+ /**
797
+ * Max file count. Maximum number of files to process in a single insert batch
798
+ */
799
+ object_storage_max_file_count?: number | null;
800
+ /**
801
+ * Max threads. Maximum number of concurrent threads for file processing
802
+ */
803
+ clickhouse_max_threads?: number | null;
804
+ /**
805
+ * Max insert threads. Maximum number of concurrent insert threads
806
+ */
807
+ clickhouse_max_insert_threads?: number | null;
808
+ /**
809
+ * Min insert block size bytes. Minimum size of data block for insert (in bytes)
810
+ */
811
+ clickhouse_min_insert_block_size_bytes?: number | null;
812
+ /**
813
+ * Max download threads. Maximum number of concurrent download threads
814
+ */
815
+ clickhouse_max_download_threads?: number | null;
816
+ /**
817
+ * Parallel distributed insert select. Parallel distributed insert select setting
818
+ */
819
+ clickhouse_parallel_distributed_insert_select?: number | null;
820
+ /**
821
+ * use cluster function. Whether to use ClickHouse cluster function for distributed processing
822
+ */
823
+ object_storage_use_cluster_function?: boolean | null;
824
+ /**
825
+ * parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially
826
+ */
827
+ clickhouse_parallel_view_processing?: boolean | null;
828
+ };
829
+ export type ClickPipeSettingsPutRequest = {
830
+ /**
831
+ * Streaming max insert wait time. Configures the max wait period before inserting data into the ClickHouse.
832
+ */
833
+ streaming_max_insert_wait_ms?: number | null;
834
+ /**
835
+ * Object storage concurrency. Number of concurrent file processing threads
836
+ */
837
+ object_storage_concurrency?: number | null;
838
+ /**
839
+ * Object storage polling interval. Configures the refresh interval for querying continuous ingest for new object storage data
840
+ */
841
+ object_storage_polling_interval_ms?: number | null;
842
+ /**
843
+ * Max insert bytes. Number of bytes to process in a single insert batch
844
+ */
845
+ object_storage_max_insert_bytes?: number | null;
846
+ /**
847
+ * Max file count. Maximum number of files to process in a single insert batch
848
+ */
849
+ object_storage_max_file_count?: number | null;
850
+ /**
851
+ * Max threads. Maximum number of concurrent threads for file processing
852
+ */
853
+ clickhouse_max_threads?: number | null;
854
+ /**
855
+ * Max insert threads. Maximum number of concurrent insert threads
856
+ */
857
+ clickhouse_max_insert_threads?: number | null;
858
+ /**
859
+ * Min insert block size bytes. Minimum size of data block for insert (in bytes)
860
+ */
861
+ clickhouse_min_insert_block_size_bytes?: number | null;
862
+ /**
863
+ * Max download threads. Maximum number of concurrent download threads
864
+ */
865
+ clickhouse_max_download_threads?: number | null;
866
+ /**
867
+ * Parallel distributed insert select. Parallel distributed insert select setting
868
+ */
869
+ clickhouse_parallel_distributed_insert_select?: number | null;
870
+ /**
871
+ * use cluster function. Whether to use ClickHouse cluster function for distributed processing
872
+ */
873
+ object_storage_use_cluster_function?: boolean | null;
874
+ /**
875
+ * parallel view processing. Whether to enable pushing to attached views concurrently instead of sequentially
876
+ */
877
+ clickhouse_parallel_view_processing?: boolean | null;
878
+ };
879
+ export type ServiceEndpoint = {
880
+ /**
881
+ * Endpoint protocol: 'https', 'nativesecure', 'mysql'.
882
+ */
883
+ protocol?: "https" | "nativesecure" | "mysql";
884
+ /**
885
+ * Service host name
886
+ */
887
+ host?: string;
888
+ /**
889
+ * Numeric port
890
+ */
891
+ port?: number;
892
+ /**
893
+ * Optional username for the endpoint
894
+ */
895
+ username?: string | null;
896
+ };
897
+ export type IpAccessListEntry = {
898
+ /**
899
+ * IP or CIDR
900
+ */
901
+ source?: string;
902
+ /**
903
+ * Optional description of IPv4 address or IPv4 CIDR to allow access from
904
+ */
905
+ description?: string;
906
+ };
907
+ export type Service = {
908
+ /**
909
+ * Unique service ID.
910
+ */
911
+ id?: string;
912
+ /**
913
+ * Name of the service. Alphanumerical string with whitespaces up to 50 characters.
914
+ */
915
+ name?: string;
916
+ /**
917
+ * Cloud provider
918
+ */
919
+ provider?: "aws" | "gcp" | "azure";
920
+ /**
921
+ * Service region.
922
+ */
923
+ region?: "ap-south-1" | "ap-southeast-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "us-east-1" | "us-east-2" | "us-west-2" | "ap-southeast-2" | "ap-northeast-1" | "me-central-1" | "us-east1" | "us-central1" | "europe-west4" | "asia-southeast1" | "eastus" | "eastus2" | "westus3" | "germanywestcentral";
924
+ /**
925
+ * Current state of the service.
926
+ */
927
+ state?: "starting" | "stopping" | "terminating" | "awaking" | "partially_running" | "provisioning" | "running" | "stopped" | "terminated" | "degraded" | "failed" | "idle";
928
+ /**
929
+ * ClickHouse version of the service.
930
+ */
931
+ clickhouseVersion?: string;
932
+ /**
933
+ * List of all service endpoints.
934
+ */
935
+ endpoints?: Array<ServiceEndpoint>;
936
+ /**
937
+ * DEPRECATED for BASIC, SCALE and ENTERPRISE organization tiers. Tier of the service: 'development', 'production', 'dedicated_high_mem', 'dedicated_high_cpu', 'dedicated_standard', 'dedicated_standard_n2d_standard_4', 'dedicated_standard_n2d_standard_8', 'dedicated_standard_n2d_standard_32', 'dedicated_standard_n2d_standard_128', 'dedicated_standard_n2d_standard_32_16SSD', 'dedicated_standard_n2d_standard_64_24SSD'. Production services scale, Development are fixed size. Azure services don't support Development tier
938
+ * @deprecated
939
+ */
940
+ tier?: "development" | "production" | "dedicated_high_mem" | "dedicated_high_cpu" | "dedicated_standard" | "dedicated_standard_n2d_standard_4" | "dedicated_standard_n2d_standard_8" | "dedicated_standard_n2d_standard_32" | "dedicated_standard_n2d_standard_128" | "dedicated_standard_n2d_standard_32_16SSD" | "dedicated_standard_n2d_standard_64_24SSD";
941
+ /**
942
+ * DEPRECATED - inaccurate for services with non-default numbers of replicas. Minimum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than or equal to 24.
943
+ * @deprecated
944
+ */
945
+ minTotalMemoryGb?: number;
946
+ /**
947
+ * DEPRECATED - inaccurate for services with non-default numbers of replicas. Maximum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than or equal to 360 for non paid services or 1068 for paid services.
948
+ * @deprecated
949
+ */
950
+ maxTotalMemoryGb?: number;
951
+ /**
952
+ * Minimum total memory of each replica during auto-scaling in Gb. Must be a multiple of 4 and greater than or equal to 8.
953
+ */
954
+ minReplicaMemoryGb?: number;
955
+ /**
956
+ * Maximum total memory of each replica during auto-scaling in Gb. Must be a multiple of 4 and lower than or equal to 120* for non paid services or 356* for paid services.* - maximum replica size subject to cloud provider hardware availability in your selected region.
957
+ */
958
+ maxReplicaMemoryGb?: number;
959
+ /**
960
+ * Number of replicas for the service. The number of replicas must be between 2 and 20 for the first service in a warehouse. Services that are created in an existing warehouse can have a number of replicas as low as 1. Further restrictions may apply based on your organization's tier. It defaults to 1 for the BASIC tier and 3 for the SCALE and ENTERPRISE tiers.
961
+ */
962
+ numReplicas?: number;
963
+ /**
964
+ * When set to true the service is allowed to scale down to zero when idle. True by default.
965
+ */
966
+ idleScaling?: boolean;
967
+ /**
968
+ * Set minimum idling timeout (in minutes). Must be >= 5 minutes.
969
+ */
970
+ idleTimeoutMinutes?: number;
971
+ /**
972
+ * List of IP addresses allowed to access the service
973
+ */
974
+ ipAccessList?: Array<IpAccessListEntry>;
975
+ /**
976
+ * Service creation timestamp. ISO-8601.
977
+ */
978
+ createdAt?: string;
979
+ /**
980
+ * Optional customer provided disk encryption key
981
+ */
982
+ encryptionKey?: string;
983
+ /**
984
+ * Optional role to use for disk encryption
985
+ */
986
+ encryptionAssumedRoleIdentifier?: string;
987
+ /**
988
+ * IAM role used for accessing objects in s3
989
+ */
990
+ iamRole?: string;
991
+ /**
992
+ * List of private endpoints
993
+ */
994
+ privateEndpointIds?: Array<string>;
995
+ /**
996
+ * List of available private endpoints ids that can be attached to the service
997
+ */
998
+ availablePrivateEndpointIds?: Array<string>;
999
+ /**
1000
+ * Data warehouse containing this service
1001
+ */
1002
+ dataWarehouseId?: string;
1003
+ /**
1004
+ * True if this service is the primary service in the data warehouse
1005
+ */
1006
+ isPrimary?: boolean;
1007
+ /**
1008
+ * True if this service is read-only. It can only be read-only if a dataWarehouseId is provided.
1009
+ */
1010
+ isReadonly?: boolean;
1011
+ /**
1012
+ * Select fast if you want to get new ClickHouse releases as soon as they are available. You'll get new features faster, but with a higher risk of bugs. Select slow if you would like to defer releases to give yourself more time to test. This feature is only available for production services. default is the regular release channel.
1013
+ */
1014
+ releaseChannel?: "slow" | "default" | "fast";
1015
+ /**
1016
+ * This is the ID returned after setting up a region for Bring Your Own Cloud (BYOC). When the byocId parameter is specified, the minReplicaMemoryGb and the maxReplicaGb parameters are required too, with values included among the following sizes: 48, 116, 172, 232.
1017
+ */
1018
+ byocId?: string;
1019
+ /**
1020
+ * True if the service should have the Transparent Data Encryption (TDE) enabled. TDE is only available for ENTERPRISE organizations tiers and can only be enabled at service creation.
1021
+ */
1022
+ hasTransparentDataEncryption?: boolean;
1023
+ /**
1024
+ * Custom instance profile. Only available for ENTERPRISE organization tiers.
1025
+ */
1026
+ profile?: "v1-default" | "v1-highmem-xs" | "v1-highmem-s" | "v1-highmem-m" | "v1-highmem-l" | "v1-highmem-xl" | "v1-highcpu-s" | "v1-highcpu-m" | "v1-highcpu-l" | "v1-highcpu-xl";
1027
+ /**
1028
+ * The ID of the Transparent Data Encryption key used for the service. This is only available if hasTransparentDataEncryption is true.
1029
+ */
1030
+ transparentDataEncryptionKeyId?: string;
1031
+ /**
1032
+ * The ID of the IAM role used for encryption. This is only available if hasTransparentDataEncryption is true.
1033
+ */
1034
+ encryptionRoleId?: string;
1035
+ /**
1036
+ * Type of regulatory compliance for service.
1037
+ */
1038
+ complianceType?: "hipaa" | "pci";
1039
+ };
1040
+ export type PrivateEndpointConfig = {
1041
+ /**
1042
+ * Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name), GCP(Target Service) or AZURE (Private Link Service) resource
1043
+ */
1044
+ endpointServiceId?: string;
1045
+ /**
1046
+ * Private DNS Hostname of the VPC you created
1047
+ */
1048
+ privateDnsHostname?: string;
1049
+ };
1050
+ export type ServiceQueryApiEndpoint = {
1051
+ /**
1052
+ * The id of the service query endpoint
1053
+ */
1054
+ id?: string;
1055
+ /**
1056
+ * List of OpenAPI keys that can access the service query endpoint
1057
+ */
1058
+ openApiKeys?: Array<string>;
1059
+ /**
1060
+ * List of roles that can access the service query endpoint
1061
+ */
1062
+ roles?: Array<"sql_console_read_only" | "sql_console_admin">;
1063
+ /**
1064
+ * The allowed origins as comma separated list of domains
1065
+ */
1066
+ allowedOrigins?: string;
1067
+ };
1068
+ export type ServiceEndpointChange = {
1069
+ /**
1070
+ * Endpoint protocol
1071
+ */
1072
+ protocol?: "mysql";
1073
+ /**
1074
+ * Enable or disable the endpoint
1075
+ */
1076
+ enabled?: boolean;
1077
+ };
1078
+ export type IpAccessListPatch = {
1079
+ /**
1080
+ * Elements to add. Executed after "remove" part is processed.
1081
+ */
1082
+ add?: Array<IpAccessListEntry>;
1083
+ /**
1084
+ * Elements to remove. Executed before "add" part is processed.
1085
+ */
1086
+ remove?: Array<IpAccessListEntry>;
1087
+ };
1088
+ export type InstancePrivateEndpointsPatch = {
1089
+ /**
1090
+ * Elements to add. Executed after "remove" part is processed.
1091
+ */
1092
+ add?: Array<string>;
1093
+ /**
1094
+ * Elements to remove. Executed before "add" part is processed.
1095
+ */
1096
+ remove?: Array<string>;
1097
+ };
1098
+ export type InstancePrivateEndpoint = {
1099
+ /**
1100
+ * Private endpoint identifier
1101
+ */
1102
+ id?: string;
1103
+ /**
1104
+ * Description of private endpoint
1105
+ */
1106
+ description?: string;
1107
+ /**
1108
+ * Cloud provider in which the private endpoint is lcoated
1109
+ */
1110
+ cloudProvider?: "gcp" | "aws" | "azure";
1111
+ /**
1112
+ * Region in which the private endpoint is located
1113
+ */
1114
+ region?: "ap-south-1" | "ap-southeast-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "us-east-1" | "us-east-2" | "us-west-2" | "ap-southeast-2" | "ap-northeast-1" | "me-central-1" | "us-east1" | "us-central1" | "europe-west4" | "asia-southeast1" | "eastus" | "eastus2" | "westus3" | "germanywestcentral";
1115
+ };
1116
+ export type UsageCostMetrics = {
1117
+ /**
1118
+ * Cost of storage in ClickHouse Credits (CHCs). Applies to dataWarehouse entities.
1119
+ */
1120
+ storageCHC?: number;
1121
+ /**
1122
+ * Cost of backup in ClickHouse Credits (CHCs). Applies to dataWarehouse entities.
1123
+ */
1124
+ backupCHC?: number;
1125
+ /**
1126
+ * Cost of compute in ClickHouse Credits (CHCs). Applies to service and clickpipe entities.
1127
+ */
1128
+ computeCHC?: number;
1129
+ /**
1130
+ * Cost of data transfer in ClickHouse Credits (CHCs). Applies to clickpipe entities.
1131
+ */
1132
+ dataTransferCHC?: number;
1133
+ /**
1134
+ * Cost of initial load and resyncs in ClickHouse Credits (CHCs). Applies to clickpipe entities.
1135
+ */
1136
+ initialLoadCHC?: number;
1137
+ /**
1138
+ * Cost of data transfer in ClickHouse Credits (CHCs). Applies to service entities.
1139
+ */
1140
+ publicDataTransferCHC?: number;
1141
+ /**
1142
+ * Cost of tier1 inter-region data transfer in ClickHouse Credits (CHCs). Applies to service entities.
1143
+ */
1144
+ interRegionTier1DataTransferCHC?: number;
1145
+ /**
1146
+ * Cost of tier2 inter-region data transfer in ClickHouse Credits (CHCs). Applies to service entities.
1147
+ */
1148
+ interRegionTier2DataTransferCHC?: number;
1149
+ /**
1150
+ * Cost of tier3 inter-region data transfer in ClickHouse Credits (CHCs). Applies to service entities.
1151
+ */
1152
+ interRegionTier3DataTransferCHC?: number;
1153
+ /**
1154
+ * Cost of tier4 inter-region data transfer in ClickHouse Credits (CHCs). Applies to service entities.
1155
+ */
1156
+ interRegionTier4DataTransferCHC?: number;
1157
+ };
1158
+ export type UsageCostRecord = {
1159
+ /**
1160
+ * ID of the dataWarehouse this entity belongs to (or is).
1161
+ */
1162
+ dataWarehouseId?: string;
1163
+ /**
1164
+ * ID of the service this entity belongs to (or is). Set to null for dataWarehouse entities.
1165
+ */
1166
+ serviceId?: string | null;
1167
+ /**
1168
+ * Date of the usage. ISO-8601 date, based on the UTC timezone.
1169
+ */
1170
+ date?: string;
1171
+ /**
1172
+ * Type of the entity.
1173
+ */
1174
+ entityType?: "datawarehouse" | "service" | "clickpipe";
1175
+ /**
1176
+ * Unique ID of the entity.
1177
+ */
1178
+ entityId?: string;
1179
+ /**
1180
+ * Name of the entity.
1181
+ */
1182
+ entityName?: string;
1183
+ metrics?: UsageCostMetrics;
1184
+ /**
1185
+ * Total cost of usage in ClickHouse Credits (CHCs) for this entity.
1186
+ */
1187
+ totalCHC?: number;
1188
+ /**
1189
+ * When true, the record is immutable. Unlocked records are subject to change until locked.
1190
+ */
1191
+ locked?: boolean;
1192
+ };
1193
+ export type UsageCost = {
1194
+ /**
1195
+ * Grand total cost of usage in ClickHouse Credits (CHCs).
1196
+ */
1197
+ grandTotalCHC?: number;
1198
+ costs?: UsageCostRecord;
1199
+ };
1200
+ export type OrganizationPrivateEndpoint = {
1201
+ /**
1202
+ * Private endpoint identifier
1203
+ */
1204
+ id?: string;
1205
+ /**
1206
+ * Description of private endpoint
1207
+ */
1208
+ description?: string;
1209
+ /**
1210
+ * Cloud provider in which the private endpoint is lcoated
1211
+ */
1212
+ cloudProvider?: "gcp" | "aws" | "azure";
1213
+ /**
1214
+ * Region in which the private endpoint is located
1215
+ */
1216
+ region?: "ap-south-1" | "ap-southeast-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "us-east-1" | "us-east-2" | "us-west-2" | "ap-southeast-2" | "ap-northeast-1" | "me-central-1" | "us-east1" | "us-central1" | "europe-west4" | "asia-southeast1" | "eastus" | "eastus2" | "westus3" | "germanywestcentral";
1217
+ };
1218
+ export type ByocConfig = {
1219
+ /**
1220
+ * Unique identifier of the BYOC configuration
1221
+ */
1222
+ id?: string;
1223
+ /**
1224
+ * State of the infrastructure
1225
+ */
1226
+ state?: "infra-ready" | "infra-provisioning" | "infra-terminated";
1227
+ /**
1228
+ * Name of the account
1229
+ */
1230
+ accountName?: string;
1231
+ /**
1232
+ * Region for which the BYOC has been configured and where it is possible to create services
1233
+ */
1234
+ regionId?: "ap-south-1" | "ap-southeast-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "us-east-1" | "us-east-2" | "us-west-2" | "ap-southeast-2" | "ap-northeast-1" | "me-central-1" | "us-east1" | "us-central1" | "europe-west4" | "asia-southeast1" | "eastus" | "eastus2" | "westus3" | "germanywestcentral";
1235
+ /**
1236
+ * Cloud provider of the region
1237
+ */
1238
+ cloudProvider?: "gcp" | "aws" | "azure";
1239
+ };
1240
+ export type Organization = {
1241
+ /**
1242
+ * Unique organization ID.
1243
+ */
1244
+ id?: string;
1245
+ /**
1246
+ * The timestamp the organization was created. ISO-8601.
1247
+ */
1248
+ createdAt?: string;
1249
+ /**
1250
+ * Name of the organization.
1251
+ */
1252
+ name?: string;
1253
+ /**
1254
+ * List of private endpoints for organization
1255
+ */
1256
+ privateEndpoints?: Array<OrganizationPrivateEndpoint>;
1257
+ /**
1258
+ * BYOC configuration for the organization
1259
+ */
1260
+ byocConfig?: Array<ByocConfig>;
1261
+ };
1262
+ export type OrganizationCloudRegionPrivateEndpointConfig = {
1263
+ /**
1264
+ * Unique identifier of the interface endpoint you created in your VPC with the AWS(Service Name) or GCP(Target Service) resource
1265
+ */
1266
+ endpointServiceId?: string;
1267
+ };
1268
+ export type OrganizationPatchPrivateEndpoint = {
1269
+ /**
1270
+ * Private endpoint identifier
1271
+ */
1272
+ id?: string;
1273
+ /**
1274
+ * Optional description of private endpoint
1275
+ */
1276
+ description?: string;
1277
+ /**
1278
+ * Cloud provider in which the private endpoint is lcoated
1279
+ */
1280
+ cloudProvider?: "gcp" | "aws" | "azure";
1281
+ /**
1282
+ * Region in which the private endpoint is located
1283
+ */
1284
+ region?: "ap-south-1" | "ap-southeast-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "us-east-1" | "us-east-2" | "us-west-2" | "ap-southeast-2" | "ap-northeast-1" | "me-central-1" | "us-east1" | "us-central1" | "europe-west4" | "asia-southeast1" | "eastus" | "eastus2" | "westus3" | "germanywestcentral";
1285
+ };
1286
+ export type OrganizationPrivateEndpointsPatch = {
1287
+ /**
1288
+ * Elements to add. Executed after "remove" part is processed. Please use the `Update Service Basic Details` endpoint instead to modify the private endpoints.
1289
+ * @deprecated
1290
+ */
1291
+ add?: Array<OrganizationPatchPrivateEndpoint>;
1292
+ /**
1293
+ * Elements to remove. Executed before "add" part is processed.
1294
+ */
1295
+ remove?: Array<OrganizationPatchPrivateEndpoint>;
1296
+ };
1297
+ export type Activity = {
1298
+ /**
1299
+ * Unique activity ID.
1300
+ */
1301
+ id?: string;
1302
+ /**
1303
+ * Timestamp of the activity. ISO-8601.
1304
+ */
1305
+ createdAt?: string;
1306
+ /**
1307
+ * Type of the activity.
1308
+ */
1309
+ type?: "create_organization" | "organization_update_name" | "transfer_service_in" | "transfer_service_out" | "save_payment_method" | "marketplace_subscription" | "migrate_marketplace_billing_details_in" | "migrate_marketplace_billing_details_out" | "organization_update_tier" | "organization_invite_create" | "organization_invite_delete" | "organization_member_join" | "organization_member_add" | "organization_member_leave" | "organization_member_delete" | "organization_member_update_role" | "organization_member_update_mfa_method" | "user_login" | "user_login_failed" | "user_logout" | "key_create" | "key_delete" | "openapi_key_update" | "service_create" | "service_start" | "service_stop" | "service_awaken" | "service_partially_running" | "service_delete" | "service_update_name" | "service_update_ip_access_list" | "service_update_autoscaling_memory" | "service_update_autoscaling_idling" | "service_update_password" | "service_update_autoscaling_replicas" | "service_update_max_allowable_replicas" | "service_update_backup_configuration" | "service_restore_backup" | "service_update_release_channel" | "service_update_gpt_usage_consent" | "service_update_private_endpoints" | "service_import_to_organization" | "service_export_from_organization" | "service_maintenance_start" | "service_maintenance_end" | "service_update_core_dump" | "backup_delete";
1310
+ /**
1311
+ * Type of the actor: 'user', 'support', 'system', 'api'.
1312
+ */
1313
+ actorType?: "user" | "support" | "system" | "api";
1314
+ /**
1315
+ * Unique actor ID.
1316
+ */
1317
+ actorId?: string;
1318
+ /**
1319
+ * Additional information about the actor.
1320
+ */
1321
+ actorDetails?: string;
1322
+ /**
1323
+ * IP address of the actor. Defined for 'user' and 'api' actor types.
1324
+ */
1325
+ actorIpAddress?: string;
1326
+ /**
1327
+ * Scope of the activity: organization ID this activity is related to.
1328
+ */
1329
+ organizationId?: string;
1330
+ /**
1331
+ * Scope of the activity: service ID this activity is related to.
1332
+ */
1333
+ serviceId?: string;
1334
+ /**
1335
+ * User agent of the actor
1336
+ */
1337
+ userAgent?: string;
1338
+ };
1339
+ export type AwsBackupBucket = {
1340
+ /**
1341
+ * Unique backup bucket ID
1342
+ */
1343
+ id?: string;
1344
+ /**
1345
+ * Bucket provider
1346
+ */
1347
+ bucketProvider?: "AWS";
1348
+ /**
1349
+ * Bucket path
1350
+ */
1351
+ bucketPath?: string;
1352
+ /**
1353
+ * AWS Role ARN
1354
+ */
1355
+ iamRoleArn?: string;
1356
+ /**
1357
+ * AWS Role session name
1358
+ */
1359
+ iamRoleSessionName?: string;
1360
+ };
1361
+ export type GcpBackupBucket = {
1362
+ /**
1363
+ * Unique backup bucket ID
1364
+ */
1365
+ id?: string;
1366
+ /**
1367
+ * Bucket provider
1368
+ */
1369
+ bucketProvider?: "GCP";
1370
+ /**
1371
+ * Bucket path
1372
+ */
1373
+ bucketPath?: string;
1374
+ /**
1375
+ * Access Key ID (HMAC key)
1376
+ */
1377
+ accessKeyId?: string;
1378
+ };
1379
+ export type AzureBackupBucket = {
1380
+ /**
1381
+ * Unique backup bucket ID.
1382
+ */
1383
+ id?: string;
1384
+ /**
1385
+ * Bucket provider
1386
+ */
1387
+ bucketProvider?: "AZURE";
1388
+ /**
1389
+ * Container Name
1390
+ */
1391
+ containerName?: string;
1392
+ };
1393
+ export type BackupBucket = AwsBackupBucket | GcpBackupBucket | AzureBackupBucket;
1394
+ export type AwsBackupBucketProperties = {
1395
+ /**
1396
+ * Bucket provider
1397
+ */
1398
+ bucketProvider?: "AWS";
1399
+ /**
1400
+ * Bucket path
1401
+ */
1402
+ bucketPath?: string;
1403
+ /**
1404
+ * AWS IAM Role
1405
+ */
1406
+ iamRoleArn?: string;
1407
+ /**
1408
+ * AWS IAM Role
1409
+ */
1410
+ iamRoleSessionName?: string;
1411
+ };
1412
+ export type GcpBackupBucketProperties = {
1413
+ /**
1414
+ * Bucket provider
1415
+ */
1416
+ bucketProvider?: "GCP";
1417
+ /**
1418
+ * Bucket path
1419
+ */
1420
+ bucketPath?: string;
1421
+ /**
1422
+ * Access Key ID (HMAC key)
1423
+ */
1424
+ accessKeyId?: string;
1425
+ };
1426
+ export type AzureBackupBucketProperties = {
1427
+ /**
1428
+ * Bucket provider
1429
+ */
1430
+ bucketProvider?: "AZURE";
1431
+ /**
1432
+ * Container Name
1433
+ */
1434
+ containerName?: string;
1435
+ };
1436
+ export type BackupBucketProperties = AwsBackupBucketProperties | GcpBackupBucketProperties | AzureBackupBucketProperties;
1437
+ export type AwsBackupBucketPostRequestV1 = {
1438
+ /**
1439
+ * Bucket provider
1440
+ */
1441
+ bucketProvider?: "AWS";
1442
+ /**
1443
+ * Bucket path
1444
+ */
1445
+ bucketPath?: string;
1446
+ /**
1447
+ * AWS Role ARN
1448
+ */
1449
+ iamRoleArn?: string;
1450
+ /**
1451
+ * AWS Role session name
1452
+ */
1453
+ iamRoleSessionName?: string;
1454
+ };
1455
+ export type GcpBackupBucketPostRequestV1 = {
1456
+ /**
1457
+ * Bucket provider
1458
+ */
1459
+ bucketProvider?: "GCP";
1460
+ /**
1461
+ * Bucket path
1462
+ */
1463
+ bucketPath?: string;
1464
+ /**
1465
+ * Access Key ID (HMAC key)
1466
+ */
1467
+ accessKeyId?: string;
1468
+ /**
1469
+ * Secret Access Key (HMAC secret key)
1470
+ */
1471
+ secretAccessKey?: string;
1472
+ };
1473
+ export type AzureBackupBucketPostRequestV1 = {
1474
+ /**
1475
+ * Bucket provider
1476
+ */
1477
+ bucketProvider?: "AZURE";
1478
+ /**
1479
+ * Container Name
1480
+ */
1481
+ containerName?: string;
1482
+ /**
1483
+ * Connection String
1484
+ */
1485
+ connectionString?: string;
1486
+ };
1487
+ export type BackupBucketPostRequest = AwsBackupBucketPostRequestV1 | GcpBackupBucketPostRequestV1 | AzureBackupBucketPostRequestV1;
1488
+ export type AwsBackupBucketPatchRequestV1 = {
1489
+ /**
1490
+ * Bucket provider
1491
+ */
1492
+ bucketProvider?: "AWS";
1493
+ /**
1494
+ * Bucket path
1495
+ */
1496
+ bucketPath?: string;
1497
+ /**
1498
+ * AWS Role ARN
1499
+ */
1500
+ iamRoleArn?: string;
1501
+ /**
1502
+ * AWS IAM Role session name
1503
+ */
1504
+ iamRoleSessionName?: string | null;
1505
+ };
1506
+ export type GcpBackupBucketPatchRequestV1 = {
1507
+ /**
1508
+ * Bucket provider
1509
+ */
1510
+ bucketProvider?: "GCP";
1511
+ /**
1512
+ * Bucket path
1513
+ */
1514
+ bucketPath?: string;
1515
+ /**
1516
+ * Access Key ID (HMAC key)
1517
+ */
1518
+ accessKeyId?: string;
1519
+ /**
1520
+ * Secret Access Key (HMAC secret key)
1521
+ */
1522
+ secretAccessKey?: string;
1523
+ };
1524
+ export type AzureBackupBucketPatchRequestV1 = {
1525
+ /**
1526
+ * Bucket provider
1527
+ */
1528
+ bucketProvider?: "AZURE";
1529
+ /**
1530
+ * Container Name
1531
+ */
1532
+ containerName?: string;
1533
+ /**
1534
+ * Connection String
1535
+ */
1536
+ connectionString?: string;
1537
+ };
1538
+ export type BackupBucketPatchRequest = AwsBackupBucketPatchRequestV1 | GcpBackupBucketPatchRequestV1 | AzureBackupBucketPatchRequestV1;
1539
+ export type BackupConfiguration = {
1540
+ /**
1541
+ * The interval in hours between each backup.
1542
+ */
1543
+ backupPeriodInHours?: number;
1544
+ /**
1545
+ * The minimum duration in hours for which the backups are available.
1546
+ */
1547
+ backupRetentionPeriodInHours?: number;
1548
+ /**
1549
+ * The time in HH:MM format for the backups to be performed (evaluated in UTC timezone). When defined the backup period resets to every 24 hours.
1550
+ */
1551
+ backupStartTime?: string;
1552
+ };
1553
+ export type Backup = {
1554
+ /**
1555
+ * Unique backup ID.
1556
+ */
1557
+ id?: string;
1558
+ /**
1559
+ * Status of the backup: 'done', 'error', 'in_progress'.
1560
+ */
1561
+ status?: "done" | "error" | "in_progress";
1562
+ /**
1563
+ * Name
1564
+ */
1565
+ serviceId?: string;
1566
+ /**
1567
+ * Backup start timestamp. ISO-8601.
1568
+ */
1569
+ startedAt?: string;
1570
+ /**
1571
+ * Backup finish timestamp. ISO-8601. Available only for finished backups
1572
+ */
1573
+ finishedAt?: string;
1574
+ /**
1575
+ * Size of the backup in bytes.
1576
+ */
1577
+ sizeInBytes?: number;
1578
+ /**
1579
+ * Time in seconds it took to perform the backup. If the status still in_progress, this is the time in seconds since the backup started until now.
1580
+ */
1581
+ durationInSeconds?: number;
1582
+ /**
1583
+ * Backup type ("full" or "incremental").
1584
+ */
1585
+ type?: "full" | "incremental";
1586
+ /**
1587
+ * Backup name on the external backup bucket.
1588
+ */
1589
+ backupName?: string;
1590
+ /**
1591
+ * Backup bucket where the backup is stored.
1592
+ */
1593
+ bucket?: AwsBackupBucketProperties | GcpBackupBucketProperties | AzureBackupBucketProperties;
1594
+ };
1595
+ export type CreateReversePrivateEndpoint = {
1596
+ /**
1597
+ * Reverse private endpoint description. Maximum length is 255 characters.
1598
+ */
1599
+ description?: string;
1600
+ /**
1601
+ * Reverse private endpoint type.
1602
+ */
1603
+ type?: "VPC_ENDPOINT_SERVICE" | "VPC_RESOURCE" | "MSK_MULTI_VPC";
1604
+ /**
1605
+ * VPC endpoint service name.
1606
+ */
1607
+ vpcEndpointServiceName?: string | null;
1608
+ /**
1609
+ * VPC resource configuration ID. Required for VPC_RESOURCE type.
1610
+ */
1611
+ vpcResourceConfigurationId?: string | null;
1612
+ /**
1613
+ * VPC resource share ARN. Required for VPC_RESOURCE type.
1614
+ */
1615
+ vpcResourceShareArn?: string | null;
1616
+ /**
1617
+ * MSK cluster ARN. Required for MSK_MULTI_VPC type.
1618
+ */
1619
+ mskClusterArn?: string | null;
1620
+ /**
1621
+ * MSK cluster authentication type. Required for MSK_MULTI_VPC type.
1622
+ */
1623
+ mskAuthentication?: "SASL_IAM" | "SASL_SCRAM";
1624
+ };
1625
+ export type ReversePrivateEndpoint = {
1626
+ /**
1627
+ * Reverse private endpoint description. Maximum length is 255 characters.
1628
+ */
1629
+ description?: string;
1630
+ /**
1631
+ * Reverse private endpoint type.
1632
+ */
1633
+ type?: "VPC_ENDPOINT_SERVICE" | "VPC_RESOURCE" | "MSK_MULTI_VPC";
1634
+ /**
1635
+ * VPC endpoint service name.
1636
+ */
1637
+ vpcEndpointServiceName?: string | null;
1638
+ /**
1639
+ * VPC resource configuration ID. Required for VPC_RESOURCE type.
1640
+ */
1641
+ vpcResourceConfigurationId?: string | null;
1642
+ /**
1643
+ * VPC resource share ARN. Required for VPC_RESOURCE type.
1644
+ */
1645
+ vpcResourceShareArn?: string | null;
1646
+ /**
1647
+ * MSK cluster ARN. Required for MSK_MULTI_VPC type.
1648
+ */
1649
+ mskClusterArn?: string | null;
1650
+ /**
1651
+ * MSK cluster authentication type. Required for MSK_MULTI_VPC type.
1652
+ */
1653
+ mskAuthentication?: "SASL_IAM" | "SASL_SCRAM";
1654
+ /**
1655
+ * Reverse private endpoint ID.
1656
+ */
1657
+ id?: string;
1658
+ /**
1659
+ * ClickHouse service ID reverse private endpoint is associated with.
1660
+ */
1661
+ serviceId?: string;
1662
+ /**
1663
+ * Reverse private endpoint endpoint ID.
1664
+ */
1665
+ endpointId?: string;
1666
+ /**
1667
+ * Reverse private endpoint internal DNS names.
1668
+ */
1669
+ dnsNames?: Array<string>;
1670
+ /**
1671
+ * Reverse private endpoint private DNS names.
1672
+ */
1673
+ privateDnsNames?: Array<string>;
1674
+ /**
1675
+ * Reverse private endpoint status.
1676
+ */
1677
+ status?: "Unknown" | "Provisioning" | "Deleting" | "Ready" | "Failed" | "PendingAcceptance" | "Rejected" | "Expired";
1678
+ };
1679
+ export type Member = {
1680
+ /**
1681
+ * Unique user ID. If a user is a member in multiple organizations this ID will stay the same.
1682
+ */
1683
+ userId?: string;
1684
+ /**
1685
+ * Name of the member as set a personal user profile.
1686
+ */
1687
+ name?: string;
1688
+ /**
1689
+ * Email of the member as set in personal user profile.
1690
+ */
1691
+ email?: string;
1692
+ /**
1693
+ * Role of the member in the organization.
1694
+ */
1695
+ role?: "admin" | "developer";
1696
+ /**
1697
+ * Timestamp the member joined the organization. ISO-8601.
1698
+ */
1699
+ joinedAt?: string;
1700
+ };
1701
+ export type Invitation = {
1702
+ /**
1703
+ * Role of the member in the organization.
1704
+ */
1705
+ role?: "admin" | "developer";
1706
+ /**
1707
+ * Unique invitation ID.
1708
+ */
1709
+ id?: string;
1710
+ /**
1711
+ * Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form.
1712
+ */
1713
+ email?: string;
1714
+ /**
1715
+ * Invitation creation timestamp. ISO-8601.
1716
+ */
1717
+ createdAt?: string;
1718
+ /**
1719
+ * Timestamp the invitation expires. ISO-8601.
1720
+ */
1721
+ expireAt?: string;
1722
+ };
1723
+ export type ApiKey = {
1724
+ /**
1725
+ * Unique API key ID.
1726
+ */
1727
+ id?: string;
1728
+ /**
1729
+ * Name of the key
1730
+ */
1731
+ name?: string;
1732
+ /**
1733
+ * State of the key: 'enabled', 'disabled'.
1734
+ */
1735
+ state?: "enabled" | "disabled";
1736
+ /**
1737
+ * List of roles assigned to the key. Contains at least 1 element.
1738
+ */
1739
+ roles?: Array<"admin" | "developer" | "query_endpoints">;
1740
+ /**
1741
+ * Last 4 letters of the key.
1742
+ */
1743
+ keySuffix?: string;
1744
+ /**
1745
+ * Timestamp the key was created. ISO-8601.
1746
+ */
1747
+ createdAt?: string;
1748
+ /**
1749
+ * Timestamp the key expires. If not present, `null` or is empty the key never expires. ISO-8601.
1750
+ */
1751
+ expireAt?: string | null;
1752
+ /**
1753
+ * Timestamp the key was used last time. If not present the key was never used. ISO-8601.
1754
+ */
1755
+ usedAt?: string;
1756
+ /**
1757
+ * List of IP addresses allowed to access the API using this key
1758
+ */
1759
+ ipAccessList?: Array<IpAccessListEntry>;
1760
+ };
1761
+ export type ApiKeyHashData = {
1762
+ /**
1763
+ * Hash of the key ID.
1764
+ */
1765
+ keyIdHash?: string;
1766
+ /**
1767
+ * Last 4 digits of the key ID. Algorithm: echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64
1768
+ */
1769
+ keyIdSuffix?: string;
1770
+ /**
1771
+ * Hash of the key secret. Algorithm: echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64
1772
+ */
1773
+ keySecretHash?: string;
1774
+ };
1775
+ export type OrganizationPatchRequest = {
1776
+ /**
1777
+ * Name of the organization.
1778
+ */
1779
+ name?: string;
1780
+ privateEndpoints?: OrganizationPrivateEndpointsPatch;
1781
+ };
1782
+ export type InstanceServiceQueryApiEndpointsPostRequest = {
1783
+ /**
1784
+ * The roles
1785
+ */
1786
+ roles?: Array<"sql_console_read_only" | "sql_console_admin">;
1787
+ /**
1788
+ * The version of the service query endpoint
1789
+ */
1790
+ openApiKeys?: Array<string>;
1791
+ /**
1792
+ * The allowed origins as comma separated list of domains
1793
+ */
1794
+ allowedOrigins?: string;
1795
+ };
1796
+ export type ServicePostResponse = {
1797
+ service?: Service;
1798
+ /**
1799
+ * Password for the newly created service.
1800
+ */
1801
+ password?: string;
1802
+ };
1803
+ export type ServicePostRequest = {
1804
+ /**
1805
+ * Name of the service. Alphanumerical string with whitespaces up to 50 characters.
1806
+ */
1807
+ name?: string;
1808
+ /**
1809
+ * Cloud provider
1810
+ */
1811
+ provider?: "aws" | "gcp" | "azure";
1812
+ /**
1813
+ * Service region.
1814
+ */
1815
+ region?: "ap-south-1" | "ap-southeast-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "us-east-1" | "us-east-2" | "us-west-2" | "ap-southeast-2" | "ap-northeast-1" | "me-central-1" | "us-east1" | "us-central1" | "europe-west4" | "asia-southeast1" | "eastus" | "eastus2" | "westus3" | "germanywestcentral";
1816
+ /**
1817
+ * DEPRECATED for BASIC, SCALE and ENTERPRISE organization tiers. Tier of the service: 'development', 'production', 'dedicated_high_mem', 'dedicated_high_cpu', 'dedicated_standard', 'dedicated_standard_n2d_standard_4', 'dedicated_standard_n2d_standard_8', 'dedicated_standard_n2d_standard_32', 'dedicated_standard_n2d_standard_128', 'dedicated_standard_n2d_standard_32_16SSD', 'dedicated_standard_n2d_standard_64_24SSD'. Production services scale, Development are fixed size. Azure services don't support Development tier
1818
+ * @deprecated
1819
+ */
1820
+ tier?: "development" | "production" | "dedicated_high_mem" | "dedicated_high_cpu" | "dedicated_standard" | "dedicated_standard_n2d_standard_4" | "dedicated_standard_n2d_standard_8" | "dedicated_standard_n2d_standard_32" | "dedicated_standard_n2d_standard_128" | "dedicated_standard_n2d_standard_32_16SSD" | "dedicated_standard_n2d_standard_64_24SSD";
1821
+ /**
1822
+ * List of IP addresses allowed to access the service
1823
+ */
1824
+ ipAccessList?: Array<IpAccessListEntry>;
1825
+ /**
1826
+ * DEPRECATED - inaccurate for services with non-default numbers of replicas. Minimum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than or equal to 24.
1827
+ * @deprecated
1828
+ */
1829
+ minTotalMemoryGb?: number;
1830
+ /**
1831
+ * DEPRECATED - inaccurate for services with non-default numbers of replicas. Maximum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than or equal to 360 for non paid services or 1068 for paid services.
1832
+ * @deprecated
1833
+ */
1834
+ maxTotalMemoryGb?: number;
1835
+ /**
1836
+ * Minimum total memory of each replica during auto-scaling in Gb. Must be a multiple of 4 and greater than or equal to 8.
1837
+ */
1838
+ minReplicaMemoryGb?: number;
1839
+ /**
1840
+ * Maximum total memory of each replica during auto-scaling in Gb. Must be a multiple of 4 and lower than or equal to 120* for non paid services or 356* for paid services.* - maximum replica size subject to cloud provider hardware availability in your selected region.
1841
+ */
1842
+ maxReplicaMemoryGb?: number;
1843
+ /**
1844
+ * Number of replicas for the service. The number of replicas must be between 2 and 20 for the first service in a warehouse. Services that are created in an existing warehouse can have a number of replicas as low as 1. Further restrictions may apply based on your organization's tier. It defaults to 1 for the BASIC tier and 3 for the SCALE and ENTERPRISE tiers.
1845
+ */
1846
+ numReplicas?: number;
1847
+ /**
1848
+ * When set to true the service is allowed to scale down to zero when idle. True by default.
1849
+ */
1850
+ idleScaling?: boolean;
1851
+ /**
1852
+ * Set minimum idling timeout (in minutes). Must be >= 5 minutes.
1853
+ */
1854
+ idleTimeoutMinutes?: number;
1855
+ /**
1856
+ * True if this service is read-only. It can only be read-only if a dataWarehouseId is provided.
1857
+ */
1858
+ isReadonly?: boolean;
1859
+ /**
1860
+ * Data warehouse containing this service
1861
+ */
1862
+ dataWarehouseId?: string;
1863
+ /**
1864
+ * Optional backup ID used as an initial state for the new service. When used the region and the tier of the new instance must be the same as the values of the original instance.
1865
+ */
1866
+ backupId?: string;
1867
+ /**
1868
+ * Optional customer provided disk encryption key
1869
+ */
1870
+ encryptionKey?: string;
1871
+ /**
1872
+ * Optional role to use for disk encryption
1873
+ */
1874
+ encryptionAssumedRoleIdentifier?: string;
1875
+ /**
1876
+ * To associate the service with private endpoints, first create the service, then use the `Update Service Basic Details` endpoint to modify private endpoints.
1877
+ * @deprecated
1878
+ */
1879
+ privateEndpointIds?: Array<string>;
1880
+ /**
1881
+ * Accept the private preview terms and conditions. It is only needed when creating the first service in the organization in case of a private preview
1882
+ */
1883
+ privatePreviewTermsChecked?: boolean;
1884
+ /**
1885
+ * Select fast if you want to get new ClickHouse releases as soon as they are available. You'll get new features faster, but with a higher risk of bugs. Select slow if you would like to defer releases to give yourself more time to test. This feature is only available for production services. default is the regular release channel.
1886
+ */
1887
+ releaseChannel?: "slow" | "default" | "fast";
1888
+ /**
1889
+ * This is the ID returned after setting up a region for Bring Your Own Cloud (BYOC). When the byocId parameter is specified, the minReplicaMemoryGb and the maxReplicaGb parameters are required too, with values included among the following sizes: 48, 116, 172, 232.
1890
+ */
1891
+ byocId?: string;
1892
+ /**
1893
+ * True if the service should have the Transparent Data Encryption (TDE) enabled. TDE is only available for ENTERPRISE organizations tiers and can only be enabled at service creation.
1894
+ */
1895
+ hasTransparentDataEncryption?: boolean;
1896
+ /**
1897
+ * List of service endpoints to enable or disable
1898
+ */
1899
+ endpoints?: Array<ServiceEndpointChange>;
1900
+ /**
1901
+ * Custom instance profile. Only available for ENTERPRISE organization tiers.
1902
+ */
1903
+ profile?: "v1-default" | "v1-highmem-xs" | "v1-highmem-s" | "v1-highmem-m" | "v1-highmem-l" | "v1-highmem-xl" | "v1-highcpu-s" | "v1-highcpu-m" | "v1-highcpu-l" | "v1-highcpu-xl";
1904
+ /**
1905
+ * Type of regulatory compliance for service.
1906
+ */
1907
+ complianceType?: "hipaa" | "pci";
1908
+ };
1909
+ export type ServicePatchRequest = {
1910
+ /**
1911
+ * Name of the service. Alphanumerical string with whitespaces up to 50 characters.
1912
+ */
1913
+ name?: string;
1914
+ ipAccessList?: IpAccessListPatch;
1915
+ privateEndpointIds?: InstancePrivateEndpointsPatch;
1916
+ /**
1917
+ * Select fast if you want to get new ClickHouse releases as soon as they are available. You'll get new features faster, but with a higher risk of bugs. Select slow if you would like to defer releases to give yourself more time to test. This feature is only available for production services. default is the regular release channel.
1918
+ */
1919
+ releaseChannel?: "slow" | "default" | "fast";
1920
+ /**
1921
+ * List of service endpoints to change
1922
+ */
1923
+ endpoints?: Array<ServiceEndpointChange>;
1924
+ /**
1925
+ * The id of the key to rotate
1926
+ */
1927
+ transparentDataEncryptionKeyId?: string;
1928
+ };
1929
+ export type ServiceStatePatchRequest = {
1930
+ /**
1931
+ * Command to change the state: 'start', 'stop'.
1932
+ */
1933
+ command?: "start" | "stop";
1934
+ };
1935
+ export type ServiceScalingPatchRequest = {
1936
+ /**
1937
+ * DEPRECATED - inaccurate for services with non-default numbers of replicas. Minimum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than or equal to 24.
1938
+ * @deprecated
1939
+ */
1940
+ minTotalMemoryGb?: number;
1941
+ /**
1942
+ * DEPRECATED - inaccurate for services with non-default numbers of replicas. Maximum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than or equal to 360 for non paid services or 1068 for paid services.
1943
+ * @deprecated
1944
+ */
1945
+ maxTotalMemoryGb?: number;
1946
+ /**
1947
+ * Number of replicas for the service. The number of replicas must be between 2 and 20 for the first service in a warehouse. Services that are created in an existing warehouse can have a number of replicas as low as 1. Further restrictions may apply based on your organization's tier. It defaults to 1 for the BASIC tier and 3 for the SCALE and ENTERPRISE tiers.
1948
+ */
1949
+ numReplicas?: number;
1950
+ /**
1951
+ * When set to true the service is allowed to scale down to zero when idle. True by default.
1952
+ */
1953
+ idleScaling?: boolean;
1954
+ /**
1955
+ * Set minimum idling timeout (in minutes). Must be >= 5 minutes.
1956
+ */
1957
+ idleTimeoutMinutes?: number;
1958
+ };
1959
+ export type ServiceScalingPatchResponse = {
1960
+ /**
1961
+ * Unique service ID.
1962
+ */
1963
+ id?: string;
1964
+ /**
1965
+ * Name of the service. Alphanumerical string with whitespaces up to 50 characters.
1966
+ */
1967
+ name?: string;
1968
+ /**
1969
+ * Cloud provider
1970
+ */
1971
+ provider?: "aws" | "gcp" | "azure";
1972
+ /**
1973
+ * Service region.
1974
+ */
1975
+ region?: "ap-south-1" | "ap-southeast-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "us-east-1" | "us-east-2" | "us-west-2" | "ap-southeast-2" | "ap-northeast-1" | "me-central-1" | "us-east1" | "us-central1" | "europe-west4" | "asia-southeast1" | "eastus" | "eastus2" | "westus3" | "germanywestcentral";
1976
+ /**
1977
+ * Current state of the service.
1978
+ */
1979
+ state?: "starting" | "stopping" | "terminating" | "awaking" | "partially_running" | "provisioning" | "running" | "stopped" | "terminated" | "degraded" | "failed" | "idle";
1980
+ /**
1981
+ * ClickHouse version of the service.
1982
+ */
1983
+ clickhouseVersion?: string;
1984
+ /**
1985
+ * List of all service endpoints.
1986
+ */
1987
+ endpoints?: Array<ServiceEndpoint>;
1988
+ /**
1989
+ * DEPRECATED for BASIC, SCALE and ENTERPRISE organization tiers. Tier of the service: 'development', 'production', 'dedicated_high_mem', 'dedicated_high_cpu', 'dedicated_standard', 'dedicated_standard_n2d_standard_4', 'dedicated_standard_n2d_standard_8', 'dedicated_standard_n2d_standard_32', 'dedicated_standard_n2d_standard_128', 'dedicated_standard_n2d_standard_32_16SSD', 'dedicated_standard_n2d_standard_64_24SSD'. Production services scale, Development are fixed size. Azure services don't support Development tier
1990
+ * @deprecated
1991
+ */
1992
+ tier?: "development" | "production" | "dedicated_high_mem" | "dedicated_high_cpu" | "dedicated_standard" | "dedicated_standard_n2d_standard_4" | "dedicated_standard_n2d_standard_8" | "dedicated_standard_n2d_standard_32" | "dedicated_standard_n2d_standard_128" | "dedicated_standard_n2d_standard_32_16SSD" | "dedicated_standard_n2d_standard_64_24SSD";
1993
+ /**
1994
+ * DEPRECATED - inaccurate for services with non-default numbers of replicas. Minimum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and greater than or equal to 24.
1995
+ * @deprecated
1996
+ */
1997
+ minTotalMemoryGb?: number;
1998
+ /**
1999
+ * DEPRECATED - inaccurate for services with non-default numbers of replicas. Maximum memory of three workers during auto-scaling in Gb. Available only for 'production' services. Must be a multiple of 12 and lower than or equal to 360 for non paid services or 1068 for paid services.
2000
+ * @deprecated
2001
+ */
2002
+ maxTotalMemoryGb?: number;
2003
+ /**
2004
+ * Minimum auto-scaling memory in Gb for a single replica. Available only for 'production' services. Must be a multiple of 4 and greater than or equal to 8.
2005
+ */
2006
+ minReplicaMemoryGb?: number;
2007
+ /**
2008
+ * Maximum auto-scaling memory in Gb for a single replica . Available only for 'production' services. Must be a multiple of 4 and lower than or equal to 120 for non paid services or 356 for paid services.
2009
+ */
2010
+ maxReplicaMemoryGb?: number;
2011
+ /**
2012
+ * Number of replicas for the service. The number of replicas must be between 2 and 20 for the first service in a warehouse. Services that are created in an existing warehouse can have a number of replicas as low as 1. Further restrictions may apply based on your organization's tier. It defaults to 1 for the BASIC tier and 3 for the SCALE and ENTERPRISE tiers.
2013
+ */
2014
+ numReplicas?: number;
2015
+ /**
2016
+ * When set to true the service is allowed to scale down to zero when idle. True by default.
2017
+ */
2018
+ idleScaling?: boolean;
2019
+ /**
2020
+ * Set minimum idling timeout (in minutes). Must be >= 5 minutes.
2021
+ */
2022
+ idleTimeoutMinutes?: number;
2023
+ /**
2024
+ * List of IP addresses allowed to access the service
2025
+ */
2026
+ ipAccessList?: Array<IpAccessListEntry>;
2027
+ /**
2028
+ * Service creation timestamp. ISO-8601.
2029
+ */
2030
+ createdAt?: string;
2031
+ /**
2032
+ * Optional customer provided disk encryption key
2033
+ */
2034
+ encryptionKey?: string;
2035
+ /**
2036
+ * Optional role to use for disk encryption
2037
+ */
2038
+ encryptionAssumedRoleIdentifier?: string;
2039
+ /**
2040
+ * IAM role used for accessing objects in s3
2041
+ */
2042
+ iamRole?: string;
2043
+ /**
2044
+ * List of private endpoints
2045
+ */
2046
+ privateEndpointIds?: Array<string>;
2047
+ /**
2048
+ * List of available private endpoints ids that can be attached to the service
2049
+ */
2050
+ availablePrivateEndpointIds?: Array<string>;
2051
+ /**
2052
+ * Data warehouse containing this service
2053
+ */
2054
+ dataWarehouseId?: string;
2055
+ /**
2056
+ * True if this service is the primary service in the data warehouse
2057
+ */
2058
+ isPrimary?: boolean;
2059
+ /**
2060
+ * True if this service is read-only. It can only be read-only if a dataWarehouseId is provided.
2061
+ */
2062
+ isReadonly?: boolean;
2063
+ /**
2064
+ * Select fast if you want to get new ClickHouse releases as soon as they are available. You'll get new features faster, but with a higher risk of bugs. Select slow if you would like to defer releases to give yourself more time to test. This feature is only available for production services. default is the regular release channel.
2065
+ */
2066
+ releaseChannel?: "slow" | "default" | "fast";
2067
+ /**
2068
+ * This is the ID returned after setting up a region for Bring Your Own Cloud (BYOC). When the byocId parameter is specified, the minReplicaMemoryGb and the maxReplicaGb parameters are required too, with values included among the following sizes: 48, 116, 172, 232.
2069
+ */
2070
+ byocId?: string;
2071
+ /**
2072
+ * True if the service should have the Transparent Data Encryption (TDE) enabled. TDE is only available for ENTERPRISE organizations tiers and can only be enabled at service creation.
2073
+ */
2074
+ hasTransparentDataEncryption?: boolean;
2075
+ /**
2076
+ * Custom instance profile. Only available for ENTERPRISE organization tiers.
2077
+ */
2078
+ profile?: "v1-default" | "v1-highmem-xs" | "v1-highmem-s" | "v1-highmem-m" | "v1-highmem-l" | "v1-highmem-xl" | "v1-highcpu-s" | "v1-highcpu-m" | "v1-highcpu-l" | "v1-highcpu-xl";
2079
+ /**
2080
+ * The ID of the Transparent Data Encryption key used for the service. This is only available if hasTransparentDataEncryption is true.
2081
+ */
2082
+ transparentDataEncryptionKeyId?: string;
2083
+ /**
2084
+ * The ID of the IAM role used for encryption. This is only available if hasTransparentDataEncryption is true.
2085
+ */
2086
+ encryptionRoleId?: string;
2087
+ /**
2088
+ * Type of regulatory compliance for service.
2089
+ */
2090
+ complianceType?: "hipaa" | "pci";
2091
+ };
2092
+ export type ServiceReplicaScalingPatchRequest = {
2093
+ /**
2094
+ * Minimum auto-scaling memory in Gb for a single replica. Available only for 'production' services. Must be a multiple of 4 and greater than or equal to 8.
2095
+ */
2096
+ minReplicaMemoryGb?: number;
2097
+ /**
2098
+ * Maximum auto-scaling memory in Gb for a single replica . Available only for 'production' services. Must be a multiple of 4 and lower than or equal to 120 for non paid services or 356 for paid services.
2099
+ */
2100
+ maxReplicaMemoryGb?: number;
2101
+ /**
2102
+ * Number of replicas for the service. The number of replicas must be between 2 and 20 for the first service in a warehouse. Services that are created in an existing warehouse can have a number of replicas as low as 1. Further restrictions may apply based on your organization's tier. It defaults to 1 for the BASIC tier and 3 for the SCALE and ENTERPRISE tiers.
2103
+ */
2104
+ numReplicas?: number;
2105
+ /**
2106
+ * When set to true the service is allowed to scale down to zero when idle. True by default.
2107
+ */
2108
+ idleScaling?: boolean;
2109
+ /**
2110
+ * Set minimum idling timeout (in minutes). Must be >= 5 minutes.
2111
+ */
2112
+ idleTimeoutMinutes?: number;
2113
+ };
2114
+ export type ServicePasswordPatchResponse = {
2115
+ /**
2116
+ * New service password. Provided only if there was no 'newPasswordHash' in the request
2117
+ */
2118
+ password?: string;
2119
+ };
2120
+ export type ServicePasswordPatchRequest = {
2121
+ /**
2122
+ * Optional password hash. Used to avoid password transmission over network. If not provided a new password is generated and is provided in the response. Otherwise this hash is used. Algorithm: echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64
2123
+ */
2124
+ newPasswordHash?: string;
2125
+ /**
2126
+ * Optional double SHA1 password hash for MySQL protocol. If newPasswordHash is not provided this key will be ignored and the generated password will be used. Algorithm: echo -n "yourpassword" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-'
2127
+ */
2128
+ newDoubleSha1Hash?: string;
2129
+ };
2130
+ export type ServicPrivateEndpointePostRequest = {
2131
+ /**
2132
+ * Private endpoint identifier
2133
+ */
2134
+ id?: string;
2135
+ /**
2136
+ * Description of private endpoint
2137
+ */
2138
+ description?: string;
2139
+ };
2140
+ export type BackupConfigurationPatchRequest = {
2141
+ /**
2142
+ * The interval in hours between each backup.
2143
+ */
2144
+ backupPeriodInHours?: number;
2145
+ /**
2146
+ * The minimum duration in hours for which the backups are available.
2147
+ */
2148
+ backupRetentionPeriodInHours?: number;
2149
+ /**
2150
+ * The time in HH:MM format for the backups to be performed (evaluated in UTC timezone). When defined the backup period resets to every 24 hours.
2151
+ */
2152
+ backupStartTime?: string;
2153
+ };
2154
+ export type ApiKeyPostResponse = {
2155
+ key?: ApiKey;
2156
+ /**
2157
+ * Generated key ID. Provided only if there was no 'hashData' in the request.
2158
+ */
2159
+ keyId?: string;
2160
+ /**
2161
+ * Generated key secret. Provided only if there was no 'hashData' in the request.
2162
+ */
2163
+ keySecret?: string;
2164
+ };
2165
+ export type ApiKeyPostRequest = {
2166
+ /**
2167
+ * Name of the key.
2168
+ */
2169
+ name?: string;
2170
+ /**
2171
+ * Timestamp the key expires. If not present, `null` or is empty the key never expires. ISO-8601.
2172
+ */
2173
+ expireAt?: string | null;
2174
+ /**
2175
+ * Initial state of the key: 'enabled', 'disabled'. If not provided the new key will be 'enabled'.
2176
+ */
2177
+ state?: "enabled" | "disabled";
2178
+ hashData?: ApiKeyHashData;
2179
+ /**
2180
+ * List of roles assigned to the key. Contains at least 1 element.
2181
+ */
2182
+ roles?: Array<"admin" | "developer" | "query_endpoints">;
2183
+ /**
2184
+ * List of IP addresses allowed to access the API using this key
2185
+ */
2186
+ ipAccessList?: Array<IpAccessListEntry>;
2187
+ };
2188
+ export type ApiKeyPatchRequest = {
2189
+ /**
2190
+ * Name of the key
2191
+ */
2192
+ name?: string;
2193
+ /**
2194
+ * List of roles assigned to the key. Contains at least 1 element.
2195
+ */
2196
+ roles?: Array<"admin" | "developer" | "query_endpoints">;
2197
+ /**
2198
+ * Timestamp the key expires. If `null` or is empty the key never expires. ISO-8601.
2199
+ */
2200
+ expireAt?: string | null;
2201
+ /**
2202
+ * State of the key: 'enabled', 'disabled'.
2203
+ */
2204
+ state?: "enabled" | "disabled";
2205
+ /**
2206
+ * List of IP addresses allowed to access the API using this key
2207
+ */
2208
+ ipAccessList?: Array<IpAccessListEntry>;
2209
+ };
2210
+ export type MemberPatchRequest = {
2211
+ /**
2212
+ * Role of the member in the organization.
2213
+ */
2214
+ role?: "admin" | "developer";
2215
+ };
2216
+ export type InvitationPostRequest = {
2217
+ /**
2218
+ * Email of the invited user. Only a user with this email can join using the invitation. The email is stored in a lowercase form.
2219
+ */
2220
+ email?: string;
2221
+ /**
2222
+ * Role of the member in the organization.
2223
+ */
2224
+ role?: "admin" | "developer";
2225
+ };
2226
+ export type ClickPipePostRequest = {
2227
+ /**
2228
+ * Name of the ClickPipe.
2229
+ */
2230
+ name?: string;
2231
+ source?: ClickPipePostSource;
2232
+ destination?: ClickPipeMutateDestination;
2233
+ /**
2234
+ * Field mappings of the ClickPipe. Note that all destination columns must be included in the mappings.
2235
+ */
2236
+ fieldMappings?: Array<ClickPipeFieldMapping>;
2237
+ scaling?: ClickPipeScaling;
2238
+ settings?: ClickPipeSettings;
2239
+ };
2240
+ export type ClickPipePatchRequest = {
2241
+ /**
2242
+ * Name of the ClickPipe.
2243
+ */
2244
+ name?: string | null;
2245
+ source?: ClickPipePatchSource | null;
2246
+ destination?: ClickPipePatchDestination | null;
2247
+ /**
2248
+ * Field mappings of the ClickPipe. This will not update the table schema, only the ClickPipe configuration.
2249
+ */
2250
+ fieldMappings?: Array<ClickPipeFieldMapping>;
2251
+ settings?: ClickPipeSettings | null;
2252
+ };
2253
+ export type ClickPipeScalingPatchRequest = {
2254
+ /**
2255
+ * Number of replicas to scale to. Use to scale Kafka pipes.
2256
+ */
2257
+ replicas?: number | null;
2258
+ /**
2259
+ * Number of concurrency to scale to. Use to scale S3 pipes.
2260
+ */
2261
+ concurrency?: number | null;
2262
+ /**
2263
+ * CPU in millicores for each replica. Use to scale streaming pipes.
2264
+ */
2265
+ replicaCpuMillicores?: number | null;
2266
+ /**
2267
+ * Memory in GB for each replica. Use to scale streaming pipes.
2268
+ */
2269
+ replicaMemoryGb?: number | null;
2270
+ };
2271
+ export type ClickPipeStatePatchRequest = {
2272
+ /**
2273
+ * Command to change the state: 'start', 'stop', 'resync'.
2274
+ */
2275
+ command?: "start" | "stop" | "resync";
2276
+ };
2277
+ export type ClickPipesCdcScalingPatchRequest = {
2278
+ /**
2279
+ * CPU in millicores for DB ClickPipes.
2280
+ */
2281
+ replicaCpuMillicores?: number;
2282
+ /**
2283
+ * Memory in GiB for DB ClickPipes. Must be 4× the CPU core count.
2284
+ */
2285
+ replicaMemoryGb?: number;
2286
+ };
2287
+ export type ByocInfrastructurePostRequest = {
2288
+ /**
2289
+ * Region in which the BYOC infrastructure will be located
2290
+ */
2291
+ regionId?: "ap-south-1" | "ap-southeast-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "us-east-1" | "us-east-2" | "us-west-2" | "ap-southeast-2" | "ap-northeast-1" | "me-central-1" | "us-east1" | "us-central1" | "europe-west4" | "asia-southeast1" | "eastus" | "eastus2" | "westus3" | "germanywestcentral";
2292
+ /**
2293
+ * Cloud account ID the BYOC infrastructure is configured for
2294
+ */
2295
+ accountId?: string;
2296
+ /**
2297
+ * List of availability zone suffixes
2298
+ */
2299
+ availabilityZoneSuffixes?: Array<"a" | "b" | "c" | "d" | "e" | "f">;
2300
+ /**
2301
+ * CIDR range for VPC
2302
+ */
2303
+ vpcCidrRange?: string;
2304
+ };
2305
+ export type ListAvailableOrganizationsData = {
2306
+ body?: never;
2307
+ path?: never;
2308
+ query?: never;
2309
+ url: "/v1/organizations";
2310
+ };
2311
+ export type ListAvailableOrganizationsErrors = {
2312
+ /**
2313
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2314
+ */
2315
+ 400: {
2316
+ /**
2317
+ * HTTP status code.
2318
+ */
2319
+ status?: number;
2320
+ /**
2321
+ * Detailed error description.
2322
+ */
2323
+ error?: string;
2324
+ };
2325
+ };
2326
+ export type ListAvailableOrganizationsError = ListAvailableOrganizationsErrors[keyof ListAvailableOrganizationsErrors];
2327
+ export type ListAvailableOrganizationsResponses = {
2328
+ /**
2329
+ * Successful response
2330
+ */
2331
+ 200: {
2332
+ /**
2333
+ * HTTP status code.
2334
+ */
2335
+ status?: number;
2336
+ /**
2337
+ * Unique id assigned to every request. UUIDv4
2338
+ */
2339
+ requestId?: string;
2340
+ result?: Array<Organization>;
2341
+ };
2342
+ };
2343
+ export type ListAvailableOrganizationsResponse = ListAvailableOrganizationsResponses[keyof ListAvailableOrganizationsResponses];
2344
+ export type GetOrganizationDetailsData = {
2345
+ body?: never;
2346
+ path: {
2347
+ /**
2348
+ * ID of the requested organization.
2349
+ */
2350
+ organizationId: string;
2351
+ };
2352
+ query?: never;
2353
+ url: "/v1/organizations/{organizationId}";
2354
+ };
2355
+ export type GetOrganizationDetailsErrors = {
2356
+ /**
2357
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2358
+ */
2359
+ 400: {
2360
+ /**
2361
+ * HTTP status code.
2362
+ */
2363
+ status?: number;
2364
+ /**
2365
+ * Detailed error description.
2366
+ */
2367
+ error?: string;
2368
+ };
2369
+ };
2370
+ export type GetOrganizationDetailsError = GetOrganizationDetailsErrors[keyof GetOrganizationDetailsErrors];
2371
+ export type GetOrganizationDetailsResponses = {
2372
+ /**
2373
+ * Successful response
2374
+ */
2375
+ 200: {
2376
+ /**
2377
+ * HTTP status code.
2378
+ */
2379
+ status?: number;
2380
+ /**
2381
+ * Unique id assigned to every request. UUIDv4
2382
+ */
2383
+ requestId?: string;
2384
+ result?: Organization;
2385
+ };
2386
+ };
2387
+ export type GetOrganizationDetailsResponse = GetOrganizationDetailsResponses[keyof GetOrganizationDetailsResponses];
2388
+ export type UpdateOrganizationDetailsData = {
2389
+ body?: OrganizationPatchRequest;
2390
+ path: {
2391
+ /**
2392
+ * ID of the organization to update.
2393
+ */
2394
+ organizationId: string;
2395
+ };
2396
+ query?: never;
2397
+ url: "/v1/organizations/{organizationId}";
2398
+ };
2399
+ export type UpdateOrganizationDetailsErrors = {
2400
+ /**
2401
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2402
+ */
2403
+ 400: {
2404
+ /**
2405
+ * HTTP status code.
2406
+ */
2407
+ status?: number;
2408
+ /**
2409
+ * Detailed error description.
2410
+ */
2411
+ error?: string;
2412
+ };
2413
+ };
2414
+ export type UpdateOrganizationDetailsError = UpdateOrganizationDetailsErrors[keyof UpdateOrganizationDetailsErrors];
2415
+ export type UpdateOrganizationDetailsResponses = {
2416
+ /**
2417
+ * Successful response
2418
+ */
2419
+ 200: {
2420
+ /**
2421
+ * HTTP status code.
2422
+ */
2423
+ status?: number;
2424
+ /**
2425
+ * Unique id assigned to every request. UUIDv4
2426
+ */
2427
+ requestId?: string;
2428
+ result?: Organization;
2429
+ };
2430
+ };
2431
+ export type UpdateOrganizationDetailsResponse = UpdateOrganizationDetailsResponses[keyof UpdateOrganizationDetailsResponses];
2432
+ export type GetOrganizationMetricsData = {
2433
+ body?: never;
2434
+ path: {
2435
+ /**
2436
+ * ID of the requested organization.
2437
+ */
2438
+ organizationId: string;
2439
+ };
2440
+ query?: {
2441
+ /**
2442
+ * Return a filtered list of Prometheus metrics.
2443
+ */
2444
+ filtered_metrics?: string;
2445
+ };
2446
+ url: "/v1/organizations/{organizationId}/prometheus";
2447
+ };
2448
+ export type GetOrganizationMetricsErrors = {
2449
+ /**
2450
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2451
+ */
2452
+ 400: {
2453
+ /**
2454
+ * HTTP status code.
2455
+ */
2456
+ status?: number;
2457
+ /**
2458
+ * Detailed error description.
2459
+ */
2460
+ error?: string;
2461
+ };
2462
+ };
2463
+ export type GetOrganizationMetricsError = GetOrganizationMetricsErrors[keyof GetOrganizationMetricsErrors];
2464
+ export type GetOrganizationMetricsResponses = {
2465
+ /**
2466
+ * Successful response
2467
+ */
2468
+ 200: string;
2469
+ };
2470
+ export type GetOrganizationMetricsResponse = GetOrganizationMetricsResponses[keyof GetOrganizationMetricsResponses];
2471
+ export type ListOrganizationServicesData = {
2472
+ body?: never;
2473
+ path: {
2474
+ /**
2475
+ * ID of the requested organization.
2476
+ */
2477
+ organizationId: string;
2478
+ };
2479
+ query?: {
2480
+ /**
2481
+ * Filter criteria to apply when retrieving the resource. Currently, only filtering by resource tags is supported.
2482
+ */
2483
+ filter?: Array<string>;
2484
+ };
2485
+ url: "/v1/organizations/{organizationId}/services";
2486
+ };
2487
+ export type ListOrganizationServicesErrors = {
2488
+ /**
2489
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2490
+ */
2491
+ 400: {
2492
+ /**
2493
+ * HTTP status code.
2494
+ */
2495
+ status?: number;
2496
+ /**
2497
+ * Detailed error description.
2498
+ */
2499
+ error?: string;
2500
+ };
2501
+ };
2502
+ export type ListOrganizationServicesError = ListOrganizationServicesErrors[keyof ListOrganizationServicesErrors];
2503
+ export type ListOrganizationServicesResponses = {
2504
+ /**
2505
+ * Successful response
2506
+ */
2507
+ 200: {
2508
+ /**
2509
+ * HTTP status code.
2510
+ */
2511
+ status?: number;
2512
+ /**
2513
+ * Unique id assigned to every request. UUIDv4
2514
+ */
2515
+ requestId?: string;
2516
+ result?: Array<Service>;
2517
+ };
2518
+ };
2519
+ export type ListOrganizationServicesResponse = ListOrganizationServicesResponses[keyof ListOrganizationServicesResponses];
2520
+ export type CreateNewServiceData = {
2521
+ body?: ServicePostRequest;
2522
+ path: {
2523
+ /**
2524
+ * ID of the organization that will own the service.
2525
+ */
2526
+ organizationId: string;
2527
+ };
2528
+ query?: never;
2529
+ url: "/v1/organizations/{organizationId}/services";
2530
+ };
2531
+ export type CreateNewServiceErrors = {
2532
+ /**
2533
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2534
+ */
2535
+ 400: {
2536
+ /**
2537
+ * HTTP status code.
2538
+ */
2539
+ status?: number;
2540
+ /**
2541
+ * Detailed error description.
2542
+ */
2543
+ error?: string;
2544
+ };
2545
+ };
2546
+ export type CreateNewServiceError = CreateNewServiceErrors[keyof CreateNewServiceErrors];
2547
+ export type CreateNewServiceResponses = {
2548
+ /**
2549
+ * Successful response
2550
+ */
2551
+ 200: {
2552
+ /**
2553
+ * HTTP status code.
2554
+ */
2555
+ status?: number;
2556
+ /**
2557
+ * Unique id assigned to every request. UUIDv4
2558
+ */
2559
+ requestId?: string;
2560
+ result?: ServicePostResponse;
2561
+ };
2562
+ };
2563
+ export type CreateNewServiceResponse = CreateNewServiceResponses[keyof CreateNewServiceResponses];
2564
+ export type DeleteServiceData = {
2565
+ body?: never;
2566
+ path: {
2567
+ /**
2568
+ * ID of the organization that owns the service.
2569
+ */
2570
+ organizationId: string;
2571
+ /**
2572
+ * ID of the service to delete.
2573
+ */
2574
+ serviceId: string;
2575
+ };
2576
+ query?: never;
2577
+ url: "/v1/organizations/{organizationId}/services/{serviceId}";
2578
+ };
2579
+ export type DeleteServiceErrors = {
2580
+ /**
2581
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2582
+ */
2583
+ 400: {
2584
+ /**
2585
+ * HTTP status code.
2586
+ */
2587
+ status?: number;
2588
+ /**
2589
+ * Detailed error description.
2590
+ */
2591
+ error?: string;
2592
+ };
2593
+ };
2594
+ export type DeleteServiceError = DeleteServiceErrors[keyof DeleteServiceErrors];
2595
+ export type DeleteServiceResponses = {
2596
+ /**
2597
+ * Successful response
2598
+ */
2599
+ 200: {
2600
+ /**
2601
+ * HTTP status code.
2602
+ */
2603
+ status?: number;
2604
+ /**
2605
+ * Unique id assigned to every request. UUIDv4
2606
+ */
2607
+ requestId?: string;
2608
+ };
2609
+ };
2610
+ export type DeleteServiceResponse = DeleteServiceResponses[keyof DeleteServiceResponses];
2611
+ export type GetServiceDetailsData = {
2612
+ body?: never;
2613
+ path: {
2614
+ /**
2615
+ * ID of the organization that owns the service.
2616
+ */
2617
+ organizationId: string;
2618
+ /**
2619
+ * ID of the requested service.
2620
+ */
2621
+ serviceId: string;
2622
+ };
2623
+ query?: never;
2624
+ url: "/v1/organizations/{organizationId}/services/{serviceId}";
2625
+ };
2626
+ export type GetServiceDetailsErrors = {
2627
+ /**
2628
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2629
+ */
2630
+ 400: {
2631
+ /**
2632
+ * HTTP status code.
2633
+ */
2634
+ status?: number;
2635
+ /**
2636
+ * Detailed error description.
2637
+ */
2638
+ error?: string;
2639
+ };
2640
+ };
2641
+ export type GetServiceDetailsError = GetServiceDetailsErrors[keyof GetServiceDetailsErrors];
2642
+ export type GetServiceDetailsResponses = {
2643
+ /**
2644
+ * Successful response
2645
+ */
2646
+ 200: {
2647
+ /**
2648
+ * HTTP status code.
2649
+ */
2650
+ status?: number;
2651
+ /**
2652
+ * Unique id assigned to every request. UUIDv4
2653
+ */
2654
+ requestId?: string;
2655
+ result?: Service;
2656
+ };
2657
+ };
2658
+ export type GetServiceDetailsResponse = GetServiceDetailsResponses[keyof GetServiceDetailsResponses];
2659
+ export type UpdateServiceBasicDetailsData = {
2660
+ body?: ServicePatchRequest;
2661
+ path: {
2662
+ /**
2663
+ * ID of the organization that owns the service.
2664
+ */
2665
+ organizationId: string;
2666
+ /**
2667
+ * ID of the service to update.
2668
+ */
2669
+ serviceId: string;
2670
+ };
2671
+ query?: never;
2672
+ url: "/v1/organizations/{organizationId}/services/{serviceId}";
2673
+ };
2674
+ export type UpdateServiceBasicDetailsErrors = {
2675
+ /**
2676
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2677
+ */
2678
+ 400: {
2679
+ /**
2680
+ * HTTP status code.
2681
+ */
2682
+ status?: number;
2683
+ /**
2684
+ * Detailed error description.
2685
+ */
2686
+ error?: string;
2687
+ };
2688
+ };
2689
+ export type UpdateServiceBasicDetailsError = UpdateServiceBasicDetailsErrors[keyof UpdateServiceBasicDetailsErrors];
2690
+ export type UpdateServiceBasicDetailsResponses = {
2691
+ /**
2692
+ * Successful response
2693
+ */
2694
+ 200: {
2695
+ /**
2696
+ * HTTP status code.
2697
+ */
2698
+ status?: number;
2699
+ /**
2700
+ * Unique id assigned to every request. UUIDv4
2701
+ */
2702
+ requestId?: string;
2703
+ result?: Service;
2704
+ };
2705
+ };
2706
+ export type UpdateServiceBasicDetailsResponse = UpdateServiceBasicDetailsResponses[keyof UpdateServiceBasicDetailsResponses];
2707
+ export type GetPrivateEndpointConfigurationData = {
2708
+ body?: never;
2709
+ path: {
2710
+ /**
2711
+ * ID of the requested organization.
2712
+ */
2713
+ organizationId: string;
2714
+ /**
2715
+ * ID of the requested service.
2716
+ */
2717
+ serviceId: string;
2718
+ };
2719
+ query?: never;
2720
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig";
2721
+ };
2722
+ export type GetPrivateEndpointConfigurationErrors = {
2723
+ /**
2724
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2725
+ */
2726
+ 400: {
2727
+ /**
2728
+ * HTTP status code.
2729
+ */
2730
+ status?: number;
2731
+ /**
2732
+ * Detailed error description.
2733
+ */
2734
+ error?: string;
2735
+ };
2736
+ };
2737
+ export type GetPrivateEndpointConfigurationError = GetPrivateEndpointConfigurationErrors[keyof GetPrivateEndpointConfigurationErrors];
2738
+ export type GetPrivateEndpointConfigurationResponses = {
2739
+ /**
2740
+ * Successful response
2741
+ */
2742
+ 200: {
2743
+ /**
2744
+ * HTTP status code.
2745
+ */
2746
+ status?: number;
2747
+ /**
2748
+ * Unique id assigned to every request. UUIDv4
2749
+ */
2750
+ requestId?: string;
2751
+ result?: PrivateEndpointConfig;
2752
+ };
2753
+ };
2754
+ export type GetPrivateEndpointConfigurationResponse = GetPrivateEndpointConfigurationResponses[keyof GetPrivateEndpointConfigurationResponses];
2755
+ export type DeleteServiceQueryEndpointForInstanceData = {
2756
+ body?: never;
2757
+ path: {
2758
+ /**
2759
+ * ID of the requested organization.
2760
+ */
2761
+ organizationId: string;
2762
+ /**
2763
+ * ID of the requested service.
2764
+ */
2765
+ serviceId: string;
2766
+ };
2767
+ query?: never;
2768
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint";
2769
+ };
2770
+ export type DeleteServiceQueryEndpointForInstanceErrors = {
2771
+ /**
2772
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2773
+ */
2774
+ 400: {
2775
+ /**
2776
+ * HTTP status code.
2777
+ */
2778
+ status?: number;
2779
+ /**
2780
+ * Detailed error description.
2781
+ */
2782
+ error?: string;
2783
+ };
2784
+ };
2785
+ export type DeleteServiceQueryEndpointForInstanceError = DeleteServiceQueryEndpointForInstanceErrors[keyof DeleteServiceQueryEndpointForInstanceErrors];
2786
+ export type DeleteServiceQueryEndpointForInstanceResponses = {
2787
+ /**
2788
+ * Successful response
2789
+ */
2790
+ 200: {
2791
+ /**
2792
+ * HTTP status code.
2793
+ */
2794
+ status?: number;
2795
+ /**
2796
+ * Unique id assigned to every request. UUIDv4
2797
+ */
2798
+ requestId?: string;
2799
+ };
2800
+ };
2801
+ export type DeleteServiceQueryEndpointForInstanceResponse = DeleteServiceQueryEndpointForInstanceResponses[keyof DeleteServiceQueryEndpointForInstanceResponses];
2802
+ export type GetServiceQueryEndpointForInstanceData = {
2803
+ body?: never;
2804
+ path: {
2805
+ /**
2806
+ * ID of the requested organization.
2807
+ */
2808
+ organizationId: string;
2809
+ /**
2810
+ * ID of the requested service.
2811
+ */
2812
+ serviceId: string;
2813
+ };
2814
+ query?: never;
2815
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint";
2816
+ };
2817
+ export type GetServiceQueryEndpointForInstanceErrors = {
2818
+ /**
2819
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2820
+ */
2821
+ 400: {
2822
+ /**
2823
+ * HTTP status code.
2824
+ */
2825
+ status?: number;
2826
+ /**
2827
+ * Detailed error description.
2828
+ */
2829
+ error?: string;
2830
+ };
2831
+ };
2832
+ export type GetServiceQueryEndpointForInstanceError = GetServiceQueryEndpointForInstanceErrors[keyof GetServiceQueryEndpointForInstanceErrors];
2833
+ export type GetServiceQueryEndpointForInstanceResponses = {
2834
+ /**
2835
+ * Successful response
2836
+ */
2837
+ 200: {
2838
+ /**
2839
+ * HTTP status code.
2840
+ */
2841
+ status?: number;
2842
+ /**
2843
+ * Unique id assigned to every request. UUIDv4
2844
+ */
2845
+ requestId?: string;
2846
+ result?: ServiceQueryApiEndpoint;
2847
+ };
2848
+ };
2849
+ export type GetServiceQueryEndpointForInstanceResponse = GetServiceQueryEndpointForInstanceResponses[keyof GetServiceQueryEndpointForInstanceResponses];
2850
+ export type UpsertServiceQueryEndpointForInstanceData = {
2851
+ body?: InstanceServiceQueryApiEndpointsPostRequest;
2852
+ path: {
2853
+ /**
2854
+ * ID of the requested organization.
2855
+ */
2856
+ organizationId: string;
2857
+ /**
2858
+ * ID of the requested service.
2859
+ */
2860
+ serviceId: string;
2861
+ };
2862
+ query?: never;
2863
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/serviceQueryEndpoint";
2864
+ };
2865
+ export type UpsertServiceQueryEndpointForInstanceErrors = {
2866
+ /**
2867
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2868
+ */
2869
+ 400: {
2870
+ /**
2871
+ * HTTP status code.
2872
+ */
2873
+ status?: number;
2874
+ /**
2875
+ * Detailed error description.
2876
+ */
2877
+ error?: string;
2878
+ };
2879
+ };
2880
+ export type UpsertServiceQueryEndpointForInstanceError = UpsertServiceQueryEndpointForInstanceErrors[keyof UpsertServiceQueryEndpointForInstanceErrors];
2881
+ export type UpsertServiceQueryEndpointForInstanceResponses = {
2882
+ /**
2883
+ * Successful response
2884
+ */
2885
+ 200: {
2886
+ /**
2887
+ * HTTP status code.
2888
+ */
2889
+ status?: number;
2890
+ /**
2891
+ * Unique id assigned to every request. UUIDv4
2892
+ */
2893
+ requestId?: string;
2894
+ result?: ServiceQueryApiEndpoint;
2895
+ };
2896
+ };
2897
+ export type UpsertServiceQueryEndpointForInstanceResponse = UpsertServiceQueryEndpointForInstanceResponses[keyof UpsertServiceQueryEndpointForInstanceResponses];
2898
+ export type UpdateServiceStateData = {
2899
+ body?: ServiceStatePatchRequest;
2900
+ path: {
2901
+ /**
2902
+ * ID of the organization that owns the service.
2903
+ */
2904
+ organizationId: string;
2905
+ /**
2906
+ * ID of the service to update state.
2907
+ */
2908
+ serviceId: string;
2909
+ };
2910
+ query?: never;
2911
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/state";
2912
+ };
2913
+ export type UpdateServiceStateErrors = {
2914
+ /**
2915
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2916
+ */
2917
+ 400: {
2918
+ /**
2919
+ * HTTP status code.
2920
+ */
2921
+ status?: number;
2922
+ /**
2923
+ * Detailed error description.
2924
+ */
2925
+ error?: string;
2926
+ };
2927
+ };
2928
+ export type UpdateServiceStateError = UpdateServiceStateErrors[keyof UpdateServiceStateErrors];
2929
+ export type UpdateServiceStateResponses = {
2930
+ /**
2931
+ * Successful response
2932
+ */
2933
+ 200: {
2934
+ /**
2935
+ * HTTP status code.
2936
+ */
2937
+ status?: number;
2938
+ /**
2939
+ * Unique id assigned to every request. UUIDv4
2940
+ */
2941
+ requestId?: string;
2942
+ result?: Service;
2943
+ };
2944
+ };
2945
+ export type UpdateServiceStateResponse = UpdateServiceStateResponses[keyof UpdateServiceStateResponses];
2946
+ export type UpdateServiceAutoScalingSettingsData = {
2947
+ body?: ServiceScalingPatchRequest;
2948
+ path: {
2949
+ /**
2950
+ * ID of the organization that owns the service.
2951
+ */
2952
+ organizationId: string;
2953
+ /**
2954
+ * ID of the service to update scaling parameters.
2955
+ */
2956
+ serviceId: string;
2957
+ };
2958
+ query?: never;
2959
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/scaling";
2960
+ };
2961
+ export type UpdateServiceAutoScalingSettingsErrors = {
2962
+ /**
2963
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
2964
+ */
2965
+ 400: {
2966
+ /**
2967
+ * HTTP status code.
2968
+ */
2969
+ status?: number;
2970
+ /**
2971
+ * Detailed error description.
2972
+ */
2973
+ error?: string;
2974
+ };
2975
+ };
2976
+ export type UpdateServiceAutoScalingSettingsError = UpdateServiceAutoScalingSettingsErrors[keyof UpdateServiceAutoScalingSettingsErrors];
2977
+ export type UpdateServiceAutoScalingSettingsResponses = {
2978
+ /**
2979
+ * Successful response
2980
+ */
2981
+ 200: {
2982
+ /**
2983
+ * HTTP status code.
2984
+ */
2985
+ status?: number;
2986
+ /**
2987
+ * Unique id assigned to every request. UUIDv4
2988
+ */
2989
+ requestId?: string;
2990
+ result?: Service;
2991
+ };
2992
+ };
2993
+ export type UpdateServiceAutoScalingSettingsResponse = UpdateServiceAutoScalingSettingsResponses[keyof UpdateServiceAutoScalingSettingsResponses];
2994
+ export type UpdateServiceAutoScalingSettings2Data = {
2995
+ body?: ServiceReplicaScalingPatchRequest;
2996
+ path: {
2997
+ /**
2998
+ * ID of the organization that owns the service.
2999
+ */
3000
+ organizationId: string;
3001
+ /**
3002
+ * ID of the service to update scaling parameters.
3003
+ */
3004
+ serviceId: string;
3005
+ };
3006
+ query?: never;
3007
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling";
3008
+ };
3009
+ export type UpdateServiceAutoScalingSettings2Errors = {
3010
+ /**
3011
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3012
+ */
3013
+ 400: {
3014
+ /**
3015
+ * HTTP status code.
3016
+ */
3017
+ status?: number;
3018
+ /**
3019
+ * Detailed error description.
3020
+ */
3021
+ error?: string;
3022
+ };
3023
+ };
3024
+ export type UpdateServiceAutoScalingSettings2Error = UpdateServiceAutoScalingSettings2Errors[keyof UpdateServiceAutoScalingSettings2Errors];
3025
+ export type UpdateServiceAutoScalingSettings2Responses = {
3026
+ /**
3027
+ * Successful response
3028
+ */
3029
+ 200: {
3030
+ /**
3031
+ * HTTP status code.
3032
+ */
3033
+ status?: number;
3034
+ /**
3035
+ * Unique id assigned to every request. UUIDv4
3036
+ */
3037
+ requestId?: string;
3038
+ result?: ServiceScalingPatchResponse;
3039
+ };
3040
+ };
3041
+ export type UpdateServiceAutoScalingSettings2Response = UpdateServiceAutoScalingSettings2Responses[keyof UpdateServiceAutoScalingSettings2Responses];
3042
+ export type UpdateServicePasswordData = {
3043
+ body?: ServicePasswordPatchRequest;
3044
+ path: {
3045
+ /**
3046
+ * ID of the organization that owns the service.
3047
+ */
3048
+ organizationId: string;
3049
+ /**
3050
+ * ID of the service to update password.
3051
+ */
3052
+ serviceId: string;
3053
+ };
3054
+ query?: never;
3055
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/password";
3056
+ };
3057
+ export type UpdateServicePasswordErrors = {
3058
+ /**
3059
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3060
+ */
3061
+ 400: {
3062
+ /**
3063
+ * HTTP status code.
3064
+ */
3065
+ status?: number;
3066
+ /**
3067
+ * Detailed error description.
3068
+ */
3069
+ error?: string;
3070
+ };
3071
+ };
3072
+ export type UpdateServicePasswordError = UpdateServicePasswordErrors[keyof UpdateServicePasswordErrors];
3073
+ export type UpdateServicePasswordResponses = {
3074
+ /**
3075
+ * Successful response
3076
+ */
3077
+ 200: {
3078
+ /**
3079
+ * HTTP status code.
3080
+ */
3081
+ status?: number;
3082
+ /**
3083
+ * Unique id assigned to every request. UUIDv4
3084
+ */
3085
+ requestId?: string;
3086
+ result?: ServicePasswordPatchResponse;
3087
+ };
3088
+ };
3089
+ export type UpdateServicePasswordResponse = UpdateServicePasswordResponses[keyof UpdateServicePasswordResponses];
3090
+ export type CreatePrivateEndpointData = {
3091
+ body?: ServicPrivateEndpointePostRequest;
3092
+ path: {
3093
+ /**
3094
+ * ID of the requested organization.
3095
+ */
3096
+ organizationId: string;
3097
+ /**
3098
+ * ID of the requested service.
3099
+ */
3100
+ serviceId: string;
3101
+ };
3102
+ query?: never;
3103
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/privateEndpoint";
3104
+ };
3105
+ export type CreatePrivateEndpointErrors = {
3106
+ /**
3107
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3108
+ */
3109
+ 400: {
3110
+ /**
3111
+ * HTTP status code.
3112
+ */
3113
+ status?: number;
3114
+ /**
3115
+ * Detailed error description.
3116
+ */
3117
+ error?: string;
3118
+ };
3119
+ };
3120
+ export type CreatePrivateEndpointError = CreatePrivateEndpointErrors[keyof CreatePrivateEndpointErrors];
3121
+ export type CreatePrivateEndpointResponses = {
3122
+ /**
3123
+ * Successful response
3124
+ */
3125
+ 200: {
3126
+ /**
3127
+ * HTTP status code.
3128
+ */
3129
+ status?: number;
3130
+ /**
3131
+ * Unique id assigned to every request. UUIDv4
3132
+ */
3133
+ requestId?: string;
3134
+ result?: InstancePrivateEndpoint;
3135
+ };
3136
+ };
3137
+ export type CreatePrivateEndpointResponse = CreatePrivateEndpointResponses[keyof CreatePrivateEndpointResponses];
3138
+ export type GetServiceMetricsData = {
3139
+ body?: never;
3140
+ path: {
3141
+ /**
3142
+ * ID of the organization that owns the service.
3143
+ */
3144
+ organizationId: string;
3145
+ /**
3146
+ * ID of the requested service.
3147
+ */
3148
+ serviceId: string;
3149
+ };
3150
+ query?: {
3151
+ /**
3152
+ * Return a filtered list of Prometheus metrics.
3153
+ */
3154
+ filtered_metrics?: string;
3155
+ };
3156
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/prometheus";
3157
+ };
3158
+ export type GetServiceMetricsErrors = {
3159
+ /**
3160
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3161
+ */
3162
+ 400: {
3163
+ /**
3164
+ * HTTP status code.
3165
+ */
3166
+ status?: number;
3167
+ /**
3168
+ * Detailed error description.
3169
+ */
3170
+ error?: string;
3171
+ };
3172
+ };
3173
+ export type GetServiceMetricsError = GetServiceMetricsErrors[keyof GetServiceMetricsErrors];
3174
+ export type GetServiceMetricsResponses = {
3175
+ /**
3176
+ * Successful response
3177
+ */
3178
+ 200: string;
3179
+ };
3180
+ export type GetServiceMetricsResponse = GetServiceMetricsResponses[keyof GetServiceMetricsResponses];
3181
+ export type ListServiceBackupsData = {
3182
+ body?: never;
3183
+ path: {
3184
+ /**
3185
+ * ID of the organization that owns the backup.
3186
+ */
3187
+ organizationId: string;
3188
+ /**
3189
+ * ID of the service the backup was created from.
3190
+ */
3191
+ serviceId: string;
3192
+ };
3193
+ query?: never;
3194
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/backups";
3195
+ };
3196
+ export type ListServiceBackupsErrors = {
3197
+ /**
3198
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3199
+ */
3200
+ 400: {
3201
+ /**
3202
+ * HTTP status code.
3203
+ */
3204
+ status?: number;
3205
+ /**
3206
+ * Detailed error description.
3207
+ */
3208
+ error?: string;
3209
+ };
3210
+ };
3211
+ export type ListServiceBackupsError = ListServiceBackupsErrors[keyof ListServiceBackupsErrors];
3212
+ export type ListServiceBackupsResponses = {
3213
+ /**
3214
+ * Successful response
3215
+ */
3216
+ 200: {
3217
+ /**
3218
+ * HTTP status code.
3219
+ */
3220
+ status?: number;
3221
+ /**
3222
+ * Unique id assigned to every request. UUIDv4
3223
+ */
3224
+ requestId?: string;
3225
+ result?: Array<Backup>;
3226
+ };
3227
+ };
3228
+ export type ListServiceBackupsResponse = ListServiceBackupsResponses[keyof ListServiceBackupsResponses];
3229
+ export type GetBackupDetailsData = {
3230
+ body?: never;
3231
+ path: {
3232
+ /**
3233
+ * ID of the organization that owns the backup.
3234
+ */
3235
+ organizationId: string;
3236
+ /**
3237
+ * ID of the service the backup was created from.
3238
+ */
3239
+ serviceId: string;
3240
+ /**
3241
+ * ID of the requested backup.
3242
+ */
3243
+ backupId: string;
3244
+ };
3245
+ query?: never;
3246
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId}";
3247
+ };
3248
+ export type GetBackupDetailsErrors = {
3249
+ /**
3250
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3251
+ */
3252
+ 400: {
3253
+ /**
3254
+ * HTTP status code.
3255
+ */
3256
+ status?: number;
3257
+ /**
3258
+ * Detailed error description.
3259
+ */
3260
+ error?: string;
3261
+ };
3262
+ };
3263
+ export type GetBackupDetailsError = GetBackupDetailsErrors[keyof GetBackupDetailsErrors];
3264
+ export type GetBackupDetailsResponses = {
3265
+ /**
3266
+ * Successful response
3267
+ */
3268
+ 200: {
3269
+ /**
3270
+ * HTTP status code.
3271
+ */
3272
+ status?: number;
3273
+ /**
3274
+ * Unique id assigned to every request. UUIDv4
3275
+ */
3276
+ requestId?: string;
3277
+ result?: Backup;
3278
+ };
3279
+ };
3280
+ export type GetBackupDetailsResponse = GetBackupDetailsResponses[keyof GetBackupDetailsResponses];
3281
+ export type GetServiceBackupConfigurationData = {
3282
+ body?: never;
3283
+ path: {
3284
+ /**
3285
+ * ID of the organization that owns the service.
3286
+ */
3287
+ organizationId: string;
3288
+ /**
3289
+ * ID of the service.
3290
+ */
3291
+ serviceId: string;
3292
+ };
3293
+ query?: never;
3294
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration";
3295
+ };
3296
+ export type GetServiceBackupConfigurationErrors = {
3297
+ /**
3298
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3299
+ */
3300
+ 400: {
3301
+ /**
3302
+ * HTTP status code.
3303
+ */
3304
+ status?: number;
3305
+ /**
3306
+ * Detailed error description.
3307
+ */
3308
+ error?: string;
3309
+ };
3310
+ };
3311
+ export type GetServiceBackupConfigurationError = GetServiceBackupConfigurationErrors[keyof GetServiceBackupConfigurationErrors];
3312
+ export type GetServiceBackupConfigurationResponses = {
3313
+ /**
3314
+ * Successful response
3315
+ */
3316
+ 200: {
3317
+ /**
3318
+ * HTTP status code.
3319
+ */
3320
+ status?: number;
3321
+ /**
3322
+ * Unique id assigned to every request. UUIDv4
3323
+ */
3324
+ requestId?: string;
3325
+ result?: BackupConfiguration;
3326
+ };
3327
+ };
3328
+ export type GetServiceBackupConfigurationResponse = GetServiceBackupConfigurationResponses[keyof GetServiceBackupConfigurationResponses];
3329
+ export type UpdateServiceBackupConfigurationData = {
3330
+ body?: BackupConfigurationPatchRequest;
3331
+ path: {
3332
+ /**
3333
+ * ID of the organization that owns the service.
3334
+ */
3335
+ organizationId: string;
3336
+ /**
3337
+ * ID of the service.
3338
+ */
3339
+ serviceId: string;
3340
+ };
3341
+ query?: never;
3342
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration";
3343
+ };
3344
+ export type UpdateServiceBackupConfigurationErrors = {
3345
+ /**
3346
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3347
+ */
3348
+ 400: {
3349
+ /**
3350
+ * HTTP status code.
3351
+ */
3352
+ status?: number;
3353
+ /**
3354
+ * Detailed error description.
3355
+ */
3356
+ error?: string;
3357
+ };
3358
+ };
3359
+ export type UpdateServiceBackupConfigurationError = UpdateServiceBackupConfigurationErrors[keyof UpdateServiceBackupConfigurationErrors];
3360
+ export type UpdateServiceBackupConfigurationResponses = {
3361
+ /**
3362
+ * Successful response
3363
+ */
3364
+ 200: {
3365
+ /**
3366
+ * HTTP status code.
3367
+ */
3368
+ status?: number;
3369
+ /**
3370
+ * Unique id assigned to every request. UUIDv4
3371
+ */
3372
+ requestId?: string;
3373
+ result?: BackupConfiguration;
3374
+ };
3375
+ };
3376
+ export type UpdateServiceBackupConfigurationResponse = UpdateServiceBackupConfigurationResponses[keyof UpdateServiceBackupConfigurationResponses];
3377
+ export type ListAllKeysData = {
3378
+ body?: never;
3379
+ path: {
3380
+ /**
3381
+ * ID of the requested organization.
3382
+ */
3383
+ organizationId: string;
3384
+ };
3385
+ query?: never;
3386
+ url: "/v1/organizations/{organizationId}/keys";
3387
+ };
3388
+ export type ListAllKeysErrors = {
3389
+ /**
3390
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3391
+ */
3392
+ 400: {
3393
+ /**
3394
+ * HTTP status code.
3395
+ */
3396
+ status?: number;
3397
+ /**
3398
+ * Detailed error description.
3399
+ */
3400
+ error?: string;
3401
+ };
3402
+ };
3403
+ export type ListAllKeysError = ListAllKeysErrors[keyof ListAllKeysErrors];
3404
+ export type ListAllKeysResponses = {
3405
+ /**
3406
+ * Successful response
3407
+ */
3408
+ 200: {
3409
+ /**
3410
+ * HTTP status code.
3411
+ */
3412
+ status?: number;
3413
+ /**
3414
+ * Unique id assigned to every request. UUIDv4
3415
+ */
3416
+ requestId?: string;
3417
+ result?: Array<ApiKey>;
3418
+ };
3419
+ };
3420
+ export type ListAllKeysResponse = ListAllKeysResponses[keyof ListAllKeysResponses];
3421
+ export type CreateKeyData = {
3422
+ body?: ApiKeyPostRequest;
3423
+ path: {
3424
+ /**
3425
+ * ID of the organization that will own the key.
3426
+ */
3427
+ organizationId: string;
3428
+ };
3429
+ query?: never;
3430
+ url: "/v1/organizations/{organizationId}/keys";
3431
+ };
3432
+ export type CreateKeyErrors = {
3433
+ /**
3434
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3435
+ */
3436
+ 400: {
3437
+ /**
3438
+ * HTTP status code.
3439
+ */
3440
+ status?: number;
3441
+ /**
3442
+ * Detailed error description.
3443
+ */
3444
+ error?: string;
3445
+ };
3446
+ };
3447
+ export type CreateKeyError = CreateKeyErrors[keyof CreateKeyErrors];
3448
+ export type CreateKeyResponses = {
3449
+ /**
3450
+ * Successful response
3451
+ */
3452
+ 200: {
3453
+ /**
3454
+ * HTTP status code.
3455
+ */
3456
+ status?: number;
3457
+ /**
3458
+ * Unique id assigned to every request. UUIDv4
3459
+ */
3460
+ requestId?: string;
3461
+ result?: ApiKeyPostResponse;
3462
+ };
3463
+ };
3464
+ export type CreateKeyResponse = CreateKeyResponses[keyof CreateKeyResponses];
3465
+ export type DeleteKeyData = {
3466
+ body?: never;
3467
+ path: {
3468
+ /**
3469
+ * ID of the organization that owns the key.
3470
+ */
3471
+ organizationId: string;
3472
+ /**
3473
+ * ID of the key to delete.
3474
+ */
3475
+ keyId: string;
3476
+ };
3477
+ query?: never;
3478
+ url: "/v1/organizations/{organizationId}/keys/{keyId}";
3479
+ };
3480
+ export type DeleteKeyErrors = {
3481
+ /**
3482
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3483
+ */
3484
+ 400: {
3485
+ /**
3486
+ * HTTP status code.
3487
+ */
3488
+ status?: number;
3489
+ /**
3490
+ * Detailed error description.
3491
+ */
3492
+ error?: string;
3493
+ };
3494
+ };
3495
+ export type DeleteKeyError = DeleteKeyErrors[keyof DeleteKeyErrors];
3496
+ export type DeleteKeyResponses = {
3497
+ /**
3498
+ * Successful response
3499
+ */
3500
+ 200: {
3501
+ /**
3502
+ * HTTP status code.
3503
+ */
3504
+ status?: number;
3505
+ /**
3506
+ * Unique id assigned to every request. UUIDv4
3507
+ */
3508
+ requestId?: string;
3509
+ };
3510
+ };
3511
+ export type DeleteKeyResponse = DeleteKeyResponses[keyof DeleteKeyResponses];
3512
+ export type GetKeyDetailsData = {
3513
+ body?: never;
3514
+ path: {
3515
+ /**
3516
+ * ID of the requested organization.
3517
+ */
3518
+ organizationId: string;
3519
+ /**
3520
+ * ID of the requested key.
3521
+ */
3522
+ keyId: string;
3523
+ };
3524
+ query?: never;
3525
+ url: "/v1/organizations/{organizationId}/keys/{keyId}";
3526
+ };
3527
+ export type GetKeyDetailsErrors = {
3528
+ /**
3529
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3530
+ */
3531
+ 400: {
3532
+ /**
3533
+ * HTTP status code.
3534
+ */
3535
+ status?: number;
3536
+ /**
3537
+ * Detailed error description.
3538
+ */
3539
+ error?: string;
3540
+ };
3541
+ };
3542
+ export type GetKeyDetailsError = GetKeyDetailsErrors[keyof GetKeyDetailsErrors];
3543
+ export type GetKeyDetailsResponses = {
3544
+ /**
3545
+ * Successful response
3546
+ */
3547
+ 200: {
3548
+ /**
3549
+ * HTTP status code.
3550
+ */
3551
+ status?: number;
3552
+ /**
3553
+ * Unique id assigned to every request. UUIDv4
3554
+ */
3555
+ requestId?: string;
3556
+ result?: ApiKey;
3557
+ };
3558
+ };
3559
+ export type GetKeyDetailsResponse = GetKeyDetailsResponses[keyof GetKeyDetailsResponses];
3560
+ export type UpdateKeyData = {
3561
+ body?: ApiKeyPatchRequest;
3562
+ path: {
3563
+ /**
3564
+ * ID of the organization that owns the key.
3565
+ */
3566
+ organizationId: string;
3567
+ /**
3568
+ * ID of the key to update.
3569
+ */
3570
+ keyId: string;
3571
+ };
3572
+ query?: never;
3573
+ url: "/v1/organizations/{organizationId}/keys/{keyId}";
3574
+ };
3575
+ export type UpdateKeyErrors = {
3576
+ /**
3577
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3578
+ */
3579
+ 400: {
3580
+ /**
3581
+ * HTTP status code.
3582
+ */
3583
+ status?: number;
3584
+ /**
3585
+ * Detailed error description.
3586
+ */
3587
+ error?: string;
3588
+ };
3589
+ };
3590
+ export type UpdateKeyError = UpdateKeyErrors[keyof UpdateKeyErrors];
3591
+ export type UpdateKeyResponses = {
3592
+ /**
3593
+ * Successful response
3594
+ */
3595
+ 200: {
3596
+ /**
3597
+ * HTTP status code.
3598
+ */
3599
+ status?: number;
3600
+ /**
3601
+ * Unique id assigned to every request. UUIDv4
3602
+ */
3603
+ requestId?: string;
3604
+ result?: ApiKey;
3605
+ };
3606
+ };
3607
+ export type UpdateKeyResponse = UpdateKeyResponses[keyof UpdateKeyResponses];
3608
+ export type ListOrganizationMembersData = {
3609
+ body?: never;
3610
+ path: {
3611
+ /**
3612
+ * ID of the requested organization.
3613
+ */
3614
+ organizationId: string;
3615
+ };
3616
+ query?: never;
3617
+ url: "/v1/organizations/{organizationId}/members";
3618
+ };
3619
+ export type ListOrganizationMembersErrors = {
3620
+ /**
3621
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3622
+ */
3623
+ 400: {
3624
+ /**
3625
+ * HTTP status code.
3626
+ */
3627
+ status?: number;
3628
+ /**
3629
+ * Detailed error description.
3630
+ */
3631
+ error?: string;
3632
+ };
3633
+ };
3634
+ export type ListOrganizationMembersError = ListOrganizationMembersErrors[keyof ListOrganizationMembersErrors];
3635
+ export type ListOrganizationMembersResponses = {
3636
+ /**
3637
+ * Successful response
3638
+ */
3639
+ 200: {
3640
+ /**
3641
+ * HTTP status code.
3642
+ */
3643
+ status?: number;
3644
+ /**
3645
+ * Unique id assigned to every request. UUIDv4
3646
+ */
3647
+ requestId?: string;
3648
+ result?: Array<Member>;
3649
+ };
3650
+ };
3651
+ export type ListOrganizationMembersResponse = ListOrganizationMembersResponses[keyof ListOrganizationMembersResponses];
3652
+ export type RemoveOrganizationMemberData = {
3653
+ body?: never;
3654
+ path: {
3655
+ /**
3656
+ * ID of the requested organization.
3657
+ */
3658
+ organizationId: string;
3659
+ /**
3660
+ * ID of the requested user.
3661
+ */
3662
+ userId: string;
3663
+ };
3664
+ query?: never;
3665
+ url: "/v1/organizations/{organizationId}/members/{userId}";
3666
+ };
3667
+ export type RemoveOrganizationMemberErrors = {
3668
+ /**
3669
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3670
+ */
3671
+ 400: {
3672
+ /**
3673
+ * HTTP status code.
3674
+ */
3675
+ status?: number;
3676
+ /**
3677
+ * Detailed error description.
3678
+ */
3679
+ error?: string;
3680
+ };
3681
+ };
3682
+ export type RemoveOrganizationMemberError = RemoveOrganizationMemberErrors[keyof RemoveOrganizationMemberErrors];
3683
+ export type RemoveOrganizationMemberResponses = {
3684
+ /**
3685
+ * Successful response
3686
+ */
3687
+ 200: {
3688
+ /**
3689
+ * HTTP status code.
3690
+ */
3691
+ status?: number;
3692
+ /**
3693
+ * Unique id assigned to every request. UUIDv4
3694
+ */
3695
+ requestId?: string;
3696
+ };
3697
+ };
3698
+ export type RemoveOrganizationMemberResponse = RemoveOrganizationMemberResponses[keyof RemoveOrganizationMemberResponses];
3699
+ export type GetMemberDetailsData = {
3700
+ body?: never;
3701
+ path: {
3702
+ /**
3703
+ * ID of the organization the member is part of.
3704
+ */
3705
+ organizationId: string;
3706
+ /**
3707
+ * ID of the requested user.
3708
+ */
3709
+ userId: string;
3710
+ };
3711
+ query?: never;
3712
+ url: "/v1/organizations/{organizationId}/members/{userId}";
3713
+ };
3714
+ export type GetMemberDetailsErrors = {
3715
+ /**
3716
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3717
+ */
3718
+ 400: {
3719
+ /**
3720
+ * HTTP status code.
3721
+ */
3722
+ status?: number;
3723
+ /**
3724
+ * Detailed error description.
3725
+ */
3726
+ error?: string;
3727
+ };
3728
+ };
3729
+ export type GetMemberDetailsError = GetMemberDetailsErrors[keyof GetMemberDetailsErrors];
3730
+ export type GetMemberDetailsResponses = {
3731
+ /**
3732
+ * Successful response
3733
+ */
3734
+ 200: {
3735
+ /**
3736
+ * HTTP status code.
3737
+ */
3738
+ status?: number;
3739
+ /**
3740
+ * Unique id assigned to every request. UUIDv4
3741
+ */
3742
+ requestId?: string;
3743
+ result?: Member;
3744
+ };
3745
+ };
3746
+ export type GetMemberDetailsResponse = GetMemberDetailsResponses[keyof GetMemberDetailsResponses];
3747
+ export type UpdateOrganizationMemberData = {
3748
+ body?: MemberPatchRequest;
3749
+ path: {
3750
+ /**
3751
+ * ID of the organization the member is part of.
3752
+ */
3753
+ organizationId: string;
3754
+ /**
3755
+ * ID of the user to patch
3756
+ */
3757
+ userId: string;
3758
+ };
3759
+ query?: never;
3760
+ url: "/v1/organizations/{organizationId}/members/{userId}";
3761
+ };
3762
+ export type UpdateOrganizationMemberErrors = {
3763
+ /**
3764
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3765
+ */
3766
+ 400: {
3767
+ /**
3768
+ * HTTP status code.
3769
+ */
3770
+ status?: number;
3771
+ /**
3772
+ * Detailed error description.
3773
+ */
3774
+ error?: string;
3775
+ };
3776
+ };
3777
+ export type UpdateOrganizationMemberError = UpdateOrganizationMemberErrors[keyof UpdateOrganizationMemberErrors];
3778
+ export type UpdateOrganizationMemberResponses = {
3779
+ /**
3780
+ * Successful response
3781
+ */
3782
+ 200: {
3783
+ /**
3784
+ * HTTP status code.
3785
+ */
3786
+ status?: number;
3787
+ /**
3788
+ * Unique id assigned to every request. UUIDv4
3789
+ */
3790
+ requestId?: string;
3791
+ result?: Member;
3792
+ };
3793
+ };
3794
+ export type UpdateOrganizationMemberResponse = UpdateOrganizationMemberResponses[keyof UpdateOrganizationMemberResponses];
3795
+ export type ListAllInvitationsData = {
3796
+ body?: never;
3797
+ path: {
3798
+ /**
3799
+ * ID of the requested organization.
3800
+ */
3801
+ organizationId: string;
3802
+ };
3803
+ query?: never;
3804
+ url: "/v1/organizations/{organizationId}/invitations";
3805
+ };
3806
+ export type ListAllInvitationsErrors = {
3807
+ /**
3808
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3809
+ */
3810
+ 400: {
3811
+ /**
3812
+ * HTTP status code.
3813
+ */
3814
+ status?: number;
3815
+ /**
3816
+ * Detailed error description.
3817
+ */
3818
+ error?: string;
3819
+ };
3820
+ };
3821
+ export type ListAllInvitationsError = ListAllInvitationsErrors[keyof ListAllInvitationsErrors];
3822
+ export type ListAllInvitationsResponses = {
3823
+ /**
3824
+ * Successful response
3825
+ */
3826
+ 200: {
3827
+ /**
3828
+ * HTTP status code.
3829
+ */
3830
+ status?: number;
3831
+ /**
3832
+ * Unique id assigned to every request. UUIDv4
3833
+ */
3834
+ requestId?: string;
3835
+ result?: Array<Invitation>;
3836
+ };
3837
+ };
3838
+ export type ListAllInvitationsResponse = ListAllInvitationsResponses[keyof ListAllInvitationsResponses];
3839
+ export type CreateInvitationData = {
3840
+ body?: InvitationPostRequest;
3841
+ path: {
3842
+ /**
3843
+ * ID of the organization to invite a user to.
3844
+ */
3845
+ organizationId: string;
3846
+ };
3847
+ query?: never;
3848
+ url: "/v1/organizations/{organizationId}/invitations";
3849
+ };
3850
+ export type CreateInvitationErrors = {
3851
+ /**
3852
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3853
+ */
3854
+ 400: {
3855
+ /**
3856
+ * HTTP status code.
3857
+ */
3858
+ status?: number;
3859
+ /**
3860
+ * Detailed error description.
3861
+ */
3862
+ error?: string;
3863
+ };
3864
+ };
3865
+ export type CreateInvitationError = CreateInvitationErrors[keyof CreateInvitationErrors];
3866
+ export type CreateInvitationResponses = {
3867
+ /**
3868
+ * Successful response
3869
+ */
3870
+ 200: {
3871
+ /**
3872
+ * HTTP status code.
3873
+ */
3874
+ status?: number;
3875
+ /**
3876
+ * Unique id assigned to every request. UUIDv4
3877
+ */
3878
+ requestId?: string;
3879
+ result?: Invitation;
3880
+ };
3881
+ };
3882
+ export type CreateInvitationResponse = CreateInvitationResponses[keyof CreateInvitationResponses];
3883
+ export type DeleteOrganizationInvitationData = {
3884
+ body?: never;
3885
+ path: {
3886
+ /**
3887
+ * ID of the organization that has the invitation.
3888
+ */
3889
+ organizationId: string;
3890
+ /**
3891
+ * ID of the requested organization.
3892
+ */
3893
+ invitationId: string;
3894
+ };
3895
+ query?: never;
3896
+ url: "/v1/organizations/{organizationId}/invitations/{invitationId}";
3897
+ };
3898
+ export type DeleteOrganizationInvitationErrors = {
3899
+ /**
3900
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3901
+ */
3902
+ 400: {
3903
+ /**
3904
+ * HTTP status code.
3905
+ */
3906
+ status?: number;
3907
+ /**
3908
+ * Detailed error description.
3909
+ */
3910
+ error?: string;
3911
+ };
3912
+ };
3913
+ export type DeleteOrganizationInvitationError = DeleteOrganizationInvitationErrors[keyof DeleteOrganizationInvitationErrors];
3914
+ export type DeleteOrganizationInvitationResponses = {
3915
+ /**
3916
+ * Successful response
3917
+ */
3918
+ 200: {
3919
+ /**
3920
+ * HTTP status code.
3921
+ */
3922
+ status?: number;
3923
+ /**
3924
+ * Unique id assigned to every request. UUIDv4
3925
+ */
3926
+ requestId?: string;
3927
+ };
3928
+ };
3929
+ export type DeleteOrganizationInvitationResponse = DeleteOrganizationInvitationResponses[keyof DeleteOrganizationInvitationResponses];
3930
+ export type GetInvitationDetailsData = {
3931
+ body?: never;
3932
+ path: {
3933
+ /**
3934
+ * ID of the requested organization.
3935
+ */
3936
+ organizationId: string;
3937
+ /**
3938
+ * ID of the requested organization.
3939
+ */
3940
+ invitationId: string;
3941
+ };
3942
+ query?: never;
3943
+ url: "/v1/organizations/{organizationId}/invitations/{invitationId}";
3944
+ };
3945
+ export type GetInvitationDetailsErrors = {
3946
+ /**
3947
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
3948
+ */
3949
+ 400: {
3950
+ /**
3951
+ * HTTP status code.
3952
+ */
3953
+ status?: number;
3954
+ /**
3955
+ * Detailed error description.
3956
+ */
3957
+ error?: string;
3958
+ };
3959
+ };
3960
+ export type GetInvitationDetailsError = GetInvitationDetailsErrors[keyof GetInvitationDetailsErrors];
3961
+ export type GetInvitationDetailsResponses = {
3962
+ /**
3963
+ * Successful response
3964
+ */
3965
+ 200: {
3966
+ /**
3967
+ * HTTP status code.
3968
+ */
3969
+ status?: number;
3970
+ /**
3971
+ * Unique id assigned to every request. UUIDv4
3972
+ */
3973
+ requestId?: string;
3974
+ result?: Invitation;
3975
+ };
3976
+ };
3977
+ export type GetInvitationDetailsResponse = GetInvitationDetailsResponses[keyof GetInvitationDetailsResponses];
3978
+ export type ListOrganizationActivitiesData = {
3979
+ body?: never;
3980
+ path: {
3981
+ /**
3982
+ * ID of the requested organization.
3983
+ */
3984
+ organizationId: string;
3985
+ };
3986
+ query?: {
3987
+ /**
3988
+ * A starting date for a search
3989
+ */
3990
+ from_date?: string;
3991
+ /**
3992
+ * An ending date for a search
3993
+ */
3994
+ to_date?: string;
3995
+ };
3996
+ url: "/v1/organizations/{organizationId}/activities";
3997
+ };
3998
+ export type ListOrganizationActivitiesErrors = {
3999
+ /**
4000
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4001
+ */
4002
+ 400: {
4003
+ /**
4004
+ * HTTP status code.
4005
+ */
4006
+ status?: number;
4007
+ /**
4008
+ * Detailed error description.
4009
+ */
4010
+ error?: string;
4011
+ };
4012
+ };
4013
+ export type ListOrganizationActivitiesError = ListOrganizationActivitiesErrors[keyof ListOrganizationActivitiesErrors];
4014
+ export type ListOrganizationActivitiesResponses = {
4015
+ /**
4016
+ * Successful response
4017
+ */
4018
+ 200: {
4019
+ /**
4020
+ * HTTP status code.
4021
+ */
4022
+ status?: number;
4023
+ /**
4024
+ * Unique id assigned to every request. UUIDv4
4025
+ */
4026
+ requestId?: string;
4027
+ result?: Array<Activity>;
4028
+ };
4029
+ };
4030
+ export type ListOrganizationActivitiesResponse = ListOrganizationActivitiesResponses[keyof ListOrganizationActivitiesResponses];
4031
+ export type OrganizationActivityData = {
4032
+ body?: never;
4033
+ path: {
4034
+ /**
4035
+ * ID of the requested organization.
4036
+ */
4037
+ organizationId: string;
4038
+ /**
4039
+ * ID of the requested activity.
4040
+ */
4041
+ activityId: string;
4042
+ };
4043
+ query?: never;
4044
+ url: "/v1/organizations/{organizationId}/activities/{activityId}";
4045
+ };
4046
+ export type OrganizationActivityErrors = {
4047
+ /**
4048
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4049
+ */
4050
+ 400: {
4051
+ /**
4052
+ * HTTP status code.
4053
+ */
4054
+ status?: number;
4055
+ /**
4056
+ * Detailed error description.
4057
+ */
4058
+ error?: string;
4059
+ };
4060
+ };
4061
+ export type OrganizationActivityError = OrganizationActivityErrors[keyof OrganizationActivityErrors];
4062
+ export type OrganizationActivityResponses = {
4063
+ /**
4064
+ * Successful response
4065
+ */
4066
+ 200: {
4067
+ /**
4068
+ * HTTP status code.
4069
+ */
4070
+ status?: number;
4071
+ /**
4072
+ * Unique id assigned to every request. UUIDv4
4073
+ */
4074
+ requestId?: string;
4075
+ result?: Activity;
4076
+ };
4077
+ };
4078
+ export type OrganizationActivityResponse = OrganizationActivityResponses[keyof OrganizationActivityResponses];
4079
+ export type GetOrganizationUsageCostsData = {
4080
+ body?: never;
4081
+ path: {
4082
+ /**
4083
+ * ID of the requested organization.
4084
+ */
4085
+ organizationId: string;
4086
+ };
4087
+ query: {
4088
+ /**
4089
+ * Start date for the report, e.g. 2024-12-19.
4090
+ */
4091
+ from_date: string;
4092
+ /**
4093
+ * End date (inclusive) for the report, e.g. 2024-12-20. This date cannot be more than 30 days after from_date (for a maximum queried period of 31 days).
4094
+ */
4095
+ to_date: string;
4096
+ };
4097
+ url: "/v1/organizations/{organizationId}/usageCost";
4098
+ };
4099
+ export type GetOrganizationUsageCostsErrors = {
4100
+ /**
4101
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4102
+ */
4103
+ 400: {
4104
+ /**
4105
+ * HTTP status code.
4106
+ */
4107
+ status?: number;
4108
+ /**
4109
+ * Detailed error description.
4110
+ */
4111
+ error?: string;
4112
+ };
4113
+ };
4114
+ export type GetOrganizationUsageCostsError = GetOrganizationUsageCostsErrors[keyof GetOrganizationUsageCostsErrors];
4115
+ export type GetOrganizationUsageCostsResponses = {
4116
+ /**
4117
+ * Successful response
4118
+ */
4119
+ 200: {
4120
+ /**
4121
+ * HTTP status code.
4122
+ */
4123
+ status?: number;
4124
+ /**
4125
+ * Unique id assigned to every request. UUIDv4
4126
+ */
4127
+ requestId?: string;
4128
+ result?: UsageCost;
4129
+ };
4130
+ };
4131
+ export type GetOrganizationUsageCostsResponse = GetOrganizationUsageCostsResponses[keyof GetOrganizationUsageCostsResponses];
4132
+ export type ListClickPipesData = {
4133
+ body?: never;
4134
+ path: {
4135
+ /**
4136
+ * ID of the organization that owns the service.
4137
+ */
4138
+ organizationId: string;
4139
+ /**
4140
+ * ID of the service that owns the ClickPipe.
4141
+ */
4142
+ serviceId: string;
4143
+ };
4144
+ query?: never;
4145
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipes";
4146
+ };
4147
+ export type ListClickPipesErrors = {
4148
+ /**
4149
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4150
+ */
4151
+ 400: {
4152
+ /**
4153
+ * HTTP status code.
4154
+ */
4155
+ status?: number;
4156
+ /**
4157
+ * Detailed error description.
4158
+ */
4159
+ error?: string;
4160
+ };
4161
+ };
4162
+ export type ListClickPipesError = ListClickPipesErrors[keyof ListClickPipesErrors];
4163
+ export type ListClickPipesResponses = {
4164
+ /**
4165
+ * Successful response
4166
+ */
4167
+ 200: {
4168
+ /**
4169
+ * HTTP status code.
4170
+ */
4171
+ status?: number;
4172
+ /**
4173
+ * Unique id assigned to every request. UUIDv4
4174
+ */
4175
+ requestId?: string;
4176
+ result?: Array<ClickPipe>;
4177
+ };
4178
+ };
4179
+ export type ListClickPipesResponse = ListClickPipesResponses[keyof ListClickPipesResponses];
4180
+ export type CreateClickPipeData = {
4181
+ body?: ClickPipePostRequest;
4182
+ path: {
4183
+ /**
4184
+ * ID of the organization that owns the service.
4185
+ */
4186
+ organizationId: string;
4187
+ /**
4188
+ * ID of the service to create the ClickPipe for.
4189
+ */
4190
+ serviceId: string;
4191
+ };
4192
+ query?: never;
4193
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipes";
4194
+ };
4195
+ export type CreateClickPipeErrors = {
4196
+ /**
4197
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4198
+ */
4199
+ 400: {
4200
+ /**
4201
+ * HTTP status code.
4202
+ */
4203
+ status?: number;
4204
+ /**
4205
+ * Detailed error description.
4206
+ */
4207
+ error?: string;
4208
+ };
4209
+ };
4210
+ export type CreateClickPipeError = CreateClickPipeErrors[keyof CreateClickPipeErrors];
4211
+ export type CreateClickPipeResponses = {
4212
+ /**
4213
+ * Successful response
4214
+ */
4215
+ 200: {
4216
+ /**
4217
+ * HTTP status code.
4218
+ */
4219
+ status?: number;
4220
+ /**
4221
+ * Unique id assigned to every request. UUIDv4
4222
+ */
4223
+ requestId?: string;
4224
+ result?: ClickPipe;
4225
+ };
4226
+ };
4227
+ export type CreateClickPipeResponse = CreateClickPipeResponses[keyof CreateClickPipeResponses];
4228
+ export type DeleteClickPipeData = {
4229
+ body?: never;
4230
+ path: {
4231
+ /**
4232
+ * ID of the organization that owns the service.
4233
+ */
4234
+ organizationId: string;
4235
+ /**
4236
+ * ID of the service that owns the ClickPipe.
4237
+ */
4238
+ serviceId: string;
4239
+ /**
4240
+ * ID of the ClickPipe to delete.
4241
+ */
4242
+ clickPipeId: string;
4243
+ };
4244
+ query?: never;
4245
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}";
4246
+ };
4247
+ export type DeleteClickPipeErrors = {
4248
+ /**
4249
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4250
+ */
4251
+ 400: {
4252
+ /**
4253
+ * HTTP status code.
4254
+ */
4255
+ status?: number;
4256
+ /**
4257
+ * Detailed error description.
4258
+ */
4259
+ error?: string;
4260
+ };
4261
+ };
4262
+ export type DeleteClickPipeError = DeleteClickPipeErrors[keyof DeleteClickPipeErrors];
4263
+ export type DeleteClickPipeResponses = {
4264
+ /**
4265
+ * Successful response
4266
+ */
4267
+ 200: {
4268
+ /**
4269
+ * HTTP status code.
4270
+ */
4271
+ status?: number;
4272
+ /**
4273
+ * Unique id assigned to every request. UUIDv4
4274
+ */
4275
+ requestId?: string;
4276
+ };
4277
+ };
4278
+ export type DeleteClickPipeResponse = DeleteClickPipeResponses[keyof DeleteClickPipeResponses];
4279
+ export type GetClickPipeData = {
4280
+ body?: never;
4281
+ path: {
4282
+ /**
4283
+ * ID of the organization that owns the service.
4284
+ */
4285
+ organizationId: string;
4286
+ /**
4287
+ * ID of the service that owns the ClickPipe.
4288
+ */
4289
+ serviceId: string;
4290
+ /**
4291
+ * ID of the requested ClickPipe.
4292
+ */
4293
+ clickPipeId: string;
4294
+ };
4295
+ query?: never;
4296
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}";
4297
+ };
4298
+ export type GetClickPipeErrors = {
4299
+ /**
4300
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4301
+ */
4302
+ 400: {
4303
+ /**
4304
+ * HTTP status code.
4305
+ */
4306
+ status?: number;
4307
+ /**
4308
+ * Detailed error description.
4309
+ */
4310
+ error?: string;
4311
+ };
4312
+ };
4313
+ export type GetClickPipeError = GetClickPipeErrors[keyof GetClickPipeErrors];
4314
+ export type GetClickPipeResponses = {
4315
+ /**
4316
+ * Successful response
4317
+ */
4318
+ 200: {
4319
+ /**
4320
+ * HTTP status code.
4321
+ */
4322
+ status?: number;
4323
+ /**
4324
+ * Unique id assigned to every request. UUIDv4
4325
+ */
4326
+ requestId?: string;
4327
+ result?: ClickPipe;
4328
+ };
4329
+ };
4330
+ export type GetClickPipeResponse = GetClickPipeResponses[keyof GetClickPipeResponses];
4331
+ export type UpdateClickPipeData = {
4332
+ body?: ClickPipePatchRequest;
4333
+ path: {
4334
+ /**
4335
+ * ID of the organization that owns the service.
4336
+ */
4337
+ organizationId: string;
4338
+ /**
4339
+ * ID of the service to create the ClickPipe for.
4340
+ */
4341
+ serviceId: string;
4342
+ /**
4343
+ * ID of the requested ClickPipe.
4344
+ */
4345
+ clickPipeId: string;
4346
+ };
4347
+ query?: never;
4348
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}";
4349
+ };
4350
+ export type UpdateClickPipeErrors = {
4351
+ /**
4352
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4353
+ */
4354
+ 400: {
4355
+ /**
4356
+ * HTTP status code.
4357
+ */
4358
+ status?: number;
4359
+ /**
4360
+ * Detailed error description.
4361
+ */
4362
+ error?: string;
4363
+ };
4364
+ };
4365
+ export type UpdateClickPipeError = UpdateClickPipeErrors[keyof UpdateClickPipeErrors];
4366
+ export type UpdateClickPipeResponses = {
4367
+ /**
4368
+ * Successful response
4369
+ */
4370
+ 200: {
4371
+ /**
4372
+ * HTTP status code.
4373
+ */
4374
+ status?: number;
4375
+ /**
4376
+ * Unique id assigned to every request. UUIDv4
4377
+ */
4378
+ requestId?: string;
4379
+ result?: ClickPipe;
4380
+ };
4381
+ };
4382
+ export type UpdateClickPipeResponse = UpdateClickPipeResponses[keyof UpdateClickPipeResponses];
4383
+ export type GetClickPipeSettingsData = {
4384
+ body?: never;
4385
+ path: {
4386
+ /**
4387
+ * ID of the organization that owns the service.
4388
+ */
4389
+ organizationId: string;
4390
+ /**
4391
+ * ID of the service that owns the ClickPipe.
4392
+ */
4393
+ serviceId: string;
4394
+ /**
4395
+ * ID of the ClickPipe to get settings for.
4396
+ */
4397
+ clickPipeId: string;
4398
+ };
4399
+ query?: never;
4400
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings";
4401
+ };
4402
+ export type GetClickPipeSettingsErrors = {
4403
+ /**
4404
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4405
+ */
4406
+ 400: {
4407
+ /**
4408
+ * HTTP status code.
4409
+ */
4410
+ status?: number;
4411
+ /**
4412
+ * Detailed error description.
4413
+ */
4414
+ error?: string;
4415
+ };
4416
+ };
4417
+ export type GetClickPipeSettingsError = GetClickPipeSettingsErrors[keyof GetClickPipeSettingsErrors];
4418
+ export type GetClickPipeSettingsResponses = {
4419
+ /**
4420
+ * Successful response
4421
+ */
4422
+ 200: {
4423
+ /**
4424
+ * HTTP status code.
4425
+ */
4426
+ status?: number;
4427
+ /**
4428
+ * Unique id assigned to every request. UUIDv4
4429
+ */
4430
+ requestId?: string;
4431
+ result?: ClickPipeSettingsGetResponse;
4432
+ };
4433
+ };
4434
+ export type GetClickPipeSettingsResponse = GetClickPipeSettingsResponses[keyof GetClickPipeSettingsResponses];
4435
+ export type UpdateClickPipeSettingsData = {
4436
+ body?: ClickPipeSettingsPutRequest;
4437
+ path: {
4438
+ /**
4439
+ * ID of the organization that owns the service.
4440
+ */
4441
+ organizationId: string;
4442
+ /**
4443
+ * ID of the service that owns the ClickPipe.
4444
+ */
4445
+ serviceId: string;
4446
+ /**
4447
+ * ID of the ClickPipe to update settings for.
4448
+ */
4449
+ clickPipeId: string;
4450
+ };
4451
+ query?: never;
4452
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings";
4453
+ };
4454
+ export type UpdateClickPipeSettingsErrors = {
4455
+ /**
4456
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4457
+ */
4458
+ 400: {
4459
+ /**
4460
+ * HTTP status code.
4461
+ */
4462
+ status?: number;
4463
+ /**
4464
+ * Detailed error description.
4465
+ */
4466
+ error?: string;
4467
+ };
4468
+ };
4469
+ export type UpdateClickPipeSettingsError = UpdateClickPipeSettingsErrors[keyof UpdateClickPipeSettingsErrors];
4470
+ export type UpdateClickPipeSettingsResponses = {
4471
+ /**
4472
+ * Successful response
4473
+ */
4474
+ 200: {
4475
+ /**
4476
+ * HTTP status code.
4477
+ */
4478
+ status?: number;
4479
+ /**
4480
+ * Unique id assigned to every request. UUIDv4
4481
+ */
4482
+ requestId?: string;
4483
+ result?: ClickPipeSettingsGetResponse;
4484
+ };
4485
+ };
4486
+ export type UpdateClickPipeSettingsResponse = UpdateClickPipeSettingsResponses[keyof UpdateClickPipeSettingsResponses];
4487
+ export type ScalingClickPipeData = {
4488
+ body?: ClickPipeScalingPatchRequest;
4489
+ path: {
4490
+ /**
4491
+ * ID of the organization that owns the service.
4492
+ */
4493
+ organizationId: string;
4494
+ /**
4495
+ * ID of the service that owns the ClickPipe.
4496
+ */
4497
+ serviceId: string;
4498
+ /**
4499
+ * ID of the ClickPipe to update scaling settings.
4500
+ */
4501
+ clickPipeId: string;
4502
+ };
4503
+ query?: never;
4504
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/scaling";
4505
+ };
4506
+ export type ScalingClickPipeErrors = {
4507
+ /**
4508
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4509
+ */
4510
+ 400: {
4511
+ /**
4512
+ * HTTP status code.
4513
+ */
4514
+ status?: number;
4515
+ /**
4516
+ * Detailed error description.
4517
+ */
4518
+ error?: string;
4519
+ };
4520
+ };
4521
+ export type ScalingClickPipeError = ScalingClickPipeErrors[keyof ScalingClickPipeErrors];
4522
+ export type ScalingClickPipeResponses = {
4523
+ /**
4524
+ * Successful response
4525
+ */
4526
+ 200: {
4527
+ /**
4528
+ * HTTP status code.
4529
+ */
4530
+ status?: number;
4531
+ /**
4532
+ * Unique id assigned to every request. UUIDv4
4533
+ */
4534
+ requestId?: string;
4535
+ result?: ClickPipe;
4536
+ };
4537
+ };
4538
+ export type ScalingClickPipeResponse = ScalingClickPipeResponses[keyof ScalingClickPipeResponses];
4539
+ export type UpdateClickPipeStateData = {
4540
+ body?: ClickPipeStatePatchRequest;
4541
+ path: {
4542
+ /**
4543
+ * ID of the organization that owns the service.
4544
+ */
4545
+ organizationId: string;
4546
+ /**
4547
+ * ID of the service that owns the ClickPipe.
4548
+ */
4549
+ serviceId: string;
4550
+ /**
4551
+ * ID of the ClickPipe to update state.
4552
+ */
4553
+ clickPipeId: string;
4554
+ };
4555
+ query?: never;
4556
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/state";
4557
+ };
4558
+ export type UpdateClickPipeStateErrors = {
4559
+ /**
4560
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4561
+ */
4562
+ 400: {
4563
+ /**
4564
+ * HTTP status code.
4565
+ */
4566
+ status?: number;
4567
+ /**
4568
+ * Detailed error description.
4569
+ */
4570
+ error?: string;
4571
+ };
4572
+ };
4573
+ export type UpdateClickPipeStateError = UpdateClickPipeStateErrors[keyof UpdateClickPipeStateErrors];
4574
+ export type UpdateClickPipeStateResponses = {
4575
+ /**
4576
+ * Successful response
4577
+ */
4578
+ 200: {
4579
+ /**
4580
+ * HTTP status code.
4581
+ */
4582
+ status?: number;
4583
+ /**
4584
+ * Unique id assigned to every request. UUIDv4
4585
+ */
4586
+ requestId?: string;
4587
+ result?: ClickPipe;
4588
+ };
4589
+ };
4590
+ export type UpdateClickPipeStateResponse = UpdateClickPipeStateResponses[keyof UpdateClickPipeStateResponses];
4591
+ export type GetCdcClickPipesScalingData = {
4592
+ body?: never;
4593
+ path: {
4594
+ /**
4595
+ * ID of the organization that owns the service.
4596
+ */
4597
+ organizationId: string;
4598
+ /**
4599
+ * ID of the service that owns the ClickPipe.
4600
+ */
4601
+ serviceId: string;
4602
+ };
4603
+ query?: never;
4604
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling";
4605
+ };
4606
+ export type GetCdcClickPipesScalingErrors = {
4607
+ /**
4608
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4609
+ */
4610
+ 400: {
4611
+ /**
4612
+ * HTTP status code.
4613
+ */
4614
+ status?: number;
4615
+ /**
4616
+ * Detailed error description.
4617
+ */
4618
+ error?: string;
4619
+ };
4620
+ };
4621
+ export type GetCdcClickPipesScalingError = GetCdcClickPipesScalingErrors[keyof GetCdcClickPipesScalingErrors];
4622
+ export type GetCdcClickPipesScalingResponses = {
4623
+ /**
4624
+ * Successful response
4625
+ */
4626
+ 200: {
4627
+ /**
4628
+ * HTTP status code.
4629
+ */
4630
+ status?: number;
4631
+ /**
4632
+ * Unique id assigned to every request. UUIDv4
4633
+ */
4634
+ requestId?: string;
4635
+ result?: ClickPipesCdcScaling;
4636
+ };
4637
+ };
4638
+ export type GetCdcClickPipesScalingResponse = GetCdcClickPipesScalingResponses[keyof GetCdcClickPipesScalingResponses];
4639
+ export type UpdateCdcClickPipesScalingData = {
4640
+ body?: ClickPipesCdcScalingPatchRequest;
4641
+ path: {
4642
+ /**
4643
+ * ID of the organization that owns the service.
4644
+ */
4645
+ organizationId: string;
4646
+ /**
4647
+ * ID of the service that owns the ClickPipe.
4648
+ */
4649
+ serviceId: string;
4650
+ };
4651
+ query?: never;
4652
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling";
4653
+ };
4654
+ export type UpdateCdcClickPipesScalingErrors = {
4655
+ /**
4656
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4657
+ */
4658
+ 400: {
4659
+ /**
4660
+ * HTTP status code.
4661
+ */
4662
+ status?: number;
4663
+ /**
4664
+ * Detailed error description.
4665
+ */
4666
+ error?: string;
4667
+ };
4668
+ };
4669
+ export type UpdateCdcClickPipesScalingError = UpdateCdcClickPipesScalingErrors[keyof UpdateCdcClickPipesScalingErrors];
4670
+ export type UpdateCdcClickPipesScalingResponses = {
4671
+ /**
4672
+ * Successful response
4673
+ */
4674
+ 200: {
4675
+ /**
4676
+ * HTTP status code.
4677
+ */
4678
+ status?: number;
4679
+ /**
4680
+ * Unique id assigned to every request. UUIDv4
4681
+ */
4682
+ requestId?: string;
4683
+ result?: ClickPipesCdcScaling;
4684
+ };
4685
+ };
4686
+ export type UpdateCdcClickPipesScalingResponse = UpdateCdcClickPipesScalingResponses[keyof UpdateCdcClickPipesScalingResponses];
4687
+ export type GetPrivateEndpointConfigurationForRegionWithinCloudProviderForOrganizationData = {
4688
+ body?: never;
4689
+ path: {
4690
+ /**
4691
+ * ID of the requested organization.
4692
+ */
4693
+ organizationId: string;
4694
+ };
4695
+ query: {
4696
+ /**
4697
+ * Cloud provider identifier. One of aws, gcp, or azure.
4698
+ */
4699
+ cloud_provider: string;
4700
+ /**
4701
+ * Region identifier within specific cloud providers.
4702
+ */
4703
+ region_id: string;
4704
+ };
4705
+ url: "/v1/organizations/{organizationId}/privateEndpointConfig";
4706
+ };
4707
+ export type GetPrivateEndpointConfigurationForRegionWithinCloudProviderForOrganizationErrors = {
4708
+ /**
4709
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4710
+ */
4711
+ 400: {
4712
+ /**
4713
+ * HTTP status code.
4714
+ */
4715
+ status?: number;
4716
+ /**
4717
+ * Detailed error description.
4718
+ */
4719
+ error?: string;
4720
+ };
4721
+ };
4722
+ export type GetPrivateEndpointConfigurationForRegionWithinCloudProviderForOrganizationError = GetPrivateEndpointConfigurationForRegionWithinCloudProviderForOrganizationErrors[keyof GetPrivateEndpointConfigurationForRegionWithinCloudProviderForOrganizationErrors];
4723
+ export type GetPrivateEndpointConfigurationForRegionWithinCloudProviderForOrganizationResponses = {
4724
+ /**
4725
+ * Successful response
4726
+ */
4727
+ 200: {
4728
+ /**
4729
+ * HTTP status code.
4730
+ */
4731
+ status?: number;
4732
+ /**
4733
+ * Unique id assigned to every request. UUIDv4
4734
+ */
4735
+ requestId?: string;
4736
+ result?: OrganizationCloudRegionPrivateEndpointConfig;
4737
+ };
4738
+ };
4739
+ export type GetPrivateEndpointConfigurationForRegionWithinCloudProviderForOrganizationResponse = GetPrivateEndpointConfigurationForRegionWithinCloudProviderForOrganizationResponses[keyof GetPrivateEndpointConfigurationForRegionWithinCloudProviderForOrganizationResponses];
4740
+ export type CreateByocInfrastructureData = {
4741
+ body?: ByocInfrastructurePostRequest;
4742
+ path: {
4743
+ /**
4744
+ * ID of the requested organization.
4745
+ */
4746
+ organizationId: string;
4747
+ };
4748
+ query?: never;
4749
+ url: "/v1/organizations/{organizationId}/byocInfrastructure";
4750
+ };
4751
+ export type CreateByocInfrastructureErrors = {
4752
+ /**
4753
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4754
+ */
4755
+ 400: {
4756
+ /**
4757
+ * HTTP status code.
4758
+ */
4759
+ status?: number;
4760
+ /**
4761
+ * Detailed error description.
4762
+ */
4763
+ error?: string;
4764
+ };
4765
+ };
4766
+ export type CreateByocInfrastructureError = CreateByocInfrastructureErrors[keyof CreateByocInfrastructureErrors];
4767
+ export type CreateByocInfrastructureResponses = {
4768
+ /**
4769
+ * Successful response
4770
+ */
4771
+ 200: {
4772
+ /**
4773
+ * HTTP status code.
4774
+ */
4775
+ status?: number;
4776
+ /**
4777
+ * Unique id assigned to every request. UUIDv4
4778
+ */
4779
+ requestId?: string;
4780
+ result?: ByocConfig;
4781
+ };
4782
+ };
4783
+ export type CreateByocInfrastructureResponse = CreateByocInfrastructureResponses[keyof CreateByocInfrastructureResponses];
4784
+ export type RemoveByocInfrastructureData = {
4785
+ body?: never;
4786
+ path: {
4787
+ /**
4788
+ * ID of the requested organization.
4789
+ */
4790
+ organizationId: string;
4791
+ /**
4792
+ * ID of the requested BYOC Infrastructure
4793
+ */
4794
+ byocInfrastructureId: string;
4795
+ };
4796
+ query?: never;
4797
+ url: "/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}";
4798
+ };
4799
+ export type RemoveByocInfrastructureErrors = {
4800
+ /**
4801
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4802
+ */
4803
+ 400: {
4804
+ /**
4805
+ * HTTP status code.
4806
+ */
4807
+ status?: number;
4808
+ /**
4809
+ * Detailed error description.
4810
+ */
4811
+ error?: string;
4812
+ };
4813
+ };
4814
+ export type RemoveByocInfrastructureError = RemoveByocInfrastructureErrors[keyof RemoveByocInfrastructureErrors];
4815
+ export type RemoveByocInfrastructureResponses = {
4816
+ /**
4817
+ * Successful response
4818
+ */
4819
+ 200: {
4820
+ /**
4821
+ * HTTP status code.
4822
+ */
4823
+ status?: number;
4824
+ /**
4825
+ * Unique id assigned to every request. UUIDv4
4826
+ */
4827
+ requestId?: string;
4828
+ };
4829
+ };
4830
+ export type RemoveByocInfrastructureResponse = RemoveByocInfrastructureResponses[keyof RemoveByocInfrastructureResponses];
4831
+ export type ListReversePrivateEndpointsData = {
4832
+ body?: never;
4833
+ path: {
4834
+ /**
4835
+ * ID of the organization that owns the service.
4836
+ */
4837
+ organizationId: string;
4838
+ /**
4839
+ * ID of the service that owns the Reverse Private Endpoint.
4840
+ */
4841
+ serviceId: string;
4842
+ };
4843
+ query?: never;
4844
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints";
4845
+ };
4846
+ export type ListReversePrivateEndpointsErrors = {
4847
+ /**
4848
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4849
+ */
4850
+ 400: {
4851
+ /**
4852
+ * HTTP status code.
4853
+ */
4854
+ status?: number;
4855
+ /**
4856
+ * Detailed error description.
4857
+ */
4858
+ error?: string;
4859
+ };
4860
+ };
4861
+ export type ListReversePrivateEndpointsError = ListReversePrivateEndpointsErrors[keyof ListReversePrivateEndpointsErrors];
4862
+ export type ListReversePrivateEndpointsResponses = {
4863
+ /**
4864
+ * Successful response
4865
+ */
4866
+ 200: {
4867
+ /**
4868
+ * HTTP status code.
4869
+ */
4870
+ status?: number;
4871
+ /**
4872
+ * Unique id assigned to every request. UUIDv4
4873
+ */
4874
+ requestId?: string;
4875
+ result?: Array<ReversePrivateEndpoint>;
4876
+ };
4877
+ };
4878
+ export type ListReversePrivateEndpointsResponse = ListReversePrivateEndpointsResponses[keyof ListReversePrivateEndpointsResponses];
4879
+ export type CreateReversePrivateEndpointData = {
4880
+ body?: CreateReversePrivateEndpoint;
4881
+ path: {
4882
+ /**
4883
+ * ID of the organization that owns the service.
4884
+ */
4885
+ organizationId: string;
4886
+ /**
4887
+ * ID of the service that owns the Reverse Private Endpoint.
4888
+ */
4889
+ serviceId: string;
4890
+ };
4891
+ query?: never;
4892
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints";
4893
+ };
4894
+ export type CreateReversePrivateEndpointErrors = {
4895
+ /**
4896
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4897
+ */
4898
+ 400: {
4899
+ /**
4900
+ * HTTP status code.
4901
+ */
4902
+ status?: number;
4903
+ /**
4904
+ * Detailed error description.
4905
+ */
4906
+ error?: string;
4907
+ };
4908
+ };
4909
+ export type CreateReversePrivateEndpointError = CreateReversePrivateEndpointErrors[keyof CreateReversePrivateEndpointErrors];
4910
+ export type CreateReversePrivateEndpointResponses = {
4911
+ /**
4912
+ * Successful response
4913
+ */
4914
+ 200: {
4915
+ /**
4916
+ * HTTP status code.
4917
+ */
4918
+ status?: number;
4919
+ /**
4920
+ * Unique id assigned to every request. UUIDv4
4921
+ */
4922
+ requestId?: string;
4923
+ result?: ReversePrivateEndpoint;
4924
+ };
4925
+ };
4926
+ export type CreateReversePrivateEndpointResponse = CreateReversePrivateEndpointResponses[keyof CreateReversePrivateEndpointResponses];
4927
+ export type DeleteReversePrivateEndpointData = {
4928
+ body?: never;
4929
+ path: {
4930
+ /**
4931
+ * ID of the organization that owns the service.
4932
+ */
4933
+ organizationId: string;
4934
+ /**
4935
+ * ID of the service that owns the Reverse Private Endpoint.
4936
+ */
4937
+ serviceId: string;
4938
+ /**
4939
+ * ID of the reverse private endpoint to delete.
4940
+ */
4941
+ reversePrivateEndpointId: string;
4942
+ };
4943
+ query?: never;
4944
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}";
4945
+ };
4946
+ export type DeleteReversePrivateEndpointErrors = {
4947
+ /**
4948
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
4949
+ */
4950
+ 400: {
4951
+ /**
4952
+ * HTTP status code.
4953
+ */
4954
+ status?: number;
4955
+ /**
4956
+ * Detailed error description.
4957
+ */
4958
+ error?: string;
4959
+ };
4960
+ };
4961
+ export type DeleteReversePrivateEndpointError = DeleteReversePrivateEndpointErrors[keyof DeleteReversePrivateEndpointErrors];
4962
+ export type DeleteReversePrivateEndpointResponses = {
4963
+ /**
4964
+ * Successful response
4965
+ */
4966
+ 200: {
4967
+ /**
4968
+ * HTTP status code.
4969
+ */
4970
+ status?: number;
4971
+ /**
4972
+ * Unique id assigned to every request. UUIDv4
4973
+ */
4974
+ requestId?: string;
4975
+ };
4976
+ };
4977
+ export type DeleteReversePrivateEndpointResponse = DeleteReversePrivateEndpointResponses[keyof DeleteReversePrivateEndpointResponses];
4978
+ export type GetReversePrivateEndpointData = {
4979
+ body?: never;
4980
+ path: {
4981
+ /**
4982
+ * ID of the organization that owns the service.
4983
+ */
4984
+ organizationId: string;
4985
+ /**
4986
+ * ID of the service that owns the Reverse Private Endpoint.
4987
+ */
4988
+ serviceId: string;
4989
+ /**
4990
+ * ID of the reverse private endpoint to get.
4991
+ */
4992
+ reversePrivateEndpointId: string;
4993
+ };
4994
+ query?: never;
4995
+ url: "/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}";
4996
+ };
4997
+ export type GetReversePrivateEndpointErrors = {
4998
+ /**
4999
+ * The server cannot or will not process the request due to something that is perceived to be a client error.
5000
+ */
5001
+ 400: {
5002
+ /**
5003
+ * HTTP status code.
5004
+ */
5005
+ status?: number;
5006
+ /**
5007
+ * Detailed error description.
5008
+ */
5009
+ error?: string;
5010
+ };
5011
+ };
5012
+ export type GetReversePrivateEndpointError = GetReversePrivateEndpointErrors[keyof GetReversePrivateEndpointErrors];
5013
+ export type GetReversePrivateEndpointResponses = {
5014
+ /**
5015
+ * Successful response
5016
+ */
5017
+ 200: {
5018
+ /**
5019
+ * HTTP status code.
5020
+ */
5021
+ status?: number;
5022
+ /**
5023
+ * Unique id assigned to every request. UUIDv4
5024
+ */
5025
+ requestId?: string;
5026
+ result?: ReversePrivateEndpoint;
5027
+ };
5028
+ };
5029
+ export type GetReversePrivateEndpointResponse = GetReversePrivateEndpointResponses[keyof GetReversePrivateEndpointResponses];
5030
+ //# sourceMappingURL=types.gen.d.ts.map