import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type TDataShape } from './client/index.js'; import type { AcceptProjectTransferRequestData, AcceptProjectTransferRequestErrors, AcceptProjectTransferRequestResponses, AddBranchNeonAuthOauthProviderData, AddBranchNeonAuthOauthProviderErrors, AddBranchNeonAuthOauthProviderResponses, AddBranchNeonAuthTrustedDomainData, AddBranchNeonAuthTrustedDomainErrors, AddBranchNeonAuthTrustedDomainResponses, AddNeonAuthDomainToRedirectUriWhitelistData, AddNeonAuthDomainToRedirectUriWhitelistErrors, AddNeonAuthDomainToRedirectUriWhitelistResponses, AddNeonAuthOauthProviderData, AddNeonAuthOauthProviderErrors, AddNeonAuthOauthProviderResponses, AddProjectJwksData, AddProjectJwksErrors, AddProjectJwksResponses, AssignOrganizationVpcEndpointData, AssignOrganizationVpcEndpointErrors, AssignOrganizationVpcEndpointResponses, AssignProjectVpcEndpointData, AssignProjectVpcEndpointErrors, AssignProjectVpcEndpointResponses, CountProjectBranchesData, CountProjectBranchesErrors, CountProjectBranchesResponses, CountProjectsData, CountProjectsErrors, CountProjectsResponses, CreateApiKeyData, CreateApiKeyErrors, CreateApiKeyResponses, CreateBranchNeonAuthNewUserData, CreateBranchNeonAuthNewUserErrors, CreateBranchNeonAuthNewUserResponses, CreateCredentialData, CreateCredentialErrors, CreateCredentialResponses, CreateNeonAuthData, CreateNeonAuthErrors, CreateNeonAuthIntegrationData, CreateNeonAuthIntegrationErrors, CreateNeonAuthIntegrationResponses, CreateNeonAuthNewUserData, CreateNeonAuthNewUserErrors, CreateNeonAuthNewUserResponses, CreateNeonAuthOAuthClientData, CreateNeonAuthOAuthClientErrors, CreateNeonAuthOAuthClientResponses, CreateNeonAuthProviderSdkKeysData, CreateNeonAuthProviderSdkKeysErrors, CreateNeonAuthProviderSdkKeysResponses, CreateNeonAuthResponses, CreateOrganizationInvitationsData, CreateOrganizationInvitationsErrors, CreateOrganizationInvitationsResponses, CreateOrgApiKeyData, CreateOrgApiKeyErrors, CreateOrgApiKeyResponses, CreateProjectBranchAnonymizedData, CreateProjectBranchAnonymizedErrors, CreateProjectBranchAnonymizedResponses, CreateProjectBranchBucketData, CreateProjectBranchBucketErrors, CreateProjectBranchBucketResponses, CreateProjectBranchData, CreateProjectBranchDataApiData, CreateProjectBranchDataApiErrors, CreateProjectBranchDataApiResponses, CreateProjectBranchDatabaseData, CreateProjectBranchDatabaseErrors, CreateProjectBranchDatabaseResponses, CreateProjectBranchErrors, CreateProjectBranchFunctionDeploymentData, CreateProjectBranchFunctionDeploymentErrors, CreateProjectBranchFunctionDeploymentResponses, CreateProjectBranchResponses, CreateProjectBranchRoleData, CreateProjectBranchRoleErrors, CreateProjectBranchRoleResponses, CreateProjectBranchTriggerData, CreateProjectBranchTriggerErrors, CreateProjectBranchTriggerResponses, CreateProjectData, CreateProjectEndpointData, CreateProjectEndpointErrors, CreateProjectEndpointResponses, CreateProjectErrors, CreateProjectResponses, CreateProjectTransferRequestData, CreateProjectTransferRequestErrors, CreateProjectTransferRequestResponses, CreateSnapshotData, CreateSnapshotErrors, CreateSnapshotResponses, DeleteBranchNeonAuthOauthProviderData, DeleteBranchNeonAuthOauthProviderErrors, DeleteBranchNeonAuthOauthProviderResponses, DeleteBranchNeonAuthTrustedDomainData, DeleteBranchNeonAuthTrustedDomainErrors, DeleteBranchNeonAuthTrustedDomainResponses, DeleteBranchNeonAuthUserData, DeleteBranchNeonAuthUserErrors, DeleteBranchNeonAuthUserResponses, DeleteNeonAuthDomainFromRedirectUriWhitelistData, DeleteNeonAuthDomainFromRedirectUriWhitelistErrors, DeleteNeonAuthDomainFromRedirectUriWhitelistResponses, DeleteNeonAuthIntegrationData, DeleteNeonAuthIntegrationErrors, DeleteNeonAuthIntegrationResponses, DeleteNeonAuthOAuthClientData, DeleteNeonAuthOAuthClientErrors, DeleteNeonAuthOAuthClientResponses, DeleteNeonAuthOauthProviderData, DeleteNeonAuthOauthProviderErrors, DeleteNeonAuthOauthProviderResponses, DeleteNeonAuthUserData, DeleteNeonAuthUserErrors, DeleteNeonAuthUserResponses, DeleteOrganizationSpendingLimitData, DeleteOrganizationSpendingLimitErrors, DeleteOrganizationSpendingLimitResponses, DeleteOrganizationVpcEndpointData, DeleteOrganizationVpcEndpointErrors, DeleteOrganizationVpcEndpointResponses, DeleteProjectBranchBucketData, DeleteProjectBranchBucketErrors, DeleteProjectBranchBucketObjectData, DeleteProjectBranchBucketObjectErrors, DeleteProjectBranchBucketObjectResponses, DeleteProjectBranchBucketObjectsByPrefixData, DeleteProjectBranchBucketObjectsByPrefixErrors, DeleteProjectBranchBucketObjectsByPrefixResponses, DeleteProjectBranchBucketResponses, DeleteProjectBranchCustomDomainData, DeleteProjectBranchCustomDomainErrors, DeleteProjectBranchCustomDomainResponses, DeleteProjectBranchData, DeleteProjectBranchDataApiData, DeleteProjectBranchDataApiErrors, DeleteProjectBranchDataApiResponses, DeleteProjectBranchDatabaseData, DeleteProjectBranchDatabaseErrors, DeleteProjectBranchDatabaseResponses, DeleteProjectBranchErrors, DeleteProjectBranchFunctionData, DeleteProjectBranchFunctionErrors, DeleteProjectBranchFunctionResponses, DeleteProjectBranchResponses, DeleteProjectBranchRoleData, DeleteProjectBranchRoleErrors, DeleteProjectBranchRoleResponses, DeleteProjectBranchTriggerData, DeleteProjectBranchTriggerErrors, DeleteProjectBranchTriggerResponses, DeleteProjectData, DeleteProjectEndpointData, DeleteProjectEndpointErrors, DeleteProjectEndpointResponses, DeleteProjectErrors, DeleteProjectJwksData, DeleteProjectJwksErrors, DeleteProjectJwksResponses, DeleteProjectResponses, DeleteProjectVpcEndpointData, DeleteProjectVpcEndpointErrors, DeleteProjectVpcEndpointResponses, DeleteSnapshotData, DeleteSnapshotErrors, DeleteSnapshotResponses, DisableNeonAuthData, DisableNeonAuthErrors, DisableNeonAuthResponses, DisableProjectBranchRealtimeData, DisableProjectBranchRealtimeErrors, DisableProjectBranchRealtimeResponses, EnableProjectBranchRealtimeData, EnableProjectBranchRealtimeErrors, EnableProjectBranchRealtimeResponses, FinalizeRestoreBranchData, FinalizeRestoreBranchErrors, FinalizeRestoreBranchResponses, GetActiveRegionsData, GetActiveRegionsErrors, GetActiveRegionsResponses, GetAnonymizedBranchStatusData, GetAnonymizedBranchStatusErrors, GetAnonymizedBranchStatusResponses, GetAuthDetailsData, GetAuthDetailsErrors, GetAuthDetailsResponses, GetAvailablePreloadLibrariesData, GetAvailablePreloadLibrariesErrors, GetAvailablePreloadLibrariesResponses, GetConnectionUriData, GetConnectionUriErrors, GetConnectionUriResponses, GetConsumptionHistoryPerBranchV2Data, GetConsumptionHistoryPerBranchV2Errors, GetConsumptionHistoryPerBranchV2Responses, GetConsumptionHistoryPerProjectData, GetConsumptionHistoryPerProjectErrors, GetConsumptionHistoryPerProjectResponses, GetConsumptionHistoryPerProjectV2Data, GetConsumptionHistoryPerProjectV2Errors, GetConsumptionHistoryPerProjectV2Responses, GetCurrentUserInfoData, GetCurrentUserInfoErrors, GetCurrentUserInfoResponses, GetCurrentUserOrganizationsData, GetCurrentUserOrganizationsErrors, GetCurrentUserOrganizationsResponses, GetMaskingRulesData, GetMaskingRulesErrors, GetMaskingRulesResponses, GetNeonAuthAllowLocalhostData, GetNeonAuthAllowLocalhostErrors, GetNeonAuthAllowLocalhostResponses, GetNeonAuthData, GetNeonAuthEmailAndPasswordConfigData, GetNeonAuthEmailAndPasswordConfigErrors, GetNeonAuthEmailAndPasswordConfigResponses, GetNeonAuthEmailProviderData, GetNeonAuthEmailProviderErrors, GetNeonAuthEmailProviderResponses, GetNeonAuthEmailServerData, GetNeonAuthEmailServerErrors, GetNeonAuthEmailServerResponses, GetNeonAuthErrors, GetNeonAuthOAuthClientData, GetNeonAuthOAuthClientErrors, GetNeonAuthOAuthClientResponses, GetNeonAuthOAuthProviderPluginData, GetNeonAuthOAuthProviderPluginErrors, GetNeonAuthOAuthProviderPluginResponses, GetNeonAuthPhoneNumberPluginData, GetNeonAuthPhoneNumberPluginErrors, GetNeonAuthPhoneNumberPluginResponses, GetNeonAuthPluginConfigsData, GetNeonAuthPluginConfigsErrors, GetNeonAuthPluginConfigsResponses, GetNeonAuthResponses, GetNeonAuthWebhookConfigData, GetNeonAuthWebhookConfigErrors, GetNeonAuthWebhookConfigResponses, GetOrganizationData, GetOrganizationErrors, GetOrganizationInvitationsData, GetOrganizationInvitationsErrors, GetOrganizationInvitationsResponses, GetOrganizationMemberData, GetOrganizationMemberErrors, GetOrganizationMemberResponses, GetOrganizationMembersData, GetOrganizationMembersErrors, GetOrganizationMembersResponses, GetOrganizationResponses, GetOrganizationSpendingLimitData, GetOrganizationSpendingLimitErrors, GetOrganizationSpendingLimitResponses, GetOrganizationVpcEndpointDetailsData, GetOrganizationVpcEndpointDetailsErrors, GetOrganizationVpcEndpointDetailsResponses, GetProjectAdvisorSecurityIssuesData, GetProjectAdvisorSecurityIssuesErrors, GetProjectAdvisorSecurityIssuesResponses, GetProjectBranchAiGatewayData, GetProjectBranchAiGatewayErrors, GetProjectBranchAiGatewayResponses, GetProjectBranchBucketObjectData, GetProjectBranchBucketObjectErrors, GetProjectBranchBucketObjectResponses, GetProjectBranchData, GetProjectBranchDataApiData, GetProjectBranchDataApiErrors, GetProjectBranchDataApiResponses, GetProjectBranchDatabaseData, GetProjectBranchDatabaseErrors, GetProjectBranchDatabaseResponses, GetProjectBranchErrors, GetProjectBranchFunctionData, GetProjectBranchFunctionErrors, GetProjectBranchFunctionResponses, GetProjectBranchRealtimeData, GetProjectBranchRealtimeErrors, GetProjectBranchRealtimeResponses, GetProjectBranchRealtimeSecretData, GetProjectBranchRealtimeSecretErrors, GetProjectBranchRealtimeSecretResponses, GetProjectBranchResponses, GetProjectBranchRoleData, GetProjectBranchRoleErrors, GetProjectBranchRolePasswordData, GetProjectBranchRolePasswordErrors, GetProjectBranchRolePasswordResponses, GetProjectBranchRoleResponses, GetProjectBranchSchemaComparisonData, GetProjectBranchSchemaComparisonErrors, GetProjectBranchSchemaComparisonResponses, GetProjectBranchSchemaData, GetProjectBranchSchemaErrors, GetProjectBranchSchemaResponses, GetProjectBranchStorageData, GetProjectBranchStorageErrors, GetProjectBranchStorageResponses, GetProjectBranchTriggerData, GetProjectBranchTriggerErrors, GetProjectBranchTriggerResponses, GetProjectData, GetProjectEndpointData, GetProjectEndpointErrors, GetProjectEndpointResponses, GetProjectErrors, GetProjectJwksData, GetProjectJwksErrors, GetProjectJwksResponses, GetProjectOperationData, GetProjectOperationErrors, GetProjectOperationResponses, GetProjectResponses, GetSnapshotScheduleData, GetSnapshotScheduleErrors, GetSnapshotScheduleResponses, GrantPermissionToProjectData, GrantPermissionToProjectErrors, GrantPermissionToProjectResponses, ListApiKeysData, ListApiKeysErrors, ListApiKeysResponses, ListBranchNeonAuthOauthProvidersData, ListBranchNeonAuthOauthProvidersErrors, ListBranchNeonAuthOauthProvidersResponses, ListBranchNeonAuthTrustedDomainsData, ListBranchNeonAuthTrustedDomainsErrors, ListBranchNeonAuthTrustedDomainsResponses, ListCredentialsData, ListCredentialsErrors, ListCredentialsResponses, ListNeonAuthIntegrationsData, ListNeonAuthIntegrationsErrors, ListNeonAuthIntegrationsResponses, ListNeonAuthOAuthClientsData, ListNeonAuthOAuthClientsErrors, ListNeonAuthOAuthClientsResponses, ListNeonAuthOauthProvidersData, ListNeonAuthOauthProvidersErrors, ListNeonAuthOauthProvidersResponses, ListNeonAuthRedirectUriWhitelistDomainsData, ListNeonAuthRedirectUriWhitelistDomainsErrors, ListNeonAuthRedirectUriWhitelistDomainsResponses, ListOrganizationVpcEndpointsAllRegionsData, ListOrganizationVpcEndpointsAllRegionsErrors, ListOrganizationVpcEndpointsAllRegionsResponses, ListOrganizationVpcEndpointsData, ListOrganizationVpcEndpointsErrors, ListOrganizationVpcEndpointsResponses, ListOrgApiKeysData, ListOrgApiKeysErrors, ListOrgApiKeysResponses, ListProjectBranchBucketObjectsData, ListProjectBranchBucketObjectsErrors, ListProjectBranchBucketObjectsResponses, ListProjectBranchBucketsData, ListProjectBranchBucketsErrors, ListProjectBranchBucketsResponses, ListProjectBranchCustomDomainsData, ListProjectBranchCustomDomainsErrors, ListProjectBranchCustomDomainsResponses, ListProjectBranchDatabasesData, ListProjectBranchDatabasesErrors, ListProjectBranchDatabasesResponses, ListProjectBranchEndpointsData, ListProjectBranchEndpointsErrors, ListProjectBranchEndpointsResponses, ListProjectBranchesData, ListProjectBranchesErrors, ListProjectBranchesResponses, ListProjectBranchFunctionsData, ListProjectBranchFunctionsErrors, ListProjectBranchFunctionsResponses, ListProjectBranchLogFieldsData, ListProjectBranchLogFieldsErrors, ListProjectBranchLogFieldsResponses, ListProjectBranchLogFieldValuesData, ListProjectBranchLogFieldValuesErrors, ListProjectBranchLogFieldValuesResponses, ListProjectBranchRolesData, ListProjectBranchRolesErrors, ListProjectBranchRolesResponses, ListProjectBranchTriggersData, ListProjectBranchTriggersErrors, ListProjectBranchTriggersResponses, ListProjectEndpointsData, ListProjectEndpointsErrors, ListProjectEndpointsResponses, ListProjectMembersData, ListProjectMembersErrors, ListProjectMembersResponses, ListProjectOperationsData, ListProjectOperationsErrors, ListProjectOperationsResponses, ListProjectPermissionsData, ListProjectPermissionsErrors, ListProjectPermissionsResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListProjectVpcEndpointsData, ListProjectVpcEndpointsErrors, ListProjectVpcEndpointsResponses, ListSharedProjectsData, ListSharedProjectsErrors, ListSharedProjectsResponses, ListSnapshotsData, ListSnapshotsErrors, ListSnapshotsResponses, PresignProjectBranchBucketObjectData, PresignProjectBranchBucketObjectErrors, PresignProjectBranchBucketObjectResponses, QueryProjectBranchLogsData, QueryProjectBranchLogsErrors, QueryProjectBranchLogsResponses, RecoverProjectData, RecoverProjectErrors, RecoverProjectResponses, RegisterProjectBranchCustomDomainData, RegisterProjectBranchCustomDomainErrors, RegisterProjectBranchCustomDomainResponses, RemoveOrganizationMemberData, RemoveOrganizationMemberErrors, RemoveOrganizationMemberResponses, RemoveProjectMemberRoleData, RemoveProjectMemberRoleErrors, RemoveProjectMemberRoleResponses, ResetProjectBranchRolePasswordData, ResetProjectBranchRolePasswordErrors, ResetProjectBranchRolePasswordResponses, RestartProjectEndpointData, RestartProjectEndpointErrors, RestartProjectEndpointResponses, RestoreProjectBranchData, RestoreProjectBranchErrors, RestoreProjectBranchResponses, RestoreSnapshotData, RestoreSnapshotErrors, RestoreSnapshotResponses, RevealCredentialData, RevealCredentialErrors, RevealCredentialResponses, RevokeApiKeyData, RevokeApiKeyErrors, RevokeApiKeyResponses, RevokeCredentialData, RevokeCredentialErrors, RevokeCredentialResponses, RevokeOrgApiKeyData, RevokeOrgApiKeyErrors, RevokeOrgApiKeyResponses, RevokePermissionFromProjectData, RevokePermissionFromProjectErrors, RevokePermissionFromProjectResponses, RotateCredentialData, RotateCredentialErrors, RotateCredentialResponses, RotateNeonAuthOAuthClientSecretData, RotateNeonAuthOAuthClientSecretErrors, RotateNeonAuthOAuthClientSecretResponses, RotateProjectBranchRealtimeSecretData, RotateProjectBranchRealtimeSecretErrors, RotateProjectBranchRealtimeSecretResponses, SendNeonAuthEmailProviderTestData, SendNeonAuthEmailProviderTestErrors, SendNeonAuthEmailProviderTestResponses, SendNeonAuthTestEmailData, SendNeonAuthTestEmailErrors, SendNeonAuthTestEmailResponses, SetDefaultProjectBranchData, SetDefaultProjectBranchErrors, SetDefaultProjectBranchResponses, SetOrganizationSpendingLimitData, SetOrganizationSpendingLimitErrors, SetOrganizationSpendingLimitResponses, SetProjectMemberRoleData, SetProjectMemberRoleErrors, SetProjectMemberRoleResponses, SetSnapshotScheduleData, SetSnapshotScheduleErrors, SetSnapshotScheduleResponses, StartAnonymizationData, StartAnonymizationErrors, StartAnonymizationResponses, StartProjectEndpointData, StartProjectEndpointErrors, StartProjectEndpointResponses, SuspendProjectEndpointData, SuspendProjectEndpointErrors, SuspendProjectEndpointResponses, TransferNeonAuthProviderProjectData, TransferNeonAuthProviderProjectErrors, TransferNeonAuthProviderProjectResponses, TransferProjectsFromOrgToOrgData, TransferProjectsFromOrgToOrgErrors, TransferProjectsFromOrgToOrgResponses, TransferProjectsFromUserToOrgData, TransferProjectsFromUserToOrgErrors, TransferProjectsFromUserToOrgResponses, UpdateBranchNeonAuthOauthProviderData, UpdateBranchNeonAuthOauthProviderErrors, UpdateBranchNeonAuthOauthProviderResponses, UpdateMaskingRulesData, UpdateMaskingRulesErrors, UpdateMaskingRulesResponses, UpdateNeonAuthAllowLocalhostData, UpdateNeonAuthAllowLocalhostErrors, UpdateNeonAuthAllowLocalhostResponses, UpdateNeonAuthConfigData, UpdateNeonAuthConfigErrors, UpdateNeonAuthConfigResponses, UpdateNeonAuthEmailAndPasswordConfigData, UpdateNeonAuthEmailAndPasswordConfigErrors, UpdateNeonAuthEmailAndPasswordConfigResponses, UpdateNeonAuthEmailProviderData, UpdateNeonAuthEmailProviderErrors, UpdateNeonAuthEmailProviderResponses, UpdateNeonAuthEmailServerData, UpdateNeonAuthEmailServerErrors, UpdateNeonAuthEmailServerResponses, UpdateNeonAuthMagicLinkPluginData, UpdateNeonAuthMagicLinkPluginErrors, UpdateNeonAuthMagicLinkPluginResponses, UpdateNeonAuthOAuthClientData, UpdateNeonAuthOAuthClientErrors, UpdateNeonAuthOAuthClientResponses, UpdateNeonAuthOauthProviderData, UpdateNeonAuthOauthProviderErrors, UpdateNeonAuthOAuthProviderPluginData, UpdateNeonAuthOAuthProviderPluginErrors, UpdateNeonAuthOAuthProviderPluginResponses, UpdateNeonAuthOauthProviderResponses, UpdateNeonAuthOrganizationPluginData, UpdateNeonAuthOrganizationPluginErrors, UpdateNeonAuthOrganizationPluginResponses, UpdateNeonAuthPhoneNumberPluginData, UpdateNeonAuthPhoneNumberPluginErrors, UpdateNeonAuthPhoneNumberPluginResponses, UpdateNeonAuthUserRoleData, UpdateNeonAuthUserRoleErrors, UpdateNeonAuthUserRoleResponses, UpdateNeonAuthWebhookConfigData, UpdateNeonAuthWebhookConfigErrors, UpdateNeonAuthWebhookConfigResponses, UpdateOrganizationMemberData, UpdateOrganizationMemberErrors, UpdateOrganizationMemberResponses, UpdateProjectBranchData, UpdateProjectBranchDataApiData, UpdateProjectBranchDataApiErrors, UpdateProjectBranchDataApiResponses, UpdateProjectBranchDatabaseData, UpdateProjectBranchDatabaseErrors, UpdateProjectBranchDatabaseResponses, UpdateProjectBranchErrors, UpdateProjectBranchFunctionData, UpdateProjectBranchFunctionErrors, UpdateProjectBranchFunctionResponses, UpdateProjectBranchResponses, UpdateProjectBranchTriggerData, UpdateProjectBranchTriggerErrors, UpdateProjectBranchTriggerResponses, UpdateProjectData, UpdateProjectEndpointData, UpdateProjectEndpointErrors, UpdateProjectEndpointResponses, UpdateProjectErrors, UpdateProjectResponses, UpdateSnapshotData, UpdateSnapshotErrors, UpdateSnapshotResponses } from './types.gen.js'; 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?: keyof ClientMeta extends never ? Record : ClientMeta; }; /** * Get advisor issues * * Analyzes the database for security and performance issues. * Returns a list of issues categorized by severity (ERROR, WARN, INFO). * * Requires read access to the project and Data API enabled. * */ export declare const getProjectAdvisorSecurityIssues: (options: Options) => RequestResult; /** * List API keys * * Retrieves the API keys for your Neon account. * The response does not include API key tokens. A token is only provided when creating an API key. * API keys can also be managed in the Neon Console. * For more information, see [Manage API keys](https://neon.com/docs/manage/api-keys/). * */ export declare const listApiKeys: (options?: Options) => RequestResult; /** * Create API key * * Creates an API key. * The `key_name` is a user-specified name for the key. * Returns an `id` and `key`; the `key` is a randomly generated, 64-bit token required to access the Neon API. * Store the key securely — it is only returned once. * API keys can also be managed in the Neon Console. * See [Manage API keys](https://neon.com/docs/manage/api-keys/). * */ export declare const createApiKey: (options: Options) => RequestResult; /** * Revoke API key * * Revokes the specified API key. * An API key that is no longer needed can be revoked. * This action cannot be reversed. * API keys can also be managed in the Neon Console. * See [Manage API keys](https://neon.com/docs/manage/api-keys/). * */ export declare const revokeApiKey: (options: Options) => RequestResult; /** * Retrieve operation details * * Retrieves details for the specified operation. * An operation is an action performed on a Neon project resource. * */ export declare const getProjectOperation: (options: Options) => RequestResult; /** * List projects * * Retrieves a list of projects for the specified organization. * If using a personal API key, include the `org_id` parameter to specify which organization to work with. * If using an org API key, `org_id` is automatically inferred from the key. * For more information, see [Manage organizations using the Neon API](https://neon.com/docs/manage/orgs-api) * and [Manage projects](https://neon.com/docs/manage/projects/). * */ export declare const listProjects: (options?: Options) => RequestResult; /** * Create project * * Creates a Neon project within an organization. * If using a personal API key, include the `org_id` parameter to specify which organization to create the project in. * If using an org API key, `org_id` is automatically inferred from the key. * Plan limits define how many projects you can create. * For more information, see [Manage projects](https://neon.com/docs/manage/projects/). * * You can specify a region and Postgres version in the request body. * Neon supports Postgres 14 through 18, with 19 rolling out to enabled regions. * For supported regions and `region_id` values, see [Regions](https://neon.com/docs/introduction/regions/). * */ export declare const createProject: (options: Options) => RequestResult; /** * Retrieve projects count * * Retrieves the number of active projects you can access in the specified organization, without paging through the list of projects. * Projects that are being created or deleted are not counted. * If using a personal API key, include the `org_id` parameter to specify which organization to work with. * If using an org API key, `org_id` is automatically inferred from the key. * */ export declare const countProjects: (options?: Options) => RequestResult; /** * List shared projects * * Retrieves a list of projects shared with your Neon account. * For more information, see [Manage projects](https://neon.com/docs/manage/projects/). * */ export declare const listSharedProjects: (options?: Options) => RequestResult; /** * Delete project * * Deletes the specified project and all its endpoints, branches, databases, and users. * Deleted projects can be recovered within 7 days using `POST /projects/{project_id}/recover`. * To list recoverable projects, use `GET /projects?recoverable=true`. * */ export declare const deleteProject: (options: Options) => RequestResult; /** * Retrieve project details * * Retrieves information about the specified project. * Returned details include the project settings, compute configuration, history retention, owner information, and current usage metrics. * The usage metrics are not intended for billing or metering. For billing, use `/consumption_history/v2/projects`. * */ export declare const getProject: (options: Options) => RequestResult; /** * Update project * * Updates the specified project. * Configurable properties include the project name, default compute settings, history retention period, and IP allowlist. * */ export declare const updateProject: (options: Options) => RequestResult; /** * Recover a deleted project * * Recovers a deleted project within the 7-day deletion recovery period. * Restores branches, endpoints, settings, and connection strings. * Some integrations require manual reconfiguration after recovery. * To list recoverable projects, use `GET /projects?recoverable=true`. * */ export declare const recoverProject: (options: Options) => RequestResult; /** * List operations * * Retrieves a list of operations for the specified Neon project. * The number of operations returned can be large. * To paginate the response, issue an initial request with a `limit` value. * Then, add the `cursor` value that was returned in the response to the next request. * Operations older than 6 months may be deleted from our systems. * If you need more history than that, you should store your own history. * */ export declare const listProjectOperations: (options: Options) => RequestResult; /** * List project access * * Retrieves details about users who have access to the project, including the permission `id`, the granted-to email address, and the date project access was granted. */ export declare const listProjectPermissions: (options: Options) => RequestResult; /** * Grant project access * * Grants project access to the account associated with the specified email address. * */ export declare const grantPermissionToProject: (options: Options) => RequestResult; /** * List org members and their project roles * * Lists organization members and their per-project roles for an org-owned project. * Returns 404 when the project is not org-owned, per-project role management is disabled, * or the caller has no access. Callers with VIEWER or EDITOR see members with * effective project access. Callers with ADMIN also see unassigned org members. * */ export declare const listProjectMembers: (options: Options) => RequestResult; /** * Remove an org member's role on a project * * Idempotently removes the explicit project grant. The member's organization-role * default project permission still applies. Self-DELETE requires * `confirm_self_lockout=true` when effective manage access would be lost. * */ export declare const removeProjectMemberRole: (options: Options) => RequestResult; /** * Set an org member's role on a project * * Idempotently sets or updates the explicit project grant of the specified org member. * Self-demotion requires `confirm_self_demotion=true`. * */ export declare const setProjectMemberRole: (options: Options) => RequestResult; /** * Revoke project access * * Revokes project access from the user associated with the specified permission `id`. You can retrieve a user's permission `id` by listing project access. */ export declare const revokePermissionFromProject: (options: Options) => RequestResult; /** * List available shared preload libraries * * Returns the shared preload libraries available for the specified project's Postgres version. * Shared preload libraries are Postgres extensions that require the `shared_preload_libraries` * setting and a compute restart to activate. * Use this list to determine which libraries can be enabled in the project's * `settings.preload_libraries` configuration. * */ export declare const getAvailablePreloadLibraries: (options: Options) => RequestResult; /** * Create a project transfer request * * Creates a transfer request for the specified project. The request expires after a set period. * To accept the request, the recipient calls `PUT /projects/{project_id}/transfer_requests/{request_id}` * or uses the Neon Console claim link. * The optional `ru` parameter redirects the recipient after acceptance. * */ export declare const createProjectTransferRequest: (options: Options) => RequestResult; /** * Accept a project transfer request * * Accepts a transfer request for the specified project, transferring it to the specified organization * or user. If org_id is not passed, the project will be transferred to the current user or organization account. * */ export declare const acceptProjectTransferRequest: (options: Options) => RequestResult; /** * List JWKS URLs * * Returns the JWKS URLs available for verifying JWTs used as the authentication mechanism for the specified project. * */ export declare const getProjectJwks: (options: Options) => RequestResult; /** * Add JWKS URL * * Adds a JWKS URL to the specified project for verifying JWTs used as the authentication mechanism. * * The URL must be a valid HTTPS URL that returns a JSON Web Key Set. * * The `provider_name` field allows you to specify which authentication provider you're using (e.g., Clerk, Auth0, AWS Cognito). * * The `branch_id` scopes the JWKS URL to specific branches; if not specified, it applies to all branches. * * The `role_names` scopes the URL to specific roles; if not specified, default roles are used (`authenticator`, `authenticated`, `anonymous`). * * The `jwt_audience` specifies which `aud` values are accepted in JWTs. * */ export declare const addProjectJwks: (options: Options) => RequestResult; /** * Delete JWKS URL * * Removes the specified JWKS URL from the project. * JWTs signed by keys from the removed URL can no longer authenticate to the project's endpoints. * */ export declare const deleteProjectJwks: (options: Options) => RequestResult; /** * Delete Neon Data API * * Deletes the Neon Data API for the specified branch. * Existing connections using the Data API endpoint will fail after deletion. * */ export declare const deleteProjectBranchDataApi: (options: Options) => RequestResult; /** * Retrieve Neon Data API configuration * * Retrieves the Neon Data API configuration for the specified branch, * including endpoint URL, enabled state, and database settings. * */ export declare const getProjectBranchDataApi: (options: Options) => RequestResult; /** * Update Neon Data API * * Updates the Neon Data API configuration for the specified branch. * You can optionally provide settings to update the Data API configuration. * The schema cache is always refreshed as part of this operation. * */ export declare const updateProjectBranchDataApi: (options: Options) => RequestResult; /** * Create Neon Data API * * Creates a new instance of Neon Data API in the specified branch. * The Data API exposes a REST interface over the branch database. The `database_name` path parameter determines which database the API serves. * */ export declare const createProjectBranchDataApi: (options: Options) => RequestResult; /** * Create Neon Auth integration * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth` instead. Removal scheduled for March 1, 2026. * Use this endpoint if the frontend integration flow can't be used. * * * @deprecated */ export declare const createNeonAuthIntegration: (options: Options) => RequestResult; /** * Disable Neon Auth for the branch * * Disables the Neon Auth integration for the specified branch, removing the connection * to the authentication provider. * If `delete_data` is `true`, also deletes the `neon_auth` schema and all associated tables * from the branch database. * The integration can be re-enabled by calling `POST /projects/{project_id}/branches/{branch_id}/auth`. * */ export declare const disableNeonAuth: (options: Options) => RequestResult; /** * Retrieve Neon Auth details for the branch * * Retrieves the Neon Auth integration details for the specified branch, * including the auth provider type and integration status. * */ export declare const getNeonAuth: (options: Options) => RequestResult; /** * Enable Neon Auth for the branch * * Enables Neon Auth for the specified branch by connecting it to an authentication provider. * Creating the integration provisions the `neon_auth` schema in the branch database, which stores user identity data synchronized from the provider. * */ export declare const createNeonAuth: (options: Options) => RequestResult; /** * Delete trusted redirect URI domain * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const deleteNeonAuthDomainFromRedirectUriWhitelist: (options: Options) => RequestResult; /** * List trusted redirect URI domains * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const listNeonAuthRedirectUriWhitelistDomains: (options: Options) => RequestResult; /** * Add trusted redirect URI domain * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const addNeonAuthDomainToRedirectUriWhitelist: (options: Options) => RequestResult; /** * Delete domain from redirect_uri whitelist * * Removes a domain from the redirect URI whitelist for the specified branch. * After removal, the domain can no longer be used as a redirect target after authentication. * */ export declare const deleteBranchNeonAuthTrustedDomain: (options: Options) => RequestResult; /** * List domains in redirect_uri whitelist * * Lists the trusted domains in the redirect URI whitelist for the specified branch. * Only domains in this list are permitted as redirect targets after authentication. * */ export declare const listBranchNeonAuthTrustedDomains: (options: Options) => RequestResult; /** * Add domain to redirect_uri whitelist * * Adds a domain to the redirect URI whitelist for the specified branch. * Only domains in this list are permitted as redirect targets after authentication. * */ export declare const addBranchNeonAuthTrustedDomain: (options: Options) => RequestResult; /** * Create Auth Provider SDK keys * * Generates SDK or API Keys for the auth provider. These might be called different things depending * on the auth provider you're using, but are generally used for setting up the frontend and backend SDKs. * */ export declare const createNeonAuthProviderSdkKeys: (options: Options) => RequestResult; /** * Create new auth user * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/users` instead. Removal scheduled for March 1, 2026. * The user will be created in your neon_auth.users_sync table and automatically propagated to your auth project, whether Neon-managed or provider-owned. * * * @deprecated */ export declare const createNeonAuthNewUser: (options: Options) => RequestResult; /** * Create new auth user * * Creates a new user in the Neon Auth user directory for the specified branch. * The user is created in the `neon_auth.users_sync` table and can immediately authenticate * using the branch's configured auth providers. * */ export declare const createBranchNeonAuthNewUser: (options: Options) => RequestResult; /** * Delete auth user * * Deletes the specified user from the Neon Auth user directory for the specified branch. * Removes the user record from `neon_auth.users_sync`. This action cannot be undone. * */ export declare const deleteBranchNeonAuthUser: (options: Options) => RequestResult; /** * Update auth user role * * Updates the role of a user in the Neon Auth user directory for the specified branch. * The role controls the user's level of access within the Neon Auth integration. * */ export declare const updateNeonAuthUserRole: (options: Options) => RequestResult; /** * Delete auth user * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const deleteNeonAuthUser: (options: Options) => RequestResult; /** * Transfer Neon-managed auth project to your own account * * Transfers ownership of your Neon-managed auth project to your own auth provider account. * */ export declare const transferNeonAuthProviderProject: (options: Options) => RequestResult; /** * List active integrations with auth providers * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth` instead. Removal scheduled for March 1, 2026. * * @deprecated */ export declare const listNeonAuthIntegrations: (options: Options) => RequestResult; /** * List OAuth providers * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const listNeonAuthOauthProviders: (options: Options) => RequestResult; /** * Add an OAuth provider * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const addNeonAuthOauthProvider: (options: Options) => RequestResult; /** * List OAuth providers for the branch * * Lists the OAuth providers configured for the specified branch's Neon Auth integration. * */ export declare const listBranchNeonAuthOauthProviders: (options: Options) => RequestResult; /** * Add an OAuth provider * * Adds an OAuth provider configuration to the specified branch's Neon Auth integration. * After adding, users can authenticate using the configured provider. * */ export declare const addBranchNeonAuthOauthProvider: (options: Options) => RequestResult; /** * Delete OAuth provider * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const deleteNeonAuthOauthProvider: (options: Options) => RequestResult; /** * Update OAuth provider * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const updateNeonAuthOauthProvider: (options: Options) => RequestResult; /** * Delete OAuth provider * * Deletes an OAuth provider from the specified project. * */ export declare const deleteBranchNeonAuthOauthProvider: (options: Options) => RequestResult; /** * Update OAuth provider * * Updates an OAuth provider for the specified project. * */ export declare const updateBranchNeonAuthOauthProvider: (options: Options) => RequestResult; /** * Retrieve email server configuration * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/email_provider` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const getNeonAuthEmailServer: (options: Options) => RequestResult; /** * Update email server configuration * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth/email_provider` instead. Removal scheduled for March 1, 2026. * * * @deprecated */ export declare const updateNeonAuthEmailServer: (options: Options) => RequestResult; /** * Send test email * * Sends a test email using the SMTP server settings supplied in the request body to verify connectivity and credentials. * The request body must include the full SMTP server settings * (`host`, `port`, `username`, `password`, `sender_email`, `sender_name`) and the `recipient_email` address. * * Deprecated: to test a branch's already-saved configuration, use `sendNeonAuthEmailProviderTest`, which * reuses the stored SMTP password server-side so the caller never has to re-supply (or be able to read) it. * This endpoint remains available for testing an unsaved full configuration and for non-Better-Auth providers. * * * @deprecated */ export declare const sendNeonAuthTestEmail: (options: Options) => RequestResult; /** * Send test email using the saved email provider * * Sends a test email using the branch's already-saved custom SMTP configuration. Only the * `recipient_email` is provided — the stored SMTP settings and password are used server-side, * so the caller does not need to re-supply (or be able to read) the password. This avoids the * GET response's masked password being sent back, which would fail SMTP authentication. * * Requires a configured custom SMTP provider on a Better Auth integration. A shared provider, * a missing configuration, or a non-Better-Auth integration is rejected. * */ export declare const sendNeonAuthEmailProviderTest: (options: Options) => RequestResult; /** * Retrieve email and password configuration * * Retrieves the email and password authentication configuration for the specified branch's Neon Auth integration, * including whether it is enabled and the email verification method. * */ export declare const getNeonAuthEmailAndPasswordConfig: (options: Options) => RequestResult; /** * Update email and password configuration * * Updates the email and password authentication configuration for the specified branch's Neon Auth integration. * Only the fields provided in the request body are updated. * */ export declare const updateNeonAuthEmailAndPasswordConfig: (options: Options) => RequestResult; /** * Retrieve email provider configuration * * Retrieves the email provider configuration for the specified branch's Neon Auth integration, * including the provider type and server settings. * */ export declare const getNeonAuthEmailProvider: (options: Options) => RequestResult; /** * Update email provider configuration * * Updates the email provider configuration for the specified branch's Neon Auth integration. * The email provider handles transactional messages such as verification emails and password reset links. * * Partial `standard` updates — omitting fields to keep their stored values — are supported only for * Better Auth integrations, which merge omitted fields server-side. Legacy Stack Auth integrations do * not merge and require all six `standard` fields (`host`, `port`, `username`, `password`, * `sender_email`, `sender_name`) on every update; a partial `standard` body is rejected with 400. * */ export declare const updateNeonAuthEmailProvider: (options: Options) => RequestResult; /** * Delete integration with auth provider * * Deprecated. Use `/projects/{project_id}/branches/{branch_id}/auth` instead. Removal scheduled for March 1, 2026. * * @deprecated */ export declare const deleteNeonAuthIntegration: (options: Options) => RequestResult; /** * Retrieve connection URI * * Retrieves a connection URI for the specified database. * The URI uses the standard PostgreSQL connection string format. Set `pooled=true` to include the `-pooler` suffix for a connection pooler URI. * */ export declare const getConnectionUri: (options: Options) => RequestResult; /** * Retrieve localhost allow setting * * Retrieves the localhost allow setting for the specified branch's Neon Auth integration. * When enabled, authentication flows work from `localhost` without adding it to the redirect URI whitelist. * */ export declare const getNeonAuthAllowLocalhost: (options: Options) => RequestResult; /** * Update localhost allow setting * * Updates the localhost allow setting for the specified branch's Neon Auth integration. * When enabled, authentication flows work from `localhost` without adding it to the redirect URI whitelist. * */ export declare const updateNeonAuthAllowLocalhost: (options: Options) => RequestResult; /** * Retrieve Neon Auth plugin configurations * * Returns all plugin configurations for Neon Auth in a single response. * This endpoint aggregates organization, email provider, email and password, * OAuth providers, and localhost settings. * */ export declare const getNeonAuthPluginConfigs: (options: Options) => RequestResult; /** * Update organization plugin configuration * * Updates the organization plugin configuration for Neon Auth. * The organization plugin enables multi-tenant organization support. * */ export declare const updateNeonAuthOrganizationPlugin: (options: Options) => RequestResult; /** * Update auth configuration * * Updates the auth configuration for the branch. * Currently supports updating the application name used in auth emails. * */ export declare const updateNeonAuthConfig: (options: Options) => RequestResult; /** * Update magic link plugin configuration * * Updates the magic link plugin configuration for Neon Auth. * The magic link plugin enables passwordless authentication via email magic links. * */ export declare const updateNeonAuthMagicLinkPlugin: (options: Options) => RequestResult; /** * Retrieve phone number plugin configuration * * Returns the phone number plugin configuration for Neon Auth. * The phone number plugin enables phone-based OTP authentication. * */ export declare const getNeonAuthPhoneNumberPlugin: (options: Options) => RequestResult; /** * Update phone number plugin configuration * * Updates the phone number plugin configuration for Neon Auth. * Only the fields provided in the request body are updated; omitted fields retain their current values. * The phone number plugin enables phone-based OTP authentication. * OTP codes are delivered via the `send.otp` webhook event with `delivery_preference: "sms"`. * A webhook must be configured with the `send.otp` event enabled for SMS delivery to work. * */ export declare const updateNeonAuthPhoneNumberPlugin: (options: Options) => RequestResult; /** * Retrieve OAuth provider plugin configuration * * Returns the OAuth provider plugin configuration for Neon Auth. * The OAuth provider plugin lets Neon Auth act as an OAuth 2.1 authorization server for your own clients, such as MCP clients. * */ export declare const getNeonAuthOAuthProviderPlugin: (options: Options) => RequestResult; /** * Update OAuth provider plugin configuration * * Updates the OAuth provider plugin configuration for Neon Auth. * Only the fields provided in the request body are updated; omitted fields retain their current values. * A provided `resources` list replaces the stored list. * A provided `mcp` object replaces the stored MCP configuration and must include `resource`. * The plugin can only be enabled on the project's root branch. * */ export declare const updateNeonAuthOAuthProviderPlugin: (options: Options) => RequestResult; /** * List OAuth clients * * Lists the OAuth clients registered for the branch's Neon Auth OAuth provider. * Client secrets are never returned. * */ export declare const listNeonAuthOAuthClients: (options: Options) => RequestResult; /** * Create an OAuth client * * Registers an OAuth client with the branch's Neon Auth OAuth provider. * For `confidential` clients the response includes the `client_secret`, which is shown only once. * Every entry in `resources` must be configured on the OAuth provider plugin. * */ export declare const createNeonAuthOAuthClient: (options: Options) => RequestResult; /** * Delete an OAuth client * * Deletes an OAuth client. Tokens already issued to the client are not revoked. * */ export declare const deleteNeonAuthOAuthClient: (options: Options) => RequestResult; /** * Retrieve an OAuth client * * Returns an OAuth client registered with the branch's Neon Auth OAuth provider. * The client secret is never returned. * */ export declare const getNeonAuthOAuthClient: (options: Options) => RequestResult; /** * Update an OAuth client * * Updates an OAuth client. Only the fields provided in the request body are updated. * A provided `resources` list replaces the client's stored list. The client `type` cannot be changed. * */ export declare const updateNeonAuthOAuthClient: (options: Options) => RequestResult; /** * Rotate an OAuth client secret * * Generates a new secret for a confidential OAuth client and invalidates the previous one. * The new secret is shown only once. * */ export declare const rotateNeonAuthOAuthClientSecret: (options: Options) => RequestResult; /** * Retrieve Neon Auth webhook configuration * * Returns the webhook configuration for the specified branch's Neon Auth integration, * including the endpoint URL and the events that trigger it. * */ export declare const getNeonAuthWebhookConfig: (options: Options) => RequestResult; /** * Update Neon Auth webhook configuration * * Updates the webhook configuration for the specified branch's Neon Auth integration. * Webhooks notify an external endpoint when auth events occur, such as user creation or sign-in. * */ export declare const updateNeonAuthWebhookConfig: (options: Options) => RequestResult; /** * List branches * * Retrieves a list of branches for the specified project. * * Each Neon project has a root branch named `main`. * A `branch_id` value has a `br-` prefix. * A project may contain child branches that were branched from `main` or from another branch. * A parent branch is identified by the `parent_id` value, which is the `id` of the parent branch. * For related information, see [Manage branches](https://neon.com/docs/manage/branches/). * */ export declare const listProjectBranches: (options: Options) => RequestResult; /** * Create branch * * Creates a branch in the specified project. * No request body is required, but you can specify one to create a compute endpoint or select a non-default parent branch. * By default, the branch is created from the project's default branch with no compute endpoint, and the branch name is auto-generated. * To access the branch, add a `read_write` endpoint. * Each branch supports one read-write endpoint and multiple read-only endpoints. * For related information, see [Manage branches](https://neon.com/docs/manage/branches/). * */ export declare const createProjectBranch: (options: Options) => RequestResult; /** * Create anonymized branch * * Creates a new branch with anonymized data using PostgreSQL Anonymizer for static masking. * This allows developers to work with masked production data. * Optionally, provide `masking_rules` to set initial masking rules for the branch * and `start_anonymization` to automatically start anonymization after creation. This * combines functionality of updating masking rules and starting anonymization into the * branch creation request. * * **Note**: This endpoint is currently in Beta. * */ export declare const createProjectBranchAnonymized: (options: Options) => RequestResult; /** * Retrieve number of branches * * Retrieves the total number of branches in the specified project. * Supports an optional `search` parameter to count branches matching a name filter. * */ export declare const countProjectBranches: (options: Options) => RequestResult; /** * Delete branch * * Deletes the specified branch from a project and places all compute endpoints into an idle state, breaking existing client connections. * * The deletion completes after all operations finish. * You cannot delete a project's root or default branch, or a branch that has a child branch. * A project must have at least one branch. * * For related information, see [Manage branches](https://neon.com/docs/manage/branches/). * */ export declare const deleteProjectBranch: (options: Options) => RequestResult; /** * Retrieve branch details * * Retrieves information about the specified branch. * A `branch_id` value has a `br-` prefix. * * Each Neon project is initially created with a root and default branch named `main`. * A project can contain one or more branches. * A parent branch is identified by a `parent_id` value, which is the `id` of the parent branch. * For related information, see [Manage branches](https://neon.com/docs/manage/branches/). * The usage metrics are not intended for billing or metering. For billing, use `/consumption_history/v2/branches`. * */ export declare const getProjectBranch: (options: Options) => RequestResult; /** * Update branch * * Updates the specified branch. * For more information, see [Manage branches](https://neon.com/docs/manage/branches/). * */ export declare const updateProjectBranch: (options: Options) => RequestResult; /** * Restore branch to a historical state * * Restores a branch to an earlier state in its own or another branch's history * by specifying an LSN or timestamp. * Creates a new branch from the historical state. * */ export declare const restoreProjectBranch: (options: Options) => RequestResult; /** * Retrieve database schema * * Retrieves the database schema. Specify `lsn` or `timestamp` (not both) to read at a point in time; omit both to read from the database's head. */ export declare const getProjectBranchSchema: (options: Options) => RequestResult; /** * Compare database schema * * Compares the schema from the specified database with another branch's schema. */ export declare const getProjectBranchSchemaComparison: (options: Options) => RequestResult; /** * Retrieve masking rules * * Retrieves the masking rules for the specified anonymized branch. * Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer. * * **Note**: This endpoint is currently in Beta. * */ export declare const getMaskingRules: (options: Options) => RequestResult; /** * Update masking rules * * Updates the masking rules for the specified anonymized branch. * Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer. * * **Note**: This endpoint is currently in Beta. * */ export declare const updateMaskingRules: (options: Options) => RequestResult; /** * Retrieve anonymized branch status * * Retrieves the current status of an anonymized branch, including its state and progress information. * This endpoint allows you to monitor the anonymization process from initialization through completion. * Only anonymized branches will have status information available. * * **Note**: This endpoint is currently in Beta. * */ export declare const getAnonymizedBranchStatus: (options: Options) => RequestResult; /** * Start anonymization * * Starts the anonymization process for an anonymized branch that is in the initialized, error, or anonymized state. * This will apply all defined masking rules to anonymize sensitive data in the branch databases. * The branch must be an anonymized branch to start anonymization. * * **Note**: This endpoint is currently in Beta. * */ export declare const startAnonymization: (options: Options) => RequestResult; /** * Set branch as default * * Sets the specified branch as the project's default branch. * The default designation is automatically removed from the previous default branch. * For more information, see [Manage branches](https://neon.com/docs/manage/branches/). * */ export declare const setDefaultProjectBranch: (options: Options) => RequestResult; /** * Finalize branch restore from snapshot * * Finalize the restore operation for a branch created from a snapshot. * This operation updates the branch so it functions as the original branch it replaced. * This includes: * - Reassigning any computes from the original branch to the restored branch (this will restart the computes) * - Renaming the restored branch to the original branch's name * - Renaming the original branch so it no longer uses the original name * * This operation only applies to branches created using the `restoreSnapshot` endpoint with `finalize_restore: false`. * */ export declare const finalizeRestoreBranch: (options: Options) => RequestResult; /** * List branch endpoints * * Retrieves a list of compute endpoints for the specified branch. * Neon permits only one read-write compute endpoint per branch. * A branch can have multiple read-only compute endpoints. * */ export declare const listProjectBranchEndpoints: (options: Options) => RequestResult; /** * List databases * * Retrieves a list of databases for the specified branch. * A branch can have multiple databases. * For related information, see [Manage databases](https://neon.com/docs/manage/databases/). * */ export declare const listProjectBranchDatabases: (options: Options) => RequestResult; /** * Create database * * Creates a database in the specified branch. * A branch can have multiple databases. * For related information, see [Manage databases](https://neon.com/docs/manage/databases/). * */ export declare const createProjectBranchDatabase: (options: Options) => RequestResult; /** * Delete database * * Deletes the specified database from the branch. * For related information, see [Manage databases](https://neon.com/docs/manage/databases/). * */ export declare const deleteProjectBranchDatabase: (options: Options) => RequestResult; /** * Retrieve database details * * Retrieves information about the specified database. * For related information, see [Manage databases](https://neon.com/docs/manage/databases/). * */ export declare const getProjectBranchDatabase: (options: Options) => RequestResult; /** * Update database * * Updates the specified database in the branch. * For related information, see [Manage databases](https://neon.com/docs/manage/databases/). * */ export declare const updateProjectBranchDatabase: (options: Options) => RequestResult; /** * List roles * * Retrieves a list of Postgres roles from the specified branch. * For related information, see [Manage roles](https://neon.com/docs/manage/roles/). * */ export declare const listProjectBranchRoles: (options: Options) => RequestResult; /** * Create role * * Creates a Postgres role in the specified branch. * For related information, see [Manage roles](https://neon.com/docs/manage/roles/). * * Connections established to the active compute endpoint will be dropped. * If the compute endpoint is idle, the endpoint becomes active for a short period of time and is suspended afterward. * */ export declare const createProjectBranchRole: (options: Options) => RequestResult; /** * Delete role * * Deletes the specified Postgres role from the branch. * For related information, see [Manage roles](https://neon.com/docs/manage/roles/). * */ export declare const deleteProjectBranchRole: (options: Options) => RequestResult; /** * Retrieve role details * * Retrieves details about the specified role. * In Neon, the terms "role" and "user" are synonymous. * For related information, see [Manage roles](https://neon.com/docs/manage/roles/). * */ export declare const getProjectBranchRole: (options: Options) => RequestResult; /** * Retrieve role password * * Retrieves the password for the specified Postgres role, if possible. * For related information, see [Manage roles](https://neon.com/docs/manage/roles/). * */ export declare const getProjectBranchRolePassword: (options: Options) => RequestResult; /** * Disable Realtime * * Disables Realtime for the branch and discards its shared secret. Deprovisioning is asynchronous. */ export declare const disableProjectBranchRealtime: (options: Options) => RequestResult; /** * Retrieve Realtime state * * Retrieves whether Realtime is enabled for the branch, whether a change is still being applied, * and, once provisioned, its invocation URL and allowed origins. The shared secret is returned by * `GET /projects/{project_id}/branches/{branch_id}/realtime/secret`. * */ export declare const getProjectBranchRealtime: (options: Options) => RequestResult; /** * Enable Realtime * * Enables Realtime for the branch, or applies new options to an enabled branch. Provisioning is * asynchronous; poll the Realtime state until it is no longer pending. * */ export declare const enableProjectBranchRealtime: (options: Options) => RequestResult; /** * Retrieve the Realtime shared secret * * Retrieves the secret the application backend issues Realtime tokens with. Requires permission to * read the project's credentials. Returns 404 while Realtime is disabled or before the secret is * provisioned. After a rotation, this returns the previous secret until `pending` is false. * */ export declare const getProjectBranchRealtimeSecret: (options: Options) => RequestResult; /** * Rotate the Realtime shared secret * * Replaces the branch's Realtime shared secret. Rotation is asynchronous: once the Realtime state is * no longer pending, the previous secret stops working and * `GET /projects/{project_id}/branches/{branch_id}/realtime/secret` returns the new one. * */ export declare const rotateProjectBranchRealtimeSecret: (options: Options) => RequestResult; /** * Reset role password * * Resets the password for the specified Postgres role. * Returns a new password and operations. The new password is ready to use when the last operation finishes. * The old password remains valid until last operation finishes. * Connections to the compute endpoint are dropped. If idle, * the compute endpoint becomes active for a short period of time. * * For related information, see [Manage roles](https://neon.com/docs/manage/roles/). * */ export declare const resetProjectBranchRolePassword: (options: Options) => RequestResult; /** * List VPC endpoint restrictions * * Lists VPC endpoint restrictions for the specified Neon project. * */ export declare const listProjectVpcEndpoints: (options: Options) => RequestResult; /** * Delete VPC endpoint restriction * * Removes the specified VPC endpoint restriction from a Neon project. * */ export declare const deleteProjectVpcEndpoint: (options: Options) => RequestResult; /** * Set VPC endpoint restriction * * Sets or updates a VPC endpoint restriction for a Neon project. * When a VPC endpoint restriction is set, the project only accepts connections * from the specified VPC. * A VPC endpoint can be set as a restriction only after it is assigned to the * parent organization of the Neon project. * */ export declare const assignProjectVpcEndpoint: (options: Options) => RequestResult; /** * List compute endpoints * * Retrieves a list of compute endpoints for the specified project. * A compute endpoint is a Neon compute instance. * For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/). * */ export declare const listProjectEndpoints: (options: Options) => RequestResult; /** * Create compute endpoint * * Creates a compute endpoint for the specified branch. * A compute endpoint is a Neon compute instance. * There is a maximum of one read-write compute endpoint per branch. * If the specified branch already has a read-write compute endpoint, the operation fails. * A branch can have multiple read-only compute endpoints. * * For more information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/). * */ export declare const createProjectEndpoint: (options: Options) => RequestResult; /** * Delete compute endpoint * * Deletes the specified compute endpoint. * A compute endpoint is a Neon compute instance. * Deleting a compute endpoint drops existing network connections to the compute endpoint. * The deletion is completed when the last operation in the chain finishes successfully. * * An `endpoint_id` has an `ep-` prefix. * For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/). * */ export declare const deleteProjectEndpoint: (options: Options) => RequestResult; /** * Retrieve compute endpoint details * * Retrieves information about the specified compute endpoint. * A compute endpoint is a Neon compute instance. * An `endpoint_id` has an `ep-` prefix. * For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/). * */ export declare const getProjectEndpoint: (options: Options) => RequestResult; /** * Update compute endpoint * * Updates the specified compute endpoint. * * An `endpoint_id` has an `ep-` prefix. A `branch_id` has a `br-` prefix. * For more information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/). * * If the returned list of operations is not empty, the compute endpoint is not ready to use. * The client must wait for the last operation to finish before using the compute endpoint. * If the compute endpoint was idle before the update, it becomes active for a short period of time, * and the control plane suspends it again after the update. * */ export declare const updateProjectEndpoint: (options: Options) => RequestResult; /** * Start compute endpoint * * Starts a compute endpoint. * The compute endpoint is ready to use after the last operation in the chain finishes successfully. * * An `endpoint_id` has an `ep-` prefix. * For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/). * */ export declare const startProjectEndpoint: (options: Options) => RequestResult; /** * Suspend compute endpoint * * Suspends the specified compute endpoint. * An `endpoint_id` has an `ep-` prefix. * For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/). * */ export declare const suspendProjectEndpoint: (options: Options) => RequestResult; /** * Restart compute endpoint * * Restarts the specified compute endpoint by immediately suspending it and then starting it again. * An `endpoint_id` has an `ep-` prefix. * For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/). * */ export declare const restartProjectEndpoint: (options: Options) => RequestResult; /** * Retrieve project consumption metrics (legacy plans) * * Retrieves consumption metrics for Scale, Business, and Enterprise plan projects. History begins at the time of upgrade. * Results are ordered by time in ascending order (oldest to newest). * Issuing a call to this API does not wake a project's compute endpoint. * */ export declare const getConsumptionHistoryPerProject: (options: Options) => RequestResult; /** * Retrieve project consumption metrics * * Returns consumption metrics for up to `limit` projects per page. If `project_ids` is omitted, * projects in the organization are included across pages (use `cursor`). If `project_ids` is * provided, the response is limited to those projects (up to 100). Available for accounts on * Launch, Scale, Agent, Business, and Enterprise plans. * * History starts when the account upgrades to an eligible plan. * * The `metrics` query parameter is required. Supported values: * `compute_unit_seconds`, `root_branch_bytes_month`, `child_branch_bytes_month`, * `instant_restore_bytes_month`, `public_network_transfer_bytes`, `private_network_transfer_bytes`, * `extra_branches_month`, `snapshot_storage_bytes_month`, * `functions_active_capacity_microseconds`, `functions_waiting_capacity_microseconds`, * `functions_invocations`, `functions_egress_bytes`. * * Consumption metrics within each project are returned in ascending time order (oldest first). * This request does not wake project computes. * */ export declare const getConsumptionHistoryPerProjectV2: (options: Options) => RequestResult; /** * Retrieve branch consumption metrics * * Returns consumption metrics for each branch across one or more projects listed in * `project_ids` (1 to 100 projects). Available for accounts on paid usage-based Launch, Scale, * Agent, and Enterprise plans. * * History starts when the account first ingests branch-level consumption data. * * The `metrics` query parameter is required. These values are supported on this * endpoint: * `compute_unit_seconds`, `root_branch_bytes_month`, `child_branch_bytes_month`, * `instant_restore_bytes_month`, `public_network_transfer_bytes`, `private_network_transfer_bytes`, * `functions_active_capacity_microseconds`, `functions_waiting_capacity_microseconds`, * `functions_invocations`, `functions_egress_bytes`. * * This endpoint does not support `extra_branches_month` or `snapshot_storage_bytes_month`. * Use `GET /consumption_history/v2/projects` for those. * * Consumption metrics within each branch are returned in ascending time order (oldest first). * This request does not wake project computes. * */ export declare const getConsumptionHistoryPerBranchV2: (options: Options) => RequestResult; /** * Retrieve organization details * * Retrieves details for the specified organization, including its name, plan, and configuration. * */ export declare const getOrganization: (options: Options) => RequestResult; /** * List organization API keys * * Retrieves the API keys for the specified organization. * The response does not include API key tokens. A token is only provided when creating an API key. * API keys can also be managed in the Neon Console. * For more information, see [Manage API keys](https://neon.com/docs/manage/api-keys/). * */ export declare const listOrgApiKeys: (options: Options