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.
- package/bin/alchemy.js +25563 -26265
- package/bin/alchemy.ts +6 -2
- package/bin/commands/configure.ts +194 -0
- package/bin/commands/login.ts +99 -55
- package/bin/commands/logout.ts +66 -0
- package/bin/trpc.ts +27 -2
- package/lib/apply.d.ts +2 -2
- package/lib/apply.d.ts.map +1 -1
- package/lib/apply.js +18 -15
- package/lib/apply.js.map +1 -1
- package/lib/auth.d.ts +72 -0
- package/lib/auth.d.ts.map +1 -0
- package/lib/auth.js +163 -0
- package/lib/auth.js.map +1 -0
- package/lib/aws/bucket.d.ts +12 -3
- package/lib/aws/bucket.d.ts.map +1 -1
- package/lib/aws/bucket.js +2 -2
- package/lib/aws/bucket.js.map +1 -1
- package/lib/aws/control/resource.d.ts +34 -3
- package/lib/aws/control/resource.d.ts.map +1 -1
- package/lib/aws/control/resource.js +3 -3
- package/lib/aws/control/resource.js.map +1 -1
- package/lib/aws/ec2/internet-gateway-attachment.d.ts +1 -2
- package/lib/aws/ec2/internet-gateway-attachment.d.ts.map +1 -1
- package/lib/aws/ec2/internet-gateway-attachment.js +4 -4
- package/lib/aws/ec2/internet-gateway-attachment.js.map +1 -1
- package/lib/aws/ec2/internet-gateway.d.ts +1 -2
- package/lib/aws/ec2/internet-gateway.d.ts.map +1 -1
- package/lib/aws/ec2/internet-gateway.js +2 -2
- package/lib/aws/ec2/internet-gateway.js.map +1 -1
- package/lib/aws/ec2/nat-gateway.d.ts +1 -2
- package/lib/aws/ec2/nat-gateway.d.ts.map +1 -1
- package/lib/aws/ec2/nat-gateway.js +2 -2
- package/lib/aws/ec2/nat-gateway.js.map +1 -1
- package/lib/aws/ec2/route-table-association.d.ts +1 -2
- package/lib/aws/ec2/route-table-association.d.ts.map +1 -1
- package/lib/aws/ec2/route-table-association.js +2 -2
- package/lib/aws/ec2/route-table-association.js.map +1 -1
- package/lib/aws/ec2/route-table.d.ts +1 -2
- package/lib/aws/ec2/route-table.d.ts.map +1 -1
- package/lib/aws/ec2/route-table.js +2 -2
- package/lib/aws/ec2/route-table.js.map +1 -1
- package/lib/aws/ec2/route.d.ts +1 -2
- package/lib/aws/ec2/route.d.ts.map +1 -1
- package/lib/aws/ec2/route.js +2 -2
- package/lib/aws/ec2/route.js.map +1 -1
- package/lib/aws/ec2/security-group-rule.d.ts +1 -2
- package/lib/aws/ec2/security-group-rule.d.ts.map +1 -1
- package/lib/aws/ec2/security-group-rule.js +2 -2
- package/lib/aws/ec2/security-group-rule.js.map +1 -1
- package/lib/aws/ec2/security-group.d.ts +1 -2
- package/lib/aws/ec2/security-group.d.ts.map +1 -1
- package/lib/aws/ec2/security-group.js +2 -2
- package/lib/aws/ec2/security-group.js.map +1 -1
- package/lib/aws/ec2/subnet.d.ts +1 -2
- package/lib/aws/ec2/subnet.d.ts.map +1 -1
- package/lib/aws/ec2/subnet.js +2 -2
- package/lib/aws/ec2/subnet.js.map +1 -1
- package/lib/aws/ec2/vpc.d.ts +1 -2
- package/lib/aws/ec2/vpc.d.ts.map +1 -1
- package/lib/aws/ec2/vpc.js +2 -2
- package/lib/aws/ec2/vpc.js.map +1 -1
- package/lib/aws/function.d.ts +116 -3
- package/lib/aws/function.d.ts.map +1 -1
- package/lib/aws/function.js +2 -2
- package/lib/aws/function.js.map +1 -1
- package/lib/aws/oidc/github-oidc-provider.d.ts +13 -2
- package/lib/aws/oidc/github-oidc-provider.d.ts.map +1 -1
- package/lib/aws/oidc/oidc-provider.d.ts +48 -3
- package/lib/aws/oidc/oidc-provider.d.ts.map +1 -1
- package/lib/aws/oidc/oidc-provider.js +2 -2
- package/lib/aws/oidc/oidc-provider.js.map +1 -1
- package/lib/aws/policy-attachment.d.ts +2 -3
- package/lib/aws/policy-attachment.d.ts.map +1 -1
- package/lib/aws/policy-attachment.js +1 -1
- package/lib/aws/policy-attachment.js.map +1 -1
- package/lib/aws/policy.d.ts +1 -2
- package/lib/aws/policy.d.ts.map +1 -1
- package/lib/aws/policy.js +4 -4
- package/lib/aws/policy.js.map +1 -1
- package/lib/aws/queue.d.ts +1 -2
- package/lib/aws/queue.d.ts.map +1 -1
- package/lib/aws/queue.js +4 -4
- package/lib/aws/queue.js.map +1 -1
- package/lib/aws/role.d.ts +1 -2
- package/lib/aws/role.d.ts.map +1 -1
- package/lib/aws/role.js +2 -2
- package/lib/aws/role.js.map +1 -1
- package/lib/aws/ses.d.ts +1 -2
- package/lib/aws/ses.d.ts.map +1 -1
- package/lib/aws/ses.js +2 -2
- package/lib/aws/ses.js.map +1 -1
- package/lib/aws/ssm-parameter.d.ts +1 -2
- package/lib/aws/ssm-parameter.d.ts.map +1 -1
- package/lib/aws/ssm-parameter.js +2 -2
- package/lib/aws/ssm-parameter.js.map +1 -1
- package/lib/aws/table.d.ts +1 -2
- package/lib/aws/table.d.ts.map +1 -1
- package/lib/aws/table.js +2 -2
- package/lib/aws/table.js.map +1 -1
- package/lib/cloudflare/account-api-token.d.ts +1 -2
- package/lib/cloudflare/account-api-token.d.ts.map +1 -1
- package/lib/cloudflare/account-api-token.js +2 -2
- package/lib/cloudflare/account-api-token.js.map +1 -1
- package/lib/cloudflare/ai-gateway.d.ts +1 -2
- package/lib/cloudflare/ai-gateway.d.ts.map +1 -1
- package/lib/cloudflare/ai-gateway.js +2 -2
- package/lib/cloudflare/ai-gateway.js.map +1 -1
- package/lib/cloudflare/api-gateway-operation.d.ts +1 -2
- package/lib/cloudflare/api-gateway-operation.d.ts.map +1 -1
- package/lib/cloudflare/api-gateway-operation.js +2 -2
- package/lib/cloudflare/api-gateway-operation.js.map +1 -1
- package/lib/cloudflare/api-schema.d.ts +1 -2
- package/lib/cloudflare/api-schema.d.ts.map +1 -1
- package/lib/cloudflare/api-schema.js +2 -2
- package/lib/cloudflare/api-schema.js.map +1 -1
- package/lib/cloudflare/api-shield.d.ts +1 -2
- package/lib/cloudflare/api-shield.d.ts.map +1 -1
- package/lib/cloudflare/api-shield.js +2 -2
- package/lib/cloudflare/api-shield.js.map +1 -1
- package/lib/cloudflare/api.d.ts +18 -10
- package/lib/cloudflare/api.d.ts.map +1 -1
- package/lib/cloudflare/api.js +93 -38
- package/lib/cloudflare/api.js.map +1 -1
- package/lib/cloudflare/assets.d.ts +21 -43
- package/lib/cloudflare/assets.d.ts.map +1 -1
- package/lib/cloudflare/assets.js +78 -70
- package/lib/cloudflare/assets.js.map +1 -1
- package/lib/cloudflare/auth.d.ts +91 -17
- package/lib/cloudflare/auth.d.ts.map +1 -1
- package/lib/cloudflare/auth.js +141 -62
- package/lib/cloudflare/auth.js.map +1 -1
- package/lib/cloudflare/bound.d.ts +1 -1
- package/lib/cloudflare/bound.d.ts.map +1 -1
- package/lib/cloudflare/bucket.d.ts +60 -8
- package/lib/cloudflare/bucket.d.ts.map +1 -1
- package/lib/cloudflare/bucket.js +161 -18
- package/lib/cloudflare/bucket.js.map +1 -1
- package/lib/cloudflare/bundle/plugin-wasm.js +4 -2
- package/lib/cloudflare/bundle/plugin-wasm.js.map +1 -1
- package/lib/cloudflare/certificate-pack.d.ts +1 -2
- package/lib/cloudflare/certificate-pack.d.ts.map +1 -1
- package/lib/cloudflare/certificate-pack.js +4 -4
- package/lib/cloudflare/certificate-pack.js.map +1 -1
- package/lib/cloudflare/compatibility-date.gen.d.ts +1 -1
- package/lib/cloudflare/compatibility-date.gen.js +1 -1
- package/lib/cloudflare/container.d.ts +1 -2
- package/lib/cloudflare/container.d.ts.map +1 -1
- package/lib/cloudflare/container.js +6 -6
- package/lib/cloudflare/container.js.map +1 -1
- package/lib/cloudflare/custom-domain.d.ts +1 -2
- package/lib/cloudflare/custom-domain.d.ts.map +1 -1
- package/lib/cloudflare/custom-domain.js +2 -2
- package/lib/cloudflare/custom-domain.js.map +1 -1
- package/lib/cloudflare/d1-database.d.ts +2 -3
- package/lib/cloudflare/d1-database.d.ts.map +1 -1
- package/lib/cloudflare/d1-database.js +5 -5
- package/lib/cloudflare/d1-database.js.map +1 -1
- package/lib/cloudflare/dispatch-namespace.d.ts +2 -3
- package/lib/cloudflare/dispatch-namespace.d.ts.map +1 -1
- package/lib/cloudflare/dispatch-namespace.js +3 -3
- package/lib/cloudflare/dispatch-namespace.js.map +1 -1
- package/lib/cloudflare/dns-records.d.ts +1 -2
- package/lib/cloudflare/dns-records.d.ts.map +1 -1
- package/lib/cloudflare/dns-records.js +4 -4
- package/lib/cloudflare/dns-records.js.map +1 -1
- package/lib/cloudflare/email-address.d.ts +1 -2
- package/lib/cloudflare/email-address.d.ts.map +1 -1
- package/lib/cloudflare/email-address.js +6 -6
- package/lib/cloudflare/email-address.js.map +1 -1
- package/lib/cloudflare/email-catch-all.d.ts +1 -2
- package/lib/cloudflare/email-catch-all.d.ts.map +1 -1
- package/lib/cloudflare/email-catch-all.js +4 -4
- package/lib/cloudflare/email-catch-all.js.map +1 -1
- package/lib/cloudflare/email-routing.d.ts +1 -2
- package/lib/cloudflare/email-routing.d.ts.map +1 -1
- package/lib/cloudflare/email-routing.js +4 -4
- package/lib/cloudflare/email-routing.js.map +1 -1
- package/lib/cloudflare/email-rule.d.ts +1 -2
- package/lib/cloudflare/email-rule.d.ts.map +1 -1
- package/lib/cloudflare/email-rule.js +4 -4
- package/lib/cloudflare/email-rule.js.map +1 -1
- package/lib/cloudflare/hyperdrive.d.ts +1 -2
- package/lib/cloudflare/hyperdrive.d.ts.map +1 -1
- package/lib/cloudflare/hyperdrive.js +4 -4
- package/lib/cloudflare/hyperdrive.js.map +1 -1
- package/lib/cloudflare/kv-namespace.d.ts +2 -3
- package/lib/cloudflare/kv-namespace.d.ts.map +1 -1
- package/lib/cloudflare/kv-namespace.js +5 -5
- package/lib/cloudflare/kv-namespace.js.map +1 -1
- package/lib/cloudflare/miniflare/delete.js +1 -1
- package/lib/cloudflare/miniflare/delete.js.map +1 -1
- package/lib/cloudflare/miniflare/miniflare-worker-proxy.d.ts.map +1 -1
- package/lib/cloudflare/miniflare/miniflare-worker-proxy.js +2 -7
- package/lib/cloudflare/miniflare/miniflare-worker-proxy.js.map +1 -1
- package/lib/cloudflare/miniflare/remote-binding-proxy.d.ts.map +1 -1
- package/lib/cloudflare/miniflare/remote-binding-proxy.js +15 -4
- package/lib/cloudflare/miniflare/remote-binding-proxy.js.map +1 -1
- package/lib/cloudflare/permission-groups.d.ts +1 -2
- package/lib/cloudflare/permission-groups.d.ts.map +1 -1
- package/lib/cloudflare/permission-groups.js +1 -1
- package/lib/cloudflare/permission-groups.js.map +1 -1
- package/lib/cloudflare/pipeline.d.ts +2 -3
- package/lib/cloudflare/pipeline.d.ts.map +1 -1
- package/lib/cloudflare/pipeline.js +5 -5
- package/lib/cloudflare/pipeline.js.map +1 -1
- package/lib/cloudflare/queue-consumer.d.ts +1 -2
- package/lib/cloudflare/queue-consumer.d.ts.map +1 -1
- package/lib/cloudflare/queue-consumer.js +4 -4
- package/lib/cloudflare/queue-consumer.js.map +1 -1
- package/lib/cloudflare/queue.d.ts +1 -2
- package/lib/cloudflare/queue.d.ts.map +1 -1
- package/lib/cloudflare/queue.js +4 -4
- package/lib/cloudflare/queue.js.map +1 -1
- package/lib/cloudflare/react-router/plugin.d.ts.map +1 -1
- package/lib/cloudflare/react-router/plugin.js +13 -0
- package/lib/cloudflare/react-router/plugin.js.map +1 -1
- package/lib/cloudflare/redirect-rule.d.ts +1 -2
- package/lib/cloudflare/redirect-rule.d.ts.map +1 -1
- package/lib/cloudflare/redirect-rule.js +4 -4
- package/lib/cloudflare/redirect-rule.js.map +1 -1
- package/lib/cloudflare/route.d.ts +1 -2
- package/lib/cloudflare/route.d.ts.map +1 -1
- package/lib/cloudflare/route.js +4 -4
- package/lib/cloudflare/route.js.map +1 -1
- package/lib/cloudflare/ruleset.d.ts +1 -2
- package/lib/cloudflare/ruleset.d.ts.map +1 -1
- package/lib/cloudflare/ruleset.js +2 -2
- package/lib/cloudflare/ruleset.js.map +1 -1
- package/lib/cloudflare/secret.d.ts +2 -3
- package/lib/cloudflare/secret.d.ts.map +1 -1
- package/lib/cloudflare/secret.js +3 -3
- package/lib/cloudflare/secret.js.map +1 -1
- package/lib/cloudflare/secrets-store.d.ts +2 -3
- package/lib/cloudflare/secrets-store.d.ts.map +1 -1
- package/lib/cloudflare/secrets-store.js +3 -3
- package/lib/cloudflare/secrets-store.js.map +1 -1
- package/lib/cloudflare/tunnel.d.ts +2 -3
- package/lib/cloudflare/tunnel.d.ts.map +1 -1
- package/lib/cloudflare/tunnel.js +3 -3
- package/lib/cloudflare/tunnel.js.map +1 -1
- package/lib/cloudflare/user.d.ts +3 -2
- package/lib/cloudflare/user.d.ts.map +1 -1
- package/lib/cloudflare/user.js +7 -5
- package/lib/cloudflare/user.js.map +1 -1
- package/lib/cloudflare/vectorize-index.d.ts +2 -3
- package/lib/cloudflare/vectorize-index.d.ts.map +1 -1
- package/lib/cloudflare/vectorize-index.js +6 -6
- package/lib/cloudflare/vectorize-index.js.map +1 -1
- package/lib/cloudflare/vectorize-metadata-index.d.ts +2 -3
- package/lib/cloudflare/vectorize-metadata-index.d.ts.map +1 -1
- package/lib/cloudflare/vectorize-metadata-index.js +4 -4
- package/lib/cloudflare/vectorize-metadata-index.js.map +1 -1
- package/lib/cloudflare/website.js +1 -1
- package/lib/cloudflare/website.js.map +1 -1
- package/lib/cloudflare/worker-assets.d.ts +1 -29
- package/lib/cloudflare/worker-assets.d.ts.map +1 -1
- package/lib/cloudflare/worker-assets.js +9 -42
- package/lib/cloudflare/worker-assets.js.map +1 -1
- package/lib/cloudflare/worker-stub.d.ts +2 -3
- package/lib/cloudflare/worker-stub.d.ts.map +1 -1
- package/lib/cloudflare/worker-stub.js +3 -3
- package/lib/cloudflare/worker-stub.js.map +1 -1
- package/lib/cloudflare/worker-subdomain.d.ts +4 -3
- package/lib/cloudflare/worker-subdomain.d.ts.map +1 -1
- package/lib/cloudflare/worker-subdomain.js +5 -5
- package/lib/cloudflare/worker-subdomain.js.map +1 -1
- package/lib/cloudflare/worker.d.ts +3 -4
- package/lib/cloudflare/worker.d.ts.map +1 -1
- package/lib/cloudflare/worker.js +6 -5
- package/lib/cloudflare/worker.js.map +1 -1
- package/lib/cloudflare/zone.d.ts +1 -2
- package/lib/cloudflare/zone.d.ts.map +1 -1
- package/lib/cloudflare/zone.js +2 -2
- package/lib/cloudflare/zone.js.map +1 -1
- package/lib/context.d.ts +8 -8
- package/lib/context.d.ts.map +1 -1
- package/lib/context.js.map +1 -1
- package/lib/destroy.d.ts +1 -1
- package/lib/destroy.d.ts.map +1 -1
- package/lib/destroy.js.map +1 -1
- package/lib/dns/import-dns.d.ts +1 -2
- package/lib/dns/import-dns.d.ts.map +1 -1
- package/lib/dns/import-dns.js +2 -2
- package/lib/dns/import-dns.js.map +1 -1
- package/lib/docker/container.d.ts +1 -2
- package/lib/docker/container.d.ts.map +1 -1
- package/lib/docker/container.js +2 -3
- package/lib/docker/container.js.map +1 -1
- package/lib/docker/image.d.ts +1 -2
- package/lib/docker/image.d.ts.map +1 -1
- package/lib/docker/image.js +9 -9
- package/lib/docker/image.js.map +1 -1
- package/lib/docker/network.d.ts +1 -2
- package/lib/docker/network.d.ts.map +1 -1
- package/lib/docker/network.js +2 -3
- package/lib/docker/network.js.map +1 -1
- package/lib/docker/remote-image.d.ts +1 -2
- package/lib/docker/remote-image.d.ts.map +1 -1
- package/lib/docker/remote-image.js +2 -3
- package/lib/docker/remote-image.js.map +1 -1
- package/lib/docker/volume.d.ts +1 -2
- package/lib/docker/volume.d.ts.map +1 -1
- package/lib/docker/volume.js +2 -3
- package/lib/docker/volume.js.map +1 -1
- package/lib/esbuild/bundle.d.ts +1 -2
- package/lib/esbuild/bundle.d.ts.map +1 -1
- package/lib/esbuild/bundle.js +4 -4
- package/lib/esbuild/bundle.js.map +1 -1
- package/lib/fs/copy-file.d.ts +1 -2
- package/lib/fs/copy-file.d.ts.map +1 -1
- package/lib/fs/copy-file.js +2 -2
- package/lib/fs/copy-file.js.map +1 -1
- package/lib/fs/file.d.ts +1 -2
- package/lib/fs/file.d.ts.map +1 -1
- package/lib/fs/file.js +2 -2
- package/lib/fs/file.js.map +1 -1
- package/lib/fs/folder.d.ts +1 -2
- package/lib/fs/folder.d.ts.map +1 -1
- package/lib/fs/folder.js +2 -2
- package/lib/fs/folder.js.map +1 -1
- package/lib/github/comment.d.ts +1 -2
- package/lib/github/comment.d.ts.map +1 -1
- package/lib/github/comment.js +4 -4
- package/lib/github/comment.js.map +1 -1
- package/lib/github/repository-environment.d.ts +1 -2
- package/lib/github/repository-environment.d.ts.map +1 -1
- package/lib/github/repository-environment.js +2 -2
- package/lib/github/repository-environment.js.map +1 -1
- package/lib/github/repository-webhook.d.ts +1 -2
- package/lib/github/repository-webhook.d.ts.map +1 -1
- package/lib/github/repository-webhook.js +2 -2
- package/lib/github/repository-webhook.js.map +1 -1
- package/lib/github/secret.d.ts +1 -2
- package/lib/github/secret.d.ts.map +1 -1
- package/lib/github/secret.js +2 -2
- package/lib/github/secret.js.map +1 -1
- package/lib/neon/api/client.gen.d.ts +13 -0
- package/lib/neon/api/client.gen.d.ts.map +1 -0
- package/lib/neon/api/client.gen.js +7 -0
- package/lib/neon/api/client.gen.js.map +1 -0
- package/lib/neon/api/sdk.gen.d.ts +880 -0
- package/lib/neon/api/sdk.gen.d.ts.map +1 -0
- package/lib/neon/api/sdk.gen.js +1527 -0
- package/lib/neon/api/sdk.gen.js.map +1 -0
- package/lib/neon/api/types.gen.d.ts +7250 -0
- package/lib/neon/api/types.gen.d.ts.map +1 -0
- package/lib/neon/api/types.gen.js +2 -0
- package/lib/neon/api/types.gen.js.map +1 -0
- package/lib/neon/api.d.ts +14 -49
- package/lib/neon/api.d.ts.map +1 -1
- package/lib/neon/api.js +36 -114
- package/lib/neon/api.js.map +1 -1
- package/lib/neon/branch.d.ts +141 -0
- package/lib/neon/branch.d.ts.map +1 -0
- package/lib/neon/branch.js +112 -0
- package/lib/neon/branch.js.map +1 -0
- package/lib/neon/index.d.ts +1 -1
- package/lib/neon/index.d.ts.map +1 -1
- package/lib/neon/index.js +1 -1
- package/lib/neon/index.js.map +1 -1
- package/lib/neon/project.d.ts +32 -242
- package/lib/neon/project.d.ts.map +1 -1
- package/lib/neon/project.js +90 -269
- package/lib/neon/project.js.map +1 -1
- package/lib/neon/utils.d.ts +49 -0
- package/lib/neon/utils.d.ts.map +1 -0
- package/lib/neon/utils.js +44 -0
- package/lib/neon/utils.js.map +1 -0
- package/lib/os/exec.d.ts +1 -2
- package/lib/os/exec.d.ts.map +1 -1
- package/lib/os/exec.js +2 -2
- package/lib/os/exec.js.map +1 -1
- package/lib/planetscale/api/client.gen.d.ts +12 -1749
- package/lib/planetscale/api/client.gen.d.ts.map +1 -1
- package/lib/planetscale/api/client.gen.js +6 -2400
- package/lib/planetscale/api/client.gen.js.map +1 -1
- package/lib/planetscale/api/sdk.gen.d.ts +1582 -0
- package/lib/planetscale/api/sdk.gen.d.ts.map +1 -0
- package/lib/planetscale/api/sdk.gen.js +2219 -0
- package/lib/planetscale/api/sdk.gen.js.map +1 -0
- package/lib/planetscale/api/types.gen.d.ts +594 -449
- package/lib/planetscale/api/types.gen.d.ts.map +1 -1
- package/lib/planetscale/api.d.ts +43 -0
- package/lib/planetscale/api.d.ts.map +1 -0
- package/lib/planetscale/api.js +53 -0
- package/lib/planetscale/api.js.map +1 -0
- package/lib/planetscale/branch.d.ts +2 -3
- package/lib/planetscale/branch.d.ts.map +1 -1
- package/lib/planetscale/branch.js +17 -15
- package/lib/planetscale/branch.js.map +1 -1
- package/lib/planetscale/database.d.ts +2 -3
- package/lib/planetscale/database.d.ts.map +1 -1
- package/lib/planetscale/database.js +34 -34
- package/lib/planetscale/database.js.map +1 -1
- package/lib/planetscale/index.d.ts +1 -1
- package/lib/planetscale/index.d.ts.map +1 -1
- package/lib/planetscale/index.js +1 -1
- package/lib/planetscale/index.js.map +1 -1
- package/lib/planetscale/password.d.ts +2 -3
- package/lib/planetscale/password.d.ts.map +1 -1
- package/lib/planetscale/password.js +11 -11
- package/lib/planetscale/password.js.map +1 -1
- package/lib/planetscale/role.d.ts +2 -3
- package/lib/planetscale/role.d.ts.map +1 -1
- package/lib/planetscale/role.js +18 -18
- package/lib/planetscale/role.js.map +1 -1
- package/lib/planetscale/utils.d.ts +1 -1
- package/lib/planetscale/utils.d.ts.map +1 -1
- package/lib/planetscale/utils.js +17 -33
- package/lib/planetscale/utils.js.map +1 -1
- package/lib/random/random-string.d.ts +1 -2
- package/lib/random/random-string.d.ts.map +1 -1
- package/lib/random/random-string.js +3 -3
- package/lib/random/random-string.js.map +1 -1
- package/lib/resource.d.ts +4 -1
- package/lib/resource.d.ts.map +1 -1
- package/lib/resource.js.map +1 -1
- package/lib/sentry/client-key.d.ts +1 -2
- package/lib/sentry/client-key.d.ts.map +1 -1
- package/lib/sentry/client-key.js +2 -2
- package/lib/sentry/client-key.js.map +1 -1
- package/lib/sentry/project.d.ts +1 -2
- package/lib/sentry/project.d.ts.map +1 -1
- package/lib/sentry/project.js +2 -2
- package/lib/sentry/project.js.map +1 -1
- package/lib/sentry/team.d.ts +1 -2
- package/lib/sentry/team.d.ts.map +1 -1
- package/lib/sentry/team.js +2 -2
- package/lib/sentry/team.js.map +1 -1
- package/lib/state/r2-rest-state-store.d.ts +1 -0
- package/lib/state/r2-rest-state-store.d.ts.map +1 -1
- package/lib/state/r2-rest-state-store.js +15 -34
- package/lib/state/r2-rest-state-store.js.map +1 -1
- package/lib/stripe/card.d.ts +1 -2
- package/lib/stripe/card.d.ts.map +1 -1
- package/lib/stripe/card.js +2 -2
- package/lib/stripe/card.js.map +1 -1
- package/lib/stripe/coupon.d.ts +1 -2
- package/lib/stripe/coupon.d.ts.map +1 -1
- package/lib/stripe/coupon.js +2 -2
- package/lib/stripe/coupon.js.map +1 -1
- package/lib/stripe/customer.d.ts +1 -2
- package/lib/stripe/customer.d.ts.map +1 -1
- package/lib/stripe/customer.js +2 -2
- package/lib/stripe/customer.js.map +1 -1
- package/lib/stripe/entitlements-feature.d.ts +1 -2
- package/lib/stripe/entitlements-feature.d.ts.map +1 -1
- package/lib/stripe/entitlements-feature.js +2 -2
- package/lib/stripe/entitlements-feature.js.map +1 -1
- package/lib/stripe/file.d.ts +1 -2
- package/lib/stripe/file.d.ts.map +1 -1
- package/lib/stripe/file.js +2 -2
- package/lib/stripe/file.js.map +1 -1
- package/lib/stripe/meter.d.ts +1 -2
- package/lib/stripe/meter.d.ts.map +1 -1
- package/lib/stripe/meter.js +1 -1
- package/lib/stripe/meter.js.map +1 -1
- package/lib/stripe/portal-configuration.d.ts +1 -2
- package/lib/stripe/portal-configuration.d.ts.map +1 -1
- package/lib/stripe/portal-configuration.js +2 -2
- package/lib/stripe/portal-configuration.js.map +1 -1
- package/lib/stripe/price.d.ts +1 -2
- package/lib/stripe/price.d.ts.map +1 -1
- package/lib/stripe/price.js +2 -2
- package/lib/stripe/price.js.map +1 -1
- package/lib/stripe/product-feature.d.ts +1 -2
- package/lib/stripe/product-feature.d.ts.map +1 -1
- package/lib/stripe/product-feature.js +2 -2
- package/lib/stripe/product-feature.js.map +1 -1
- package/lib/stripe/product.d.ts +1 -2
- package/lib/stripe/product.d.ts.map +1 -1
- package/lib/stripe/product.js +2 -2
- package/lib/stripe/product.js.map +1 -1
- package/lib/stripe/promotion-code.d.ts +1 -2
- package/lib/stripe/promotion-code.d.ts.map +1 -1
- package/lib/stripe/promotion-code.js +2 -2
- package/lib/stripe/promotion-code.js.map +1 -1
- package/lib/stripe/shipping-rate.d.ts +1 -2
- package/lib/stripe/shipping-rate.d.ts.map +1 -1
- package/lib/stripe/shipping-rate.js +2 -2
- package/lib/stripe/shipping-rate.js.map +1 -1
- package/lib/stripe/tax-rate.d.ts +1 -2
- package/lib/stripe/tax-rate.d.ts.map +1 -1
- package/lib/stripe/tax-rate.js +2 -2
- package/lib/stripe/tax-rate.js.map +1 -1
- package/lib/stripe/webhook.d.ts +16 -3
- package/lib/stripe/webhook.d.ts.map +1 -1
- package/lib/stripe/webhook.js +2 -2
- package/lib/stripe/webhook.js.map +1 -1
- package/lib/test/bun.d.ts.map +1 -1
- package/lib/test/bun.js +1 -0
- package/lib/test/bun.js.map +1 -1
- package/lib/test/options.d.ts +5 -0
- package/lib/test/options.d.ts.map +1 -1
- package/lib/test/vitest.d.ts.map +1 -1
- package/lib/test/vitest.js +1 -0
- package/lib/test/vitest.js.map +1 -1
- package/lib/upstash/redis.d.ts +1 -2
- package/lib/upstash/redis.d.ts.map +1 -1
- package/lib/upstash/redis.js.map +1 -1
- package/lib/util/api/client/client.gen.d.ts +3 -0
- package/lib/util/api/client/client.gen.d.ts.map +1 -0
- package/lib/util/api/client/client.gen.js +205 -0
- package/lib/util/api/client/client.gen.js.map +1 -0
- package/lib/util/api/client/index.d.ts +8 -0
- package/lib/util/api/client/index.d.ts.map +1 -0
- package/lib/util/api/client/index.js +6 -0
- package/lib/util/api/client/index.js.map +1 -0
- package/lib/util/api/client/types.gen.d.ts +125 -0
- package/lib/util/api/client/types.gen.d.ts.map +1 -0
- package/lib/util/api/client/types.gen.js +2 -0
- package/lib/util/api/client/types.gen.js.map +1 -0
- package/lib/util/api/client/utils.gen.d.ts +34 -0
- package/lib/util/api/client/utils.gen.d.ts.map +1 -0
- package/lib/util/api/client/utils.gen.js +231 -0
- package/lib/util/api/client/utils.gen.js.map +1 -0
- package/lib/util/api/core/auth.gen.d.ts +19 -0
- package/lib/util/api/core/auth.gen.d.ts.map +1 -0
- package/lib/util/api/core/auth.gen.js +15 -0
- package/lib/util/api/core/auth.gen.js.map +1 -0
- package/lib/util/api/core/bodySerializer.gen.d.ts +18 -0
- package/lib/util/api/core/bodySerializer.gen.d.ts.map +1 -0
- package/lib/util/api/core/bodySerializer.gen.js +58 -0
- package/lib/util/api/core/bodySerializer.gen.js.map +1 -0
- package/lib/util/api/core/params.gen.d.ts +34 -0
- package/lib/util/api/core/params.gen.d.ts.map +1 -0
- package/lib/util/api/core/params.gen.js +89 -0
- package/lib/util/api/core/params.gen.js.map +1 -0
- package/lib/util/api/core/pathSerializer.gen.d.ts +34 -0
- package/lib/util/api/core/pathSerializer.gen.d.ts.map +1 -0
- package/lib/util/api/core/pathSerializer.gen.js +115 -0
- package/lib/util/api/core/pathSerializer.gen.js.map +1 -0
- package/lib/util/api/core/serverSentEvents.gen.d.ts +72 -0
- package/lib/util/api/core/serverSentEvents.gen.d.ts.map +1 -0
- package/lib/util/api/core/serverSentEvents.gen.js +136 -0
- package/lib/util/api/core/serverSentEvents.gen.js.map +1 -0
- package/lib/util/api/core/types.gen.d.ts +79 -0
- package/lib/util/api/core/types.gen.d.ts.map +1 -0
- package/lib/util/api/core/types.gen.js +2 -0
- package/lib/util/api/core/types.gen.js.map +1 -0
- package/lib/util/api/core/utils.gen.d.ts +20 -0
- package/lib/util/api/core/utils.gen.d.ts.map +1 -0
- package/lib/util/api/core/utils.gen.js +88 -0
- package/lib/util/api/core/utils.gen.js.map +1 -0
- package/lib/util/http.d.ts +7 -2
- package/lib/util/http.d.ts.map +1 -1
- package/lib/util/http.js +29 -11
- package/lib/util/http.js.map +1 -1
- package/lib/util/lock.d.ts +20 -0
- package/lib/util/lock.d.ts.map +1 -0
- package/lib/util/lock.js +45 -0
- package/lib/util/lock.js.map +1 -0
- package/lib/util/memoize.d.ts +6 -0
- package/lib/util/memoize.d.ts.map +1 -1
- package/lib/util/memoize.js +23 -0
- package/lib/util/memoize.js.map +1 -1
- package/lib/util/oauth-client.d.ts +71 -0
- package/lib/util/oauth-client.d.ts.map +1 -0
- package/lib/util/oauth-client.js +188 -0
- package/lib/util/oauth-client.js.map +1 -0
- package/lib/util/poll.d.ts +33 -0
- package/lib/util/poll.d.ts.map +1 -0
- package/lib/util/poll.js +19 -0
- package/lib/util/poll.js.map +1 -0
- package/lib/vercel/project-domain.d.ts +1 -2
- package/lib/vercel/project-domain.d.ts.map +1 -1
- package/lib/vercel/project-domain.js.map +1 -1
- package/lib/vercel/project.d.ts +1 -2
- package/lib/vercel/project.d.ts.map +1 -1
- package/lib/vercel/project.js +2 -2
- package/lib/vercel/project.js.map +1 -1
- package/package.json +5 -1
- package/src/apply.ts +32 -29
- package/src/auth.ts +253 -0
- package/src/aws/bucket.ts +3 -3
- package/src/aws/control/resource.ts +4 -6
- package/src/aws/ec2/internet-gateway-attachment.ts +5 -6
- package/src/aws/ec2/internet-gateway.ts +3 -5
- package/src/aws/ec2/nat-gateway.ts +3 -5
- package/src/aws/ec2/route-table-association.ts +3 -5
- package/src/aws/ec2/route-table.ts +3 -5
- package/src/aws/ec2/route.ts +3 -3
- package/src/aws/ec2/security-group-rule.ts +3 -5
- package/src/aws/ec2/security-group.ts +3 -5
- package/src/aws/ec2/subnet.ts +3 -3
- package/src/aws/ec2/vpc.ts +3 -3
- package/src/aws/function.ts +3 -3
- package/src/aws/oidc/oidc-provider.ts +3 -5
- package/src/aws/policy-attachment.ts +2 -4
- package/src/aws/policy.ts +5 -5
- package/src/aws/queue.ts +5 -5
- package/src/aws/role.ts +3 -3
- package/src/aws/ses.ts +3 -3
- package/src/aws/ssm-parameter.ts +3 -3
- package/src/aws/table.ts +3 -3
- package/src/cloudflare/account-api-token.ts +3 -4
- package/src/cloudflare/ai-gateway.ts +3 -5
- package/src/cloudflare/api-gateway-operation.ts +3 -4
- package/src/cloudflare/api-schema.ts +25 -26
- package/src/cloudflare/api-shield.ts +3 -4
- package/src/cloudflare/api.ts +122 -57
- package/src/cloudflare/assets.ts +95 -136
- package/src/cloudflare/auth.ts +160 -95
- package/src/cloudflare/bound.ts +1 -1
- package/src/cloudflare/bucket.ts +321 -58
- package/src/cloudflare/bundle/plugin-wasm.ts +5 -5
- package/src/cloudflare/certificate-pack.ts +5 -6
- package/src/cloudflare/compatibility-date.gen.ts +1 -1
- package/src/cloudflare/container.ts +7 -8
- package/src/cloudflare/custom-domain.ts +3 -5
- package/src/cloudflare/d1-database.ts +33 -34
- package/src/cloudflare/dispatch-namespace.ts +5 -6
- package/src/cloudflare/dns-records.ts +5 -5
- package/src/cloudflare/email-address.ts +7 -7
- package/src/cloudflare/email-catch-all.ts +6 -6
- package/src/cloudflare/email-routing.ts +5 -5
- package/src/cloudflare/email-rule.ts +5 -5
- package/src/cloudflare/hyperdrive.ts +35 -36
- package/src/cloudflare/kv-namespace.ts +31 -32
- package/src/cloudflare/miniflare/delete.ts +1 -1
- package/src/cloudflare/miniflare/miniflare-worker-proxy.ts +2 -7
- package/src/cloudflare/miniflare/remote-binding-proxy.ts +16 -4
- package/src/cloudflare/permission-groups.ts +4 -6
- package/src/cloudflare/pipeline.ts +29 -30
- package/src/cloudflare/queue-consumer.ts +5 -7
- package/src/cloudflare/queue.ts +42 -43
- package/src/cloudflare/react-router/plugin.ts +20 -0
- package/src/cloudflare/redirect-rule.ts +5 -5
- package/src/cloudflare/route.ts +5 -5
- package/src/cloudflare/ruleset.ts +3 -4
- package/src/cloudflare/secret.ts +35 -36
- package/src/cloudflare/secrets-store.ts +5 -8
- package/src/cloudflare/tunnel.ts +5 -7
- package/src/cloudflare/user.ts +12 -9
- package/src/cloudflare/vectorize-index.ts +8 -12
- package/src/cloudflare/vectorize-metadata-index.ts +6 -8
- package/src/cloudflare/website.ts +1 -1
- package/src/cloudflare/worker-assets.ts +10 -56
- package/src/cloudflare/worker-stub.ts +5 -5
- package/src/cloudflare/worker-subdomain.ts +6 -7
- package/src/cloudflare/worker.ts +91 -91
- package/src/cloudflare/zone.ts +3 -3
- package/src/context.ts +9 -7
- package/src/destroy.ts +2 -2
- package/src/dns/import-dns.ts +3 -5
- package/src/docker/container.ts +3 -6
- package/src/docker/image.ts +13 -13
- package/src/docker/network.ts +3 -4
- package/src/docker/remote-image.ts +3 -6
- package/src/docker/volume.ts +3 -4
- package/src/esbuild/bundle.ts +10 -8
- package/src/fs/copy-file.ts +3 -3
- package/src/fs/file.ts +3 -3
- package/src/fs/folder.ts +3 -3
- package/src/github/comment.ts +5 -7
- package/src/github/repository-environment.ts +3 -5
- package/src/github/repository-webhook.ts +3 -5
- package/src/github/secret.ts +3 -5
- package/src/neon/api/client.gen.ts +28 -0
- package/src/neon/api/sdk.gen.ts +2596 -0
- package/src/neon/api/types.gen.ts +8287 -0
- package/src/neon/api.ts +51 -147
- package/src/neon/branch.ts +278 -0
- package/src/neon/index.ts +1 -1
- package/src/neon/project.ts +136 -721
- package/src/neon/utils.ts +105 -0
- package/src/os/exec.ts +3 -3
- package/src/planetscale/api/client.gen.ts +28 -2882
- package/src/planetscale/api/sdk.gen.ts +3336 -0
- package/src/planetscale/api/types.gen.ts +778 -450
- package/src/planetscale/api.ts +101 -0
- package/src/planetscale/branch.ts +20 -19
- package/src/planetscale/database.ts +69 -70
- package/src/planetscale/index.ts +1 -1
- package/src/planetscale/password.ts +18 -22
- package/src/planetscale/role.ts +21 -21
- package/src/planetscale/utils.ts +20 -74
- package/src/random/random-string.ts +4 -4
- package/src/resource.ts +6 -2
- package/src/sentry/client-key.ts +3 -5
- package/src/sentry/project.ts +3 -5
- package/src/sentry/team.ts +3 -3
- package/src/state/r2-rest-state-store.ts +15 -57
- package/src/stripe/card.ts +3 -3
- package/src/stripe/coupon.ts +3 -3
- package/src/stripe/customer.ts +3 -3
- package/src/stripe/entitlements-feature.ts +3 -5
- package/src/stripe/file.ts +3 -3
- package/src/stripe/meter.ts +3 -3
- package/src/stripe/portal-configuration.ts +3 -5
- package/src/stripe/price.ts +3 -3
- package/src/stripe/product-feature.ts +3 -5
- package/src/stripe/product.ts +3 -3
- package/src/stripe/promotion-code.ts +3 -5
- package/src/stripe/shipping-rate.ts +3 -5
- package/src/stripe/tax-rate.ts +3 -3
- package/src/stripe/webhook.ts +3 -5
- package/src/test/bun.ts +1 -0
- package/src/test/options.ts +6 -0
- package/src/test/vitest.ts +1 -0
- package/src/upstash/redis.ts +1 -3
- package/src/util/api/client/client.gen.ts +268 -0
- package/src/util/api/client/index.ts +25 -0
- package/src/util/api/client/types.gen.ts +268 -0
- package/src/util/api/client/utils.gen.ts +331 -0
- package/src/util/api/core/auth.gen.ts +42 -0
- package/src/util/api/core/bodySerializer.gen.ts +92 -0
- package/src/util/api/core/params.gen.ts +153 -0
- package/src/util/api/core/pathSerializer.gen.ts +181 -0
- package/src/util/api/core/serverSentEvents.gen.ts +264 -0
- package/src/util/api/core/types.gen.ts +118 -0
- package/src/util/api/core/utils.gen.ts +143 -0
- package/src/util/http.ts +38 -11
- package/src/util/lock.ts +48 -0
- package/src/util/memoize.ts +26 -0
- package/src/util/oauth-client.ts +238 -0
- package/src/util/poll.ts +55 -0
- package/src/vercel/project-domain.ts +1 -3
- package/src/vercel/project.ts +3 -3
- package/workers/cloudflare-state-store.js +8 -5619
- package/workers/dofs-state-store.js +2 -802
- package/workers/remote-binding-proxy.js +3 -39
- package/workers/remote-binding-proxy.ts +126 -35
- package/workers/tunnel-proxy.js +6 -73
- package/lib/cloudflare/asset-manifest.d.ts +0 -15
- package/lib/cloudflare/asset-manifest.d.ts.map +0 -1
- package/lib/cloudflare/asset-manifest.js +0 -1
- package/lib/cloudflare/asset-manifest.js.map +0 -1
- package/lib/cloudflare/oauth.d.ts +0 -22
- package/lib/cloudflare/oauth.d.ts.map +0 -1
- package/lib/cloudflare/oauth.js +0 -214
- package/lib/cloudflare/oauth.js.map +0 -1
- package/lib/neon/api-error.d.ts +0 -31
- package/lib/neon/api-error.d.ts.map +0 -1
- package/lib/neon/api-error.js +0 -73
- package/lib/neon/api-error.js.map +0 -1
- package/lib/planetscale/api/index.d.ts +0 -3
- package/lib/planetscale/api/index.d.ts.map +0 -1
- package/lib/planetscale/api/index.js +0 -4
- package/lib/planetscale/api/index.js.map +0 -1
- package/lib/util/neverthrow.d.ts +0 -16
- package/lib/util/neverthrow.d.ts.map +0 -1
- package/lib/util/neverthrow.js +0 -46
- package/lib/util/neverthrow.js.map +0 -1
- package/src/cloudflare/asset-manifest.ts +0 -16
- package/src/cloudflare/oauth.ts +0 -301
- package/src/neon/api-error.ts +0 -81
- package/src/planetscale/api/index.ts +0 -4
- package/src/util/neverthrow.ts +0 -64
|
@@ -0,0 +1,1582 @@
|
|
|
1
|
+
import type { Client, Options as Options2, TDataShape } from "../../util/api/client/index.ts";
|
|
2
|
+
import type { CancelBranchChangeRequestData, CancelBranchChangeRequestErrors, CancelBranchChangeRequestResponses, CancelDeployRequestData, CancelDeployRequestErrors, CancelDeployRequestResponses, CloseDeployRequestData, CloseDeployRequestErrors, CloseDeployRequestResponses, CompleteErroredDeployData, CompleteErroredDeployErrors, CompleteErroredDeployResponses, CompleteGatedDeployRequestData, CompleteGatedDeployRequestErrors, CompleteGatedDeployRequestResponses, CompleteRevertData, CompleteRevertErrors, CompleteRevertResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateBranchData, CreateBranchErrors, CreateBranchResponses, CreateDatabaseData, CreateDatabaseErrors, CreateDatabaseResponses, CreateDeployRequestData, CreateDeployRequestErrors, CreateDeployRequestResponses, CreateKeyspaceData, CreateKeyspaceErrors, CreateKeyspaceResponses, CreateOauthTokenData, CreateOauthTokenErrors, CreateOauthTokenResponses, CreatePasswordData, CreatePasswordErrors, CreatePasswordResponses, CreateQueryPatternsReportData, CreateQueryPatternsReportErrors, CreateQueryPatternsReportResponses, CreateRoleData, CreateRoleErrors, CreateRoleResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteBackupData, DeleteBackupErrors, DeleteBackupResponses, DeleteBranchData, DeleteBranchErrors, DeleteBranchResponses, DeleteDatabaseData, DeleteDatabaseErrors, DeleteDatabaseResponses, DeleteKeyspaceData, DeleteKeyspaceErrors, DeleteKeyspaceResponses, DeleteOauthTokenData, DeleteOauthTokenErrors, DeleteOauthTokenResponses, DeletePasswordData, DeletePasswordErrors, DeletePasswordResponses, DeleteQueryPatternsReportData, DeleteQueryPatternsReportErrors, DeleteQueryPatternsReportResponses, DeleteRoleData, DeleteRoleErrors, DeleteRoleResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, DemoteBranchData, DemoteBranchErrors, DemoteBranchResponses, DisableSafeMigrationsData, DisableSafeMigrationsErrors, DisableSafeMigrationsResponses, EnableSafeMigrationsData, EnableSafeMigrationsErrors, EnableSafeMigrationsResponses, GetBackupData, GetBackupErrors, GetBackupResponses, GetBranchData, GetBranchErrors, GetBranchResponses, GetBranchSchemaData, GetBranchSchemaErrors, GetBranchSchemaResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseData, GetDatabaseErrors, GetDatabaseResponses, GetDatabaseThrottlerData, GetDatabaseThrottlerErrors, GetDatabaseThrottlerResponses, GetDeploymentData, GetDeploymentErrors, GetDeploymentResponses, GetDeployQueueData, GetDeployQueueErrors, GetDeployQueueResponses, GetDeployRequestData, GetDeployRequestErrors, GetDeployRequestResponses, GetDeployRequestThrottlerData, GetDeployRequestThrottlerErrors, GetDeployRequestThrottlerResponses, GetInvoiceData, GetInvoiceErrors, GetInvoiceLineItemsData, GetInvoiceLineItemsErrors, GetInvoiceLineItemsResponses, GetInvoiceResponses, GetKeyspaceData, GetKeyspaceErrors, GetKeyspaceResponses, GetKeyspaceRolloutStatusData, GetKeyspaceRolloutStatusErrors, GetKeyspaceRolloutStatusResponses, GetKeyspaceVschemaData, GetKeyspaceVschemaErrors, GetKeyspaceVschemaResponses, GetOauthApplicationData, GetOauthApplicationErrors, GetOauthApplicationResponses, GetOauthTokenData, GetOauthTokenErrors, GetOauthTokenResponses, GetOrganizationData, GetOrganizationErrors, GetOrganizationResponses, GetPasswordData, GetPasswordErrors, GetPasswordResponses, GetQueryPatternsReportData, GetQueryPatternsReportErrors, GetQueryPatternsReportStatusData, GetQueryPatternsReportStatusErrors, GetQueryPatternsReportStatusResponses, GetRoleData, GetRoleErrors, GetRoleResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponses, LintBranchSchemaData, LintBranchSchemaErrors, LintBranchSchemaResponses, ListAuditLogsData, ListAuditLogsErrors, ListAuditLogsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListBranchChangeRequestsData, ListBranchChangeRequestsErrors, ListBranchChangeRequestsResponses, ListBranchesData, ListBranchesErrors, ListBranchesResponses, ListDatabaseRegionsData, ListDatabaseRegionsErrors, ListDatabaseRegionsResponses, ListDatabasesData, ListDatabasesErrors, ListDatabasesResponses, ListDeployOperationsData, ListDeployOperationsErrors, ListDeployOperationsResponses, ListDeployRequestReviewsData, ListDeployRequestReviewsErrors, ListDeployRequestReviewsResponses, ListDeployRequestsData, ListDeployRequestsErrors, ListDeployRequestsResponses, ListExtensionsData, ListExtensionsErrors, ListExtensionsResponses, ListGeneratedQueryPatternsReportsData, ListGeneratedQueryPatternsReportsErrors, ListGeneratedQueryPatternsReportsResponses, ListInvoicesData, ListInvoicesErrors, ListInvoicesResponses, ListKeyspaceResizesData, ListKeyspaceResizesErrors, ListKeyspaceResizesResponses, ListKeyspacesData, ListKeyspacesErrors, ListKeyspacesResponses, ListOauthApplicationsData, ListOauthApplicationsErrors, ListOauthApplicationsResponses, ListOauthTokensData, ListOauthTokensErrors, ListOauthTokensResponses, ListOrganizationMembersData, ListOrganizationMembersErrors, ListOrganizationMembersResponses, ListOrganizationsData, ListOrganizationsErrors, ListOrganizationsResponses, ListParametersData, ListParametersErrors, ListParametersResponses, ListPasswordsData, ListPasswordsErrors, ListPasswordsResponses, ListPublicRegionsData, ListPublicRegionsErrors, ListPublicRegionsResponses, ListReadOnlyRegionsData, ListReadOnlyRegionsErrors, ListReadOnlyRegionsResponses, ListRegionsForOrganizationData, ListRegionsForOrganizationErrors, ListRegionsForOrganizationResponses, ListRolesData, ListRolesErrors, ListRolesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, PromoteBranchData, PromoteBranchErrors, PromoteBranchResponses, QueueDeployRequestData, QueueDeployRequestErrors, QueueDeployRequestResponses, RenewPasswordData, RenewPasswordErrors, RenewPasswordResponses, RenewRoleData, RenewRoleErrors, RenewRoleResponses, ReviewDeployRequestData, ReviewDeployRequestErrors, ReviewDeployRequestResponses, SkipRevertPeriodData, SkipRevertPeriodErrors, SkipRevertPeriodResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAutoApplyData, UpdateAutoApplyErrors, UpdateAutoApplyResponses, UpdateBackupData, UpdateBackupErrors, UpdateBackupResponses, UpdateBranchChangeRequestData, UpdateBranchChangeRequestErrors, UpdateBranchChangeRequestResponses, UpdateBranchClusterConfigData, UpdateBranchClusterConfigErrors, UpdateBranchClusterConfigResponses, UpdateDatabaseSettingsData, UpdateDatabaseSettingsErrors, UpdateDatabaseSettingsResponses, UpdateDatabaseThrottlerData, UpdateDatabaseThrottlerErrors, UpdateDatabaseThrottlerResponses, UpdateDeployRequestThrottlerData, UpdateDeployRequestThrottlerErrors, UpdateDeployRequestThrottlerResponses, UpdateKeyspaceData, UpdateKeyspaceErrors, UpdateKeyspaceResponses, UpdateKeyspaceVschemaData, UpdateKeyspaceVschemaErrors, UpdateKeyspaceVschemaResponses, UpdateOrganizationData, UpdateOrganizationErrors, UpdateOrganizationResponses, UpdatePasswordData, UpdatePasswordErrors, UpdatePasswordResponses, UpdateRoleData, UpdateRoleErrors, UpdateRoleResponses, UpdateWebhookData, UpdateWebhookErrors, UpdateWebhookResponses, VerifyWorkflowData, VerifyWorkflowErrors, VerifyWorkflowResponses, WorkflowCancelData, WorkflowCancelErrors, WorkflowCancelResponses, WorkflowCompleteData, WorkflowCompleteErrors, WorkflowCompleteResponses, WorkflowCutoverData, WorkflowCutoverErrors, WorkflowCutoverResponses, WorkflowRetryData, WorkflowRetryErrors, WorkflowRetryResponses, WorkflowReverseCutoverData, WorkflowReverseCutoverErrors, WorkflowReverseCutoverResponses, WorkflowReverseTrafficData, WorkflowReverseTrafficErrors, WorkflowReverseTrafficResponses, WorkflowSwitchPrimariesData, WorkflowSwitchPrimariesErrors, WorkflowSwitchPrimariesResponses, WorkflowSwitchReplicasData, WorkflowSwitchReplicasErrors, WorkflowSwitchReplicasResponses } from "./types.gen.ts";
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: Record<string, unknown>;
|
|
15
|
+
};
|
|
16
|
+
declare class _HeyApiClient {
|
|
17
|
+
protected _client: Client;
|
|
18
|
+
constructor(args?: {
|
|
19
|
+
client?: Client;
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
export declare class PlanetScaleClient extends _HeyApiClient {
|
|
23
|
+
/**
|
|
24
|
+
* List organizations
|
|
25
|
+
* 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.
|
|
26
|
+
* ### Authorization
|
|
27
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
28
|
+
*
|
|
29
|
+
* **OAuth Scopes**
|
|
30
|
+
*
|
|
31
|
+
* | Resource | Scopes |
|
|
32
|
+
* | :------- | :---------- |
|
|
33
|
+
* | User | `read_organizations` |
|
|
34
|
+
*/
|
|
35
|
+
listOrganizations<ThrowOnError extends boolean = true>(options?: Options<ListOrganizationsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListOrganizationsResponses, ListOrganizationsErrors, ThrowOnError, "fields">;
|
|
36
|
+
/**
|
|
37
|
+
* Get an organization
|
|
38
|
+
*
|
|
39
|
+
* ### Authorization
|
|
40
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
41
|
+
*
|
|
42
|
+
* **Service Token Accesses**
|
|
43
|
+
* `read_organization`
|
|
44
|
+
*
|
|
45
|
+
* **OAuth Scopes**
|
|
46
|
+
*
|
|
47
|
+
* | Resource | Scopes |
|
|
48
|
+
* | :------- | :---------- |
|
|
49
|
+
* | User | `read_organizations` |
|
|
50
|
+
* | Organization | `read_organization` |
|
|
51
|
+
*/
|
|
52
|
+
getOrganization<ThrowOnError extends boolean = true>(options: Options<GetOrganizationData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetOrganizationResponses, GetOrganizationErrors, ThrowOnError, "fields">;
|
|
53
|
+
/**
|
|
54
|
+
* Update an organization
|
|
55
|
+
*
|
|
56
|
+
* ### Authorization
|
|
57
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
58
|
+
*
|
|
59
|
+
* **OAuth Scopes**
|
|
60
|
+
*
|
|
61
|
+
* | Resource | Scopes |
|
|
62
|
+
* | :------- | :---------- |
|
|
63
|
+
* | Organization | `write_organization` |
|
|
64
|
+
*/
|
|
65
|
+
updateOrganization<ThrowOnError extends boolean = true>(options: Options<UpdateOrganizationData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateOrganizationResponses, UpdateOrganizationErrors, ThrowOnError, "fields">;
|
|
66
|
+
/**
|
|
67
|
+
* List audit logs
|
|
68
|
+
*
|
|
69
|
+
* ### Authorization
|
|
70
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
71
|
+
*
|
|
72
|
+
* **Service Token Accesses**
|
|
73
|
+
* `read_audit_logs`
|
|
74
|
+
*
|
|
75
|
+
*
|
|
76
|
+
*/
|
|
77
|
+
listAuditLogs<ThrowOnError extends boolean = true>(options: Options<ListAuditLogsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListAuditLogsResponses, ListAuditLogsErrors, ThrowOnError, "fields">;
|
|
78
|
+
/**
|
|
79
|
+
* List regions for an organization
|
|
80
|
+
*
|
|
81
|
+
* ### Authorization
|
|
82
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
83
|
+
*
|
|
84
|
+
* **Service Token Accesses**
|
|
85
|
+
* `read_organization`
|
|
86
|
+
*
|
|
87
|
+
* **OAuth Scopes**
|
|
88
|
+
*
|
|
89
|
+
* | Resource | Scopes |
|
|
90
|
+
* | :------- | :---------- |
|
|
91
|
+
* | User | `read_organizations` |
|
|
92
|
+
* | Organization | `read_organization` |
|
|
93
|
+
*/
|
|
94
|
+
listRegionsForOrganization<ThrowOnError extends boolean = true>(options: Options<ListRegionsForOrganizationData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListRegionsForOrganizationResponses, ListRegionsForOrganizationErrors, ThrowOnError, "fields">;
|
|
95
|
+
/**
|
|
96
|
+
* List databases
|
|
97
|
+
*
|
|
98
|
+
* ### Authorization
|
|
99
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
100
|
+
*
|
|
101
|
+
* **Service Token Accesses**
|
|
102
|
+
* `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`
|
|
103
|
+
*
|
|
104
|
+
* **OAuth Scopes**
|
|
105
|
+
*
|
|
106
|
+
* | Resource | Scopes |
|
|
107
|
+
* | :------- | :---------- |
|
|
108
|
+
* | Organization | `read_databases` |
|
|
109
|
+
*/
|
|
110
|
+
listDatabases<ThrowOnError extends boolean = true>(options: Options<ListDatabasesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListDatabasesResponses, ListDatabasesErrors, ThrowOnError, "fields">;
|
|
111
|
+
/**
|
|
112
|
+
* Create a database
|
|
113
|
+
*
|
|
114
|
+
* ### Authorization
|
|
115
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
116
|
+
*
|
|
117
|
+
* **Service Token Accesses**
|
|
118
|
+
* `create_databases`
|
|
119
|
+
*
|
|
120
|
+
* **OAuth Scopes**
|
|
121
|
+
*
|
|
122
|
+
* | Resource | Scopes |
|
|
123
|
+
* | :------- | :---------- |
|
|
124
|
+
* | Organization | `create_databases` |
|
|
125
|
+
*/
|
|
126
|
+
createDatabase<ThrowOnError extends boolean = true>(options: Options<CreateDatabaseData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateDatabaseResponses, CreateDatabaseErrors, ThrowOnError, "fields">;
|
|
127
|
+
/**
|
|
128
|
+
* List branches
|
|
129
|
+
*
|
|
130
|
+
* ### Authorization
|
|
131
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
132
|
+
*
|
|
133
|
+
* **Service Token Accesses**
|
|
134
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
135
|
+
*
|
|
136
|
+
* **OAuth Scopes**
|
|
137
|
+
*
|
|
138
|
+
* | Resource | Scopes |
|
|
139
|
+
* | :------- | :---------- |
|
|
140
|
+
* | Organization | `read_branches` |
|
|
141
|
+
* | Database | `read_branches` |
|
|
142
|
+
* | Branch | `read_branch` |
|
|
143
|
+
*/
|
|
144
|
+
listBranches<ThrowOnError extends boolean = true>(options: Options<ListBranchesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListBranchesResponses, ListBranchesErrors, ThrowOnError, "fields">;
|
|
145
|
+
/**
|
|
146
|
+
* Create a branch
|
|
147
|
+
*
|
|
148
|
+
* ### Authorization
|
|
149
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
150
|
+
*
|
|
151
|
+
* **Service Token Accesses**
|
|
152
|
+
* `create_branch`, `restore_production_branch_backup`, `restore_backup`
|
|
153
|
+
*
|
|
154
|
+
* **OAuth Scopes**
|
|
155
|
+
*
|
|
156
|
+
* | Resource | Scopes |
|
|
157
|
+
* | :------- | :---------- |
|
|
158
|
+
* | Organization | `write_branches`, `restore_production_branch_backups`, `restore_backups` |
|
|
159
|
+
* | Database | `write_branches`, `restore_production_branch_backups`, `restore_backups` |
|
|
160
|
+
* | Branch | `restore_backups` |
|
|
161
|
+
*/
|
|
162
|
+
createBranch<ThrowOnError extends boolean = true>(options: Options<CreateBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateBranchResponses, CreateBranchErrors, ThrowOnError, "fields">;
|
|
163
|
+
/**
|
|
164
|
+
* List backups
|
|
165
|
+
*
|
|
166
|
+
* ### Authorization
|
|
167
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
168
|
+
*
|
|
169
|
+
* **Service Token Accesses**
|
|
170
|
+
* `read_backups`
|
|
171
|
+
*
|
|
172
|
+
* **OAuth Scopes**
|
|
173
|
+
*
|
|
174
|
+
* | Resource | Scopes |
|
|
175
|
+
* | :------- | :---------- |
|
|
176
|
+
* | Organization | `read_backups` |
|
|
177
|
+
* | Database | `read_backups` |
|
|
178
|
+
* | Branch | `read_backups` |
|
|
179
|
+
*/
|
|
180
|
+
listBackups<ThrowOnError extends boolean = true>(options: Options<ListBackupsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListBackupsResponses, ListBackupsErrors, ThrowOnError, "fields">;
|
|
181
|
+
/**
|
|
182
|
+
* Create a backup
|
|
183
|
+
*
|
|
184
|
+
* ### Authorization
|
|
185
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
186
|
+
*
|
|
187
|
+
* **Service Token Accesses**
|
|
188
|
+
* `write_backups`
|
|
189
|
+
*
|
|
190
|
+
* **OAuth Scopes**
|
|
191
|
+
*
|
|
192
|
+
* | Resource | Scopes |
|
|
193
|
+
* | :------- | :---------- |
|
|
194
|
+
* | Organization | `write_backups` |
|
|
195
|
+
* | Database | `write_backups` |
|
|
196
|
+
* | Branch | `write_backups` |
|
|
197
|
+
*/
|
|
198
|
+
createBackup<ThrowOnError extends boolean = true>(options: Options<CreateBackupData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateBackupResponses, CreateBackupErrors, ThrowOnError, "fields">;
|
|
199
|
+
/**
|
|
200
|
+
* Delete a backup
|
|
201
|
+
*
|
|
202
|
+
* ### Authorization
|
|
203
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
204
|
+
*
|
|
205
|
+
* **Service Token Accesses**
|
|
206
|
+
* `delete_backups`, `delete_production_branch_backups`
|
|
207
|
+
*
|
|
208
|
+
* **OAuth Scopes**
|
|
209
|
+
*
|
|
210
|
+
* | Resource | Scopes |
|
|
211
|
+
* | :------- | :---------- |
|
|
212
|
+
* | Organization | `delete_backups`, `delete_production_branch_backups` |
|
|
213
|
+
* | Database | `delete_backups`, `delete_production_branch_backups` |
|
|
214
|
+
* | Branch | `delete_backups` |
|
|
215
|
+
*/
|
|
216
|
+
deleteBackup<ThrowOnError extends boolean = true>(options: Options<DeleteBackupData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteBackupResponses, DeleteBackupErrors, ThrowOnError, "fields">;
|
|
217
|
+
/**
|
|
218
|
+
* Get a backup
|
|
219
|
+
*
|
|
220
|
+
* ### Authorization
|
|
221
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
222
|
+
*
|
|
223
|
+
* **Service Token Accesses**
|
|
224
|
+
* `read_backups`
|
|
225
|
+
*
|
|
226
|
+
* **OAuth Scopes**
|
|
227
|
+
*
|
|
228
|
+
* | Resource | Scopes |
|
|
229
|
+
* | :------- | :---------- |
|
|
230
|
+
* | Organization | `read_backups` |
|
|
231
|
+
* | Database | `read_backups` |
|
|
232
|
+
* | Branch | `read_backups` |
|
|
233
|
+
*/
|
|
234
|
+
getBackup<ThrowOnError extends boolean = true>(options: Options<GetBackupData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetBackupResponses, GetBackupErrors, ThrowOnError, "fields">;
|
|
235
|
+
/**
|
|
236
|
+
* Update a backup
|
|
237
|
+
*
|
|
238
|
+
* ### Authorization
|
|
239
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
240
|
+
*
|
|
241
|
+
* **Service Token Accesses**
|
|
242
|
+
* `write_backups`
|
|
243
|
+
*
|
|
244
|
+
* **OAuth Scopes**
|
|
245
|
+
*
|
|
246
|
+
* | Resource | Scopes |
|
|
247
|
+
* | :------- | :---------- |
|
|
248
|
+
* | Organization | `write_backups` |
|
|
249
|
+
* | Database | `write_backups` |
|
|
250
|
+
* | Branch | `write_backups` |
|
|
251
|
+
*/
|
|
252
|
+
updateBackup<ThrowOnError extends boolean = true>(options: Options<UpdateBackupData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateBackupResponses, UpdateBackupErrors, ThrowOnError, "fields">;
|
|
253
|
+
/**
|
|
254
|
+
* Get branch change requests
|
|
255
|
+
*
|
|
256
|
+
* ### Authorization
|
|
257
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
258
|
+
*
|
|
259
|
+
* **Service Token Accesses**
|
|
260
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
261
|
+
*
|
|
262
|
+
* **OAuth Scopes**
|
|
263
|
+
*
|
|
264
|
+
* | Resource | Scopes |
|
|
265
|
+
* | :------- | :---------- |
|
|
266
|
+
* | Organization | `read_branches` |
|
|
267
|
+
* | Database | `read_branches` |
|
|
268
|
+
* | Branch | `read_branch` |
|
|
269
|
+
*/
|
|
270
|
+
listBranchChangeRequests<ThrowOnError extends boolean = true>(options: Options<ListBranchChangeRequestsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListBranchChangeRequestsResponses, ListBranchChangeRequestsErrors, ThrowOnError, "fields">;
|
|
271
|
+
/**
|
|
272
|
+
* Upsert a change request
|
|
273
|
+
*
|
|
274
|
+
* ### Authorization
|
|
275
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
276
|
+
*
|
|
277
|
+
* **Service Token Accesses**
|
|
278
|
+
* `write_database`
|
|
279
|
+
*
|
|
280
|
+
* **OAuth Scopes**
|
|
281
|
+
*
|
|
282
|
+
* | Resource | Scopes |
|
|
283
|
+
* | :------- | :---------- |
|
|
284
|
+
* | Organization | `write_databases` |
|
|
285
|
+
* | Database | `write_database` |
|
|
286
|
+
*/
|
|
287
|
+
updateBranchChangeRequest<ThrowOnError extends boolean = true>(options: Options<UpdateBranchChangeRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateBranchChangeRequestResponses, UpdateBranchChangeRequestErrors, ThrowOnError, "fields">;
|
|
288
|
+
/**
|
|
289
|
+
* List cluster extensions
|
|
290
|
+
*
|
|
291
|
+
* ### Authorization
|
|
292
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
293
|
+
*
|
|
294
|
+
* **Service Token Accesses**
|
|
295
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
296
|
+
*
|
|
297
|
+
* **OAuth Scopes**
|
|
298
|
+
*
|
|
299
|
+
* | Resource | Scopes |
|
|
300
|
+
* | :------- | :---------- |
|
|
301
|
+
* | Organization | `read_branches` |
|
|
302
|
+
* | Database | `read_branches` |
|
|
303
|
+
* | Branch | `read_branch` |
|
|
304
|
+
*/
|
|
305
|
+
listExtensions<ThrowOnError extends boolean = true>(options: Options<ListExtensionsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListExtensionsResponses, ListExtensionsErrors, ThrowOnError, "fields">;
|
|
306
|
+
/**
|
|
307
|
+
* Get keyspaces
|
|
308
|
+
*
|
|
309
|
+
*
|
|
310
|
+
*/
|
|
311
|
+
listKeyspaces<ThrowOnError extends boolean = true>(options: Options<ListKeyspacesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListKeyspacesResponses, ListKeyspacesErrors, ThrowOnError, "fields">;
|
|
312
|
+
/**
|
|
313
|
+
* Create a keyspace
|
|
314
|
+
*
|
|
315
|
+
*
|
|
316
|
+
*/
|
|
317
|
+
createKeyspace<ThrowOnError extends boolean = true>(options: Options<CreateKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateKeyspaceResponses, CreateKeyspaceErrors, ThrowOnError, "fields">;
|
|
318
|
+
/**
|
|
319
|
+
* Get the VSchema for the keyspace
|
|
320
|
+
*
|
|
321
|
+
* ### Authorization
|
|
322
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
323
|
+
*
|
|
324
|
+
* **Service Token Accesses**
|
|
325
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
326
|
+
*
|
|
327
|
+
*
|
|
328
|
+
*/
|
|
329
|
+
getKeyspaceVschema<ThrowOnError extends boolean = true>(options: Options<GetKeyspaceVschemaData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetKeyspaceVschemaResponses, GetKeyspaceVschemaErrors, ThrowOnError, "fields">;
|
|
330
|
+
/**
|
|
331
|
+
* Update the VSchema for the keyspace
|
|
332
|
+
*
|
|
333
|
+
* ### Authorization
|
|
334
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
335
|
+
*
|
|
336
|
+
* **Service Token Accesses**
|
|
337
|
+
* `write_production_branch_vschema`, `write_branch_vschema`
|
|
338
|
+
*
|
|
339
|
+
*
|
|
340
|
+
*/
|
|
341
|
+
updateKeyspaceVschema<ThrowOnError extends boolean = true>(options: Options<UpdateKeyspaceVschemaData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateKeyspaceVschemaResponses, UpdateKeyspaceVschemaErrors, ThrowOnError, "fields">;
|
|
342
|
+
/**
|
|
343
|
+
* Delete a keyspace
|
|
344
|
+
*
|
|
345
|
+
*
|
|
346
|
+
*/
|
|
347
|
+
deleteKeyspace<ThrowOnError extends boolean = true>(options: Options<DeleteKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteKeyspaceResponses, DeleteKeyspaceErrors, ThrowOnError, "fields">;
|
|
348
|
+
/**
|
|
349
|
+
* Get a keyspace
|
|
350
|
+
*
|
|
351
|
+
*
|
|
352
|
+
*/
|
|
353
|
+
getKeyspace<ThrowOnError extends boolean = true>(options: Options<GetKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetKeyspaceResponses, GetKeyspaceErrors, ThrowOnError, "fields">;
|
|
354
|
+
/**
|
|
355
|
+
* Configure keyspace settings
|
|
356
|
+
*
|
|
357
|
+
*
|
|
358
|
+
*/
|
|
359
|
+
updateKeyspace<ThrowOnError extends boolean = true>(options: Options<UpdateKeyspaceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateKeyspaceResponses, UpdateKeyspaceErrors, ThrowOnError, "fields">;
|
|
360
|
+
/**
|
|
361
|
+
* Get keyspace rollout status
|
|
362
|
+
*
|
|
363
|
+
*
|
|
364
|
+
*/
|
|
365
|
+
getKeyspaceRolloutStatus<ThrowOnError extends boolean = true>(options: Options<GetKeyspaceRolloutStatusData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetKeyspaceRolloutStatusResponses, GetKeyspaceRolloutStatusErrors, ThrowOnError, "fields">;
|
|
366
|
+
/**
|
|
367
|
+
* List cluster parameters
|
|
368
|
+
*
|
|
369
|
+
* ### Authorization
|
|
370
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
371
|
+
*
|
|
372
|
+
* **Service Token Accesses**
|
|
373
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
374
|
+
*
|
|
375
|
+
* **OAuth Scopes**
|
|
376
|
+
*
|
|
377
|
+
* | Resource | Scopes |
|
|
378
|
+
* | :------- | :---------- |
|
|
379
|
+
* | Organization | `read_branches` |
|
|
380
|
+
* | Database | `read_branches` |
|
|
381
|
+
* | Branch | `read_branch` |
|
|
382
|
+
*/
|
|
383
|
+
listParameters<ThrowOnError extends boolean = true>(options: Options<ListParametersData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListParametersResponses, ListParametersErrors, ThrowOnError, "fields">;
|
|
384
|
+
/**
|
|
385
|
+
* List passwords
|
|
386
|
+
*
|
|
387
|
+
* ### Authorization
|
|
388
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
389
|
+
*
|
|
390
|
+
* **Service Token Accesses**
|
|
391
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
392
|
+
*
|
|
393
|
+
* **OAuth Scopes**
|
|
394
|
+
*
|
|
395
|
+
* | Resource | Scopes |
|
|
396
|
+
* | :------- | :---------- |
|
|
397
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
398
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
399
|
+
* | Branch | `manage_passwords` |
|
|
400
|
+
*/
|
|
401
|
+
listPasswords<ThrowOnError extends boolean = true>(options: Options<ListPasswordsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListPasswordsResponses, ListPasswordsErrors, ThrowOnError, "fields">;
|
|
402
|
+
/**
|
|
403
|
+
* Create a password
|
|
404
|
+
*
|
|
405
|
+
* ### Authorization
|
|
406
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
407
|
+
*
|
|
408
|
+
* **Service Token Accesses**
|
|
409
|
+
* `connect_production_branch`, `connect_branch`
|
|
410
|
+
*
|
|
411
|
+
* **OAuth Scopes**
|
|
412
|
+
*
|
|
413
|
+
* | Resource | Scopes |
|
|
414
|
+
* | :------- | :---------- |
|
|
415
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
416
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
417
|
+
* | Branch | `manage_passwords` |
|
|
418
|
+
*/
|
|
419
|
+
createPassword<ThrowOnError extends boolean = true>(options: Options<CreatePasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreatePasswordResponses, CreatePasswordErrors, ThrowOnError, "fields">;
|
|
420
|
+
/**
|
|
421
|
+
* Delete a password
|
|
422
|
+
*
|
|
423
|
+
* ### Authorization
|
|
424
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
425
|
+
*
|
|
426
|
+
* **Service Token Accesses**
|
|
427
|
+
* `delete_production_branch_password`, `delete_branch_password`
|
|
428
|
+
*
|
|
429
|
+
* **OAuth Scopes**
|
|
430
|
+
*
|
|
431
|
+
* | Resource | Scopes |
|
|
432
|
+
* | :------- | :---------- |
|
|
433
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
434
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
435
|
+
* | Branch | `manage_passwords` |
|
|
436
|
+
*/
|
|
437
|
+
deletePassword<ThrowOnError extends boolean = true>(options: Options<DeletePasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeletePasswordResponses, DeletePasswordErrors, ThrowOnError, "fields">;
|
|
438
|
+
/**
|
|
439
|
+
* Get a password
|
|
440
|
+
*
|
|
441
|
+
* ### Authorization
|
|
442
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
443
|
+
*
|
|
444
|
+
* **Service Token Accesses**
|
|
445
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
446
|
+
*
|
|
447
|
+
* **OAuth Scopes**
|
|
448
|
+
*
|
|
449
|
+
* | Resource | Scopes |
|
|
450
|
+
* | :------- | :---------- |
|
|
451
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
452
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
453
|
+
* | Branch | `manage_passwords` |
|
|
454
|
+
*/
|
|
455
|
+
getPassword<ThrowOnError extends boolean = true>(options: Options<GetPasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetPasswordResponses, GetPasswordErrors, ThrowOnError, "fields">;
|
|
456
|
+
/**
|
|
457
|
+
* Update a password
|
|
458
|
+
*
|
|
459
|
+
* ### Authorization
|
|
460
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
461
|
+
*
|
|
462
|
+
* **Service Token Accesses**
|
|
463
|
+
* `connect_production_branch`, `connect_branch`
|
|
464
|
+
*
|
|
465
|
+
* **OAuth Scopes**
|
|
466
|
+
*
|
|
467
|
+
* | Resource | Scopes |
|
|
468
|
+
* | :------- | :---------- |
|
|
469
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
470
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
471
|
+
* | Branch | `manage_passwords` |
|
|
472
|
+
*/
|
|
473
|
+
updatePassword<ThrowOnError extends boolean = true>(options: Options<UpdatePasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdatePasswordResponses, UpdatePasswordErrors, ThrowOnError, "fields">;
|
|
474
|
+
/**
|
|
475
|
+
* Renew a password
|
|
476
|
+
*
|
|
477
|
+
* ### Authorization
|
|
478
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
479
|
+
*
|
|
480
|
+
* **Service Token Accesses**
|
|
481
|
+
* `connect_production_branch`, `connect_branch`
|
|
482
|
+
*
|
|
483
|
+
* **OAuth Scopes**
|
|
484
|
+
*
|
|
485
|
+
* | Resource | Scopes |
|
|
486
|
+
* | :------- | :---------- |
|
|
487
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
488
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
489
|
+
* | Branch | `manage_passwords` |
|
|
490
|
+
*/
|
|
491
|
+
renewPassword<ThrowOnError extends boolean = true>(options: Options<RenewPasswordData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<RenewPasswordResponses, RenewPasswordErrors, ThrowOnError, "fields">;
|
|
492
|
+
/**
|
|
493
|
+
* List generated query patterns reports
|
|
494
|
+
*
|
|
495
|
+
* ### Authorization
|
|
496
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
497
|
+
*
|
|
498
|
+
* **Service Token Accesses**
|
|
499
|
+
* `read_branch`
|
|
500
|
+
*
|
|
501
|
+
* **OAuth Scopes**
|
|
502
|
+
*
|
|
503
|
+
* | Resource | Scopes |
|
|
504
|
+
* | :------- | :---------- |
|
|
505
|
+
* | Organization | `read_branches` |
|
|
506
|
+
* | Database | `read_branches` |
|
|
507
|
+
* | Branch | `read_branch` |
|
|
508
|
+
*/
|
|
509
|
+
listGeneratedQueryPatternsReports<ThrowOnError extends boolean = true>(options: Options<ListGeneratedQueryPatternsReportsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListGeneratedQueryPatternsReportsResponses, ListGeneratedQueryPatternsReportsErrors, ThrowOnError, "fields">;
|
|
510
|
+
/**
|
|
511
|
+
* Create a new query patterns report
|
|
512
|
+
*
|
|
513
|
+
* ### Authorization
|
|
514
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
515
|
+
*
|
|
516
|
+
* **Service Token Accesses**
|
|
517
|
+
* `read_branch`
|
|
518
|
+
*
|
|
519
|
+
* **OAuth Scopes**
|
|
520
|
+
*
|
|
521
|
+
* | Resource | Scopes |
|
|
522
|
+
* | :------- | :---------- |
|
|
523
|
+
* | Organization | `read_branches` |
|
|
524
|
+
* | Database | `read_branches` |
|
|
525
|
+
* | Branch | `read_branch` |
|
|
526
|
+
*/
|
|
527
|
+
createQueryPatternsReport<ThrowOnError extends boolean = true>(options: Options<CreateQueryPatternsReportData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateQueryPatternsReportResponses, CreateQueryPatternsReportErrors, ThrowOnError, "fields">;
|
|
528
|
+
/**
|
|
529
|
+
* Delete a query patterns report
|
|
530
|
+
*
|
|
531
|
+
* ### Authorization
|
|
532
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
533
|
+
*
|
|
534
|
+
* **Service Token Accesses**
|
|
535
|
+
* `read_branch`
|
|
536
|
+
*
|
|
537
|
+
* **OAuth Scopes**
|
|
538
|
+
*
|
|
539
|
+
* | Resource | Scopes |
|
|
540
|
+
* | :------- | :---------- |
|
|
541
|
+
* | Organization | `read_branches` |
|
|
542
|
+
* | Database | `read_branches` |
|
|
543
|
+
* | Branch | `read_branch` |
|
|
544
|
+
*/
|
|
545
|
+
deleteQueryPatternsReport<ThrowOnError extends boolean = true>(options: Options<DeleteQueryPatternsReportData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteQueryPatternsReportResponses, DeleteQueryPatternsReportErrors, ThrowOnError, "fields">;
|
|
546
|
+
/**
|
|
547
|
+
* Show the status of a query patterns report
|
|
548
|
+
*
|
|
549
|
+
* ### Authorization
|
|
550
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
551
|
+
*
|
|
552
|
+
* **Service Token Accesses**
|
|
553
|
+
* `read_branch`
|
|
554
|
+
*
|
|
555
|
+
* **OAuth Scopes**
|
|
556
|
+
*
|
|
557
|
+
* | Resource | Scopes |
|
|
558
|
+
* | :------- | :---------- |
|
|
559
|
+
* | Organization | `read_branches` |
|
|
560
|
+
* | Database | `read_branches` |
|
|
561
|
+
* | Branch | `read_branch` |
|
|
562
|
+
*/
|
|
563
|
+
getQueryPatternsReportStatus<ThrowOnError extends boolean = true>(options: Options<GetQueryPatternsReportStatusData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetQueryPatternsReportStatusResponses, GetQueryPatternsReportStatusErrors, ThrowOnError, "fields">;
|
|
564
|
+
/**
|
|
565
|
+
* Download a finished query patterns report
|
|
566
|
+
*
|
|
567
|
+
* ### Authorization
|
|
568
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
569
|
+
*
|
|
570
|
+
* **Service Token Accesses**
|
|
571
|
+
* `read_branch`
|
|
572
|
+
*
|
|
573
|
+
* **OAuth Scopes**
|
|
574
|
+
*
|
|
575
|
+
* | Resource | Scopes |
|
|
576
|
+
* | :------- | :---------- |
|
|
577
|
+
* | Organization | `read_branches` |
|
|
578
|
+
* | Database | `read_branches` |
|
|
579
|
+
* | Branch | `read_branch` |
|
|
580
|
+
*/
|
|
581
|
+
getQueryPatternsReport<ThrowOnError extends boolean = true>(options: Options<GetQueryPatternsReportData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<unknown, GetQueryPatternsReportErrors, ThrowOnError, "fields">;
|
|
582
|
+
/**
|
|
583
|
+
* Cancel a change request
|
|
584
|
+
*
|
|
585
|
+
* ### Authorization
|
|
586
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
587
|
+
*
|
|
588
|
+
* **Service Token Accesses**
|
|
589
|
+
* `write_database`
|
|
590
|
+
*
|
|
591
|
+
* **OAuth Scopes**
|
|
592
|
+
*
|
|
593
|
+
* | Resource | Scopes |
|
|
594
|
+
* | :------- | :---------- |
|
|
595
|
+
* | Organization | `write_databases` |
|
|
596
|
+
* | Database | `write_database` |
|
|
597
|
+
*/
|
|
598
|
+
cancelBranchChangeRequest<ThrowOnError extends boolean = true>(options: Options<CancelBranchChangeRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CancelBranchChangeRequestResponses, CancelBranchChangeRequestErrors, ThrowOnError, "fields">;
|
|
599
|
+
/**
|
|
600
|
+
* List roles
|
|
601
|
+
*
|
|
602
|
+
* ### Authorization
|
|
603
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
604
|
+
*
|
|
605
|
+
* **Service Token Accesses**
|
|
606
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
607
|
+
*
|
|
608
|
+
* **OAuth Scopes**
|
|
609
|
+
*
|
|
610
|
+
* | Resource | Scopes |
|
|
611
|
+
* | :------- | :---------- |
|
|
612
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
613
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
614
|
+
* | Branch | `manage_passwords` |
|
|
615
|
+
*/
|
|
616
|
+
listRoles<ThrowOnError extends boolean = true>(options: Options<ListRolesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListRolesResponses, ListRolesErrors, ThrowOnError, "fields">;
|
|
617
|
+
/**
|
|
618
|
+
* Create role credentials
|
|
619
|
+
*
|
|
620
|
+
* ### Authorization
|
|
621
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
622
|
+
*
|
|
623
|
+
* **Service Token Accesses**
|
|
624
|
+
* `create_production_branch_password`, `create_branch_password`
|
|
625
|
+
*
|
|
626
|
+
* **OAuth Scopes**
|
|
627
|
+
*
|
|
628
|
+
* | Resource | Scopes |
|
|
629
|
+
* | :------- | :---------- |
|
|
630
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
631
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
632
|
+
* | Branch | `manage_passwords` |
|
|
633
|
+
*/
|
|
634
|
+
createRole<ThrowOnError extends boolean = true>(options: Options<CreateRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateRoleResponses, CreateRoleErrors, ThrowOnError, "fields">;
|
|
635
|
+
/**
|
|
636
|
+
* Delete role credentials
|
|
637
|
+
*
|
|
638
|
+
* ### Authorization
|
|
639
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
640
|
+
*
|
|
641
|
+
* **Service Token Accesses**
|
|
642
|
+
* `delete_production_branch_password`, `delete_branch_password`
|
|
643
|
+
*
|
|
644
|
+
* **OAuth Scopes**
|
|
645
|
+
*
|
|
646
|
+
* | Resource | Scopes |
|
|
647
|
+
* | :------- | :---------- |
|
|
648
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
649
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
650
|
+
* | Branch | `manage_passwords` |
|
|
651
|
+
*/
|
|
652
|
+
deleteRole<ThrowOnError extends boolean = true>(options: Options<DeleteRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteRoleResponses, DeleteRoleErrors, ThrowOnError, "fields">;
|
|
653
|
+
/**
|
|
654
|
+
* Get a role
|
|
655
|
+
*
|
|
656
|
+
* ### Authorization
|
|
657
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
658
|
+
*
|
|
659
|
+
* **Service Token Accesses**
|
|
660
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
661
|
+
*
|
|
662
|
+
* **OAuth Scopes**
|
|
663
|
+
*
|
|
664
|
+
* | Resource | Scopes |
|
|
665
|
+
* | :------- | :---------- |
|
|
666
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
667
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
668
|
+
* | Branch | `manage_passwords` |
|
|
669
|
+
*/
|
|
670
|
+
getRole<ThrowOnError extends boolean = true>(options: Options<GetRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetRoleResponses, GetRoleErrors, ThrowOnError, "fields">;
|
|
671
|
+
/**
|
|
672
|
+
* Update role name
|
|
673
|
+
*
|
|
674
|
+
* ### Authorization
|
|
675
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
676
|
+
*
|
|
677
|
+
* **Service Token Accesses**
|
|
678
|
+
* `create_production_branch_password`, `create_branch_password`
|
|
679
|
+
*
|
|
680
|
+
* **OAuth Scopes**
|
|
681
|
+
*
|
|
682
|
+
* | Resource | Scopes |
|
|
683
|
+
* | :------- | :---------- |
|
|
684
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
685
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
686
|
+
* | Branch | `manage_passwords` |
|
|
687
|
+
*/
|
|
688
|
+
updateRole<ThrowOnError extends boolean = true>(options: Options<UpdateRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateRoleResponses, UpdateRoleErrors, ThrowOnError, "fields">;
|
|
689
|
+
/**
|
|
690
|
+
* Renew role expiration
|
|
691
|
+
*
|
|
692
|
+
* ### Authorization
|
|
693
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
694
|
+
*
|
|
695
|
+
* **Service Token Accesses**
|
|
696
|
+
* `create_production_branch_password`, `create_branch_password`
|
|
697
|
+
*
|
|
698
|
+
* **OAuth Scopes**
|
|
699
|
+
*
|
|
700
|
+
* | Resource | Scopes |
|
|
701
|
+
* | :------- | :---------- |
|
|
702
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
703
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
704
|
+
* | Branch | `manage_passwords` |
|
|
705
|
+
*/
|
|
706
|
+
renewRole<ThrowOnError extends boolean = true>(options: Options<RenewRoleData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<RenewRoleResponses, RenewRoleErrors, ThrowOnError, "fields">;
|
|
707
|
+
/**
|
|
708
|
+
* Delete a branch
|
|
709
|
+
*
|
|
710
|
+
* ### Authorization
|
|
711
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
712
|
+
*
|
|
713
|
+
* **Service Token Accesses**
|
|
714
|
+
* `delete_branch`
|
|
715
|
+
*
|
|
716
|
+
* **OAuth Scopes**
|
|
717
|
+
*
|
|
718
|
+
* | Resource | Scopes |
|
|
719
|
+
* | :------- | :---------- |
|
|
720
|
+
* | Organization | `delete_branches`, `delete_production_branches` |
|
|
721
|
+
* | Database | `delete_branches`, `delete_production_branches` |
|
|
722
|
+
* | Branch | `delete_branch` |
|
|
723
|
+
*/
|
|
724
|
+
deleteBranch<ThrowOnError extends boolean = true>(options: Options<DeleteBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteBranchResponses, DeleteBranchErrors, ThrowOnError, "fields">;
|
|
725
|
+
/**
|
|
726
|
+
* Get a branch
|
|
727
|
+
*
|
|
728
|
+
* ### Authorization
|
|
729
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
730
|
+
*
|
|
731
|
+
* **Service Token Accesses**
|
|
732
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
733
|
+
*
|
|
734
|
+
* **OAuth Scopes**
|
|
735
|
+
*
|
|
736
|
+
* | Resource | Scopes |
|
|
737
|
+
* | :------- | :---------- |
|
|
738
|
+
* | Organization | `read_branches` |
|
|
739
|
+
* | Database | `read_branches` |
|
|
740
|
+
* | Branch | `read_branch` |
|
|
741
|
+
*/
|
|
742
|
+
getBranch<ThrowOnError extends boolean = true>(options: Options<GetBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetBranchResponses, GetBranchErrors, ThrowOnError, "fields">;
|
|
743
|
+
/**
|
|
744
|
+
* Change a branch cluster configuration
|
|
745
|
+
*
|
|
746
|
+
* ### Authorization
|
|
747
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
748
|
+
*
|
|
749
|
+
* **Service Token Accesses**
|
|
750
|
+
* `write_database`
|
|
751
|
+
*
|
|
752
|
+
*
|
|
753
|
+
*/
|
|
754
|
+
updateBranchClusterConfig<ThrowOnError extends boolean = true>(options: Options<UpdateBranchClusterConfigData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateBranchClusterConfigResponses, UpdateBranchClusterConfigErrors, ThrowOnError, "fields">;
|
|
755
|
+
/**
|
|
756
|
+
* Demote a branch
|
|
757
|
+
* Demotes a branch from production to development
|
|
758
|
+
* ### Authorization
|
|
759
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
760
|
+
*
|
|
761
|
+
* **Service Token Accesses**
|
|
762
|
+
* `connect_production_branch`, `demote_branches`
|
|
763
|
+
*
|
|
764
|
+
* **OAuth Scopes**
|
|
765
|
+
*
|
|
766
|
+
* | Resource | Scopes |
|
|
767
|
+
* | :------- | :---------- |
|
|
768
|
+
* | Organization | `demote_branches` |
|
|
769
|
+
* | Database | `demote_branches` |
|
|
770
|
+
*/
|
|
771
|
+
demoteBranch<ThrowOnError extends boolean = true>(options: Options<DemoteBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DemoteBranchResponses, DemoteBranchErrors, ThrowOnError, "fields">;
|
|
772
|
+
/**
|
|
773
|
+
* Promote a branch
|
|
774
|
+
* Promotes a branch from development to production
|
|
775
|
+
* ### Authorization
|
|
776
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
777
|
+
*
|
|
778
|
+
* **Service Token Accesses**
|
|
779
|
+
* `connect_production_branch`, `promote_branches`
|
|
780
|
+
*
|
|
781
|
+
* **OAuth Scopes**
|
|
782
|
+
*
|
|
783
|
+
* | Resource | Scopes |
|
|
784
|
+
* | :------- | :---------- |
|
|
785
|
+
* | Organization | `promote_branches` |
|
|
786
|
+
* | Database | `promote_branches` |
|
|
787
|
+
*/
|
|
788
|
+
promoteBranch<ThrowOnError extends boolean = true>(options: Options<PromoteBranchData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<PromoteBranchResponses, PromoteBranchErrors, ThrowOnError, "fields">;
|
|
789
|
+
/**
|
|
790
|
+
* Disable safe migrations for a branch
|
|
791
|
+
*
|
|
792
|
+
*
|
|
793
|
+
*/
|
|
794
|
+
disableSafeMigrations<ThrowOnError extends boolean = true>(options: Options<DisableSafeMigrationsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DisableSafeMigrationsResponses, DisableSafeMigrationsErrors, ThrowOnError, "fields">;
|
|
795
|
+
/**
|
|
796
|
+
* Enable safe migrations for a branch
|
|
797
|
+
*
|
|
798
|
+
*
|
|
799
|
+
*/
|
|
800
|
+
enableSafeMigrations<ThrowOnError extends boolean = true>(options: Options<EnableSafeMigrationsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<EnableSafeMigrationsResponses, EnableSafeMigrationsErrors, ThrowOnError, "fields">;
|
|
801
|
+
/**
|
|
802
|
+
* Get a branch schema
|
|
803
|
+
*
|
|
804
|
+
* ### Authorization
|
|
805
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
806
|
+
*
|
|
807
|
+
* **Service Token Accesses**
|
|
808
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
809
|
+
*
|
|
810
|
+
* **OAuth Scopes**
|
|
811
|
+
*
|
|
812
|
+
* | Resource | Scopes |
|
|
813
|
+
* | :------- | :---------- |
|
|
814
|
+
* | Organization | `read_branches` |
|
|
815
|
+
* | Database | `read_branches` |
|
|
816
|
+
* | Branch | `read_branch` |
|
|
817
|
+
*/
|
|
818
|
+
getBranchSchema<ThrowOnError extends boolean = true>(options: Options<GetBranchSchemaData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetBranchSchemaResponses, GetBranchSchemaErrors, ThrowOnError, "fields">;
|
|
819
|
+
/**
|
|
820
|
+
* Lint a branch schema
|
|
821
|
+
*
|
|
822
|
+
* ### Authorization
|
|
823
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
824
|
+
*
|
|
825
|
+
* **Service Token Accesses**
|
|
826
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
827
|
+
*
|
|
828
|
+
* **OAuth Scopes**
|
|
829
|
+
*
|
|
830
|
+
* | Resource | Scopes |
|
|
831
|
+
* | :------- | :---------- |
|
|
832
|
+
* | Organization | `read_branches` |
|
|
833
|
+
* | Database | `read_branches` |
|
|
834
|
+
* | Branch | `read_branch` |
|
|
835
|
+
*/
|
|
836
|
+
lintBranchSchema<ThrowOnError extends boolean = true>(options: Options<LintBranchSchemaData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<LintBranchSchemaResponses, LintBranchSchemaErrors, ThrowOnError, "fields">;
|
|
837
|
+
/**
|
|
838
|
+
* Get the deploy queue
|
|
839
|
+
* The deploy queue returns the current list of deploy requests in the order they will be deployed.
|
|
840
|
+
*
|
|
841
|
+
*/
|
|
842
|
+
getDeployQueue<ThrowOnError extends boolean = true>(options: Options<GetDeployQueueData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetDeployQueueResponses, GetDeployQueueErrors, ThrowOnError, "fields">;
|
|
843
|
+
/**
|
|
844
|
+
* List deploy requests
|
|
845
|
+
* List deploy requests for a database
|
|
846
|
+
* ### Authorization
|
|
847
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
848
|
+
*
|
|
849
|
+
* **Service Token Accesses**
|
|
850
|
+
* `read_deploy_request`
|
|
851
|
+
*
|
|
852
|
+
* **OAuth Scopes**
|
|
853
|
+
*
|
|
854
|
+
* | Resource | Scopes |
|
|
855
|
+
* | :------- | :---------- |
|
|
856
|
+
* | Organization | `read_deploy_requests` |
|
|
857
|
+
* | Database | `read_deploy_requests` |
|
|
858
|
+
*/
|
|
859
|
+
listDeployRequests<ThrowOnError extends boolean = true>(options: Options<ListDeployRequestsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListDeployRequestsResponses, ListDeployRequestsErrors, ThrowOnError, "fields">;
|
|
860
|
+
/**
|
|
861
|
+
* Create a deploy request
|
|
862
|
+
*
|
|
863
|
+
* ### Authorization
|
|
864
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
865
|
+
*
|
|
866
|
+
* **Service Token Accesses**
|
|
867
|
+
* `read_deploy_request`, `create_deploy_requests`
|
|
868
|
+
*
|
|
869
|
+
* **OAuth Scopes**
|
|
870
|
+
*
|
|
871
|
+
* | Resource | Scopes |
|
|
872
|
+
* | :------- | :---------- |
|
|
873
|
+
* | Organization | `write_deploy_requests` |
|
|
874
|
+
* | Database | `write_deploy_requests` |
|
|
875
|
+
*/
|
|
876
|
+
createDeployRequest<ThrowOnError extends boolean = true>(options: Options<CreateDeployRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateDeployRequestResponses, CreateDeployRequestErrors, ThrowOnError, "fields">;
|
|
877
|
+
/**
|
|
878
|
+
* Get a deploy request
|
|
879
|
+
*
|
|
880
|
+
* ### Authorization
|
|
881
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
882
|
+
*
|
|
883
|
+
* **Service Token Accesses**
|
|
884
|
+
* `read_deploy_request`
|
|
885
|
+
*
|
|
886
|
+
* **OAuth Scopes**
|
|
887
|
+
*
|
|
888
|
+
* | Resource | Scopes |
|
|
889
|
+
* | :------- | :---------- |
|
|
890
|
+
* | Organization | `read_deploy_requests` |
|
|
891
|
+
* | Database | `read_deploy_requests` |
|
|
892
|
+
*/
|
|
893
|
+
getDeployRequest<ThrowOnError extends boolean = true>(options: Options<GetDeployRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetDeployRequestResponses, GetDeployRequestErrors, ThrowOnError, "fields">;
|
|
894
|
+
/**
|
|
895
|
+
* Close a deploy request
|
|
896
|
+
*
|
|
897
|
+
* ### Authorization
|
|
898
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
899
|
+
*
|
|
900
|
+
* **Service Token Accesses**
|
|
901
|
+
* `read_deploy_request`
|
|
902
|
+
*
|
|
903
|
+
* **OAuth Scopes**
|
|
904
|
+
*
|
|
905
|
+
* | Resource | Scopes |
|
|
906
|
+
* | :------- | :---------- |
|
|
907
|
+
* | Organization | `write_deploy_requests` |
|
|
908
|
+
* | Database | `write_deploy_requests` |
|
|
909
|
+
*/
|
|
910
|
+
closeDeployRequest<ThrowOnError extends boolean = true>(options: Options<CloseDeployRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CloseDeployRequestResponses, CloseDeployRequestErrors, ThrowOnError, "fields">;
|
|
911
|
+
/**
|
|
912
|
+
* Complete a gated deploy request
|
|
913
|
+
*
|
|
914
|
+
* ### Authorization
|
|
915
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
916
|
+
*
|
|
917
|
+
* **Service Token Accesses**
|
|
918
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
919
|
+
*
|
|
920
|
+
* **OAuth Scopes**
|
|
921
|
+
*
|
|
922
|
+
* | Resource | Scopes |
|
|
923
|
+
* | :------- | :---------- |
|
|
924
|
+
* | Organization | `deploy_deploy_requests` |
|
|
925
|
+
* | Database | `deploy_deploy_requests` |
|
|
926
|
+
*/
|
|
927
|
+
completeGatedDeployRequest<ThrowOnError extends boolean = true>(options: Options<CompleteGatedDeployRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CompleteGatedDeployRequestResponses, CompleteGatedDeployRequestErrors, ThrowOnError, "fields">;
|
|
928
|
+
/**
|
|
929
|
+
* Update auto-apply for deploy request
|
|
930
|
+
* Enables or disabled the auto-apply setting for a deploy request
|
|
931
|
+
* ### 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_deploy_request`, `create_deploy_request`
|
|
936
|
+
*
|
|
937
|
+
* **OAuth Scopes**
|
|
938
|
+
*
|
|
939
|
+
* | Resource | Scopes |
|
|
940
|
+
* | :------- | :---------- |
|
|
941
|
+
* | Organization | `deploy_deploy_requests` |
|
|
942
|
+
* | Database | `deploy_deploy_requests` |
|
|
943
|
+
*/
|
|
944
|
+
updateAutoApply<ThrowOnError extends boolean = true>(options: Options<UpdateAutoApplyData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateAutoApplyResponses, UpdateAutoApplyErrors, ThrowOnError, "fields">;
|
|
945
|
+
/**
|
|
946
|
+
* Cancel a queued deploy request
|
|
947
|
+
*
|
|
948
|
+
* ### Authorization
|
|
949
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
950
|
+
*
|
|
951
|
+
* **Service Token Accesses**
|
|
952
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
953
|
+
*
|
|
954
|
+
* **OAuth Scopes**
|
|
955
|
+
*
|
|
956
|
+
* | Resource | Scopes |
|
|
957
|
+
* | :------- | :---------- |
|
|
958
|
+
* | Organization | `deploy_deploy_requests` |
|
|
959
|
+
* | Database | `deploy_deploy_requests` |
|
|
960
|
+
*/
|
|
961
|
+
cancelDeployRequest<ThrowOnError extends boolean = true>(options: Options<CancelDeployRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CancelDeployRequestResponses, CancelDeployRequestErrors, ThrowOnError, "fields">;
|
|
962
|
+
/**
|
|
963
|
+
* Complete an errored deploy
|
|
964
|
+
*
|
|
965
|
+
* ### Authorization
|
|
966
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
967
|
+
*
|
|
968
|
+
* **Service Token Accesses**
|
|
969
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
970
|
+
*
|
|
971
|
+
* **OAuth Scopes**
|
|
972
|
+
*
|
|
973
|
+
* | Resource | Scopes |
|
|
974
|
+
* | :------- | :---------- |
|
|
975
|
+
* | Organization | `deploy_deploy_requests` |
|
|
976
|
+
* | Database | `deploy_deploy_requests` |
|
|
977
|
+
*/
|
|
978
|
+
completeErroredDeploy<ThrowOnError extends boolean = true>(options: Options<CompleteErroredDeployData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CompleteErroredDeployResponses, CompleteErroredDeployErrors, ThrowOnError, "fields">;
|
|
979
|
+
/**
|
|
980
|
+
* Queue a deploy request
|
|
981
|
+
*
|
|
982
|
+
* ### Authorization
|
|
983
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
984
|
+
*
|
|
985
|
+
* **Service Token Accesses**
|
|
986
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
987
|
+
*
|
|
988
|
+
* **OAuth Scopes**
|
|
989
|
+
*
|
|
990
|
+
* | Resource | Scopes |
|
|
991
|
+
* | :------- | :---------- |
|
|
992
|
+
* | Organization | `deploy_deploy_requests` |
|
|
993
|
+
* | Database | `deploy_deploy_requests` |
|
|
994
|
+
*/
|
|
995
|
+
queueDeployRequest<ThrowOnError extends boolean = true>(options: Options<QueueDeployRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<QueueDeployRequestResponses, QueueDeployRequestErrors, ThrowOnError, "fields">;
|
|
996
|
+
/**
|
|
997
|
+
* Get a deployment
|
|
998
|
+
* Get the deployment for a deploy request
|
|
999
|
+
* ### Authorization
|
|
1000
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1001
|
+
*
|
|
1002
|
+
* **Service Token Accesses**
|
|
1003
|
+
* `read_deploy_request`
|
|
1004
|
+
*
|
|
1005
|
+
* **OAuth Scopes**
|
|
1006
|
+
*
|
|
1007
|
+
* | Resource | Scopes |
|
|
1008
|
+
* | :------- | :---------- |
|
|
1009
|
+
* | Organization | `read_deploy_requests` |
|
|
1010
|
+
* | Database | `read_deploy_requests` |
|
|
1011
|
+
*/
|
|
1012
|
+
getDeployment<ThrowOnError extends boolean = true>(options: Options<GetDeploymentData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetDeploymentResponses, GetDeploymentErrors, ThrowOnError, "fields">;
|
|
1013
|
+
/**
|
|
1014
|
+
* List deploy operations
|
|
1015
|
+
* List deploy operations for a deploy request
|
|
1016
|
+
* ### Authorization
|
|
1017
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1018
|
+
*
|
|
1019
|
+
* **Service Token Accesses**
|
|
1020
|
+
* `read_deploy_request`
|
|
1021
|
+
*
|
|
1022
|
+
* **OAuth Scopes**
|
|
1023
|
+
*
|
|
1024
|
+
* | Resource | Scopes |
|
|
1025
|
+
* | :------- | :---------- |
|
|
1026
|
+
* | Organization | `read_deploy_requests` |
|
|
1027
|
+
* | Database | `read_deploy_requests` |
|
|
1028
|
+
*/
|
|
1029
|
+
listDeployOperations<ThrowOnError extends boolean = true>(options: Options<ListDeployOperationsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListDeployOperationsResponses, ListDeployOperationsErrors, ThrowOnError, "fields">;
|
|
1030
|
+
/**
|
|
1031
|
+
* Complete a revert
|
|
1032
|
+
*
|
|
1033
|
+
* ### Authorization
|
|
1034
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1035
|
+
*
|
|
1036
|
+
* **Service Token Accesses**
|
|
1037
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
1038
|
+
*
|
|
1039
|
+
* **OAuth Scopes**
|
|
1040
|
+
*
|
|
1041
|
+
* | Resource | Scopes |
|
|
1042
|
+
* | :------- | :---------- |
|
|
1043
|
+
* | Organization | `deploy_deploy_requests` |
|
|
1044
|
+
* | Database | `deploy_deploy_requests` |
|
|
1045
|
+
*/
|
|
1046
|
+
completeRevert<ThrowOnError extends boolean = true>(options: Options<CompleteRevertData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CompleteRevertResponses, CompleteRevertErrors, ThrowOnError, "fields">;
|
|
1047
|
+
/**
|
|
1048
|
+
* List deploy request reviews
|
|
1049
|
+
*
|
|
1050
|
+
* ### Authorization
|
|
1051
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1052
|
+
*
|
|
1053
|
+
* **Service Token Accesses**
|
|
1054
|
+
* `read_deploy_request`
|
|
1055
|
+
*
|
|
1056
|
+
* **OAuth Scopes**
|
|
1057
|
+
*
|
|
1058
|
+
* | Resource | Scopes |
|
|
1059
|
+
* | :------- | :---------- |
|
|
1060
|
+
* | Organization | `read_deploy_requests` |
|
|
1061
|
+
* | Database | `read_deploy_requests` |
|
|
1062
|
+
*/
|
|
1063
|
+
listDeployRequestReviews<ThrowOnError extends boolean = true>(options: Options<ListDeployRequestReviewsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListDeployRequestReviewsResponses, ListDeployRequestReviewsErrors, ThrowOnError, "fields">;
|
|
1064
|
+
/**
|
|
1065
|
+
* Review a deploy request
|
|
1066
|
+
* Review a deploy request by either approving or commenting on the deploy request
|
|
1067
|
+
* ### Authorization
|
|
1068
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1069
|
+
*
|
|
1070
|
+
* **Service Token Accesses**
|
|
1071
|
+
* `approve_deploy_request`, `review_deploy_request`
|
|
1072
|
+
*
|
|
1073
|
+
* **OAuth Scopes**
|
|
1074
|
+
*
|
|
1075
|
+
* | Resource | Scopes |
|
|
1076
|
+
* | :------- | :---------- |
|
|
1077
|
+
* | Organization | `approve_deploy_requests` |
|
|
1078
|
+
* | Database | `approve_deploy_requests` |
|
|
1079
|
+
*/
|
|
1080
|
+
reviewDeployRequest<ThrowOnError extends boolean = true>(options: Options<ReviewDeployRequestData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ReviewDeployRequestResponses, ReviewDeployRequestErrors, ThrowOnError, "fields">;
|
|
1081
|
+
/**
|
|
1082
|
+
* Skip revert period
|
|
1083
|
+
* Skips the revert period for a deploy request
|
|
1084
|
+
* ### Authorization
|
|
1085
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1086
|
+
*
|
|
1087
|
+
* **Service Token Accesses**
|
|
1088
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
1089
|
+
*
|
|
1090
|
+
* **OAuth Scopes**
|
|
1091
|
+
*
|
|
1092
|
+
* | Resource | Scopes |
|
|
1093
|
+
* | :------- | :---------- |
|
|
1094
|
+
* | Organization | `deploy_deploy_requests` |
|
|
1095
|
+
* | Database | `deploy_deploy_requests` |
|
|
1096
|
+
*/
|
|
1097
|
+
skipRevertPeriod<ThrowOnError extends boolean = true>(options: Options<SkipRevertPeriodData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<SkipRevertPeriodResponses, SkipRevertPeriodErrors, ThrowOnError, "fields">;
|
|
1098
|
+
/**
|
|
1099
|
+
* Get deploy request throttler configurations
|
|
1100
|
+
*
|
|
1101
|
+
* ### Authorization
|
|
1102
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1103
|
+
*
|
|
1104
|
+
* **Service Token Accesses**
|
|
1105
|
+
* `read_deploy_request`
|
|
1106
|
+
*
|
|
1107
|
+
* **OAuth Scopes**
|
|
1108
|
+
*
|
|
1109
|
+
* | Resource | Scopes |
|
|
1110
|
+
* | :------- | :---------- |
|
|
1111
|
+
* | Organization | `read_deploy_requests` |
|
|
1112
|
+
* | Database | `read_deploy_requests` |
|
|
1113
|
+
*/
|
|
1114
|
+
getDeployRequestThrottler<ThrowOnError extends boolean = true>(options: Options<GetDeployRequestThrottlerData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetDeployRequestThrottlerResponses, GetDeployRequestThrottlerErrors, ThrowOnError, "fields">;
|
|
1115
|
+
/**
|
|
1116
|
+
* Update deploy request throttler configurations
|
|
1117
|
+
*
|
|
1118
|
+
* ### Authorization
|
|
1119
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1120
|
+
*
|
|
1121
|
+
* **Service Token Accesses**
|
|
1122
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
1123
|
+
*
|
|
1124
|
+
* **OAuth Scopes**
|
|
1125
|
+
*
|
|
1126
|
+
* | Resource | Scopes |
|
|
1127
|
+
* | :------- | :---------- |
|
|
1128
|
+
* | Organization | `deploy_deploy_requests` |
|
|
1129
|
+
* | Database | `deploy_deploy_requests` |
|
|
1130
|
+
*/
|
|
1131
|
+
updateDeployRequestThrottler<ThrowOnError extends boolean = true>(options: Options<UpdateDeployRequestThrottlerData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateDeployRequestThrottlerResponses, UpdateDeployRequestThrottlerErrors, ThrowOnError, "fields">;
|
|
1132
|
+
/**
|
|
1133
|
+
* Get database throttler configurations
|
|
1134
|
+
*
|
|
1135
|
+
* ### Authorization
|
|
1136
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1137
|
+
*
|
|
1138
|
+
* **Service Token Accesses**
|
|
1139
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
1140
|
+
*
|
|
1141
|
+
* **OAuth Scopes**
|
|
1142
|
+
*
|
|
1143
|
+
* | Resource | Scopes |
|
|
1144
|
+
* | :------- | :---------- |
|
|
1145
|
+
* | Organization | `read_databases` |
|
|
1146
|
+
* | Database | `read_database` |
|
|
1147
|
+
*/
|
|
1148
|
+
getDatabaseThrottler<ThrowOnError extends boolean = true>(options: Options<GetDatabaseThrottlerData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetDatabaseThrottlerResponses, GetDatabaseThrottlerErrors, ThrowOnError, "fields">;
|
|
1149
|
+
/**
|
|
1150
|
+
* Update database throttler configurations
|
|
1151
|
+
*
|
|
1152
|
+
* ### Authorization
|
|
1153
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1154
|
+
*
|
|
1155
|
+
* **Service Token Accesses**
|
|
1156
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
1157
|
+
*
|
|
1158
|
+
* **OAuth Scopes**
|
|
1159
|
+
*
|
|
1160
|
+
* | Resource | Scopes |
|
|
1161
|
+
* | :------- | :---------- |
|
|
1162
|
+
* | Organization | `deploy_deploy_requests` |
|
|
1163
|
+
* | Database | `deploy_deploy_requests` |
|
|
1164
|
+
*/
|
|
1165
|
+
updateDatabaseThrottler<ThrowOnError extends boolean = true>(options: Options<UpdateDatabaseThrottlerData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateDatabaseThrottlerResponses, UpdateDatabaseThrottlerErrors, ThrowOnError, "fields">;
|
|
1166
|
+
/**
|
|
1167
|
+
* List webhooks
|
|
1168
|
+
* List webhooks for a database
|
|
1169
|
+
* ### Authorization
|
|
1170
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1171
|
+
*
|
|
1172
|
+
* **Service Token Accesses**
|
|
1173
|
+
* `read_database`
|
|
1174
|
+
*
|
|
1175
|
+
* **OAuth Scopes**
|
|
1176
|
+
*
|
|
1177
|
+
* | Resource | Scopes |
|
|
1178
|
+
* | :------- | :---------- |
|
|
1179
|
+
* | Organization | `read_databases` |
|
|
1180
|
+
* | Database | `read_database` |
|
|
1181
|
+
*/
|
|
1182
|
+
listWebhooks<ThrowOnError extends boolean = true>(options: Options<ListWebhooksData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListWebhooksResponses, ListWebhooksErrors, ThrowOnError, "fields">;
|
|
1183
|
+
/**
|
|
1184
|
+
* Create a webhook
|
|
1185
|
+
*
|
|
1186
|
+
* ### 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
|
+
* `write_database`
|
|
1191
|
+
*
|
|
1192
|
+
* **OAuth Scopes**
|
|
1193
|
+
*
|
|
1194
|
+
* | Resource | Scopes |
|
|
1195
|
+
* | :------- | :---------- |
|
|
1196
|
+
* | Organization | `write_databases` |
|
|
1197
|
+
* | Database | `write_database` |
|
|
1198
|
+
*/
|
|
1199
|
+
createWebhook<ThrowOnError extends boolean = true>(options: Options<CreateWebhookData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateWebhookResponses, CreateWebhookErrors, ThrowOnError, "fields">;
|
|
1200
|
+
/**
|
|
1201
|
+
* Delete a webhook
|
|
1202
|
+
*
|
|
1203
|
+
* ### Authorization
|
|
1204
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1205
|
+
*
|
|
1206
|
+
* **Service Token Accesses**
|
|
1207
|
+
* `write_database`
|
|
1208
|
+
*
|
|
1209
|
+
* **OAuth Scopes**
|
|
1210
|
+
*
|
|
1211
|
+
* | Resource | Scopes |
|
|
1212
|
+
* | :------- | :---------- |
|
|
1213
|
+
* | Organization | `write_databases` |
|
|
1214
|
+
* | Database | `write_database` |
|
|
1215
|
+
*/
|
|
1216
|
+
deleteWebhook<ThrowOnError extends boolean = true>(options: Options<DeleteWebhookData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteWebhookResponses, DeleteWebhookErrors, ThrowOnError, "fields">;
|
|
1217
|
+
/**
|
|
1218
|
+
* Get a webhook
|
|
1219
|
+
*
|
|
1220
|
+
* ### Authorization
|
|
1221
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1222
|
+
*
|
|
1223
|
+
* **Service Token Accesses**
|
|
1224
|
+
* `read_database`
|
|
1225
|
+
*
|
|
1226
|
+
* **OAuth Scopes**
|
|
1227
|
+
*
|
|
1228
|
+
* | Resource | Scopes |
|
|
1229
|
+
* | :------- | :---------- |
|
|
1230
|
+
* | Organization | `read_databases` |
|
|
1231
|
+
* | Database | `read_database` |
|
|
1232
|
+
*/
|
|
1233
|
+
getWebhook<ThrowOnError extends boolean = true>(options: Options<GetWebhookData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetWebhookResponses, GetWebhookErrors, ThrowOnError, "fields">;
|
|
1234
|
+
/**
|
|
1235
|
+
* Update a webhook
|
|
1236
|
+
*
|
|
1237
|
+
* ### Authorization
|
|
1238
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1239
|
+
*
|
|
1240
|
+
* **Service Token Accesses**
|
|
1241
|
+
* `write_database`
|
|
1242
|
+
*
|
|
1243
|
+
* **OAuth Scopes**
|
|
1244
|
+
*
|
|
1245
|
+
* | Resource | Scopes |
|
|
1246
|
+
* | :------- | :---------- |
|
|
1247
|
+
* | Organization | `write_databases` |
|
|
1248
|
+
* | Database | `write_database` |
|
|
1249
|
+
*/
|
|
1250
|
+
updateWebhook<ThrowOnError extends boolean = true>(options: Options<UpdateWebhookData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateWebhookResponses, UpdateWebhookErrors, ThrowOnError, "fields">;
|
|
1251
|
+
/**
|
|
1252
|
+
* Test a webhook
|
|
1253
|
+
* Sends a test event to the webhook
|
|
1254
|
+
* ### Authorization
|
|
1255
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1256
|
+
*
|
|
1257
|
+
* **Service Token Accesses**
|
|
1258
|
+
* `write_database`
|
|
1259
|
+
*
|
|
1260
|
+
* **OAuth Scopes**
|
|
1261
|
+
*
|
|
1262
|
+
* | Resource | Scopes |
|
|
1263
|
+
* | :------- | :---------- |
|
|
1264
|
+
* | Organization | `write_databases` |
|
|
1265
|
+
* | Database | `write_database` |
|
|
1266
|
+
*/
|
|
1267
|
+
testWebhook<ThrowOnError extends boolean = true>(options: Options<TestWebhookData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<TestWebhookResponses, TestWebhookErrors, ThrowOnError, "fields">;
|
|
1268
|
+
/**
|
|
1269
|
+
* List workflows
|
|
1270
|
+
*
|
|
1271
|
+
*
|
|
1272
|
+
*/
|
|
1273
|
+
listWorkflows<ThrowOnError extends boolean = true>(options: Options<ListWorkflowsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListWorkflowsResponses, ListWorkflowsErrors, ThrowOnError, "fields">;
|
|
1274
|
+
/**
|
|
1275
|
+
* Create a workflow
|
|
1276
|
+
*
|
|
1277
|
+
*
|
|
1278
|
+
*/
|
|
1279
|
+
createWorkflow<ThrowOnError extends boolean = true>(options: Options<CreateWorkflowData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateWorkflowResponses, CreateWorkflowErrors, ThrowOnError, "fields">;
|
|
1280
|
+
/**
|
|
1281
|
+
* Cancel a workflow
|
|
1282
|
+
*
|
|
1283
|
+
*
|
|
1284
|
+
*/
|
|
1285
|
+
workflowCancel<ThrowOnError extends boolean = true>(options: Options<WorkflowCancelData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<WorkflowCancelResponses, WorkflowCancelErrors, ThrowOnError, "fields">;
|
|
1286
|
+
/**
|
|
1287
|
+
* Get a workflow
|
|
1288
|
+
*
|
|
1289
|
+
*
|
|
1290
|
+
*/
|
|
1291
|
+
getWorkflow<ThrowOnError extends boolean = true>(options: Options<GetWorkflowData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetWorkflowResponses, GetWorkflowErrors, ThrowOnError, "fields">;
|
|
1292
|
+
/**
|
|
1293
|
+
* Complete a workflow
|
|
1294
|
+
*
|
|
1295
|
+
*
|
|
1296
|
+
*/
|
|
1297
|
+
workflowComplete<ThrowOnError extends boolean = true>(options: Options<WorkflowCompleteData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<WorkflowCompleteResponses, WorkflowCompleteErrors, ThrowOnError, "fields">;
|
|
1298
|
+
/**
|
|
1299
|
+
* Cutover traffic
|
|
1300
|
+
*
|
|
1301
|
+
*
|
|
1302
|
+
*/
|
|
1303
|
+
workflowCutover<ThrowOnError extends boolean = true>(options: Options<WorkflowCutoverData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<WorkflowCutoverResponses, WorkflowCutoverErrors, ThrowOnError, "fields">;
|
|
1304
|
+
/**
|
|
1305
|
+
* Retry a failed workflow
|
|
1306
|
+
*
|
|
1307
|
+
*
|
|
1308
|
+
*/
|
|
1309
|
+
workflowRetry<ThrowOnError extends boolean = true>(options: Options<WorkflowRetryData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<WorkflowRetryResponses, WorkflowRetryErrors, ThrowOnError, "fields">;
|
|
1310
|
+
/**
|
|
1311
|
+
* Reverse traffic cutover
|
|
1312
|
+
*
|
|
1313
|
+
*
|
|
1314
|
+
*/
|
|
1315
|
+
workflowReverseCutover<ThrowOnError extends boolean = true>(options: Options<WorkflowReverseCutoverData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<WorkflowReverseCutoverResponses, WorkflowReverseCutoverErrors, ThrowOnError, "fields">;
|
|
1316
|
+
/**
|
|
1317
|
+
* Reverse traffic
|
|
1318
|
+
*
|
|
1319
|
+
*
|
|
1320
|
+
*/
|
|
1321
|
+
workflowReverseTraffic<ThrowOnError extends boolean = true>(options: Options<WorkflowReverseTrafficData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<WorkflowReverseTrafficResponses, WorkflowReverseTrafficErrors, ThrowOnError, "fields">;
|
|
1322
|
+
/**
|
|
1323
|
+
* Switch primary traffic
|
|
1324
|
+
*
|
|
1325
|
+
*
|
|
1326
|
+
*/
|
|
1327
|
+
workflowSwitchPrimaries<ThrowOnError extends boolean = true>(options: Options<WorkflowSwitchPrimariesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<WorkflowSwitchPrimariesResponses, WorkflowSwitchPrimariesErrors, ThrowOnError, "fields">;
|
|
1328
|
+
/**
|
|
1329
|
+
* Switch replica traffic
|
|
1330
|
+
*
|
|
1331
|
+
*
|
|
1332
|
+
*/
|
|
1333
|
+
workflowSwitchReplicas<ThrowOnError extends boolean = true>(options: Options<WorkflowSwitchReplicasData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<WorkflowSwitchReplicasResponses, WorkflowSwitchReplicasErrors, ThrowOnError, "fields">;
|
|
1334
|
+
/**
|
|
1335
|
+
* Verify workflow data
|
|
1336
|
+
*
|
|
1337
|
+
*
|
|
1338
|
+
*/
|
|
1339
|
+
verifyWorkflow<ThrowOnError extends boolean = true>(options: Options<VerifyWorkflowData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<VerifyWorkflowResponses, VerifyWorkflowErrors, ThrowOnError, "fields">;
|
|
1340
|
+
/**
|
|
1341
|
+
* Delete a database
|
|
1342
|
+
*
|
|
1343
|
+
* ### Authorization
|
|
1344
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1345
|
+
*
|
|
1346
|
+
* **Service Token Accesses**
|
|
1347
|
+
* `delete_database`
|
|
1348
|
+
*
|
|
1349
|
+
* **OAuth Scopes**
|
|
1350
|
+
*
|
|
1351
|
+
* | Resource | Scopes |
|
|
1352
|
+
* | :------- | :---------- |
|
|
1353
|
+
* | Organization | `delete_databases` |
|
|
1354
|
+
* | Database | `delete_database` |
|
|
1355
|
+
*/
|
|
1356
|
+
deleteDatabase<ThrowOnError extends boolean = true>(options: Options<DeleteDatabaseData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteDatabaseResponses, DeleteDatabaseErrors, ThrowOnError, "fields">;
|
|
1357
|
+
/**
|
|
1358
|
+
* Get a database
|
|
1359
|
+
*
|
|
1360
|
+
* ### Authorization
|
|
1361
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1362
|
+
*
|
|
1363
|
+
* **Service Token Accesses**
|
|
1364
|
+
* `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`
|
|
1365
|
+
*
|
|
1366
|
+
* **OAuth Scopes**
|
|
1367
|
+
*
|
|
1368
|
+
* | Resource | Scopes |
|
|
1369
|
+
* | :------- | :---------- |
|
|
1370
|
+
* | Organization | `read_databases` |
|
|
1371
|
+
* | Database | `read_database` |
|
|
1372
|
+
*/
|
|
1373
|
+
getDatabase<ThrowOnError extends boolean = true>(options: Options<GetDatabaseData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetDatabaseResponses, GetDatabaseErrors, ThrowOnError, "fields">;
|
|
1374
|
+
/**
|
|
1375
|
+
* Update database settings
|
|
1376
|
+
*
|
|
1377
|
+
* ### Authorization
|
|
1378
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1379
|
+
*
|
|
1380
|
+
* **Service Token Accesses**
|
|
1381
|
+
* `write_database`
|
|
1382
|
+
*
|
|
1383
|
+
* **OAuth Scopes**
|
|
1384
|
+
*
|
|
1385
|
+
* | Resource | Scopes |
|
|
1386
|
+
* | :------- | :---------- |
|
|
1387
|
+
* | Organization | `write_databases` |
|
|
1388
|
+
* | Database | `write_database` |
|
|
1389
|
+
*/
|
|
1390
|
+
updateDatabaseSettings<ThrowOnError extends boolean = true>(options: Options<UpdateDatabaseSettingsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<UpdateDatabaseSettingsResponses, UpdateDatabaseSettingsErrors, ThrowOnError, "fields">;
|
|
1391
|
+
/**
|
|
1392
|
+
* List read-only regions
|
|
1393
|
+
* List read-only regions for the database's default branch
|
|
1394
|
+
* ### Authorization
|
|
1395
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1396
|
+
*
|
|
1397
|
+
* **Service Token Accesses**
|
|
1398
|
+
* `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`
|
|
1399
|
+
*
|
|
1400
|
+
* **OAuth Scopes**
|
|
1401
|
+
*
|
|
1402
|
+
* | Resource | Scopes |
|
|
1403
|
+
* | :------- | :---------- |
|
|
1404
|
+
* | Organization | `read_branches` |
|
|
1405
|
+
* | Database | `read_branches` |
|
|
1406
|
+
*/
|
|
1407
|
+
listReadOnlyRegions<ThrowOnError extends boolean = true>(options: Options<ListReadOnlyRegionsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListReadOnlyRegionsResponses, ListReadOnlyRegionsErrors, ThrowOnError, "fields">;
|
|
1408
|
+
/**
|
|
1409
|
+
* List database regions
|
|
1410
|
+
*
|
|
1411
|
+
* ### Authorization
|
|
1412
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1413
|
+
*
|
|
1414
|
+
* **Service Token Accesses**
|
|
1415
|
+
* `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`
|
|
1416
|
+
*
|
|
1417
|
+
* **OAuth Scopes**
|
|
1418
|
+
*
|
|
1419
|
+
* | Resource | Scopes |
|
|
1420
|
+
* | :------- | :---------- |
|
|
1421
|
+
* | Organization | `read_databases` |
|
|
1422
|
+
* | Database | `read_database` |
|
|
1423
|
+
*/
|
|
1424
|
+
listDatabaseRegions<ThrowOnError extends boolean = true>(options: Options<ListDatabaseRegionsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListDatabaseRegionsResponses, ListDatabaseRegionsErrors, ThrowOnError, "fields">;
|
|
1425
|
+
/**
|
|
1426
|
+
* Get invoices
|
|
1427
|
+
* Get the invoices for an organization
|
|
1428
|
+
* ### Authorization
|
|
1429
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1430
|
+
*
|
|
1431
|
+
* **Service Token Accesses**
|
|
1432
|
+
* `read_invoices`
|
|
1433
|
+
*
|
|
1434
|
+
* **OAuth Scopes**
|
|
1435
|
+
*
|
|
1436
|
+
* | Resource | Scopes |
|
|
1437
|
+
* | :------- | :---------- |
|
|
1438
|
+
* | Organization | `read_invoices` |
|
|
1439
|
+
*/
|
|
1440
|
+
listInvoices<ThrowOnError extends boolean = true>(options: Options<ListInvoicesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
1441
|
+
/**
|
|
1442
|
+
* Get an invoice
|
|
1443
|
+
*
|
|
1444
|
+
* ### Authorization
|
|
1445
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1446
|
+
*
|
|
1447
|
+
* **Service Token Accesses**
|
|
1448
|
+
* `read_invoices`
|
|
1449
|
+
*
|
|
1450
|
+
* **OAuth Scopes**
|
|
1451
|
+
*
|
|
1452
|
+
* | Resource | Scopes |
|
|
1453
|
+
* | :------- | :---------- |
|
|
1454
|
+
* | Organization | `read_invoices` |
|
|
1455
|
+
*/
|
|
1456
|
+
getInvoice<ThrowOnError extends boolean = true>(options: Options<GetInvoiceData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetInvoiceResponses, GetInvoiceErrors, ThrowOnError, "fields">;
|
|
1457
|
+
/**
|
|
1458
|
+
* Get invoice line items
|
|
1459
|
+
* Get the line items for an invoice
|
|
1460
|
+
* ### Authorization
|
|
1461
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1462
|
+
*
|
|
1463
|
+
* **Service Token Accesses**
|
|
1464
|
+
* `read_invoices`
|
|
1465
|
+
*
|
|
1466
|
+
* **OAuth Scopes**
|
|
1467
|
+
*
|
|
1468
|
+
* | Resource | Scopes |
|
|
1469
|
+
* | :------- | :---------- |
|
|
1470
|
+
* | Organization | `read_invoices` |
|
|
1471
|
+
*/
|
|
1472
|
+
getInvoiceLineItems<ThrowOnError extends boolean = true>(options: Options<GetInvoiceLineItemsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetInvoiceLineItemsResponses, GetInvoiceLineItemsErrors, ThrowOnError, "fields">;
|
|
1473
|
+
/**
|
|
1474
|
+
* List organization members
|
|
1475
|
+
*
|
|
1476
|
+
* ### Authorization
|
|
1477
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
1478
|
+
*
|
|
1479
|
+
* **Service Token Accesses**
|
|
1480
|
+
* `read_organization`
|
|
1481
|
+
*
|
|
1482
|
+
*
|
|
1483
|
+
*/
|
|
1484
|
+
listOrganizationMembers<ThrowOnError extends boolean = true>(options: Options<ListOrganizationMembersData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListOrganizationMembersResponses, ListOrganizationMembersErrors, ThrowOnError, "fields">;
|
|
1485
|
+
/**
|
|
1486
|
+
* List OAuth applications
|
|
1487
|
+
*
|
|
1488
|
+
* ### Authorization
|
|
1489
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
1490
|
+
*
|
|
1491
|
+
* **Service Token Accesses**
|
|
1492
|
+
* `read_oauth_applications`
|
|
1493
|
+
*
|
|
1494
|
+
*
|
|
1495
|
+
*/
|
|
1496
|
+
listOauthApplications<ThrowOnError extends boolean = true>(options: Options<ListOauthApplicationsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListOauthApplicationsResponses, ListOauthApplicationsErrors, ThrowOnError, "fields">;
|
|
1497
|
+
/**
|
|
1498
|
+
* Get an OAuth application
|
|
1499
|
+
*
|
|
1500
|
+
* ### Authorization
|
|
1501
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
1502
|
+
*
|
|
1503
|
+
* **Service Token Accesses**
|
|
1504
|
+
* `read_oauth_applications`
|
|
1505
|
+
*
|
|
1506
|
+
*
|
|
1507
|
+
*/
|
|
1508
|
+
getOauthApplication<ThrowOnError extends boolean = true>(options: Options<GetOauthApplicationData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetOauthApplicationResponses, GetOauthApplicationErrors, ThrowOnError, "fields">;
|
|
1509
|
+
/**
|
|
1510
|
+
* List OAuth tokens
|
|
1511
|
+
* List OAuth tokens created by an OAuth application
|
|
1512
|
+
* ### Authorization
|
|
1513
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
1514
|
+
*
|
|
1515
|
+
* **Service Token Accesses**
|
|
1516
|
+
* `read_oauth_tokens`
|
|
1517
|
+
*
|
|
1518
|
+
*
|
|
1519
|
+
*/
|
|
1520
|
+
listOauthTokens<ThrowOnError extends boolean = true>(options: Options<ListOauthTokensData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListOauthTokensResponses, ListOauthTokensErrors, ThrowOnError, "fields">;
|
|
1521
|
+
/**
|
|
1522
|
+
* Delete an OAuth token
|
|
1523
|
+
*
|
|
1524
|
+
* ### Authorization
|
|
1525
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
1526
|
+
*
|
|
1527
|
+
* **Service Token Accesses**
|
|
1528
|
+
* `delete_oauth_tokens`
|
|
1529
|
+
*
|
|
1530
|
+
*
|
|
1531
|
+
*/
|
|
1532
|
+
deleteOauthToken<ThrowOnError extends boolean = true>(options: Options<DeleteOauthTokenData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<DeleteOauthTokenResponses, DeleteOauthTokenErrors, ThrowOnError, "fields">;
|
|
1533
|
+
/**
|
|
1534
|
+
* Get an OAuth token
|
|
1535
|
+
*
|
|
1536
|
+
* ### Authorization
|
|
1537
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
1538
|
+
*
|
|
1539
|
+
* **Service Token Accesses**
|
|
1540
|
+
* `read_oauth_tokens`
|
|
1541
|
+
*
|
|
1542
|
+
*
|
|
1543
|
+
*/
|
|
1544
|
+
getOauthToken<ThrowOnError extends boolean = true>(options: Options<GetOauthTokenData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetOauthTokenResponses, GetOauthTokenErrors, ThrowOnError, "fields">;
|
|
1545
|
+
/**
|
|
1546
|
+
* Create or renew an OAuth token
|
|
1547
|
+
* Create an OAuth token from an authorization grant code, or refresh an OAuth token from a refresh token
|
|
1548
|
+
* ### Authorization
|
|
1549
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
1550
|
+
*
|
|
1551
|
+
* **Service Token Accesses**
|
|
1552
|
+
* `write_oauth_tokens`
|
|
1553
|
+
*
|
|
1554
|
+
*
|
|
1555
|
+
*/
|
|
1556
|
+
createOauthToken<ThrowOnError extends boolean = true>(options: Options<CreateOauthTokenData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<CreateOauthTokenResponses, CreateOauthTokenErrors, ThrowOnError, "fields">;
|
|
1557
|
+
/**
|
|
1558
|
+
* List public regions
|
|
1559
|
+
* Endpoint is available without authentication.
|
|
1560
|
+
*
|
|
1561
|
+
*/
|
|
1562
|
+
listPublicRegions<ThrowOnError extends boolean = true>(options?: Options<ListPublicRegionsData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListPublicRegionsResponses, ListPublicRegionsErrors, ThrowOnError, "fields">;
|
|
1563
|
+
/**
|
|
1564
|
+
* Get current user
|
|
1565
|
+
* Get the user associated with this service token
|
|
1566
|
+
* ### Authorization
|
|
1567
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1568
|
+
*
|
|
1569
|
+
* **OAuth Scopes**
|
|
1570
|
+
*
|
|
1571
|
+
* | Resource | Scopes |
|
|
1572
|
+
* | :------- | :---------- |
|
|
1573
|
+
* | User | `read_user` |
|
|
1574
|
+
*/
|
|
1575
|
+
getCurrentUser<ThrowOnError extends boolean = true>(options?: Options<GetCurrentUserData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<GetCurrentUserResponses, GetCurrentUserErrors, ThrowOnError, "fields">;
|
|
1576
|
+
/**
|
|
1577
|
+
* List keyspace resizes
|
|
1578
|
+
*/
|
|
1579
|
+
listKeyspaceResizes<ThrowOnError extends boolean = true>(options: Options<ListKeyspaceResizesData, ThrowOnError>): import("../../util/api/client/types.gen.ts").RequestResult<ListKeyspaceResizesResponses, ListKeyspaceResizesErrors, ThrowOnError, "fields">;
|
|
1580
|
+
}
|
|
1581
|
+
export {};
|
|
1582
|
+
//# sourceMappingURL=sdk.gen.d.ts.map
|