alchemy 0.67.0 → 0.68.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 (750) hide show
  1. package/bin/alchemy.js +25563 -26265
  2. package/bin/alchemy.ts +6 -2
  3. package/bin/commands/configure.ts +194 -0
  4. package/bin/commands/login.ts +99 -55
  5. package/bin/commands/logout.ts +66 -0
  6. package/bin/trpc.ts +27 -2
  7. package/lib/apply.d.ts +2 -2
  8. package/lib/apply.d.ts.map +1 -1
  9. package/lib/apply.js +18 -15
  10. package/lib/apply.js.map +1 -1
  11. package/lib/auth.d.ts +72 -0
  12. package/lib/auth.d.ts.map +1 -0
  13. package/lib/auth.js +163 -0
  14. package/lib/auth.js.map +1 -0
  15. package/lib/aws/bucket.d.ts +12 -3
  16. package/lib/aws/bucket.d.ts.map +1 -1
  17. package/lib/aws/bucket.js +2 -2
  18. package/lib/aws/bucket.js.map +1 -1
  19. package/lib/aws/control/resource.d.ts +34 -3
  20. package/lib/aws/control/resource.d.ts.map +1 -1
  21. package/lib/aws/control/resource.js +3 -3
  22. package/lib/aws/control/resource.js.map +1 -1
  23. package/lib/aws/ec2/internet-gateway-attachment.d.ts +1 -2
  24. package/lib/aws/ec2/internet-gateway-attachment.d.ts.map +1 -1
  25. package/lib/aws/ec2/internet-gateway-attachment.js +4 -4
  26. package/lib/aws/ec2/internet-gateway-attachment.js.map +1 -1
  27. package/lib/aws/ec2/internet-gateway.d.ts +1 -2
  28. package/lib/aws/ec2/internet-gateway.d.ts.map +1 -1
  29. package/lib/aws/ec2/internet-gateway.js +2 -2
  30. package/lib/aws/ec2/internet-gateway.js.map +1 -1
  31. package/lib/aws/ec2/nat-gateway.d.ts +1 -2
  32. package/lib/aws/ec2/nat-gateway.d.ts.map +1 -1
  33. package/lib/aws/ec2/nat-gateway.js +2 -2
  34. package/lib/aws/ec2/nat-gateway.js.map +1 -1
  35. package/lib/aws/ec2/route-table-association.d.ts +1 -2
  36. package/lib/aws/ec2/route-table-association.d.ts.map +1 -1
  37. package/lib/aws/ec2/route-table-association.js +2 -2
  38. package/lib/aws/ec2/route-table-association.js.map +1 -1
  39. package/lib/aws/ec2/route-table.d.ts +1 -2
  40. package/lib/aws/ec2/route-table.d.ts.map +1 -1
  41. package/lib/aws/ec2/route-table.js +2 -2
  42. package/lib/aws/ec2/route-table.js.map +1 -1
  43. package/lib/aws/ec2/route.d.ts +1 -2
  44. package/lib/aws/ec2/route.d.ts.map +1 -1
  45. package/lib/aws/ec2/route.js +2 -2
  46. package/lib/aws/ec2/route.js.map +1 -1
  47. package/lib/aws/ec2/security-group-rule.d.ts +1 -2
  48. package/lib/aws/ec2/security-group-rule.d.ts.map +1 -1
  49. package/lib/aws/ec2/security-group-rule.js +2 -2
  50. package/lib/aws/ec2/security-group-rule.js.map +1 -1
  51. package/lib/aws/ec2/security-group.d.ts +1 -2
  52. package/lib/aws/ec2/security-group.d.ts.map +1 -1
  53. package/lib/aws/ec2/security-group.js +2 -2
  54. package/lib/aws/ec2/security-group.js.map +1 -1
  55. package/lib/aws/ec2/subnet.d.ts +1 -2
  56. package/lib/aws/ec2/subnet.d.ts.map +1 -1
  57. package/lib/aws/ec2/subnet.js +2 -2
  58. package/lib/aws/ec2/subnet.js.map +1 -1
  59. package/lib/aws/ec2/vpc.d.ts +1 -2
  60. package/lib/aws/ec2/vpc.d.ts.map +1 -1
  61. package/lib/aws/ec2/vpc.js +2 -2
  62. package/lib/aws/ec2/vpc.js.map +1 -1
  63. package/lib/aws/function.d.ts +116 -3
  64. package/lib/aws/function.d.ts.map +1 -1
  65. package/lib/aws/function.js +2 -2
  66. package/lib/aws/function.js.map +1 -1
  67. package/lib/aws/oidc/github-oidc-provider.d.ts +13 -2
  68. package/lib/aws/oidc/github-oidc-provider.d.ts.map +1 -1
  69. package/lib/aws/oidc/oidc-provider.d.ts +48 -3
  70. package/lib/aws/oidc/oidc-provider.d.ts.map +1 -1
  71. package/lib/aws/oidc/oidc-provider.js +2 -2
  72. package/lib/aws/oidc/oidc-provider.js.map +1 -1
  73. package/lib/aws/policy-attachment.d.ts +2 -3
  74. package/lib/aws/policy-attachment.d.ts.map +1 -1
  75. package/lib/aws/policy-attachment.js +1 -1
  76. package/lib/aws/policy-attachment.js.map +1 -1
  77. package/lib/aws/policy.d.ts +1 -2
  78. package/lib/aws/policy.d.ts.map +1 -1
  79. package/lib/aws/policy.js +4 -4
  80. package/lib/aws/policy.js.map +1 -1
  81. package/lib/aws/queue.d.ts +1 -2
  82. package/lib/aws/queue.d.ts.map +1 -1
  83. package/lib/aws/queue.js +4 -4
  84. package/lib/aws/queue.js.map +1 -1
  85. package/lib/aws/role.d.ts +1 -2
  86. package/lib/aws/role.d.ts.map +1 -1
  87. package/lib/aws/role.js +2 -2
  88. package/lib/aws/role.js.map +1 -1
  89. package/lib/aws/ses.d.ts +1 -2
  90. package/lib/aws/ses.d.ts.map +1 -1
  91. package/lib/aws/ses.js +2 -2
  92. package/lib/aws/ses.js.map +1 -1
  93. package/lib/aws/ssm-parameter.d.ts +1 -2
  94. package/lib/aws/ssm-parameter.d.ts.map +1 -1
  95. package/lib/aws/ssm-parameter.js +2 -2
  96. package/lib/aws/ssm-parameter.js.map +1 -1
  97. package/lib/aws/table.d.ts +1 -2
  98. package/lib/aws/table.d.ts.map +1 -1
  99. package/lib/aws/table.js +2 -2
  100. package/lib/aws/table.js.map +1 -1
  101. package/lib/cloudflare/account-api-token.d.ts +1 -2
  102. package/lib/cloudflare/account-api-token.d.ts.map +1 -1
  103. package/lib/cloudflare/account-api-token.js +2 -2
  104. package/lib/cloudflare/account-api-token.js.map +1 -1
  105. package/lib/cloudflare/ai-gateway.d.ts +1 -2
  106. package/lib/cloudflare/ai-gateway.d.ts.map +1 -1
  107. package/lib/cloudflare/ai-gateway.js +2 -2
  108. package/lib/cloudflare/ai-gateway.js.map +1 -1
  109. package/lib/cloudflare/api-gateway-operation.d.ts +1 -2
  110. package/lib/cloudflare/api-gateway-operation.d.ts.map +1 -1
  111. package/lib/cloudflare/api-gateway-operation.js +2 -2
  112. package/lib/cloudflare/api-gateway-operation.js.map +1 -1
  113. package/lib/cloudflare/api-schema.d.ts +1 -2
  114. package/lib/cloudflare/api-schema.d.ts.map +1 -1
  115. package/lib/cloudflare/api-schema.js +2 -2
  116. package/lib/cloudflare/api-schema.js.map +1 -1
  117. package/lib/cloudflare/api-shield.d.ts +1 -2
  118. package/lib/cloudflare/api-shield.d.ts.map +1 -1
  119. package/lib/cloudflare/api-shield.js +2 -2
  120. package/lib/cloudflare/api-shield.js.map +1 -1
  121. package/lib/cloudflare/api.d.ts +18 -10
  122. package/lib/cloudflare/api.d.ts.map +1 -1
  123. package/lib/cloudflare/api.js +93 -38
  124. package/lib/cloudflare/api.js.map +1 -1
  125. package/lib/cloudflare/assets.d.ts +21 -43
  126. package/lib/cloudflare/assets.d.ts.map +1 -1
  127. package/lib/cloudflare/assets.js +78 -70
  128. package/lib/cloudflare/assets.js.map +1 -1
  129. package/lib/cloudflare/auth.d.ts +91 -17
  130. package/lib/cloudflare/auth.d.ts.map +1 -1
  131. package/lib/cloudflare/auth.js +141 -62
  132. package/lib/cloudflare/auth.js.map +1 -1
  133. package/lib/cloudflare/bound.d.ts +1 -1
  134. package/lib/cloudflare/bound.d.ts.map +1 -1
  135. package/lib/cloudflare/bucket.d.ts +60 -8
  136. package/lib/cloudflare/bucket.d.ts.map +1 -1
  137. package/lib/cloudflare/bucket.js +161 -18
  138. package/lib/cloudflare/bucket.js.map +1 -1
  139. package/lib/cloudflare/bundle/plugin-wasm.js +4 -2
  140. package/lib/cloudflare/bundle/plugin-wasm.js.map +1 -1
  141. package/lib/cloudflare/certificate-pack.d.ts +1 -2
  142. package/lib/cloudflare/certificate-pack.d.ts.map +1 -1
  143. package/lib/cloudflare/certificate-pack.js +4 -4
  144. package/lib/cloudflare/certificate-pack.js.map +1 -1
  145. package/lib/cloudflare/compatibility-date.gen.d.ts +1 -1
  146. package/lib/cloudflare/compatibility-date.gen.js +1 -1
  147. package/lib/cloudflare/container.d.ts +1 -2
  148. package/lib/cloudflare/container.d.ts.map +1 -1
  149. package/lib/cloudflare/container.js +6 -6
  150. package/lib/cloudflare/container.js.map +1 -1
  151. package/lib/cloudflare/custom-domain.d.ts +1 -2
  152. package/lib/cloudflare/custom-domain.d.ts.map +1 -1
  153. package/lib/cloudflare/custom-domain.js +2 -2
  154. package/lib/cloudflare/custom-domain.js.map +1 -1
  155. package/lib/cloudflare/d1-database.d.ts +2 -3
  156. package/lib/cloudflare/d1-database.d.ts.map +1 -1
  157. package/lib/cloudflare/d1-database.js +5 -5
  158. package/lib/cloudflare/d1-database.js.map +1 -1
  159. package/lib/cloudflare/dispatch-namespace.d.ts +2 -3
  160. package/lib/cloudflare/dispatch-namespace.d.ts.map +1 -1
  161. package/lib/cloudflare/dispatch-namespace.js +3 -3
  162. package/lib/cloudflare/dispatch-namespace.js.map +1 -1
  163. package/lib/cloudflare/dns-records.d.ts +1 -2
  164. package/lib/cloudflare/dns-records.d.ts.map +1 -1
  165. package/lib/cloudflare/dns-records.js +4 -4
  166. package/lib/cloudflare/dns-records.js.map +1 -1
  167. package/lib/cloudflare/email-address.d.ts +1 -2
  168. package/lib/cloudflare/email-address.d.ts.map +1 -1
  169. package/lib/cloudflare/email-address.js +6 -6
  170. package/lib/cloudflare/email-address.js.map +1 -1
  171. package/lib/cloudflare/email-catch-all.d.ts +1 -2
  172. package/lib/cloudflare/email-catch-all.d.ts.map +1 -1
  173. package/lib/cloudflare/email-catch-all.js +4 -4
  174. package/lib/cloudflare/email-catch-all.js.map +1 -1
  175. package/lib/cloudflare/email-routing.d.ts +1 -2
  176. package/lib/cloudflare/email-routing.d.ts.map +1 -1
  177. package/lib/cloudflare/email-routing.js +4 -4
  178. package/lib/cloudflare/email-routing.js.map +1 -1
  179. package/lib/cloudflare/email-rule.d.ts +1 -2
  180. package/lib/cloudflare/email-rule.d.ts.map +1 -1
  181. package/lib/cloudflare/email-rule.js +4 -4
  182. package/lib/cloudflare/email-rule.js.map +1 -1
  183. package/lib/cloudflare/hyperdrive.d.ts +1 -2
  184. package/lib/cloudflare/hyperdrive.d.ts.map +1 -1
  185. package/lib/cloudflare/hyperdrive.js +4 -4
  186. package/lib/cloudflare/hyperdrive.js.map +1 -1
  187. package/lib/cloudflare/kv-namespace.d.ts +2 -3
  188. package/lib/cloudflare/kv-namespace.d.ts.map +1 -1
  189. package/lib/cloudflare/kv-namespace.js +5 -5
  190. package/lib/cloudflare/kv-namespace.js.map +1 -1
  191. package/lib/cloudflare/miniflare/delete.js +1 -1
  192. package/lib/cloudflare/miniflare/delete.js.map +1 -1
  193. package/lib/cloudflare/miniflare/miniflare-worker-proxy.d.ts.map +1 -1
  194. package/lib/cloudflare/miniflare/miniflare-worker-proxy.js +2 -7
  195. package/lib/cloudflare/miniflare/miniflare-worker-proxy.js.map +1 -1
  196. package/lib/cloudflare/miniflare/remote-binding-proxy.d.ts.map +1 -1
  197. package/lib/cloudflare/miniflare/remote-binding-proxy.js +15 -4
  198. package/lib/cloudflare/miniflare/remote-binding-proxy.js.map +1 -1
  199. package/lib/cloudflare/permission-groups.d.ts +1 -2
  200. package/lib/cloudflare/permission-groups.d.ts.map +1 -1
  201. package/lib/cloudflare/permission-groups.js +1 -1
  202. package/lib/cloudflare/permission-groups.js.map +1 -1
  203. package/lib/cloudflare/pipeline.d.ts +2 -3
  204. package/lib/cloudflare/pipeline.d.ts.map +1 -1
  205. package/lib/cloudflare/pipeline.js +5 -5
  206. package/lib/cloudflare/pipeline.js.map +1 -1
  207. package/lib/cloudflare/queue-consumer.d.ts +1 -2
  208. package/lib/cloudflare/queue-consumer.d.ts.map +1 -1
  209. package/lib/cloudflare/queue-consumer.js +4 -4
  210. package/lib/cloudflare/queue-consumer.js.map +1 -1
  211. package/lib/cloudflare/queue.d.ts +1 -2
  212. package/lib/cloudflare/queue.d.ts.map +1 -1
  213. package/lib/cloudflare/queue.js +4 -4
  214. package/lib/cloudflare/queue.js.map +1 -1
  215. package/lib/cloudflare/react-router/plugin.d.ts.map +1 -1
  216. package/lib/cloudflare/react-router/plugin.js +13 -0
  217. package/lib/cloudflare/react-router/plugin.js.map +1 -1
  218. package/lib/cloudflare/redirect-rule.d.ts +1 -2
  219. package/lib/cloudflare/redirect-rule.d.ts.map +1 -1
  220. package/lib/cloudflare/redirect-rule.js +4 -4
  221. package/lib/cloudflare/redirect-rule.js.map +1 -1
  222. package/lib/cloudflare/route.d.ts +1 -2
  223. package/lib/cloudflare/route.d.ts.map +1 -1
  224. package/lib/cloudflare/route.js +4 -4
  225. package/lib/cloudflare/route.js.map +1 -1
  226. package/lib/cloudflare/ruleset.d.ts +1 -2
  227. package/lib/cloudflare/ruleset.d.ts.map +1 -1
  228. package/lib/cloudflare/ruleset.js +2 -2
  229. package/lib/cloudflare/ruleset.js.map +1 -1
  230. package/lib/cloudflare/secret.d.ts +2 -3
  231. package/lib/cloudflare/secret.d.ts.map +1 -1
  232. package/lib/cloudflare/secret.js +3 -3
  233. package/lib/cloudflare/secret.js.map +1 -1
  234. package/lib/cloudflare/secrets-store.d.ts +2 -3
  235. package/lib/cloudflare/secrets-store.d.ts.map +1 -1
  236. package/lib/cloudflare/secrets-store.js +3 -3
  237. package/lib/cloudflare/secrets-store.js.map +1 -1
  238. package/lib/cloudflare/tunnel.d.ts +2 -3
  239. package/lib/cloudflare/tunnel.d.ts.map +1 -1
  240. package/lib/cloudflare/tunnel.js +3 -3
  241. package/lib/cloudflare/tunnel.js.map +1 -1
  242. package/lib/cloudflare/user.d.ts +3 -2
  243. package/lib/cloudflare/user.d.ts.map +1 -1
  244. package/lib/cloudflare/user.js +7 -5
  245. package/lib/cloudflare/user.js.map +1 -1
  246. package/lib/cloudflare/vectorize-index.d.ts +2 -3
  247. package/lib/cloudflare/vectorize-index.d.ts.map +1 -1
  248. package/lib/cloudflare/vectorize-index.js +6 -6
  249. package/lib/cloudflare/vectorize-index.js.map +1 -1
  250. package/lib/cloudflare/vectorize-metadata-index.d.ts +2 -3
  251. package/lib/cloudflare/vectorize-metadata-index.d.ts.map +1 -1
  252. package/lib/cloudflare/vectorize-metadata-index.js +4 -4
  253. package/lib/cloudflare/vectorize-metadata-index.js.map +1 -1
  254. package/lib/cloudflare/website.js +1 -1
  255. package/lib/cloudflare/website.js.map +1 -1
  256. package/lib/cloudflare/worker-assets.d.ts +1 -29
  257. package/lib/cloudflare/worker-assets.d.ts.map +1 -1
  258. package/lib/cloudflare/worker-assets.js +9 -42
  259. package/lib/cloudflare/worker-assets.js.map +1 -1
  260. package/lib/cloudflare/worker-stub.d.ts +2 -3
  261. package/lib/cloudflare/worker-stub.d.ts.map +1 -1
  262. package/lib/cloudflare/worker-stub.js +3 -3
  263. package/lib/cloudflare/worker-stub.js.map +1 -1
  264. package/lib/cloudflare/worker-subdomain.d.ts +4 -3
  265. package/lib/cloudflare/worker-subdomain.d.ts.map +1 -1
  266. package/lib/cloudflare/worker-subdomain.js +5 -5
  267. package/lib/cloudflare/worker-subdomain.js.map +1 -1
  268. package/lib/cloudflare/worker.d.ts +3 -4
  269. package/lib/cloudflare/worker.d.ts.map +1 -1
  270. package/lib/cloudflare/worker.js +6 -5
  271. package/lib/cloudflare/worker.js.map +1 -1
  272. package/lib/cloudflare/zone.d.ts +1 -2
  273. package/lib/cloudflare/zone.d.ts.map +1 -1
  274. package/lib/cloudflare/zone.js +2 -2
  275. package/lib/cloudflare/zone.js.map +1 -1
  276. package/lib/context.d.ts +8 -8
  277. package/lib/context.d.ts.map +1 -1
  278. package/lib/context.js.map +1 -1
  279. package/lib/destroy.d.ts +1 -1
  280. package/lib/destroy.d.ts.map +1 -1
  281. package/lib/destroy.js.map +1 -1
  282. package/lib/dns/import-dns.d.ts +1 -2
  283. package/lib/dns/import-dns.d.ts.map +1 -1
  284. package/lib/dns/import-dns.js +2 -2
  285. package/lib/dns/import-dns.js.map +1 -1
  286. package/lib/docker/container.d.ts +1 -2
  287. package/lib/docker/container.d.ts.map +1 -1
  288. package/lib/docker/container.js +2 -3
  289. package/lib/docker/container.js.map +1 -1
  290. package/lib/docker/image.d.ts +1 -2
  291. package/lib/docker/image.d.ts.map +1 -1
  292. package/lib/docker/image.js +9 -9
  293. package/lib/docker/image.js.map +1 -1
  294. package/lib/docker/network.d.ts +1 -2
  295. package/lib/docker/network.d.ts.map +1 -1
  296. package/lib/docker/network.js +2 -3
  297. package/lib/docker/network.js.map +1 -1
  298. package/lib/docker/remote-image.d.ts +1 -2
  299. package/lib/docker/remote-image.d.ts.map +1 -1
  300. package/lib/docker/remote-image.js +2 -3
  301. package/lib/docker/remote-image.js.map +1 -1
  302. package/lib/docker/volume.d.ts +1 -2
  303. package/lib/docker/volume.d.ts.map +1 -1
  304. package/lib/docker/volume.js +2 -3
  305. package/lib/docker/volume.js.map +1 -1
  306. package/lib/esbuild/bundle.d.ts +1 -2
  307. package/lib/esbuild/bundle.d.ts.map +1 -1
  308. package/lib/esbuild/bundle.js +4 -4
  309. package/lib/esbuild/bundle.js.map +1 -1
  310. package/lib/fs/copy-file.d.ts +1 -2
  311. package/lib/fs/copy-file.d.ts.map +1 -1
  312. package/lib/fs/copy-file.js +2 -2
  313. package/lib/fs/copy-file.js.map +1 -1
  314. package/lib/fs/file.d.ts +1 -2
  315. package/lib/fs/file.d.ts.map +1 -1
  316. package/lib/fs/file.js +2 -2
  317. package/lib/fs/file.js.map +1 -1
  318. package/lib/fs/folder.d.ts +1 -2
  319. package/lib/fs/folder.d.ts.map +1 -1
  320. package/lib/fs/folder.js +2 -2
  321. package/lib/fs/folder.js.map +1 -1
  322. package/lib/github/comment.d.ts +1 -2
  323. package/lib/github/comment.d.ts.map +1 -1
  324. package/lib/github/comment.js +4 -4
  325. package/lib/github/comment.js.map +1 -1
  326. package/lib/github/repository-environment.d.ts +1 -2
  327. package/lib/github/repository-environment.d.ts.map +1 -1
  328. package/lib/github/repository-environment.js +2 -2
  329. package/lib/github/repository-environment.js.map +1 -1
  330. package/lib/github/repository-webhook.d.ts +1 -2
  331. package/lib/github/repository-webhook.d.ts.map +1 -1
  332. package/lib/github/repository-webhook.js +2 -2
  333. package/lib/github/repository-webhook.js.map +1 -1
  334. package/lib/github/secret.d.ts +1 -2
  335. package/lib/github/secret.d.ts.map +1 -1
  336. package/lib/github/secret.js +2 -2
  337. package/lib/github/secret.js.map +1 -1
  338. package/lib/neon/api/client.gen.d.ts +13 -0
  339. package/lib/neon/api/client.gen.d.ts.map +1 -0
  340. package/lib/neon/api/client.gen.js +7 -0
  341. package/lib/neon/api/client.gen.js.map +1 -0
  342. package/lib/neon/api/sdk.gen.d.ts +880 -0
  343. package/lib/neon/api/sdk.gen.d.ts.map +1 -0
  344. package/lib/neon/api/sdk.gen.js +1527 -0
  345. package/lib/neon/api/sdk.gen.js.map +1 -0
  346. package/lib/neon/api/types.gen.d.ts +7250 -0
  347. package/lib/neon/api/types.gen.d.ts.map +1 -0
  348. package/lib/neon/api/types.gen.js +2 -0
  349. package/lib/neon/api/types.gen.js.map +1 -0
  350. package/lib/neon/api.d.ts +14 -49
  351. package/lib/neon/api.d.ts.map +1 -1
  352. package/lib/neon/api.js +36 -114
  353. package/lib/neon/api.js.map +1 -1
  354. package/lib/neon/branch.d.ts +141 -0
  355. package/lib/neon/branch.d.ts.map +1 -0
  356. package/lib/neon/branch.js +112 -0
  357. package/lib/neon/branch.js.map +1 -0
  358. package/lib/neon/index.d.ts +1 -1
  359. package/lib/neon/index.d.ts.map +1 -1
  360. package/lib/neon/index.js +1 -1
  361. package/lib/neon/index.js.map +1 -1
  362. package/lib/neon/project.d.ts +32 -242
  363. package/lib/neon/project.d.ts.map +1 -1
  364. package/lib/neon/project.js +90 -269
  365. package/lib/neon/project.js.map +1 -1
  366. package/lib/neon/utils.d.ts +49 -0
  367. package/lib/neon/utils.d.ts.map +1 -0
  368. package/lib/neon/utils.js +44 -0
  369. package/lib/neon/utils.js.map +1 -0
  370. package/lib/os/exec.d.ts +1 -2
  371. package/lib/os/exec.d.ts.map +1 -1
  372. package/lib/os/exec.js +2 -2
  373. package/lib/os/exec.js.map +1 -1
  374. package/lib/planetscale/api/client.gen.d.ts +12 -1749
  375. package/lib/planetscale/api/client.gen.d.ts.map +1 -1
  376. package/lib/planetscale/api/client.gen.js +6 -2400
  377. package/lib/planetscale/api/client.gen.js.map +1 -1
  378. package/lib/planetscale/api/sdk.gen.d.ts +1582 -0
  379. package/lib/planetscale/api/sdk.gen.d.ts.map +1 -0
  380. package/lib/planetscale/api/sdk.gen.js +2219 -0
  381. package/lib/planetscale/api/sdk.gen.js.map +1 -0
  382. package/lib/planetscale/api/types.gen.d.ts +594 -449
  383. package/lib/planetscale/api/types.gen.d.ts.map +1 -1
  384. package/lib/planetscale/api.d.ts +43 -0
  385. package/lib/planetscale/api.d.ts.map +1 -0
  386. package/lib/planetscale/api.js +53 -0
  387. package/lib/planetscale/api.js.map +1 -0
  388. package/lib/planetscale/branch.d.ts +2 -3
  389. package/lib/planetscale/branch.d.ts.map +1 -1
  390. package/lib/planetscale/branch.js +17 -15
  391. package/lib/planetscale/branch.js.map +1 -1
  392. package/lib/planetscale/database.d.ts +2 -3
  393. package/lib/planetscale/database.d.ts.map +1 -1
  394. package/lib/planetscale/database.js +34 -34
  395. package/lib/planetscale/database.js.map +1 -1
  396. package/lib/planetscale/index.d.ts +1 -1
  397. package/lib/planetscale/index.d.ts.map +1 -1
  398. package/lib/planetscale/index.js +1 -1
  399. package/lib/planetscale/index.js.map +1 -1
  400. package/lib/planetscale/password.d.ts +2 -3
  401. package/lib/planetscale/password.d.ts.map +1 -1
  402. package/lib/planetscale/password.js +11 -11
  403. package/lib/planetscale/password.js.map +1 -1
  404. package/lib/planetscale/role.d.ts +2 -3
  405. package/lib/planetscale/role.d.ts.map +1 -1
  406. package/lib/planetscale/role.js +18 -18
  407. package/lib/planetscale/role.js.map +1 -1
  408. package/lib/planetscale/utils.d.ts +1 -1
  409. package/lib/planetscale/utils.d.ts.map +1 -1
  410. package/lib/planetscale/utils.js +17 -33
  411. package/lib/planetscale/utils.js.map +1 -1
  412. package/lib/random/random-string.d.ts +1 -2
  413. package/lib/random/random-string.d.ts.map +1 -1
  414. package/lib/random/random-string.js +3 -3
  415. package/lib/random/random-string.js.map +1 -1
  416. package/lib/resource.d.ts +4 -1
  417. package/lib/resource.d.ts.map +1 -1
  418. package/lib/resource.js.map +1 -1
  419. package/lib/sentry/client-key.d.ts +1 -2
  420. package/lib/sentry/client-key.d.ts.map +1 -1
  421. package/lib/sentry/client-key.js +2 -2
  422. package/lib/sentry/client-key.js.map +1 -1
  423. package/lib/sentry/project.d.ts +1 -2
  424. package/lib/sentry/project.d.ts.map +1 -1
  425. package/lib/sentry/project.js +2 -2
  426. package/lib/sentry/project.js.map +1 -1
  427. package/lib/sentry/team.d.ts +1 -2
  428. package/lib/sentry/team.d.ts.map +1 -1
  429. package/lib/sentry/team.js +2 -2
  430. package/lib/sentry/team.js.map +1 -1
  431. package/lib/state/r2-rest-state-store.d.ts +1 -0
  432. package/lib/state/r2-rest-state-store.d.ts.map +1 -1
  433. package/lib/state/r2-rest-state-store.js +15 -34
  434. package/lib/state/r2-rest-state-store.js.map +1 -1
  435. package/lib/stripe/card.d.ts +1 -2
  436. package/lib/stripe/card.d.ts.map +1 -1
  437. package/lib/stripe/card.js +2 -2
  438. package/lib/stripe/card.js.map +1 -1
  439. package/lib/stripe/coupon.d.ts +1 -2
  440. package/lib/stripe/coupon.d.ts.map +1 -1
  441. package/lib/stripe/coupon.js +2 -2
  442. package/lib/stripe/coupon.js.map +1 -1
  443. package/lib/stripe/customer.d.ts +1 -2
  444. package/lib/stripe/customer.d.ts.map +1 -1
  445. package/lib/stripe/customer.js +2 -2
  446. package/lib/stripe/customer.js.map +1 -1
  447. package/lib/stripe/entitlements-feature.d.ts +1 -2
  448. package/lib/stripe/entitlements-feature.d.ts.map +1 -1
  449. package/lib/stripe/entitlements-feature.js +2 -2
  450. package/lib/stripe/entitlements-feature.js.map +1 -1
  451. package/lib/stripe/file.d.ts +1 -2
  452. package/lib/stripe/file.d.ts.map +1 -1
  453. package/lib/stripe/file.js +2 -2
  454. package/lib/stripe/file.js.map +1 -1
  455. package/lib/stripe/meter.d.ts +1 -2
  456. package/lib/stripe/meter.d.ts.map +1 -1
  457. package/lib/stripe/meter.js +1 -1
  458. package/lib/stripe/meter.js.map +1 -1
  459. package/lib/stripe/portal-configuration.d.ts +1 -2
  460. package/lib/stripe/portal-configuration.d.ts.map +1 -1
  461. package/lib/stripe/portal-configuration.js +2 -2
  462. package/lib/stripe/portal-configuration.js.map +1 -1
  463. package/lib/stripe/price.d.ts +1 -2
  464. package/lib/stripe/price.d.ts.map +1 -1
  465. package/lib/stripe/price.js +2 -2
  466. package/lib/stripe/price.js.map +1 -1
  467. package/lib/stripe/product-feature.d.ts +1 -2
  468. package/lib/stripe/product-feature.d.ts.map +1 -1
  469. package/lib/stripe/product-feature.js +2 -2
  470. package/lib/stripe/product-feature.js.map +1 -1
  471. package/lib/stripe/product.d.ts +1 -2
  472. package/lib/stripe/product.d.ts.map +1 -1
  473. package/lib/stripe/product.js +2 -2
  474. package/lib/stripe/product.js.map +1 -1
  475. package/lib/stripe/promotion-code.d.ts +1 -2
  476. package/lib/stripe/promotion-code.d.ts.map +1 -1
  477. package/lib/stripe/promotion-code.js +2 -2
  478. package/lib/stripe/promotion-code.js.map +1 -1
  479. package/lib/stripe/shipping-rate.d.ts +1 -2
  480. package/lib/stripe/shipping-rate.d.ts.map +1 -1
  481. package/lib/stripe/shipping-rate.js +2 -2
  482. package/lib/stripe/shipping-rate.js.map +1 -1
  483. package/lib/stripe/tax-rate.d.ts +1 -2
  484. package/lib/stripe/tax-rate.d.ts.map +1 -1
  485. package/lib/stripe/tax-rate.js +2 -2
  486. package/lib/stripe/tax-rate.js.map +1 -1
  487. package/lib/stripe/webhook.d.ts +16 -3
  488. package/lib/stripe/webhook.d.ts.map +1 -1
  489. package/lib/stripe/webhook.js +2 -2
  490. package/lib/stripe/webhook.js.map +1 -1
  491. package/lib/test/bun.d.ts.map +1 -1
  492. package/lib/test/bun.js +1 -0
  493. package/lib/test/bun.js.map +1 -1
  494. package/lib/test/options.d.ts +5 -0
  495. package/lib/test/options.d.ts.map +1 -1
  496. package/lib/test/vitest.d.ts.map +1 -1
  497. package/lib/test/vitest.js +1 -0
  498. package/lib/test/vitest.js.map +1 -1
  499. package/lib/upstash/redis.d.ts +1 -2
  500. package/lib/upstash/redis.d.ts.map +1 -1
  501. package/lib/upstash/redis.js.map +1 -1
  502. package/lib/util/api/client/client.gen.d.ts +3 -0
  503. package/lib/util/api/client/client.gen.d.ts.map +1 -0
  504. package/lib/util/api/client/client.gen.js +205 -0
  505. package/lib/util/api/client/client.gen.js.map +1 -0
  506. package/lib/util/api/client/index.d.ts +8 -0
  507. package/lib/util/api/client/index.d.ts.map +1 -0
  508. package/lib/util/api/client/index.js +6 -0
  509. package/lib/util/api/client/index.js.map +1 -0
  510. package/lib/util/api/client/types.gen.d.ts +125 -0
  511. package/lib/util/api/client/types.gen.d.ts.map +1 -0
  512. package/lib/util/api/client/types.gen.js +2 -0
  513. package/lib/util/api/client/types.gen.js.map +1 -0
  514. package/lib/util/api/client/utils.gen.d.ts +34 -0
  515. package/lib/util/api/client/utils.gen.d.ts.map +1 -0
  516. package/lib/util/api/client/utils.gen.js +231 -0
  517. package/lib/util/api/client/utils.gen.js.map +1 -0
  518. package/lib/util/api/core/auth.gen.d.ts +19 -0
  519. package/lib/util/api/core/auth.gen.d.ts.map +1 -0
  520. package/lib/util/api/core/auth.gen.js +15 -0
  521. package/lib/util/api/core/auth.gen.js.map +1 -0
  522. package/lib/util/api/core/bodySerializer.gen.d.ts +18 -0
  523. package/lib/util/api/core/bodySerializer.gen.d.ts.map +1 -0
  524. package/lib/util/api/core/bodySerializer.gen.js +58 -0
  525. package/lib/util/api/core/bodySerializer.gen.js.map +1 -0
  526. package/lib/util/api/core/params.gen.d.ts +34 -0
  527. package/lib/util/api/core/params.gen.d.ts.map +1 -0
  528. package/lib/util/api/core/params.gen.js +89 -0
  529. package/lib/util/api/core/params.gen.js.map +1 -0
  530. package/lib/util/api/core/pathSerializer.gen.d.ts +34 -0
  531. package/lib/util/api/core/pathSerializer.gen.d.ts.map +1 -0
  532. package/lib/util/api/core/pathSerializer.gen.js +115 -0
  533. package/lib/util/api/core/pathSerializer.gen.js.map +1 -0
  534. package/lib/util/api/core/serverSentEvents.gen.d.ts +72 -0
  535. package/lib/util/api/core/serverSentEvents.gen.d.ts.map +1 -0
  536. package/lib/util/api/core/serverSentEvents.gen.js +136 -0
  537. package/lib/util/api/core/serverSentEvents.gen.js.map +1 -0
  538. package/lib/util/api/core/types.gen.d.ts +79 -0
  539. package/lib/util/api/core/types.gen.d.ts.map +1 -0
  540. package/lib/util/api/core/types.gen.js +2 -0
  541. package/lib/util/api/core/types.gen.js.map +1 -0
  542. package/lib/util/api/core/utils.gen.d.ts +20 -0
  543. package/lib/util/api/core/utils.gen.d.ts.map +1 -0
  544. package/lib/util/api/core/utils.gen.js +88 -0
  545. package/lib/util/api/core/utils.gen.js.map +1 -0
  546. package/lib/util/http.d.ts +7 -2
  547. package/lib/util/http.d.ts.map +1 -1
  548. package/lib/util/http.js +29 -11
  549. package/lib/util/http.js.map +1 -1
  550. package/lib/util/lock.d.ts +20 -0
  551. package/lib/util/lock.d.ts.map +1 -0
  552. package/lib/util/lock.js +45 -0
  553. package/lib/util/lock.js.map +1 -0
  554. package/lib/util/memoize.d.ts +6 -0
  555. package/lib/util/memoize.d.ts.map +1 -1
  556. package/lib/util/memoize.js +23 -0
  557. package/lib/util/memoize.js.map +1 -1
  558. package/lib/util/oauth-client.d.ts +71 -0
  559. package/lib/util/oauth-client.d.ts.map +1 -0
  560. package/lib/util/oauth-client.js +188 -0
  561. package/lib/util/oauth-client.js.map +1 -0
  562. package/lib/util/poll.d.ts +33 -0
  563. package/lib/util/poll.d.ts.map +1 -0
  564. package/lib/util/poll.js +19 -0
  565. package/lib/util/poll.js.map +1 -0
  566. package/lib/vercel/project-domain.d.ts +1 -2
  567. package/lib/vercel/project-domain.d.ts.map +1 -1
  568. package/lib/vercel/project-domain.js.map +1 -1
  569. package/lib/vercel/project.d.ts +1 -2
  570. package/lib/vercel/project.d.ts.map +1 -1
  571. package/lib/vercel/project.js +2 -2
  572. package/lib/vercel/project.js.map +1 -1
  573. package/package.json +5 -1
  574. package/src/apply.ts +32 -29
  575. package/src/auth.ts +253 -0
  576. package/src/aws/bucket.ts +3 -3
  577. package/src/aws/control/resource.ts +4 -6
  578. package/src/aws/ec2/internet-gateway-attachment.ts +5 -6
  579. package/src/aws/ec2/internet-gateway.ts +3 -5
  580. package/src/aws/ec2/nat-gateway.ts +3 -5
  581. package/src/aws/ec2/route-table-association.ts +3 -5
  582. package/src/aws/ec2/route-table.ts +3 -5
  583. package/src/aws/ec2/route.ts +3 -3
  584. package/src/aws/ec2/security-group-rule.ts +3 -5
  585. package/src/aws/ec2/security-group.ts +3 -5
  586. package/src/aws/ec2/subnet.ts +3 -3
  587. package/src/aws/ec2/vpc.ts +3 -3
  588. package/src/aws/function.ts +3 -3
  589. package/src/aws/oidc/oidc-provider.ts +3 -5
  590. package/src/aws/policy-attachment.ts +2 -4
  591. package/src/aws/policy.ts +5 -5
  592. package/src/aws/queue.ts +5 -5
  593. package/src/aws/role.ts +3 -3
  594. package/src/aws/ses.ts +3 -3
  595. package/src/aws/ssm-parameter.ts +3 -3
  596. package/src/aws/table.ts +3 -3
  597. package/src/cloudflare/account-api-token.ts +3 -4
  598. package/src/cloudflare/ai-gateway.ts +3 -5
  599. package/src/cloudflare/api-gateway-operation.ts +3 -4
  600. package/src/cloudflare/api-schema.ts +25 -26
  601. package/src/cloudflare/api-shield.ts +3 -4
  602. package/src/cloudflare/api.ts +122 -57
  603. package/src/cloudflare/assets.ts +95 -136
  604. package/src/cloudflare/auth.ts +160 -95
  605. package/src/cloudflare/bound.ts +1 -1
  606. package/src/cloudflare/bucket.ts +321 -58
  607. package/src/cloudflare/bundle/plugin-wasm.ts +5 -5
  608. package/src/cloudflare/certificate-pack.ts +5 -6
  609. package/src/cloudflare/compatibility-date.gen.ts +1 -1
  610. package/src/cloudflare/container.ts +7 -8
  611. package/src/cloudflare/custom-domain.ts +3 -5
  612. package/src/cloudflare/d1-database.ts +33 -34
  613. package/src/cloudflare/dispatch-namespace.ts +5 -6
  614. package/src/cloudflare/dns-records.ts +5 -5
  615. package/src/cloudflare/email-address.ts +7 -7
  616. package/src/cloudflare/email-catch-all.ts +6 -6
  617. package/src/cloudflare/email-routing.ts +5 -5
  618. package/src/cloudflare/email-rule.ts +5 -5
  619. package/src/cloudflare/hyperdrive.ts +35 -36
  620. package/src/cloudflare/kv-namespace.ts +31 -32
  621. package/src/cloudflare/miniflare/delete.ts +1 -1
  622. package/src/cloudflare/miniflare/miniflare-worker-proxy.ts +2 -7
  623. package/src/cloudflare/miniflare/remote-binding-proxy.ts +16 -4
  624. package/src/cloudflare/permission-groups.ts +4 -6
  625. package/src/cloudflare/pipeline.ts +29 -30
  626. package/src/cloudflare/queue-consumer.ts +5 -7
  627. package/src/cloudflare/queue.ts +42 -43
  628. package/src/cloudflare/react-router/plugin.ts +20 -0
  629. package/src/cloudflare/redirect-rule.ts +5 -5
  630. package/src/cloudflare/route.ts +5 -5
  631. package/src/cloudflare/ruleset.ts +3 -4
  632. package/src/cloudflare/secret.ts +35 -36
  633. package/src/cloudflare/secrets-store.ts +5 -8
  634. package/src/cloudflare/tunnel.ts +5 -7
  635. package/src/cloudflare/user.ts +12 -9
  636. package/src/cloudflare/vectorize-index.ts +8 -12
  637. package/src/cloudflare/vectorize-metadata-index.ts +6 -8
  638. package/src/cloudflare/website.ts +1 -1
  639. package/src/cloudflare/worker-assets.ts +10 -56
  640. package/src/cloudflare/worker-stub.ts +5 -5
  641. package/src/cloudflare/worker-subdomain.ts +6 -7
  642. package/src/cloudflare/worker.ts +91 -91
  643. package/src/cloudflare/zone.ts +3 -3
  644. package/src/context.ts +9 -7
  645. package/src/destroy.ts +2 -2
  646. package/src/dns/import-dns.ts +3 -5
  647. package/src/docker/container.ts +3 -6
  648. package/src/docker/image.ts +13 -13
  649. package/src/docker/network.ts +3 -4
  650. package/src/docker/remote-image.ts +3 -6
  651. package/src/docker/volume.ts +3 -4
  652. package/src/esbuild/bundle.ts +10 -8
  653. package/src/fs/copy-file.ts +3 -3
  654. package/src/fs/file.ts +3 -3
  655. package/src/fs/folder.ts +3 -3
  656. package/src/github/comment.ts +5 -7
  657. package/src/github/repository-environment.ts +3 -5
  658. package/src/github/repository-webhook.ts +3 -5
  659. package/src/github/secret.ts +3 -5
  660. package/src/neon/api/client.gen.ts +28 -0
  661. package/src/neon/api/sdk.gen.ts +2596 -0
  662. package/src/neon/api/types.gen.ts +8287 -0
  663. package/src/neon/api.ts +51 -147
  664. package/src/neon/branch.ts +278 -0
  665. package/src/neon/index.ts +1 -1
  666. package/src/neon/project.ts +136 -721
  667. package/src/neon/utils.ts +105 -0
  668. package/src/os/exec.ts +3 -3
  669. package/src/planetscale/api/client.gen.ts +28 -2882
  670. package/src/planetscale/api/sdk.gen.ts +3336 -0
  671. package/src/planetscale/api/types.gen.ts +778 -450
  672. package/src/planetscale/api.ts +101 -0
  673. package/src/planetscale/branch.ts +20 -19
  674. package/src/planetscale/database.ts +69 -70
  675. package/src/planetscale/index.ts +1 -1
  676. package/src/planetscale/password.ts +18 -22
  677. package/src/planetscale/role.ts +21 -21
  678. package/src/planetscale/utils.ts +20 -74
  679. package/src/random/random-string.ts +4 -4
  680. package/src/resource.ts +6 -2
  681. package/src/sentry/client-key.ts +3 -5
  682. package/src/sentry/project.ts +3 -5
  683. package/src/sentry/team.ts +3 -3
  684. package/src/state/r2-rest-state-store.ts +15 -57
  685. package/src/stripe/card.ts +3 -3
  686. package/src/stripe/coupon.ts +3 -3
  687. package/src/stripe/customer.ts +3 -3
  688. package/src/stripe/entitlements-feature.ts +3 -5
  689. package/src/stripe/file.ts +3 -3
  690. package/src/stripe/meter.ts +3 -3
  691. package/src/stripe/portal-configuration.ts +3 -5
  692. package/src/stripe/price.ts +3 -3
  693. package/src/stripe/product-feature.ts +3 -5
  694. package/src/stripe/product.ts +3 -3
  695. package/src/stripe/promotion-code.ts +3 -5
  696. package/src/stripe/shipping-rate.ts +3 -5
  697. package/src/stripe/tax-rate.ts +3 -3
  698. package/src/stripe/webhook.ts +3 -5
  699. package/src/test/bun.ts +1 -0
  700. package/src/test/options.ts +6 -0
  701. package/src/test/vitest.ts +1 -0
  702. package/src/upstash/redis.ts +1 -3
  703. package/src/util/api/client/client.gen.ts +268 -0
  704. package/src/util/api/client/index.ts +25 -0
  705. package/src/util/api/client/types.gen.ts +268 -0
  706. package/src/util/api/client/utils.gen.ts +331 -0
  707. package/src/util/api/core/auth.gen.ts +42 -0
  708. package/src/util/api/core/bodySerializer.gen.ts +92 -0
  709. package/src/util/api/core/params.gen.ts +153 -0
  710. package/src/util/api/core/pathSerializer.gen.ts +181 -0
  711. package/src/util/api/core/serverSentEvents.gen.ts +264 -0
  712. package/src/util/api/core/types.gen.ts +118 -0
  713. package/src/util/api/core/utils.gen.ts +143 -0
  714. package/src/util/http.ts +38 -11
  715. package/src/util/lock.ts +48 -0
  716. package/src/util/memoize.ts +26 -0
  717. package/src/util/oauth-client.ts +238 -0
  718. package/src/util/poll.ts +55 -0
  719. package/src/vercel/project-domain.ts +1 -3
  720. package/src/vercel/project.ts +3 -3
  721. package/workers/cloudflare-state-store.js +8 -5619
  722. package/workers/dofs-state-store.js +2 -802
  723. package/workers/remote-binding-proxy.js +3 -39
  724. package/workers/remote-binding-proxy.ts +126 -35
  725. package/workers/tunnel-proxy.js +6 -73
  726. package/lib/cloudflare/asset-manifest.d.ts +0 -15
  727. package/lib/cloudflare/asset-manifest.d.ts.map +0 -1
  728. package/lib/cloudflare/asset-manifest.js +0 -1
  729. package/lib/cloudflare/asset-manifest.js.map +0 -1
  730. package/lib/cloudflare/oauth.d.ts +0 -22
  731. package/lib/cloudflare/oauth.d.ts.map +0 -1
  732. package/lib/cloudflare/oauth.js +0 -214
  733. package/lib/cloudflare/oauth.js.map +0 -1
  734. package/lib/neon/api-error.d.ts +0 -31
  735. package/lib/neon/api-error.d.ts.map +0 -1
  736. package/lib/neon/api-error.js +0 -73
  737. package/lib/neon/api-error.js.map +0 -1
  738. package/lib/planetscale/api/index.d.ts +0 -3
  739. package/lib/planetscale/api/index.d.ts.map +0 -1
  740. package/lib/planetscale/api/index.js +0 -4
  741. package/lib/planetscale/api/index.js.map +0 -1
  742. package/lib/util/neverthrow.d.ts +0 -16
  743. package/lib/util/neverthrow.d.ts.map +0 -1
  744. package/lib/util/neverthrow.js +0 -46
  745. package/lib/util/neverthrow.js.map +0 -1
  746. package/src/cloudflare/asset-manifest.ts +0 -16
  747. package/src/cloudflare/oauth.ts +0 -301
  748. package/src/neon/api-error.ts +0 -81
  749. package/src/planetscale/api/index.ts +0 -4
  750. package/src/util/neverthrow.ts +0 -64
@@ -1,1750 +1,13 @@
1
- import type { Backup, CancelBranchChangeRequestData, CancelDeployRequestData, CloseDeployRequestData, CompleteErroredDeployData, CompleteGatedDeployRequestData, CompleteRevertData, CreateBackupData, CreateBranchData, CreateDatabaseData, CreateDeployRequestData, CreateKeyspaceData, CreateOauthTokenData, CreatePasswordData, CreateQueryPatternsReportData, CreateRoleData, CreateWebhookData, CreateWorkflowData, Database, DatabaseBranch, DatabaseBranchKeyspace, DatabaseBranchPassword, DatabaseDeployRequest, DatabaseWebhook, DeleteBackupData, DeleteBranchData, DeleteDatabaseData, DeleteKeyspaceData, DeleteOauthTokenData, DeletePasswordData, DeleteQueryPatternsReportData, DeleteRoleData, DeleteWebhookData, DemoteBranchData, DeployRequestReview, Deployment, DisableSafeMigrationsData, EnableSafeMigrationsData, GetBackupData, GetBranchData, GetBranchSchemaData, GetCurrentUserData, GetDatabaseData, GetDatabaseThrottlerData, GetDeployQueueData, GetDeployRequestData, GetDeployRequestThrottlerData, GetDeploymentData, GetInvoiceData, GetInvoiceLineItemsData, GetKeyspaceData, GetKeyspaceRolloutStatusData, GetKeyspaceVschemaData, GetOauthApplicationData, GetOauthTokenData, GetOrganizationData, GetPasswordData, GetQueryPatternsReportData, GetQueryPatternsReportStatusData, GetRoleData, GetWebhookData, GetWorkflowData, Invoice, LintBranchSchemaData, ListAuditLogsData, ListBackupsData, ListBranchChangeRequestsData, ListBranchesData, ListDatabaseRegionsData, ListDatabasesData, ListDeployOperationsData, ListDeployRequestReviewsData, ListDeployRequestsData, ListExtensionsData, ListGeneratedQueryPatternsReportsData, ListInvoicesData, ListKeyspaceResizesData, ListKeyspacesData, ListOauthApplicationsData, ListOauthTokensData, ListOrganizationMembersData, ListOrganizationsData, ListParametersData, ListPasswordsData, ListPublicRegionsData, ListReadOnlyRegionsData, ListRegionsForOrganizationData, ListRolesData, ListWebhooksData, ListWorkflowsData, OauthApplication, Organization, PaginatedAuditLogEvent, PaginatedBackup, PaginatedDatabase, PaginatedDatabaseBranch, PaginatedDatabaseBranchKeyspace, PaginatedDatabaseBranchPassword, PaginatedDatabaseBranchReadOnlyRegion, PaginatedDatabaseDeployRequest, PaginatedDatabaseWebhook, PaginatedDeployOperation, PaginatedDeployRequestReview, PaginatedDeployment, PaginatedInvoice, PaginatedKeyspaceResizeRequest, PaginatedLineItem, PaginatedOauthApplication, PaginatedOrganization, PaginatedOrganizationMembership, PaginatedPlanetscaleRegion, PaginatedPostgresClusterResizeRequest, PaginatedPostgresRole, PaginatedPublicPlanetscaleRegionSerializer, PaginatedQueryPatternsDownload, PaginatedSchemaLintError, PaginatedServiceToken, PaginatedWorkflow, PostgresClusterResizeRequest, PostgresRole, PromoteBranchData, QueryPatternsDownload, QueueDeployRequestData, RenewPasswordData, RenewRoleData, ReviewDeployRequestData, ServiceToken, SkipRevertPeriodData, TestWebhookData, ThrottlerConfigurations, UpdateAutoApplyData, UpdateBackupData, UpdateBranchChangeRequestData, UpdateBranchClusterConfigData, UpdateDatabaseSettingsData, UpdateDatabaseThrottlerData, UpdateDeployRequestThrottlerData, UpdateKeyspaceData, UpdateKeyspaceVschemaData, UpdateOrganizationData, UpdatePasswordData, UpdateRoleData, UpdateWebhookData, User, VerifyWorkflowData, Workflow, WorkflowCancelData, WorkflowCompleteData, WorkflowCutoverData, WorkflowRetryData, WorkflowReverseCutoverData, WorkflowReverseTrafficData, WorkflowSwitchPrimariesData, WorkflowSwitchReplicasData } from "./types.gen.ts";
2
- import type { Secret } from "../../secret.ts";
3
- export declare class PlanetScaleError extends Error {
4
- readonly code: string;
5
- readonly status: number;
6
- readonly url: string;
7
- readonly method: string;
8
- constructor(props: {
9
- code: string;
10
- message: string;
11
- status: number;
12
- url: string;
13
- method: string;
14
- });
15
- }
16
- export interface PlanetScaleProps {
17
- /**
18
- * The base URL of the PlanetScale API. Defaults to https://api.planetscale.com/v1.
19
- */
20
- baseUrl?: string;
21
- /**
22
- * The ID of the service token to use for authentication. Defaults to the value of the PLANETSCALE_SERVICE_TOKEN_ID environment variable.
23
- */
24
- serviceTokenId?: Secret;
25
- /**
26
- * The secret of the service token to use for authentication. Defaults to the value of the PLANETSCALE_SERVICE_TOKEN environment variable.
27
- */
28
- serviceToken?: Secret;
29
- /**
30
- * The API key to use for authentication. Defaults to the value of the PLANETSCALE_API_TOKEN environment variable.
31
- * @deprecated Use serviceTokenId and serviceToken instead.
32
- */
33
- apiKey?: Secret;
34
- /**
35
- * The organization to use for authentication. Defaults to the value of the PLANETSCALE_ORGANIZATION or PLANETSCALE_ORG_ID environment variable.
36
- */
37
- organizationId?: string;
38
- }
39
- type ResultType = "json" | "full";
40
- type RequestType<TParams, TResult extends ResultType> = Omit<TParams, "url"> & {
41
- /**
42
- * The type of response to return.
43
- * If "json", the response JSON will be returned and any errors will be thrown.
44
- * If "response", the entire response will be returned regardless of errors.
45
- * @default "json"
46
- */
47
- result?: TResult;
48
- };
49
- type ResponseType<T, TResult extends ResultType> = TResult extends "json" ? T : {
50
- status: number;
51
- data: T;
52
- error: null;
53
- response: Response;
54
- } | {
55
- status: number;
56
- data: null;
57
- error: PlanetScaleError;
58
- response: Response;
59
- };
60
- export declare class PlanetScaleClient {
61
- private readonly baseUrl;
62
- private readonly token;
63
- constructor(props?: PlanetScaleProps);
64
- request<T, TResult extends ResultType = "json">(input: {
65
- method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
66
- path: `/${string}`;
67
- params?: {
68
- body?: Record<string, unknown>;
69
- query?: Record<string, string | number | boolean>;
70
- path?: Record<string, string>;
71
- result?: TResult;
72
- };
73
- }): Promise<ResponseType<T, TResult>>;
74
- organizations: {
75
- /**
76
- * List organizations
77
- *
78
- * @description When using a service token, returns the list of organizations the service token has access to. When using an OAuth token, returns the list of organizations the user has access to.
79
- * ### Authorization
80
- * A OAuth token must have at least one of the following scopes in order to use this API endpoint:
81
- *
82
- * **OAuth Scopes**
83
- *
84
- * | Resource | Scopes |
85
- * | :------- | :---------- |
86
- * | User | `read_organizations` |
87
- */
88
- list: <TResult extends ResultType = "json">(params?: RequestType<ListOrganizationsData, TResult>) => Promise<ResponseType<PaginatedOrganization, TResult>>;
89
- /**
90
- * Get an organization
91
- *
92
- * @description ### Authorization
93
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
94
- *
95
- * **Service Token Accesses**
96
- * `read_organization`
97
- *
98
- * **OAuth Scopes**
99
- *
100
- * | Resource | Scopes |
101
- * | :------- | :---------- |
102
- * | User | `read_organizations` |
103
- * | Organization | `read_organization` |
104
- */
105
- get: <TResult extends ResultType = "json">(params: RequestType<GetOrganizationData, TResult>) => Promise<ResponseType<Organization, TResult>>;
106
- /**
107
- * Update an organization
108
- *
109
- * @description ### Authorization
110
- * A OAuth token must have at least one of the following scopes in order to use this API endpoint:
111
- *
112
- * **OAuth Scopes**
113
- *
114
- * | Resource | Scopes |
115
- * | :------- | :---------- |
116
- * | Organization | `write_organization` |
117
- */
118
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateOrganizationData, TResult>) => Promise<ResponseType<Organization, TResult>>;
119
- auditLog: {
120
- /**
121
- * List audit logs
122
- *
123
- * @description ### Authorization
124
- * A service token must have at least one of the following access in order to use this API endpoint:
125
- *
126
- * **Service Token Accesses**
127
- * `read_audit_logs`
128
- */
129
- list: <TResult extends ResultType = "json">(params: RequestType<ListAuditLogsData, TResult>) => Promise<ResponseType<PaginatedAuditLogEvent, TResult>>;
130
- };
131
- regions: {
132
- /**
133
- * List regions for an organization
134
- *
135
- * @description ### Authorization
136
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
137
- *
138
- * **Service Token Accesses**
139
- * `read_organization`
140
- *
141
- * **OAuth Scopes**
142
- *
143
- * | Resource | Scopes |
144
- * | :------- | :---------- |
145
- * | User | `read_organizations` |
146
- * | Organization | `read_organization` |
147
- */
148
- list: <TResult extends ResultType = "json">(params: RequestType<ListRegionsForOrganizationData, TResult>) => Promise<ResponseType<PaginatedPlanetscaleRegion, TResult>>;
149
- };
150
- databases: {
151
- /**
152
- * List databases
153
- *
154
- * @description ### Authorization
155
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
156
- *
157
- * **Service Token Accesses**
158
- * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `delete_branch_password`, `delete_production_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_schema_recommendations`, `close_schema_recommendations`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
159
- *
160
- * **OAuth Scopes**
161
- *
162
- * | Resource | Scopes |
163
- * | :------- | :---------- |
164
- * | Organization | `read_databases` |
165
- */
166
- list: <TResult extends ResultType = "json">(params: RequestType<ListDatabasesData, TResult>) => Promise<ResponseType<PaginatedDatabase, TResult>>;
167
- /**
168
- * Create a database
169
- *
170
- * @description ### Authorization
171
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
172
- *
173
- * **Service Token Accesses**
174
- * `create_databases`
175
- *
176
- * **OAuth Scopes**
177
- *
178
- * | Resource | Scopes |
179
- * | :------- | :---------- |
180
- * | Organization | `create_databases` |
181
- */
182
- post: <TResult extends ResultType = "json">(params: RequestType<CreateDatabaseData, TResult>) => Promise<ResponseType<Database, TResult>>;
183
- branches: {
184
- /**
185
- * List branches
186
- *
187
- * @description ### Authorization
188
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
189
- *
190
- * **Service Token Accesses**
191
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
192
- *
193
- * **OAuth Scopes**
194
- *
195
- * | Resource | Scopes |
196
- * | :------- | :---------- |
197
- * | Organization | `read_branches` |
198
- * | Database | `read_branches` |
199
- * | Branch | `read_branch` |
200
- */
201
- list: <TResult extends ResultType = "json">(params: RequestType<ListBranchesData, TResult>) => Promise<ResponseType<PaginatedDatabaseBranch, TResult>>;
202
- /**
203
- * Create a branch
204
- *
205
- * @description ### Authorization
206
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
207
- *
208
- * **Service Token Accesses**
209
- * `create_branch`, `restore_production_branch_backup`, `restore_backup`
210
- *
211
- * **OAuth Scopes**
212
- *
213
- * | Resource | Scopes |
214
- * | :------- | :---------- |
215
- * | Organization | `write_branches`, `restore_production_branch_backups`, `restore_backups` |
216
- * | Database | `write_branches`, `restore_production_branch_backups`, `restore_backups` |
217
- * | Branch | `restore_backups` |
218
- */
219
- post: <TResult extends ResultType = "json">(params: RequestType<CreateBranchData, TResult>) => Promise<ResponseType<DatabaseBranch, TResult>>;
220
- backups: {
221
- /**
222
- * List backups
223
- *
224
- * @description ### Authorization
225
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
226
- *
227
- * **Service Token Accesses**
228
- * `read_backups`
229
- *
230
- * **OAuth Scopes**
231
- *
232
- * | Resource | Scopes |
233
- * | :------- | :---------- |
234
- * | Organization | `read_backups` |
235
- * | Database | `read_backups` |
236
- * | Branch | `read_backups` |
237
- */
238
- list: <TResult extends ResultType = "json">(params: RequestType<ListBackupsData, TResult>) => Promise<ResponseType<PaginatedBackup, TResult>>;
239
- /**
240
- * Create a backup
241
- *
242
- * @description ### Authorization
243
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
244
- *
245
- * **Service Token Accesses**
246
- * `write_backups`
247
- *
248
- * **OAuth Scopes**
249
- *
250
- * | Resource | Scopes |
251
- * | :------- | :---------- |
252
- * | Organization | `write_backups` |
253
- * | Database | `write_backups` |
254
- * | Branch | `write_backups` |
255
- */
256
- post: <TResult extends ResultType = "json">(params: RequestType<CreateBackupData, TResult>) => Promise<ResponseType<Backup, TResult>>;
257
- /**
258
- * Get a backup
259
- *
260
- * @description ### Authorization
261
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
262
- *
263
- * **Service Token Accesses**
264
- * `read_backups`
265
- *
266
- * **OAuth Scopes**
267
- *
268
- * | Resource | Scopes |
269
- * | :------- | :---------- |
270
- * | Organization | `read_backups` |
271
- * | Database | `read_backups` |
272
- * | Branch | `read_backups` |
273
- */
274
- get: <TResult extends ResultType = "json">(params: RequestType<GetBackupData, TResult>) => Promise<ResponseType<Backup, TResult>>;
275
- /**
276
- * Update a backup
277
- *
278
- * @description ### Authorization
279
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
280
- *
281
- * **Service Token Accesses**
282
- * `write_backups`
283
- *
284
- * **OAuth Scopes**
285
- *
286
- * | Resource | Scopes |
287
- * | :------- | :---------- |
288
- * | Organization | `write_backups` |
289
- * | Database | `write_backups` |
290
- * | Branch | `write_backups` |
291
- */
292
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateBackupData, TResult>) => Promise<ResponseType<Backup, TResult>>;
293
- /**
294
- * Delete a backup
295
- *
296
- * @description ### Authorization
297
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
298
- *
299
- * **Service Token Accesses**
300
- * `delete_backups`, `delete_production_branch_backups`
301
- *
302
- * **OAuth Scopes**
303
- *
304
- * | Resource | Scopes |
305
- * | :------- | :---------- |
306
- * | Organization | `delete_backups`, `delete_production_branch_backups` |
307
- * | Database | `delete_backups`, `delete_production_branch_backups` |
308
- * | Branch | `delete_backups` |
309
- */
310
- delete: <TResult extends ResultType = "json">(params: RequestType<DeleteBackupData, TResult>) => Promise<ResponseType<unknown, TResult>>;
311
- };
312
- changes: {
313
- /**
314
- * Get branch change requests
315
- *
316
- * @description ### Authorization
317
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
318
- *
319
- * **Service Token Accesses**
320
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
321
- *
322
- * **OAuth Scopes**
323
- *
324
- * | Resource | Scopes |
325
- * | :------- | :---------- |
326
- * | Organization | `read_branches` |
327
- * | Database | `read_branches` |
328
- * | Branch | `read_branch` |
329
- */
330
- list: <TResult extends ResultType = "json">(params: RequestType<ListBranchChangeRequestsData, TResult>) => Promise<ResponseType<PaginatedPostgresClusterResizeRequest, TResult>>;
331
- /**
332
- * Upsert a change request
333
- *
334
- * @description ### Authorization
335
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
336
- *
337
- * **Service Token Accesses**
338
- * `write_database`
339
- *
340
- * **OAuth Scopes**
341
- *
342
- * | Resource | Scopes |
343
- * | :------- | :---------- |
344
- * | Organization | `write_databases` |
345
- * | Database | `write_database` |
346
- */
347
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateBranchChangeRequestData, TResult>) => Promise<ResponseType<PostgresClusterResizeRequest, TResult>>;
348
- };
349
- extensions: {
350
- /**
351
- * List cluster extensions
352
- *
353
- * @description ### Authorization
354
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
355
- *
356
- * **Service Token Accesses**
357
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
358
- *
359
- * **OAuth Scopes**
360
- *
361
- * | Resource | Scopes |
362
- * | :------- | :---------- |
363
- * | Organization | `read_branches` |
364
- * | Database | `read_branches` |
365
- * | Branch | `read_branch` |
366
- */
367
- list: <TResult extends ResultType = "json">(params: RequestType<ListExtensionsData, TResult>) => Promise<ResponseType<import("./types.gen.ts").PostgresClusterExtension[], TResult>>;
368
- };
369
- keyspaces: {
370
- /**
371
- * Get keyspaces
372
- *
373
- */
374
- list: <TResult extends ResultType = "json">(params: RequestType<ListKeyspacesData, TResult>) => Promise<ResponseType<PaginatedDatabaseBranchKeyspace, TResult>>;
375
- /**
376
- * Create a keyspace
377
- *
378
- */
379
- post: <TResult extends ResultType = "json">(params: RequestType<CreateKeyspaceData, TResult>) => Promise<ResponseType<DatabaseBranchKeyspace, TResult>>;
380
- vschema: {
381
- /**
382
- * Get the VSchema for the keyspace
383
- *
384
- * @description ### Authorization
385
- * A service token must have at least one of the following access in order to use this API endpoint:
386
- *
387
- * **Service Token Accesses**
388
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
389
- */
390
- get: <TResult extends ResultType = "json">(params: RequestType<GetKeyspaceVschemaData, TResult>) => Promise<ResponseType<{
391
- raw: string;
392
- }, TResult>>;
393
- /**
394
- * Update the VSchema for the keyspace
395
- *
396
- * @description ### Authorization
397
- * A service token must have at least one of the following access in order to use this API endpoint:
398
- *
399
- * **Service Token Accesses**
400
- * `write_production_branch_vschema`, `write_branch_vschema`
401
- */
402
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateKeyspaceVschemaData, TResult>) => Promise<ResponseType<{
403
- raw: string;
404
- }, TResult>>;
405
- };
406
- /**
407
- * Get a keyspace
408
- *
409
- */
410
- get: <TResult extends ResultType = "json">(params: RequestType<GetKeyspaceData, TResult>) => Promise<ResponseType<DatabaseBranchKeyspace, TResult>>;
411
- /**
412
- * Configure keyspace settings
413
- *
414
- */
415
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateKeyspaceData, TResult>) => Promise<ResponseType<DatabaseBranchKeyspace, TResult>>;
416
- /**
417
- * Delete a keyspace
418
- *
419
- */
420
- delete: <TResult extends ResultType = "json">(params: RequestType<DeleteKeyspaceData, TResult>) => Promise<ResponseType<unknown, TResult>>;
421
- rolloutStatus: {
422
- /**
423
- * Get keyspace rollout status
424
- *
425
- */
426
- get: <TResult extends ResultType = "json">(params: RequestType<GetKeyspaceRolloutStatusData, TResult>) => Promise<ResponseType<{
427
- name: string;
428
- state: string;
429
- shards: Array<{
430
- name: string;
431
- last_rollout_started_at: string;
432
- last_rollout_finished_at: string;
433
- state: string;
434
- }>;
435
- }, TResult>>;
436
- };
437
- resizes: {
438
- /**
439
- * List keyspace resizes
440
- *
441
- */
442
- list: <TResult extends ResultType = "json">(params: RequestType<ListKeyspaceResizesData, TResult>) => Promise<ResponseType<PaginatedKeyspaceResizeRequest, TResult>>;
443
- };
444
- };
445
- parameters: {
446
- /**
447
- * List cluster parameters
448
- *
449
- * @description ### Authorization
450
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
451
- *
452
- * **Service Token Accesses**
453
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
454
- *
455
- * **OAuth Scopes**
456
- *
457
- * | Resource | Scopes |
458
- * | :------- | :---------- |
459
- * | Organization | `read_branches` |
460
- * | Database | `read_branches` |
461
- * | Branch | `read_branch` |
462
- */
463
- list: <TResult extends ResultType = "json">(params: RequestType<ListParametersData, TResult>) => Promise<ResponseType<import("./types.gen.ts").PostgresClusterParameter[], TResult>>;
464
- };
465
- passwords: {
466
- /**
467
- * List passwords
468
- *
469
- * @description ### Authorization
470
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
471
- *
472
- * **Service Token Accesses**
473
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
474
- *
475
- * **OAuth Scopes**
476
- *
477
- * | Resource | Scopes |
478
- * | :------- | :---------- |
479
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
480
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
481
- * | Branch | `manage_passwords` |
482
- */
483
- list: <TResult extends ResultType = "json">(params: RequestType<ListPasswordsData, TResult>) => Promise<ResponseType<PaginatedDatabaseBranchPassword, TResult>>;
484
- /**
485
- * Create a password
486
- *
487
- * @description ### Authorization
488
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
489
- *
490
- * **Service Token Accesses**
491
- * `connect_production_branch`, `connect_branch`
492
- *
493
- * **OAuth Scopes**
494
- *
495
- * | Resource | Scopes |
496
- * | :------- | :---------- |
497
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
498
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
499
- * | Branch | `manage_passwords` |
500
- */
501
- post: <TResult extends ResultType = "json">(params: RequestType<CreatePasswordData, TResult>) => Promise<ResponseType<DatabaseBranchPassword, TResult>>;
502
- /**
503
- * Get a password
504
- *
505
- * @description ### Authorization
506
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
507
- *
508
- * **Service Token Accesses**
509
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
510
- *
511
- * **OAuth Scopes**
512
- *
513
- * | Resource | Scopes |
514
- * | :------- | :---------- |
515
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
516
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
517
- * | Branch | `manage_passwords` |
518
- */
519
- get: <TResult extends ResultType = "json">(params: RequestType<GetPasswordData, TResult>) => Promise<ResponseType<DatabaseBranchPassword, TResult>>;
520
- /**
521
- * Update a password
522
- *
523
- * @description ### Authorization
524
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
525
- *
526
- * **Service Token Accesses**
527
- * `connect_production_branch`, `connect_branch`
528
- *
529
- * **OAuth Scopes**
530
- *
531
- * | Resource | Scopes |
532
- * | :------- | :---------- |
533
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
534
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
535
- * | Branch | `manage_passwords` |
536
- */
537
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdatePasswordData, TResult>) => Promise<ResponseType<DatabaseBranchPassword, TResult>>;
538
- /**
539
- * Delete a password
540
- *
541
- * @description ### Authorization
542
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
543
- *
544
- * **Service Token Accesses**
545
- * `delete_production_branch_password`, `delete_branch_password`
546
- *
547
- * **OAuth Scopes**
548
- *
549
- * | Resource | Scopes |
550
- * | :------- | :---------- |
551
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
552
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
553
- * | Branch | `manage_passwords` |
554
- */
555
- delete: <TResult extends ResultType = "json">(params: RequestType<DeletePasswordData, TResult>) => Promise<ResponseType<unknown, TResult>>;
556
- renew: {
557
- /**
558
- * Renew a password
559
- *
560
- * @description ### Authorization
561
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
562
- *
563
- * **Service Token Accesses**
564
- * `connect_production_branch`, `connect_branch`
565
- *
566
- * **OAuth Scopes**
567
- *
568
- * | Resource | Scopes |
569
- * | :------- | :---------- |
570
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
571
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
572
- * | Branch | `manage_passwords` |
573
- */
574
- post: <TResult extends ResultType = "json">(params: RequestType<RenewPasswordData, TResult>) => Promise<ResponseType<DatabaseBranchPassword, TResult>>;
575
- };
576
- };
577
- queryPatterns: {
578
- /**
579
- * List generated query patterns reports
580
- *
581
- * @description ### Authorization
582
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
583
- *
584
- * **Service Token Accesses**
585
- * `read_branch`
586
- *
587
- * **OAuth Scopes**
588
- *
589
- * | Resource | Scopes |
590
- * | :------- | :---------- |
591
- * | Organization | `read_branches` |
592
- * | Database | `read_branches` |
593
- * | Branch | `read_branch` |
594
- */
595
- list: <TResult extends ResultType = "json">(params: RequestType<ListGeneratedQueryPatternsReportsData, TResult>) => Promise<ResponseType<PaginatedQueryPatternsDownload, TResult>>;
596
- /**
597
- * Create a new query patterns report
598
- *
599
- * @description ### Authorization
600
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
601
- *
602
- * **Service Token Accesses**
603
- * `read_branch`
604
- *
605
- * **OAuth Scopes**
606
- *
607
- * | Resource | Scopes |
608
- * | :------- | :---------- |
609
- * | Organization | `read_branches` |
610
- * | Database | `read_branches` |
611
- * | Branch | `read_branch` |
612
- */
613
- post: <TResult extends ResultType = "json">(params: RequestType<CreateQueryPatternsReportData, TResult>) => Promise<ResponseType<QueryPatternsDownload, TResult>>;
614
- /**
615
- * Show the status of a query patterns report
616
- *
617
- * @description ### Authorization
618
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
619
- *
620
- * **Service Token Accesses**
621
- * `read_branch`
622
- *
623
- * **OAuth Scopes**
624
- *
625
- * | Resource | Scopes |
626
- * | :------- | :---------- |
627
- * | Organization | `read_branches` |
628
- * | Database | `read_branches` |
629
- * | Branch | `read_branch` |
630
- */
631
- get: <TResult extends ResultType = "json">(params: RequestType<GetQueryPatternsReportStatusData, TResult>) => Promise<ResponseType<QueryPatternsDownload, TResult>>;
632
- /**
633
- * Delete a query patterns report
634
- *
635
- * @description ### Authorization
636
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
637
- *
638
- * **Service Token Accesses**
639
- * `read_branch`
640
- *
641
- * **OAuth Scopes**
642
- *
643
- * | Resource | Scopes |
644
- * | :------- | :---------- |
645
- * | Organization | `read_branches` |
646
- * | Database | `read_branches` |
647
- * | Branch | `read_branch` |
648
- */
649
- delete: <TResult extends ResultType = "json">(params: RequestType<DeleteQueryPatternsReportData, TResult>) => Promise<ResponseType<unknown, TResult>>;
650
- download: {
651
- /**
652
- * Download a finished query patterns report
653
- *
654
- * @description ### Authorization
655
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
656
- *
657
- * **Service Token Accesses**
658
- * `read_branch`
659
- *
660
- * **OAuth Scopes**
661
- *
662
- * | Resource | Scopes |
663
- * | :------- | :---------- |
664
- * | Organization | `read_branches` |
665
- * | Database | `read_branches` |
666
- * | Branch | `read_branch` |
667
- */
668
- get: <TResult extends ResultType = "json">(params: RequestType<GetQueryPatternsReportData, TResult>) => Promise<ResponseType<QueryPatternsDownload, TResult>>;
669
- };
670
- };
671
- resizes: {
672
- /**
673
- * Cancel a change request
674
- *
675
- * @description ### Authorization
676
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
677
- *
678
- * **Service Token Accesses**
679
- * `write_database`
680
- *
681
- * **OAuth Scopes**
682
- *
683
- * | Resource | Scopes |
684
- * | :------- | :---------- |
685
- * | Organization | `write_databases` |
686
- * | Database | `write_database` |
687
- */
688
- delete: <TResult extends ResultType = "json">(params: RequestType<CancelBranchChangeRequestData, TResult>) => Promise<ResponseType<unknown, TResult>>;
689
- };
690
- roles: {
691
- /**
692
- * List roles
693
- *
694
- * @description ### Authorization
695
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
696
- *
697
- * **Service Token Accesses**
698
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
699
- *
700
- * **OAuth Scopes**
701
- *
702
- * | Resource | Scopes |
703
- * | :------- | :---------- |
704
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
705
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
706
- * | Branch | `manage_passwords` |
707
- */
708
- list: <TResult extends ResultType = "json">(params: RequestType<ListRolesData, TResult>) => Promise<ResponseType<PaginatedPostgresRole, TResult>>;
709
- /**
710
- * Create role credentials
711
- *
712
- * @description ### Authorization
713
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
714
- *
715
- * **Service Token Accesses**
716
- * `create_production_branch_password`, `create_branch_password`
717
- *
718
- * **OAuth Scopes**
719
- *
720
- * | Resource | Scopes |
721
- * | :------- | :---------- |
722
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
723
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
724
- * | Branch | `manage_passwords` |
725
- */
726
- post: <TResult extends ResultType = "json">(params: RequestType<CreateRoleData, TResult>) => Promise<ResponseType<PostgresRole, TResult>>;
727
- /**
728
- * Get a role
729
- *
730
- * @description ### Authorization
731
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
732
- *
733
- * **Service Token Accesses**
734
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
735
- *
736
- * **OAuth Scopes**
737
- *
738
- * | Resource | Scopes |
739
- * | :------- | :---------- |
740
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
741
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
742
- * | Branch | `manage_passwords` |
743
- */
744
- get: <TResult extends ResultType = "json">(params: RequestType<GetRoleData, TResult>) => Promise<ResponseType<PostgresRole, TResult>>;
745
- /**
746
- * Update role name
747
- *
748
- * @description ### Authorization
749
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
750
- *
751
- * **Service Token Accesses**
752
- * `create_production_branch_password`, `create_branch_password`
753
- *
754
- * **OAuth Scopes**
755
- *
756
- * | Resource | Scopes |
757
- * | :------- | :---------- |
758
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
759
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
760
- * | Branch | `manage_passwords` |
761
- */
762
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateRoleData, TResult>) => Promise<ResponseType<PostgresRole, TResult>>;
763
- /**
764
- * Delete role credentials
765
- *
766
- * @description ### Authorization
767
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
768
- *
769
- * **Service Token Accesses**
770
- * `delete_production_branch_password`, `delete_branch_password`
771
- *
772
- * **OAuth Scopes**
773
- *
774
- * | Resource | Scopes |
775
- * | :------- | :---------- |
776
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
777
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
778
- * | Branch | `manage_passwords` |
779
- */
780
- delete: <TResult extends ResultType = "json">(params: RequestType<DeleteRoleData, TResult>) => Promise<ResponseType<unknown, TResult>>;
781
- renew: {
782
- /**
783
- * Renew role expiration
784
- *
785
- * @description ### Authorization
786
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
787
- *
788
- * **Service Token Accesses**
789
- * `create_production_branch_password`, `create_branch_password`
790
- *
791
- * **OAuth Scopes**
792
- *
793
- * | Resource | Scopes |
794
- * | :------- | :---------- |
795
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
796
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
797
- * | Branch | `manage_passwords` |
798
- */
799
- post: <TResult extends ResultType = "json">(params: RequestType<RenewRoleData, TResult>) => Promise<ResponseType<PostgresRole, TResult>>;
800
- };
801
- };
802
- /**
803
- * Get a branch
804
- *
805
- * @description ### Authorization
806
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
807
- *
808
- * **Service Token Accesses**
809
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
810
- *
811
- * **OAuth Scopes**
812
- *
813
- * | Resource | Scopes |
814
- * | :------- | :---------- |
815
- * | Organization | `read_branches` |
816
- * | Database | `read_branches` |
817
- * | Branch | `read_branch` |
818
- */
819
- get: <TResult extends ResultType = "json">(params: RequestType<GetBranchData, TResult>) => Promise<ResponseType<DatabaseBranch, TResult>>;
820
- /**
821
- * Delete a branch
822
- *
823
- * @description ### Authorization
824
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
825
- *
826
- * **Service Token Accesses**
827
- * `delete_branch`
828
- *
829
- * **OAuth Scopes**
830
- *
831
- * | Resource | Scopes |
832
- * | :------- | :---------- |
833
- * | Organization | `delete_branches`, `delete_production_branches` |
834
- * | Database | `delete_branches`, `delete_production_branches` |
835
- * | Branch | `delete_branch` |
836
- */
837
- delete: <TResult extends ResultType = "json">(params: RequestType<DeleteBranchData, TResult>) => Promise<ResponseType<unknown, TResult>>;
838
- cluster: {
839
- /**
840
- * Change a branch cluster configuration
841
- *
842
- * @description ### Authorization
843
- * A service token must have at least one of the following access in order to use this API endpoint:
844
- *
845
- * **Service Token Accesses**
846
- * `write_database`
847
- */
848
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateBranchClusterConfigData, TResult>) => Promise<ResponseType<unknown, TResult>>;
849
- };
850
- demote: {
851
- /**
852
- * Demote a branch
853
- *
854
- * @description Demotes a branch from production to development
855
- * ### Authorization
856
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
857
- *
858
- * **Service Token Accesses**
859
- * `connect_production_branch`, `demote_branches`
860
- *
861
- * **OAuth Scopes**
862
- *
863
- * | Resource | Scopes |
864
- * | :------- | :---------- |
865
- * | Organization | `demote_branches` |
866
- * | Database | `demote_branches` |
867
- */
868
- post: <TResult extends ResultType = "json">(params: RequestType<DemoteBranchData, TResult>) => Promise<ResponseType<DatabaseBranch, TResult>>;
869
- };
870
- promote: {
871
- /**
872
- * Promote a branch
873
- *
874
- * @description Promotes a branch from development to production
875
- * ### Authorization
876
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
877
- *
878
- * **Service Token Accesses**
879
- * `connect_production_branch`, `promote_branches`
880
- *
881
- * **OAuth Scopes**
882
- *
883
- * | Resource | Scopes |
884
- * | :------- | :---------- |
885
- * | Organization | `promote_branches` |
886
- * | Database | `promote_branches` |
887
- */
888
- post: <TResult extends ResultType = "json">(params: RequestType<PromoteBranchData, TResult>) => Promise<ResponseType<DatabaseBranch, TResult>>;
889
- };
890
- safeMigrations: {
891
- /**
892
- * Enable safe migrations for a branch
893
- *
894
- */
895
- post: <TResult extends ResultType = "json">(params: RequestType<EnableSafeMigrationsData, TResult>) => Promise<ResponseType<DatabaseBranch, TResult>>;
896
- /**
897
- * Disable safe migrations for a branch
898
- *
899
- */
900
- delete: <TResult extends ResultType = "json">(params: RequestType<DisableSafeMigrationsData, TResult>) => Promise<ResponseType<DatabaseBranch, TResult>>;
901
- };
902
- schema: {
903
- /**
904
- * Get a branch schema
905
- *
906
- * @description ### Authorization
907
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
908
- *
909
- * **Service Token Accesses**
910
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
911
- *
912
- * **OAuth Scopes**
913
- *
914
- * | Resource | Scopes |
915
- * | :------- | :---------- |
916
- * | Organization | `read_branches` |
917
- * | Database | `read_branches` |
918
- * | Branch | `read_branch` |
919
- */
920
- get: <TResult extends ResultType = "json">(params: RequestType<GetBranchSchemaData, TResult>) => Promise<ResponseType<{
921
- data: Array<{
922
- name: string;
923
- html: string;
924
- raw: string;
925
- }>;
926
- }, TResult>>;
927
- lint: {
928
- /**
929
- * Lint a branch schema
930
- *
931
- * @description ### Authorization
932
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
933
- *
934
- * **Service Token Accesses**
935
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
936
- *
937
- * **OAuth Scopes**
938
- *
939
- * | Resource | Scopes |
940
- * | :------- | :---------- |
941
- * | Organization | `read_branches` |
942
- * | Database | `read_branches` |
943
- * | Branch | `read_branch` |
944
- */
945
- get: <TResult extends ResultType = "json">(params: RequestType<LintBranchSchemaData, TResult>) => Promise<ResponseType<PaginatedSchemaLintError, TResult>>;
946
- };
947
- };
948
- };
949
- deployQueue: {
950
- /**
951
- * Get the deploy queue
952
- *
953
- * @description The deploy queue returns the current list of deploy requests in the order they will be deployed.
954
- */
955
- get: <TResult extends ResultType = "json">(params: RequestType<GetDeployQueueData, TResult>) => Promise<ResponseType<PaginatedDeployment, TResult>>;
956
- };
957
- deployRequests: {
958
- /**
959
- * List deploy requests
960
- *
961
- * @description List deploy requests for a database
962
- * ### Authorization
963
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
964
- *
965
- * **Service Token Accesses**
966
- * `read_deploy_request`
967
- *
968
- * **OAuth Scopes**
969
- *
970
- * | Resource | Scopes |
971
- * | :------- | :---------- |
972
- * | Organization | `read_deploy_requests` |
973
- * | Database | `read_deploy_requests` |
974
- */
975
- list: <TResult extends ResultType = "json">(params: RequestType<ListDeployRequestsData, TResult>) => Promise<ResponseType<PaginatedDatabaseDeployRequest, TResult>>;
976
- /**
977
- * Create a deploy request
978
- *
979
- * @description ### Authorization
980
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
981
- *
982
- * **Service Token Accesses**
983
- * `read_deploy_request`, `create_deploy_requests`
984
- *
985
- * **OAuth Scopes**
986
- *
987
- * | Resource | Scopes |
988
- * | :------- | :---------- |
989
- * | Organization | `write_deploy_requests` |
990
- * | Database | `write_deploy_requests` |
991
- */
992
- post: <TResult extends ResultType = "json">(params: RequestType<CreateDeployRequestData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
993
- /**
994
- * Get a deploy request
995
- *
996
- * @description ### Authorization
997
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
998
- *
999
- * **Service Token Accesses**
1000
- * `read_deploy_request`
1001
- *
1002
- * **OAuth Scopes**
1003
- *
1004
- * | Resource | Scopes |
1005
- * | :------- | :---------- |
1006
- * | Organization | `read_deploy_requests` |
1007
- * | Database | `read_deploy_requests` |
1008
- */
1009
- get: <TResult extends ResultType = "json">(params: RequestType<GetDeployRequestData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
1010
- /**
1011
- * Close a deploy request
1012
- *
1013
- * @description ### Authorization
1014
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1015
- *
1016
- * **Service Token Accesses**
1017
- * `read_deploy_request`
1018
- *
1019
- * **OAuth Scopes**
1020
- *
1021
- * | Resource | Scopes |
1022
- * | :------- | :---------- |
1023
- * | Organization | `write_deploy_requests` |
1024
- * | Database | `write_deploy_requests` |
1025
- */
1026
- patch: <TResult extends ResultType = "json">(params: RequestType<CloseDeployRequestData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
1027
- applyDeploy: {
1028
- /**
1029
- * Complete a gated deploy request
1030
- *
1031
- * @description ### Authorization
1032
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1033
- *
1034
- * **Service Token Accesses**
1035
- * `read_deploy_request`, `create_deploy_request`
1036
- *
1037
- * **OAuth Scopes**
1038
- *
1039
- * | Resource | Scopes |
1040
- * | :------- | :---------- |
1041
- * | Organization | `deploy_deploy_requests` |
1042
- * | Database | `deploy_deploy_requests` |
1043
- */
1044
- post: <TResult extends ResultType = "json">(params: RequestType<CompleteGatedDeployRequestData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
1045
- };
1046
- autoApply: {
1047
- /**
1048
- * Update auto-apply for deploy request
1049
- *
1050
- * @description Enables or disabled the auto-apply setting for a deploy request
1051
- * ### Authorization
1052
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1053
- *
1054
- * **Service Token Accesses**
1055
- * `read_deploy_request`, `create_deploy_request`
1056
- *
1057
- * **OAuth Scopes**
1058
- *
1059
- * | Resource | Scopes |
1060
- * | :------- | :---------- |
1061
- * | Organization | `deploy_deploy_requests` |
1062
- * | Database | `deploy_deploy_requests` |
1063
- */
1064
- put: <TResult extends ResultType = "json">(params: RequestType<UpdateAutoApplyData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
1065
- };
1066
- cancel: {
1067
- /**
1068
- * Cancel a queued deploy request
1069
- *
1070
- * @description ### Authorization
1071
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1072
- *
1073
- * **Service Token Accesses**
1074
- * `read_deploy_request`, `create_deploy_request`
1075
- *
1076
- * **OAuth Scopes**
1077
- *
1078
- * | Resource | Scopes |
1079
- * | :------- | :---------- |
1080
- * | Organization | `deploy_deploy_requests` |
1081
- * | Database | `deploy_deploy_requests` |
1082
- */
1083
- post: <TResult extends ResultType = "json">(params: RequestType<CancelDeployRequestData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
1084
- };
1085
- completeDeploy: {
1086
- /**
1087
- * Complete an errored deploy
1088
- *
1089
- * @description ### Authorization
1090
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1091
- *
1092
- * **Service Token Accesses**
1093
- * `read_deploy_request`, `create_deploy_request`
1094
- *
1095
- * **OAuth Scopes**
1096
- *
1097
- * | Resource | Scopes |
1098
- * | :------- | :---------- |
1099
- * | Organization | `deploy_deploy_requests` |
1100
- * | Database | `deploy_deploy_requests` |
1101
- */
1102
- post: <TResult extends ResultType = "json">(params: RequestType<CompleteErroredDeployData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
1103
- };
1104
- deploy: {
1105
- /**
1106
- * Queue a deploy request
1107
- *
1108
- * @description ### Authorization
1109
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1110
- *
1111
- * **Service Token Accesses**
1112
- * `read_deploy_request`, `create_deploy_request`
1113
- *
1114
- * **OAuth Scopes**
1115
- *
1116
- * | Resource | Scopes |
1117
- * | :------- | :---------- |
1118
- * | Organization | `deploy_deploy_requests` |
1119
- * | Database | `deploy_deploy_requests` |
1120
- */
1121
- post: <TResult extends ResultType = "json">(params: RequestType<QueueDeployRequestData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
1122
- };
1123
- deployment: {
1124
- /**
1125
- * Get a deployment
1126
- *
1127
- * @description Get the deployment for a deploy request
1128
- * ### Authorization
1129
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1130
- *
1131
- * **Service Token Accesses**
1132
- * `read_deploy_request`
1133
- *
1134
- * **OAuth Scopes**
1135
- *
1136
- * | Resource | Scopes |
1137
- * | :------- | :---------- |
1138
- * | Organization | `read_deploy_requests` |
1139
- * | Database | `read_deploy_requests` |
1140
- */
1141
- get: <TResult extends ResultType = "json">(params: RequestType<GetDeploymentData, TResult>) => Promise<ResponseType<Deployment, TResult>>;
1142
- };
1143
- operations: {
1144
- /**
1145
- * List deploy operations
1146
- *
1147
- * @description List deploy operations for a deploy request
1148
- * ### Authorization
1149
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1150
- *
1151
- * **Service Token Accesses**
1152
- * `read_deploy_request`
1153
- *
1154
- * **OAuth Scopes**
1155
- *
1156
- * | Resource | Scopes |
1157
- * | :------- | :---------- |
1158
- * | Organization | `read_deploy_requests` |
1159
- * | Database | `read_deploy_requests` |
1160
- */
1161
- list: <TResult extends ResultType = "json">(params: RequestType<ListDeployOperationsData, TResult>) => Promise<ResponseType<PaginatedDeployOperation, TResult>>;
1162
- };
1163
- revert: {
1164
- /**
1165
- * Complete a revert
1166
- *
1167
- * @description ### Authorization
1168
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1169
- *
1170
- * **Service Token Accesses**
1171
- * `read_deploy_request`, `create_deploy_request`
1172
- *
1173
- * **OAuth Scopes**
1174
- *
1175
- * | Resource | Scopes |
1176
- * | :------- | :---------- |
1177
- * | Organization | `deploy_deploy_requests` |
1178
- * | Database | `deploy_deploy_requests` |
1179
- */
1180
- post: <TResult extends ResultType = "json">(params: RequestType<CompleteRevertData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
1181
- };
1182
- reviews: {
1183
- /**
1184
- * List deploy request reviews
1185
- *
1186
- * @description ### Authorization
1187
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1188
- *
1189
- * **Service Token Accesses**
1190
- * `read_deploy_request`
1191
- *
1192
- * **OAuth Scopes**
1193
- *
1194
- * | Resource | Scopes |
1195
- * | :------- | :---------- |
1196
- * | Organization | `read_deploy_requests` |
1197
- * | Database | `read_deploy_requests` |
1198
- */
1199
- list: <TResult extends ResultType = "json">(params: RequestType<ListDeployRequestReviewsData, TResult>) => Promise<ResponseType<PaginatedDeployRequestReview, TResult>>;
1200
- /**
1201
- * Review a deploy request
1202
- *
1203
- * @description Review a deploy request by either approving or commenting on the deploy request
1204
- * ### Authorization
1205
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1206
- *
1207
- * **Service Token Accesses**
1208
- * `approve_deploy_request`, `review_deploy_request`
1209
- *
1210
- * **OAuth Scopes**
1211
- *
1212
- * | Resource | Scopes |
1213
- * | :------- | :---------- |
1214
- * | Organization | `approve_deploy_requests` |
1215
- * | Database | `approve_deploy_requests` |
1216
- */
1217
- post: <TResult extends ResultType = "json">(params: RequestType<ReviewDeployRequestData, TResult>) => Promise<ResponseType<DeployRequestReview, TResult>>;
1218
- };
1219
- skipRevert: {
1220
- /**
1221
- * Skip revert period
1222
- *
1223
- * @description Skips the revert period for a deploy request
1224
- * ### Authorization
1225
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1226
- *
1227
- * **Service Token Accesses**
1228
- * `read_deploy_request`, `create_deploy_request`
1229
- *
1230
- * **OAuth Scopes**
1231
- *
1232
- * | Resource | Scopes |
1233
- * | :------- | :---------- |
1234
- * | Organization | `deploy_deploy_requests` |
1235
- * | Database | `deploy_deploy_requests` |
1236
- */
1237
- post: <TResult extends ResultType = "json">(params: RequestType<SkipRevertPeriodData, TResult>) => Promise<ResponseType<DatabaseDeployRequest, TResult>>;
1238
- };
1239
- throttler: {
1240
- /**
1241
- * Get deploy request throttler configurations
1242
- *
1243
- * @description ### Authorization
1244
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1245
- *
1246
- * **Service Token Accesses**
1247
- * `read_deploy_request`
1248
- *
1249
- * **OAuth Scopes**
1250
- *
1251
- * | Resource | Scopes |
1252
- * | :------- | :---------- |
1253
- * | Organization | `read_deploy_requests` |
1254
- * | Database | `read_deploy_requests` |
1255
- */
1256
- get: <TResult extends ResultType = "json">(params: RequestType<GetDeployRequestThrottlerData, TResult>) => Promise<ResponseType<ThrottlerConfigurations, TResult>>;
1257
- /**
1258
- * Update deploy request throttler configurations
1259
- *
1260
- * @description ### Authorization
1261
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1262
- *
1263
- * **Service Token Accesses**
1264
- * `read_deploy_request`, `create_deploy_request`
1265
- *
1266
- * **OAuth Scopes**
1267
- *
1268
- * | Resource | Scopes |
1269
- * | :------- | :---------- |
1270
- * | Organization | `deploy_deploy_requests` |
1271
- * | Database | `deploy_deploy_requests` |
1272
- */
1273
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateDeployRequestThrottlerData, TResult>) => Promise<ResponseType<ThrottlerConfigurations, TResult>>;
1274
- };
1275
- };
1276
- throttler: {
1277
- /**
1278
- * Get database throttler configurations
1279
- *
1280
- * @description ### Authorization
1281
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1282
- *
1283
- * **Service Token Accesses**
1284
- * `read_deploy_request`, `create_deploy_request`
1285
- *
1286
- * **OAuth Scopes**
1287
- *
1288
- * | Resource | Scopes |
1289
- * | :------- | :---------- |
1290
- * | Organization | `read_databases` |
1291
- * | Database | `read_database` |
1292
- */
1293
- get: <TResult extends ResultType = "json">(params: RequestType<GetDatabaseThrottlerData, TResult>) => Promise<ResponseType<ThrottlerConfigurations, TResult>>;
1294
- /**
1295
- * Update database throttler configurations
1296
- *
1297
- * @description ### Authorization
1298
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1299
- *
1300
- * **Service Token Accesses**
1301
- * `read_deploy_request`, `create_deploy_request`
1302
- *
1303
- * **OAuth Scopes**
1304
- *
1305
- * | Resource | Scopes |
1306
- * | :------- | :---------- |
1307
- * | Organization | `deploy_deploy_requests` |
1308
- * | Database | `deploy_deploy_requests` |
1309
- */
1310
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateDatabaseThrottlerData, TResult>) => Promise<ResponseType<ThrottlerConfigurations, TResult>>;
1311
- };
1312
- webhooks: {
1313
- /**
1314
- * List webhooks
1315
- *
1316
- * @description List webhooks for a database
1317
- * ### Authorization
1318
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1319
- *
1320
- * **Service Token Accesses**
1321
- * `read_database`
1322
- *
1323
- * **OAuth Scopes**
1324
- *
1325
- * | Resource | Scopes |
1326
- * | :------- | :---------- |
1327
- * | Organization | `read_databases` |
1328
- * | Database | `read_database` |
1329
- */
1330
- list: <TResult extends ResultType = "json">(params: RequestType<ListWebhooksData, TResult>) => Promise<ResponseType<PaginatedDatabaseWebhook, TResult>>;
1331
- /**
1332
- * Create a webhook
1333
- *
1334
- * @description ### Authorization
1335
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1336
- *
1337
- * **Service Token Accesses**
1338
- * `write_database`
1339
- *
1340
- * **OAuth Scopes**
1341
- *
1342
- * | Resource | Scopes |
1343
- * | :------- | :---------- |
1344
- * | Organization | `write_databases` |
1345
- * | Database | `write_database` |
1346
- */
1347
- post: <TResult extends ResultType = "json">(params: RequestType<CreateWebhookData, TResult>) => Promise<ResponseType<DatabaseWebhook, TResult>>;
1348
- /**
1349
- * Get a webhook
1350
- *
1351
- * @description ### Authorization
1352
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1353
- *
1354
- * **Service Token Accesses**
1355
- * `read_database`
1356
- *
1357
- * **OAuth Scopes**
1358
- *
1359
- * | Resource | Scopes |
1360
- * | :------- | :---------- |
1361
- * | Organization | `read_databases` |
1362
- * | Database | `read_database` |
1363
- */
1364
- get: <TResult extends ResultType = "json">(params: RequestType<GetWebhookData, TResult>) => Promise<ResponseType<DatabaseWebhook, TResult>>;
1365
- /**
1366
- * Update a webhook
1367
- *
1368
- * @description ### Authorization
1369
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1370
- *
1371
- * **Service Token Accesses**
1372
- * `write_database`
1373
- *
1374
- * **OAuth Scopes**
1375
- *
1376
- * | Resource | Scopes |
1377
- * | :------- | :---------- |
1378
- * | Organization | `write_databases` |
1379
- * | Database | `write_database` |
1380
- */
1381
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateWebhookData, TResult>) => Promise<ResponseType<DatabaseWebhook, TResult>>;
1382
- /**
1383
- * Delete a webhook
1384
- *
1385
- * @description ### Authorization
1386
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1387
- *
1388
- * **Service Token Accesses**
1389
- * `write_database`
1390
- *
1391
- * **OAuth Scopes**
1392
- *
1393
- * | Resource | Scopes |
1394
- * | :------- | :---------- |
1395
- * | Organization | `write_databases` |
1396
- * | Database | `write_database` |
1397
- */
1398
- delete: <TResult extends ResultType = "json">(params: RequestType<DeleteWebhookData, TResult>) => Promise<ResponseType<unknown, TResult>>;
1399
- test: {
1400
- /**
1401
- * Test a webhook
1402
- *
1403
- * @description Sends a test event to the webhook
1404
- * ### Authorization
1405
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1406
- *
1407
- * **Service Token Accesses**
1408
- * `write_database`
1409
- *
1410
- * **OAuth Scopes**
1411
- *
1412
- * | Resource | Scopes |
1413
- * | :------- | :---------- |
1414
- * | Organization | `write_databases` |
1415
- * | Database | `write_database` |
1416
- */
1417
- post: <TResult extends ResultType = "json">(params: RequestType<TestWebhookData, TResult>) => Promise<ResponseType<unknown, TResult>>;
1418
- };
1419
- };
1420
- workflows: {
1421
- /**
1422
- * List workflows
1423
- *
1424
- */
1425
- list: <TResult extends ResultType = "json">(params: RequestType<ListWorkflowsData, TResult>) => Promise<ResponseType<PaginatedWorkflow, TResult>>;
1426
- /**
1427
- * Create a workflow
1428
- *
1429
- */
1430
- post: <TResult extends ResultType = "json">(params: RequestType<CreateWorkflowData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1431
- /**
1432
- * Get a workflow
1433
- *
1434
- */
1435
- get: <TResult extends ResultType = "json">(params: RequestType<GetWorkflowData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1436
- /**
1437
- * Cancel a workflow
1438
- *
1439
- */
1440
- delete: <TResult extends ResultType = "json">(params: RequestType<WorkflowCancelData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1441
- complete: {
1442
- /**
1443
- * Complete a workflow
1444
- *
1445
- */
1446
- patch: <TResult extends ResultType = "json">(params: RequestType<WorkflowCompleteData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1447
- };
1448
- cutover: {
1449
- /**
1450
- * Cutover traffic
1451
- *
1452
- */
1453
- patch: <TResult extends ResultType = "json">(params: RequestType<WorkflowCutoverData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1454
- };
1455
- retry: {
1456
- /**
1457
- * Retry a failed workflow
1458
- *
1459
- */
1460
- patch: <TResult extends ResultType = "json">(params: RequestType<WorkflowRetryData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1461
- };
1462
- reverseCutover: {
1463
- /**
1464
- * Reverse traffic cutover
1465
- *
1466
- */
1467
- patch: <TResult extends ResultType = "json">(params: RequestType<WorkflowReverseCutoverData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1468
- };
1469
- reverseTraffic: {
1470
- /**
1471
- * Reverse traffic
1472
- *
1473
- */
1474
- patch: <TResult extends ResultType = "json">(params: RequestType<WorkflowReverseTrafficData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1475
- };
1476
- switchPrimaries: {
1477
- /**
1478
- * Switch primary traffic
1479
- *
1480
- */
1481
- patch: <TResult extends ResultType = "json">(params: RequestType<WorkflowSwitchPrimariesData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1482
- };
1483
- switchReplicas: {
1484
- /**
1485
- * Switch replica traffic
1486
- *
1487
- */
1488
- patch: <TResult extends ResultType = "json">(params: RequestType<WorkflowSwitchReplicasData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1489
- };
1490
- verifyData: {
1491
- /**
1492
- * Verify workflow data
1493
- *
1494
- */
1495
- patch: <TResult extends ResultType = "json">(params: RequestType<VerifyWorkflowData, TResult>) => Promise<ResponseType<Workflow, TResult>>;
1496
- };
1497
- };
1498
- /**
1499
- * Get a database
1500
- *
1501
- * @description ### Authorization
1502
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1503
- *
1504
- * **Service Token Accesses**
1505
- * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `delete_branch_password`, `delete_production_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_schema_recommendations`, `close_schema_recommendations`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
1506
- *
1507
- * **OAuth Scopes**
1508
- *
1509
- * | Resource | Scopes |
1510
- * | :------- | :---------- |
1511
- * | Organization | `read_databases` |
1512
- * | Database | `read_database` |
1513
- */
1514
- get: <TResult extends ResultType = "json">(params: RequestType<GetDatabaseData, TResult>) => Promise<ResponseType<Database, TResult>>;
1515
- /**
1516
- * Update database settings
1517
- *
1518
- * @description ### Authorization
1519
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1520
- *
1521
- * **Service Token Accesses**
1522
- * `write_database`
1523
- *
1524
- * **OAuth Scopes**
1525
- *
1526
- * | Resource | Scopes |
1527
- * | :------- | :---------- |
1528
- * | Organization | `write_databases` |
1529
- * | Database | `write_database` |
1530
- */
1531
- patch: <TResult extends ResultType = "json">(params: RequestType<UpdateDatabaseSettingsData, TResult>) => Promise<ResponseType<Database, TResult>>;
1532
- /**
1533
- * Delete a database
1534
- *
1535
- * @description ### Authorization
1536
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1537
- *
1538
- * **Service Token Accesses**
1539
- * `delete_database`
1540
- *
1541
- * **OAuth Scopes**
1542
- *
1543
- * | Resource | Scopes |
1544
- * | :------- | :---------- |
1545
- * | Organization | `delete_databases` |
1546
- * | Database | `delete_database` |
1547
- */
1548
- delete: <TResult extends ResultType = "json">(params: RequestType<DeleteDatabaseData, TResult>) => Promise<ResponseType<unknown, TResult>>;
1549
- readOnlyRegions: {
1550
- /**
1551
- * List read-only regions
1552
- *
1553
- * @description List read-only regions for the database's default branch
1554
- * ### Authorization
1555
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1556
- *
1557
- * **Service Token Accesses**
1558
- * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `delete_branch_password`, `delete_production_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_schema_recommendations`, `close_schema_recommendations`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
1559
- *
1560
- * **OAuth Scopes**
1561
- *
1562
- * | Resource | Scopes |
1563
- * | :------- | :---------- |
1564
- * | Organization | `read_branches` |
1565
- * | Database | `read_branches` |
1566
- */
1567
- list: <TResult extends ResultType = "json">(params: RequestType<ListReadOnlyRegionsData, TResult>) => Promise<ResponseType<PaginatedDatabaseBranchReadOnlyRegion, TResult>>;
1568
- };
1569
- regions: {
1570
- /**
1571
- * List database regions
1572
- *
1573
- * @description ### Authorization
1574
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1575
- *
1576
- * **Service Token Accesses**
1577
- * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `delete_branch_password`, `delete_production_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_schema_recommendations`, `close_schema_recommendations`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
1578
- *
1579
- * **OAuth Scopes**
1580
- *
1581
- * | Resource | Scopes |
1582
- * | :------- | :---------- |
1583
- * | Organization | `read_databases` |
1584
- * | Database | `read_database` |
1585
- */
1586
- list: <TResult extends ResultType = "json">(params: RequestType<ListDatabaseRegionsData, TResult>) => Promise<ResponseType<PaginatedPlanetscaleRegion, TResult>>;
1587
- };
1588
- };
1589
- invoices: {
1590
- /**
1591
- * Get invoices
1592
- *
1593
- * @description Get the invoices for an organization
1594
- * ### Authorization
1595
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1596
- *
1597
- * **Service Token Accesses**
1598
- * `read_invoices`
1599
- *
1600
- * **OAuth Scopes**
1601
- *
1602
- * | Resource | Scopes |
1603
- * | :------- | :---------- |
1604
- * | Organization | `read_invoices` |
1605
- */
1606
- list: <TResult extends ResultType = "json">(params: RequestType<ListInvoicesData, TResult>) => Promise<ResponseType<PaginatedInvoice, TResult>>;
1607
- /**
1608
- * Get an invoice
1609
- *
1610
- * @description ### Authorization
1611
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1612
- *
1613
- * **Service Token Accesses**
1614
- * `read_invoices`
1615
- *
1616
- * **OAuth Scopes**
1617
- *
1618
- * | Resource | Scopes |
1619
- * | :------- | :---------- |
1620
- * | Organization | `read_invoices` |
1621
- */
1622
- get: <TResult extends ResultType = "json">(params: RequestType<GetInvoiceData, TResult>) => Promise<ResponseType<Invoice, TResult>>;
1623
- lineItems: {
1624
- /**
1625
- * Get invoice line items
1626
- *
1627
- * @description Get the line items for an invoice
1628
- * ### Authorization
1629
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1630
- *
1631
- * **Service Token Accesses**
1632
- * `read_invoices`
1633
- *
1634
- * **OAuth Scopes**
1635
- *
1636
- * | Resource | Scopes |
1637
- * | :------- | :---------- |
1638
- * | Organization | `read_invoices` |
1639
- */
1640
- get: <TResult extends ResultType = "json">(params: RequestType<GetInvoiceLineItemsData, TResult>) => Promise<ResponseType<PaginatedLineItem, TResult>>;
1641
- };
1642
- };
1643
- members: {
1644
- /**
1645
- * List organization members
1646
- *
1647
- * @description ### Authorization
1648
- * A service token must have at least one of the following access in order to use this API endpoint:
1649
- *
1650
- * **Service Token Accesses**
1651
- * `read_organization`
1652
- */
1653
- list: <TResult extends ResultType = "json">(params: RequestType<ListOrganizationMembersData, TResult>) => Promise<ResponseType<PaginatedOrganizationMembership, TResult>>;
1654
- };
1655
- oauthApplications: {
1656
- /**
1657
- * List OAuth applications
1658
- *
1659
- * @description ### Authorization
1660
- * A service token must have at least one of the following access in order to use this API endpoint:
1661
- *
1662
- * **Service Token Accesses**
1663
- * `read_oauth_applications`
1664
- */
1665
- list: <TResult extends ResultType = "json">(params: RequestType<ListOauthApplicationsData, TResult>) => Promise<ResponseType<PaginatedOauthApplication, TResult>>;
1666
- /**
1667
- * Get an OAuth application
1668
- *
1669
- * @description ### Authorization
1670
- * A service token must have at least one of the following access in order to use this API endpoint:
1671
- *
1672
- * **Service Token Accesses**
1673
- * `read_oauth_applications`
1674
- */
1675
- get: <TResult extends ResultType = "json">(params: RequestType<GetOauthApplicationData, TResult>) => Promise<ResponseType<OauthApplication, TResult>>;
1676
- tokens: {
1677
- /**
1678
- * List OAuth tokens
1679
- *
1680
- * @description List OAuth tokens created by an OAuth application
1681
- * ### Authorization
1682
- * A service token must have at least one of the following access in order to use this API endpoint:
1683
- *
1684
- * **Service Token Accesses**
1685
- * `read_oauth_tokens`
1686
- */
1687
- list: <TResult extends ResultType = "json">(params: RequestType<ListOauthTokensData, TResult>) => Promise<ResponseType<PaginatedServiceToken, TResult>>;
1688
- /**
1689
- * Get an OAuth token
1690
- *
1691
- * @description ### Authorization
1692
- * A service token must have at least one of the following access in order to use this API endpoint:
1693
- *
1694
- * **Service Token Accesses**
1695
- * `read_oauth_tokens`
1696
- */
1697
- get: <TResult extends ResultType = "json">(params: RequestType<GetOauthTokenData, TResult>) => Promise<ResponseType<ServiceToken, TResult>>;
1698
- /**
1699
- * Delete an OAuth token
1700
- *
1701
- * @description ### Authorization
1702
- * A service token must have at least one of the following access in order to use this API endpoint:
1703
- *
1704
- * **Service Token Accesses**
1705
- * `delete_oauth_tokens`
1706
- */
1707
- delete: <TResult extends ResultType = "json">(params: RequestType<DeleteOauthTokenData, TResult>) => Promise<ResponseType<unknown, TResult>>;
1708
- };
1709
- token: {
1710
- /**
1711
- * Create or renew an OAuth token
1712
- *
1713
- * @description Create an OAuth token from an authorization grant code, or refresh an OAuth token from a refresh token
1714
- * ### Authorization
1715
- * A service token must have at least one of the following access in order to use this API endpoint:
1716
- *
1717
- * **Service Token Accesses**
1718
- * `write_oauth_tokens`
1719
- */
1720
- post: <TResult extends ResultType = "json">(params: RequestType<CreateOauthTokenData, TResult>) => Promise<ResponseType<ServiceToken, TResult>>;
1721
- };
1722
- };
1723
- };
1724
- regions: {
1725
- /**
1726
- * List public regions
1727
- *
1728
- * @description Endpoint is available without authentication.
1729
- */
1730
- list: <TResult extends ResultType = "json">(params?: RequestType<ListPublicRegionsData, TResult>) => Promise<ResponseType<PaginatedPublicPlanetscaleRegionSerializer, TResult>>;
1731
- };
1732
- user: {
1733
- /**
1734
- * Get current user
1735
- *
1736
- * @description Get the user associated with this service token
1737
- * ### Authorization
1738
- * A OAuth token must have at least one of the following scopes in order to use this API endpoint:
1739
- *
1740
- * **OAuth Scopes**
1741
- *
1742
- * | Resource | Scopes |
1743
- * | :------- | :---------- |
1744
- * | User | `read_user` |
1745
- */
1746
- get: <TResult extends ResultType = "json">(params?: RequestType<GetCurrentUserData, TResult>) => Promise<ResponseType<User, TResult>>;
1747
- };
1748
- }
1749
- export {};
1
+ import { type ClientOptions, type Config } from "../../util/api/client/index.ts";
2
+ import type { ClientOptions as ClientOptions2 } from "./types.gen.ts";
3
+ /**
4
+ * The `createClientConfig()` function will be called on client initialization
5
+ * and the returned object will become the client's initial configuration.
6
+ *
7
+ * You may want to initialize your client this way instead of calling
8
+ * `setConfig()`. This is useful for example if you're using Next.js
9
+ * to ensure your client always has the correct values.
10
+ */
11
+ export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
12
+ export declare const client: import("../../util/api/client/types.gen.ts").Client;
1750
13
  //# sourceMappingURL=client.gen.d.ts.map