import type { Client, Options as Options2, TDataShape } from "../../util/api/client/index.ts"; import type { AddOrganizationTeamMemberData, AddOrganizationTeamMemberErrors, AddOrganizationTeamMemberResponses, CancelBouncerResizeRequestData, CancelBouncerResizeRequestErrors, CancelBouncerResizeRequestResponses, CancelBranchChangeRequestData, CancelBranchChangeRequestErrors, CancelBranchChangeRequestResponses, CancelDeployRequestData, CancelDeployRequestErrors, CancelDeployRequestResponses, CloseDeployRequestData, CloseDeployRequestErrors, CloseDeployRequestResponses, CompleteErroredDeployData, CompleteErroredDeployErrors, CompleteErroredDeployResponses, CompleteGatedDeployRequestData, CompleteGatedDeployRequestErrors, CompleteGatedDeployRequestResponses, CompleteRevertData, CompleteRevertErrors, CompleteRevertResponses, CreateBackupData, CreateBackupErrors, CreateBackupResponses, CreateBouncerData, CreateBouncerErrors, CreateBouncerResponses, CreateBranchData, CreateBranchErrors, CreateBranchResponses, CreateDatabaseData, CreateDatabaseErrors, CreateDatabasePostgresCidrData, CreateDatabasePostgresCidrErrors, CreateDatabasePostgresCidrResponses, CreateDatabaseResponses, CreateDeployRequestData, CreateDeployRequestErrors, CreateDeployRequestResponses, CreateKeyspaceData, CreateKeyspaceErrors, CreateKeyspaceResponses, CreateOauthTokenData, CreateOauthTokenErrors, CreateOauthTokenResponses, CreateOrganizationTeamData, CreateOrganizationTeamErrors, CreateOrganizationTeamResponses, CreatePasswordData, CreatePasswordErrors, CreatePasswordResponses, CreateQueryPatternsReportData, CreateQueryPatternsReportErrors, CreateQueryPatternsReportResponses, CreateRoleData, CreateRoleErrors, CreateRoleResponses, CreateServiceTokenData, CreateServiceTokenErrors, CreateServiceTokenResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteBackupData, DeleteBackupErrors, DeleteBackupResponses, DeleteBouncerData, DeleteBouncerErrors, DeleteBouncerResponses, DeleteBranchData, DeleteBranchErrors, DeleteBranchResponses, DeleteDatabaseData, DeleteDatabaseErrors, DeleteDatabasePostgresCidrData, DeleteDatabasePostgresCidrErrors, DeleteDatabasePostgresCidrResponses, DeleteDatabaseResponses, DeleteKeyspaceData, DeleteKeyspaceErrors, DeleteKeyspaceResponses, DeleteOauthTokenData, DeleteOauthTokenErrors, DeleteOauthTokenResponses, DeleteOrganizationTeamData, DeleteOrganizationTeamErrors, DeleteOrganizationTeamResponses, DeletePasswordData, DeletePasswordErrors, DeletePasswordResponses, DeleteQueryPatternsReportData, DeleteQueryPatternsReportErrors, DeleteQueryPatternsReportResponses, DeleteRoleData, DeleteRoleErrors, DeleteRoleResponses, DeleteServiceTokenData, DeleteServiceTokenErrors, DeleteServiceTokenResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, DemoteBranchData, DemoteBranchErrors, DemoteBranchResponses, DisableSafeMigrationsData, DisableSafeMigrationsErrors, DisableSafeMigrationsResponses, DismissSchemaRecommendationData, DismissSchemaRecommendationErrors, DismissSchemaRecommendationResponses, EnableSafeMigrationsData, EnableSafeMigrationsErrors, EnableSafeMigrationsResponses, GetBackupData, GetBackupErrors, GetBackupResponses, GetBouncerData, GetBouncerErrors, GetBouncerResponses, GetBranchChangeRequestData, GetBranchChangeRequestErrors, GetBranchChangeRequestResponses, GetBranchData, GetBranchErrors, GetBranchResponses, GetBranchSchemaData, GetBranchSchemaErrors, GetBranchSchemaResponses, GetCurrentUserData, GetCurrentUserErrors, GetCurrentUserResponses, GetDatabaseData, GetDatabaseErrors, GetDatabasePostgresCidrData, GetDatabasePostgresCidrErrors, GetDatabasePostgresCidrResponses, GetDatabaseResponses, GetDatabaseThrottlerData, GetDatabaseThrottlerErrors, GetDatabaseThrottlerResponses, GetDefaultRoleData, GetDefaultRoleErrors, GetDefaultRoleResponses, 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, GetOrganizationMembershipData, GetOrganizationMembershipErrors, GetOrganizationMembershipResponses, GetOrganizationResponses, GetOrganizationTeamData, GetOrganizationTeamErrors, GetOrganizationTeamMemberData, GetOrganizationTeamMemberErrors, GetOrganizationTeamMemberResponses, GetOrganizationTeamResponses, GetPasswordData, GetPasswordErrors, GetPasswordResponses, GetQueryPatternsReportData, GetQueryPatternsReportErrors, GetQueryPatternsReportStatusData, GetQueryPatternsReportStatusErrors, GetQueryPatternsReportStatusResponses, GetRoleData, GetRoleErrors, GetRoleResponses, GetSchemaRecommendationData, GetSchemaRecommendationErrors, GetSchemaRecommendationResponses, GetServiceTokenData, GetServiceTokenErrors, GetServiceTokenResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponses, LintBranchSchemaData, LintBranchSchemaErrors, LintBranchSchemaResponses, ListAuditLogsData, ListAuditLogsErrors, ListAuditLogsResponses, ListBackupsData, ListBackupsErrors, ListBackupsResponses, ListBouncerResizeRequestsData, ListBouncerResizeRequestsErrors, ListBouncerResizeRequestsResponses, ListBouncersData, ListBouncersErrors, ListBouncersResponses, ListBranchBouncerResizeRequestsData, ListBranchBouncerResizeRequestsErrors, ListBranchBouncerResizeRequestsResponses, ListBranchChangeRequestsData, ListBranchChangeRequestsErrors, ListBranchChangeRequestsResponses, ListBranchesData, ListBranchesErrors, ListBranchesResponses, ListClusterSizeSkusData, ListClusterSizeSkusErrors, ListClusterSizeSkusResponses, ListDatabasePostgresCidrsData, ListDatabasePostgresCidrsErrors, ListDatabasePostgresCidrsResponses, 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, ListOrganizationTeamMembersData, ListOrganizationTeamMembersErrors, ListOrganizationTeamMembersResponses, ListOrganizationTeamsData, ListOrganizationTeamsErrors, ListOrganizationTeamsResponses, ListParametersData, ListParametersErrors, ListParametersResponses, ListPasswordsData, ListPasswordsErrors, ListPasswordsResponses, ListPublicRegionsData, ListPublicRegionsErrors, ListPublicRegionsResponses, ListReadOnlyRegionsData, ListReadOnlyRegionsErrors, ListReadOnlyRegionsResponses, ListRegionsForOrganizationData, ListRegionsForOrganizationErrors, ListRegionsForOrganizationResponses, ListRolesData, ListRolesErrors, ListRolesResponses, ListSchemaRecommendationsData, ListSchemaRecommendationsErrors, ListSchemaRecommendationsResponses, ListServiceTokensData, ListServiceTokensErrors, ListServiceTokensResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, PromoteBranchData, PromoteBranchErrors, PromoteBranchResponses, QueueDeployRequestData, QueueDeployRequestErrors, QueueDeployRequestResponses, ReassignRoleObjectsData, ReassignRoleObjectsErrors, ReassignRoleObjectsResponses, RemoveOrganizationMemberData, RemoveOrganizationMemberErrors, RemoveOrganizationMemberResponses, RemoveOrganizationTeamMemberData, RemoveOrganizationTeamMemberErrors, RemoveOrganizationTeamMemberResponses, RenewPasswordData, RenewPasswordErrors, RenewPasswordResponses, RenewRoleData, RenewRoleErrors, RenewRoleResponses, ResetDefaultRoleData, ResetDefaultRoleErrors, ResetDefaultRoleResponses, ResetRoleData, ResetRoleErrors, ResetRoleResponses, ReviewDeployRequestData, ReviewDeployRequestErrors, ReviewDeployRequestResponses, SkipRevertPeriodData, SkipRevertPeriodErrors, SkipRevertPeriodResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAutoApplyData, UpdateAutoApplyErrors, UpdateAutoApplyResponses, UpdateAutoDeleteBranchData, UpdateAutoDeleteBranchErrors, UpdateAutoDeleteBranchResponses, UpdateBackupData, UpdateBackupErrors, UpdateBackupResponses, UpdateBouncerResizeRequestData, UpdateBouncerResizeRequestErrors, UpdateBouncerResizeRequestResponses, UpdateBranchChangeRequestData, UpdateBranchChangeRequestErrors, UpdateBranchChangeRequestResponses, UpdateBranchClusterConfigData, UpdateBranchClusterConfigErrors, UpdateBranchClusterConfigResponses, UpdateBranchData, UpdateBranchErrors, UpdateBranchResponses, UpdateDatabasePostgresCidrData, UpdateDatabasePostgresCidrErrors, UpdateDatabasePostgresCidrResponses, UpdateDatabaseSettingsData, UpdateDatabaseSettingsErrors, UpdateDatabaseSettingsResponses, UpdateDatabaseThrottlerData, UpdateDatabaseThrottlerErrors, UpdateDatabaseThrottlerResponses, UpdateDeployRequestThrottlerData, UpdateDeployRequestThrottlerErrors, UpdateDeployRequestThrottlerResponses, UpdateKeyspaceData, UpdateKeyspaceErrors, UpdateKeyspaceResponses, UpdateKeyspaceVschemaData, UpdateKeyspaceVschemaErrors, UpdateKeyspaceVschemaResponses, UpdateOrganizationData, UpdateOrganizationErrors, UpdateOrganizationMembershipData, UpdateOrganizationMembershipErrors, UpdateOrganizationMembershipResponses, UpdateOrganizationResponses, UpdateOrganizationTeamData, UpdateOrganizationTeamErrors, UpdateOrganizationTeamResponses, 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"; export type Options = Options2 & { /** * You can provide a client instance returned by `createClient()` instead of * individual options. This might be also useful if you want to implement a * custom client. */ client?: Client; /** * You can pass arbitrary values through the `meta` object. This can be * used to access values that aren't defined as part of the SDK function. */ meta?: Record; }; declare class _HeyApiClient { protected _client: Client; constructor(args?: { client?: Client; }); } export declare class PlanetScaleClient extends _HeyApiClient { /** * List organizations * 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. * ### Authorization * A OAuth token must have at least one of the following scopes in order to use this API endpoint: * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | User | `read_organizations` | */ listOrganizations(options?: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get an organization * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_organization` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | User | `read_organizations` | * | Organization | `read_organization` | */ getOrganization(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update an organization * * ### Authorization * A OAuth token must have at least one of the following scopes in order to use this API endpoint: * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_organization` | */ updateOrganization(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List audit logs * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `read_audit_logs` * * */ listAuditLogs(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List available cluster sizes * List available cluster sizes for an organization * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_organization` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | User | `read_organizations` | * | Organization | `read_organization` | */ listClusterSizeSkus(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List databases * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `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` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | */ listDatabases(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a database * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `create_databases` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `create_databases` | */ createDatabase(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete a database * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `delete_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `delete_databases` | * | Database | `delete_database` | */ deleteDatabase(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a database * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `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` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | * | Database | `read_database` | */ getDatabase(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update database settings * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ updateDatabaseSettings(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List branches * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ listBranches(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a branch * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `create_branch`, `restore_production_branch_backup`, `restore_backup` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_branches`, `restore_production_branch_backups`, `restore_backups` | * | Database | `write_branches`, `restore_production_branch_backups`, `restore_backups` | * | Branch | `restore_backups` | */ createBranch(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete a branch * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `delete_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `delete_branches`, `delete_production_branches` | * | Database | `delete_branches`, `delete_production_branches` | * | Branch | `delete_branch` | */ deleteBranch(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a branch * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ getBranch(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update a branch * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_branches` | * | Database | `write_branches` | * | Branch | `write_branch` | */ updateBranch(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List backups * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_backups` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_backups` | * | Database | `read_backups` | * | Branch | `read_backups` | */ listBackups(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a backup * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_backups` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_backups` | * | Database | `write_backups` | * | Branch | `write_backups` | */ createBackup(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete a backup * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `delete_backups`, `delete_production_branch_backups` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `delete_backups`, `delete_production_branch_backups` | * | Database | `delete_backups`, `delete_production_branch_backups` | * | Branch | `delete_backups` | */ deleteBackup(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a backup * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_backups` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_backups` | * | Database | `read_backups` | * | Branch | `read_backups` | */ getBackup(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update a backup * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_backups` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_backups` | * | Database | `write_backups` | * | Branch | `write_backups` | */ updateBackup(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get bouncer resize requests * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ listBranchBouncerResizeRequests(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List bouncers * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ listBouncers(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a bouncer * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ createBouncer(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete a bouncer * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ deleteBouncer(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a bouncer * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ getBouncer(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Cancel a resize request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ cancelBouncerResizeRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get bouncer resize requests * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ listBouncerResizeRequests(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Upsert a bouncer resize request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ updateBouncerResizeRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get branch change requests * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ listBranchChangeRequests(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Upsert a change request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ updateBranchChangeRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a branch change request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ getBranchChangeRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Change a branch cluster configuration * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * */ updateBranchClusterConfig(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Demote a branch * Demotes a branch from production to development * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `connect_production_branch`, `demote_branches` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `demote_branches` | * | Database | `demote_branches` | */ demoteBranch(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List cluster extensions * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ listExtensions(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get keyspaces * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `read_branch` * * */ listKeyspaces(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a keyspace * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `create_branch` * * */ createKeyspace(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete a keyspace * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `delete_branch`, `delete_production_branch` * * */ deleteKeyspace(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a keyspace * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `read_branch` * * */ getKeyspace(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Configure keyspace settings * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `create_branch` * * */ updateKeyspace(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get keyspace rollout status * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `read_branch` * * */ getKeyspaceRolloutStatus(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get the VSchema for the keyspace * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * */ getKeyspaceVschema(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update the VSchema for the keyspace * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `write_production_branch_vschema`, `write_branch_vschema` * * */ updateKeyspaceVschema(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List cluster parameters * Returns the parameters for a branch. To update the parameters, use the "Upsert a change request" endpoint. * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ listParameters(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List passwords * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ listPasswords(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a password * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ createPassword(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete a password * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ deletePassword(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a password * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ getPassword(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update a password * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ updatePassword(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Renew a password * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ renewPassword(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Promote a branch * Promotes a branch from development to production * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `connect_production_branch`, `promote_branches` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `promote_branches` | * | Database | `promote_branches` | */ promoteBranch(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List generated query patterns reports * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ listGeneratedQueryPatternsReports(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a new query patterns report * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ createQueryPatternsReport(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete a query patterns report * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ deleteQueryPatternsReport(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Show the status of a query patterns report * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ getQueryPatternsReportStatus(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Download a finished query patterns report * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ getQueryPatternsReport(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Cancel a change request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ cancelBranchChangeRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List roles * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ listRoles(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create role credentials * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ createRole(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get the default postgres role * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ getDefaultRole(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Reset default credentials * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ resetDefaultRole(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete role credentials * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ deleteRole(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a role * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ getRole(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update role name * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ updateRole(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Reassign objects owned by one role to another role * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ reassignRoleObjects(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Renew role expiration * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ renewRole(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Reset a role's password * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` | * | Branch | `manage_passwords`, `manage_read_only_passwords` | */ resetRole(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Disable safe migrations for a branch * * */ disableSafeMigrations(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Enable safe migrations for a branch * * */ enableSafeMigrations(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a branch schema * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ getBranchSchema(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Lint a branch schema * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | * | Branch | `read_branch` | */ lintBranchSchema(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List IP restriction entries * * ### Authorization * A OAuth token must have at least one of the following scopes in order to use this API endpoint: * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | * | Database | `read_database` | */ listDatabasePostgresCidrs(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create an IP restriction entry * * ### Authorization * A OAuth token must have at least one of the following scopes in order to use this API endpoint: * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ createDatabasePostgresCidr(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete an IP restriction entry * * ### Authorization * A OAuth token must have at least one of the following scopes in order to use this API endpoint: * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ deleteDatabasePostgresCidr(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get an IP restriction entry * * ### Authorization * A OAuth token must have at least one of the following scopes in order to use this API endpoint: * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | * | Database | `read_database` | */ getDatabasePostgresCidr(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update an IP restriction entry * * ### Authorization * A OAuth token must have at least one of the following scopes in order to use this API endpoint: * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ updateDatabasePostgresCidr(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get the deploy queue * The deploy queue returns the current list of deploy requests in the order they will be deployed. * */ getDeployQueue(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List deploy requests * List deploy requests for a database * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_deploy_requests` | * | Database | `read_deploy_requests` | */ listDeployRequests(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a deploy request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_requests` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_deploy_requests` | * | Database | `write_deploy_requests` | */ createDeployRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a deploy request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_deploy_requests` | * | Database | `read_deploy_requests` | */ getDeployRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Close a deploy request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_deploy_requests` | * | Database | `write_deploy_requests` | */ closeDeployRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Complete a gated deploy request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ completeGatedDeployRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update auto-apply for deploy request * Enables or disabled the auto-apply setting for a deploy request * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ updateAutoApply(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update auto-delete branch for deploy request * Enables or disabled the auto-delete branch setting for a deploy request * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ updateAutoDeleteBranch(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Cancel a queued deploy request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ cancelDeployRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Complete an errored deploy * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ completeErroredDeploy(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Queue a deploy request * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ queueDeployRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a deployment * Get the deployment for a deploy request * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_deploy_requests` | * | Database | `read_deploy_requests` | */ getDeployment(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List deploy operations * List deploy operations for a deploy request * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_deploy_requests` | * | Database | `read_deploy_requests` | */ listDeployOperations(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Complete a revert * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ completeRevert(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List deploy request reviews * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_deploy_requests` | * | Database | `read_deploy_requests` | */ listDeployRequestReviews(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Review a deploy request * Review a deploy request by either approving or commenting on the deploy request * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `approve_deploy_request`, `review_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `approve_deploy_requests` | * | Database | `approve_deploy_requests` | */ reviewDeployRequest(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Skip revert period * Skips the revert period for a deploy request * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ skipRevertPeriod(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get deploy request throttler configurations * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_deploy_requests` | * | Database | `read_deploy_requests` | */ getDeployRequestThrottler(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update deploy request throttler configurations * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ updateDeployRequestThrottler(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List read-only regions * List read-only regions for the database's default branch * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `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` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_branches` | * | Database | `read_branches` | */ listReadOnlyRegions(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List database regions * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `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` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | * | Database | `read_database` | */ listDatabaseRegions(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List schema recommendations * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | * | Database | `read_database` | */ listSchemaRecommendations(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a schema recommendation * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | * | Database | `read_database` | */ getSchemaRecommendation(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Dismiss a schema recommendation * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ dismissSchemaRecommendation(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get database throttler configurations * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | * | Database | `read_database` | */ getDatabaseThrottler(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update database throttler configurations * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_deploy_request`, `create_deploy_request` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `deploy_deploy_requests` | * | Database | `deploy_deploy_requests` | */ updateDatabaseThrottler(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List webhooks * List webhooks for a database * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | * | Database | `read_database` | */ listWebhooks(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a webhook * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ createWebhook(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete a webhook * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ deleteWebhook(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a webhook * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_databases` | * | Database | `read_database` | */ getWebhook(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update a webhook * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ updateWebhook(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Test a webhook * Sends a test event to the webhook * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_database` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_databases` | * | Database | `write_database` | */ testWebhook(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List workflows * * */ listWorkflows(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create a workflow * * */ createWorkflow(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Cancel a workflow * * */ workflowCancel(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get a workflow * * */ getWorkflow(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Complete a workflow * * */ workflowComplete(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Cutover traffic * * */ workflowCutover(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Retry a failed workflow * * */ workflowRetry(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Reverse traffic cutover * * */ workflowReverseCutover(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Reverse traffic * * */ workflowReverseTraffic(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Switch primary traffic * * */ workflowSwitchPrimaries(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Switch replica traffic * * */ workflowSwitchReplicas(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Verify workflow data * * */ verifyWorkflow(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get invoices * Get the invoices for an organization * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_invoices` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_invoices` | */ listInvoices(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get an invoice * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_invoices` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_invoices` | */ getInvoice(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get invoice line items * Get the line items for an invoice * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_invoices` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_invoices` | */ getInvoiceLineItems(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List organization members * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_organization` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_organization` | */ listOrganizationMembers(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Remove a member from an organization * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_organization` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_organization` | */ removeOrganizationMember(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get an organization member * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_organization` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `read_organization` | */ getOrganizationMembership(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Update organization member role * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `write_organization` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | Organization | `write_organization` | */ updateOrganizationMembership(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List OAuth applications * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `read_oauth_applications` * * */ listOauthApplications(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get an OAuth application * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `read_oauth_applications` * * */ getOauthApplication(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List OAuth tokens * List OAuth tokens created by an OAuth application * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `read_oauth_tokens` * * */ listOauthTokens(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Delete an OAuth token * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `delete_oauth_tokens` * * */ deleteOauthToken(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Get an OAuth token * * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `read_oauth_tokens` * * */ getOauthToken(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * Create or renew an OAuth token * Create an OAuth token from an authorization grant code, or refresh an OAuth token from a refresh token * ### Authorization * A service token must have at least one of the following access in order to use this API endpoint: * * **Service Token Accesses** * `write_oauth_tokens` * * */ createOauthToken(options: Options): import("../../util/api/client/types.gen.ts").RequestResult; /** * List regions for an organization * * ### Authorization * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint: * * **Service Token Accesses** * `read_organization` * * **OAuth Scopes** * * | Resource | Scopes | * | :------- | :---------- | * | User | `read_organizations` | * | Organization | `read_organization` | */ listRegionsForOrganization(options: Options