@neon/sdk 0.0.0 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +178 -0
- package/README.md +349 -0
- package/dist/_virtual/_rolldown/runtime.js +13 -0
- package/dist/client/client/client.gen.d.ts +7 -0
- package/dist/client/client/client.gen.d.ts.map +1 -0
- package/dist/client/client/client.gen.js +176 -0
- package/dist/client/client/client.gen.js.map +1 -0
- package/dist/client/client/index.d.ts +10 -0
- package/dist/client/client/index.js +6 -0
- package/dist/client/client/types.gen.d.ts +124 -0
- package/dist/client/client/types.gen.d.ts.map +1 -0
- package/dist/client/client/types.gen.js +1 -0
- package/dist/client/client/utils.gen.d.ts +42 -0
- package/dist/client/client/utils.gen.d.ts.map +1 -0
- package/dist/client/client/utils.gen.js +179 -0
- package/dist/client/client/utils.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +18 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +8 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/core/auth.gen.d.ts +29 -0
- package/dist/client/core/auth.gen.d.ts.map +1 -0
- package/dist/client/core/auth.gen.js +12 -0
- package/dist/client/core/auth.gen.js.map +1 -0
- package/dist/client/core/bodySerializer.gen.d.ts +29 -0
- package/dist/client/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/client/core/bodySerializer.gen.js +33 -0
- package/dist/client/core/bodySerializer.gen.js.map +1 -0
- package/dist/client/core/params.gen.d.ts +46 -0
- package/dist/client/core/params.gen.d.ts.map +1 -0
- package/dist/client/core/params.gen.js +65 -0
- package/dist/client/core/params.gen.js.map +1 -0
- package/dist/client/core/pathSerializer.gen.d.ts +52 -0
- package/dist/client/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/client/core/pathSerializer.gen.js +82 -0
- package/dist/client/core/pathSerializer.gen.js.map +1 -0
- package/dist/client/core/queryKeySerializer.gen.d.ts +22 -0
- package/dist/client/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/client/core/queryKeySerializer.gen.js +64 -0
- package/dist/client/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/client/core/serverSentEvents.gen.d.ts +88 -0
- package/dist/client/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/client/core/serverSentEvents.gen.js +95 -0
- package/dist/client/core/serverSentEvents.gen.js.map +1 -0
- package/dist/client/core/types.gen.d.ts +80 -0
- package/dist/client/core/types.gen.d.ts.map +1 -0
- package/dist/client/core/types.gen.js +1 -0
- package/dist/client/core/utils.gen.d.ts +33 -0
- package/dist/client/core/utils.gen.d.ts.map +1 -0
- package/dist/client/core/utils.gen.js +78 -0
- package/dist/client/core/utils.gen.js.map +1 -0
- package/dist/client/index.d.ts +3 -0
- package/dist/client/index.js +2 -0
- package/dist/client/sdk.gen.d.ts +1362 -0
- package/dist/client/sdk.gen.d.ts.map +1 -0
- package/dist/client/sdk.gen.js +4315 -0
- package/dist/client/sdk.gen.js.map +1 -0
- package/dist/client/types.gen.d.ts +9938 -0
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +1 -0
- package/dist/index.d.ts +19 -0
- package/dist/index.js +4 -0
- package/dist/neon/client.d.ts +52 -0
- package/dist/neon/client.d.ts.map +1 -0
- package/dist/neon/client.js +40 -0
- package/dist/neon/client.js.map +1 -0
- package/dist/neon/config.d.ts +40 -0
- package/dist/neon/config.d.ts.map +1 -0
- package/dist/neon/config.js +23 -0
- package/dist/neon/config.js.map +1 -0
- package/dist/neon/connection.d.ts +22 -0
- package/dist/neon/connection.d.ts.map +1 -0
- package/dist/neon/connection.js +33 -0
- package/dist/neon/connection.js.map +1 -0
- package/dist/neon/context.d.ts +50 -0
- package/dist/neon/context.d.ts.map +1 -0
- package/dist/neon/context.js +59 -0
- package/dist/neon/context.js.map +1 -0
- package/dist/neon/coverage.d.ts +26 -0
- package/dist/neon/coverage.d.ts.map +1 -0
- package/dist/neon/coverage.js +229 -0
- package/dist/neon/coverage.js.map +1 -0
- package/dist/neon/errors.d.ts +78 -0
- package/dist/neon/errors.d.ts.map +1 -0
- package/dist/neon/errors.js +116 -0
- package/dist/neon/errors.js.map +1 -0
- package/dist/neon/paginate.d.ts +34 -0
- package/dist/neon/paginate.d.ts.map +1 -0
- package/dist/neon/paginate.js +51 -0
- package/dist/neon/paginate.js.map +1 -0
- package/dist/neon/resources/account.d.ts +45 -0
- package/dist/neon/resources/account.d.ts.map +1 -0
- package/dist/neon/resources/account.js +65 -0
- package/dist/neon/resources/account.js.map +1 -0
- package/dist/neon/resources/branches.d.ts +84 -0
- package/dist/neon/resources/branches.d.ts.map +1 -0
- package/dist/neon/resources/branches.js +132 -0
- package/dist/neon/resources/branches.js.map +1 -0
- package/dist/neon/resources/consumption.d.ts +22 -0
- package/dist/neon/resources/consumption.d.ts.map +1 -0
- package/dist/neon/resources/consumption.js +59 -0
- package/dist/neon/resources/consumption.js.map +1 -0
- package/dist/neon/resources/dataapi.d.ts +25 -0
- package/dist/neon/resources/dataapi.d.ts.map +1 -0
- package/dist/neon/resources/dataapi.js +59 -0
- package/dist/neon/resources/dataapi.js.map +1 -0
- package/dist/neon/resources/databases.d.ts +30 -0
- package/dist/neon/resources/databases.d.ts.map +1 -0
- package/dist/neon/resources/databases.js +68 -0
- package/dist/neon/resources/databases.js.map +1 -0
- package/dist/neon/resources/endpoints.d.ts +39 -0
- package/dist/neon/resources/endpoints.d.ts.map +1 -0
- package/dist/neon/resources/endpoints.js +89 -0
- package/dist/neon/resources/endpoints.js.map +1 -0
- package/dist/neon/resources/operations.d.ts +27 -0
- package/dist/neon/resources/operations.d.ts.map +1 -0
- package/dist/neon/resources/operations.js +50 -0
- package/dist/neon/resources/operations.js.map +1 -0
- package/dist/neon/resources/postgres.d.ts +45 -0
- package/dist/neon/resources/postgres.d.ts.map +1 -0
- package/dist/neon/resources/postgres.js +104 -0
- package/dist/neon/resources/postgres.js.map +1 -0
- package/dist/neon/resources/projects.d.ts +84 -0
- package/dist/neon/resources/projects.d.ts.map +1 -0
- package/dist/neon/resources/projects.js +111 -0
- package/dist/neon/resources/projects.js.map +1 -0
- package/dist/neon/resources/roles.d.ts +40 -0
- package/dist/neon/resources/roles.d.ts.map +1 -0
- package/dist/neon/resources/roles.js +78 -0
- package/dist/neon/resources/roles.js.map +1 -0
- package/dist/neon/resources/snapshots.d.ts +86 -0
- package/dist/neon/resources/snapshots.d.ts.map +1 -0
- package/dist/neon/resources/snapshots.js +125 -0
- package/dist/neon/resources/snapshots.js.map +1 -0
- package/dist/neon/result.d.ts +32 -0
- package/dist/neon/result.d.ts.map +1 -0
- package/dist/neon/result.js +26 -0
- package/dist/neon/result.js.map +1 -0
- package/dist/neon/retry.d.ts +17 -0
- package/dist/neon/retry.d.ts.map +1 -0
- package/dist/neon/retry.js +42 -0
- package/dist/neon/retry.js.map +1 -0
- package/dist/neon/wait.d.ts +27 -0
- package/dist/neon/wait.d.ts.map +1 -0
- package/dist/neon/wait.js +70 -0
- package/dist/neon/wait.js.map +1 -0
- package/dist/raw.d.ts +13 -0
- package/dist/raw.d.ts.map +1 -0
- package/dist/raw.js +159 -0
- package/dist/raw.js.map +1 -0
- package/package.json +57 -16
|
@@ -0,0 +1,1362 @@
|
|
|
1
|
+
import { ClientMeta } from "./core/types.gen.js";
|
|
2
|
+
import { Client, Options as Options$1, RequestResult, TDataShape } from "./client/types.gen.js";
|
|
3
|
+
import { 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, CreateApiKeyData, CreateApiKeyErrors, CreateApiKeyResponses, CreateBranchNeonAuthNewUserData, CreateBranchNeonAuthNewUserErrors, CreateBranchNeonAuthNewUserResponses, CreateNeonAuthData, CreateNeonAuthErrors, CreateNeonAuthIntegrationData, CreateNeonAuthIntegrationErrors, CreateNeonAuthIntegrationResponses, CreateNeonAuthNewUserData, CreateNeonAuthNewUserErrors, CreateNeonAuthNewUserResponses, CreateNeonAuthProviderSdkKeysData, CreateNeonAuthProviderSdkKeysErrors, CreateNeonAuthProviderSdkKeysResponses, CreateNeonAuthResponses, CreateOrgApiKeyData, CreateOrgApiKeyErrors, CreateOrgApiKeyResponses, CreateOrganizationInvitationsData, CreateOrganizationInvitationsErrors, CreateOrganizationInvitationsResponses, CreateProjectBranchAnonymizedData, CreateProjectBranchAnonymizedErrors, CreateProjectBranchAnonymizedResponses, CreateProjectBranchData, CreateProjectBranchDataApiData, CreateProjectBranchDataApiErrors, CreateProjectBranchDataApiResponses, CreateProjectBranchDatabaseData, CreateProjectBranchDatabaseErrors, CreateProjectBranchDatabaseResponses, CreateProjectBranchErrors, CreateProjectBranchResponses, CreateProjectBranchRoleData, CreateProjectBranchRoleErrors, CreateProjectBranchRoleResponses, 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, DeleteNeonAuthOauthProviderData, DeleteNeonAuthOauthProviderErrors, DeleteNeonAuthOauthProviderResponses, DeleteNeonAuthUserData, DeleteNeonAuthUserErrors, DeleteNeonAuthUserResponses, DeleteOrganizationSpendingLimitData, DeleteOrganizationSpendingLimitErrors, DeleteOrganizationSpendingLimitResponses, DeleteOrganizationVpcEndpointData, DeleteOrganizationVpcEndpointErrors, DeleteOrganizationVpcEndpointResponses, DeleteProjectBranchData, DeleteProjectBranchDataApiData, DeleteProjectBranchDataApiErrors, DeleteProjectBranchDataApiResponses, DeleteProjectBranchDatabaseData, DeleteProjectBranchDatabaseErrors, DeleteProjectBranchDatabaseResponses, DeleteProjectBranchErrors, DeleteProjectBranchResponses, DeleteProjectBranchRoleData, DeleteProjectBranchRoleErrors, DeleteProjectBranchRoleResponses, DeleteProjectData, DeleteProjectEndpointData, DeleteProjectEndpointErrors, DeleteProjectEndpointResponses, DeleteProjectErrors, DeleteProjectJwksData, DeleteProjectJwksErrors, DeleteProjectJwksResponses, DeleteProjectResponses, DeleteProjectVpcEndpointData, DeleteProjectVpcEndpointErrors, DeleteProjectVpcEndpointResponses, DeleteSnapshotData, DeleteSnapshotErrors, DeleteSnapshotResponses, DisableNeonAuthData, DisableNeonAuthErrors, DisableNeonAuthResponses, 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, 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, GetProjectBranchData, GetProjectBranchDataApiData, GetProjectBranchDataApiErrors, GetProjectBranchDataApiResponses, GetProjectBranchDatabaseData, GetProjectBranchDatabaseErrors, GetProjectBranchDatabaseResponses, GetProjectBranchErrors, GetProjectBranchResponses, GetProjectBranchRoleData, GetProjectBranchRoleErrors, GetProjectBranchRolePasswordData, GetProjectBranchRolePasswordErrors, GetProjectBranchRolePasswordResponses, GetProjectBranchRoleResponses, GetProjectBranchSchemaComparisonData, GetProjectBranchSchemaComparisonErrors, GetProjectBranchSchemaComparisonResponses, GetProjectBranchSchemaData, GetProjectBranchSchemaErrors, GetProjectBranchSchemaResponses, 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, ListNeonAuthIntegrationsData, ListNeonAuthIntegrationsErrors, ListNeonAuthIntegrationsResponses, ListNeonAuthOauthProvidersData, ListNeonAuthOauthProvidersErrors, ListNeonAuthOauthProvidersResponses, ListNeonAuthRedirectUriWhitelistDomainsData, ListNeonAuthRedirectUriWhitelistDomainsErrors, ListNeonAuthRedirectUriWhitelistDomainsResponses, ListOrgApiKeysData, ListOrgApiKeysErrors, ListOrgApiKeysResponses, ListOrganizationVpcEndpointsAllRegionsData, ListOrganizationVpcEndpointsAllRegionsErrors, ListOrganizationVpcEndpointsAllRegionsResponses, ListOrganizationVpcEndpointsData, ListOrganizationVpcEndpointsErrors, ListOrganizationVpcEndpointsResponses, ListProjectBranchDatabasesData, ListProjectBranchDatabasesErrors, ListProjectBranchDatabasesResponses, ListProjectBranchEndpointsData, ListProjectBranchEndpointsErrors, ListProjectBranchEndpointsResponses, ListProjectBranchRolesData, ListProjectBranchRolesErrors, ListProjectBranchRolesResponses, ListProjectBranchesData, ListProjectBranchesErrors, ListProjectBranchesResponses, ListProjectEndpointsData, ListProjectEndpointsErrors, ListProjectEndpointsResponses, ListProjectOperationsData, ListProjectOperationsErrors, ListProjectOperationsResponses, ListProjectPermissionsData, ListProjectPermissionsErrors, ListProjectPermissionsResponses, ListProjectVpcEndpointsData, ListProjectVpcEndpointsErrors, ListProjectVpcEndpointsResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListSharedProjectsData, ListSharedProjectsErrors, ListSharedProjectsResponses, ListSnapshotsData, ListSnapshotsErrors, ListSnapshotsResponses, RecoverProjectData, RecoverProjectErrors, RecoverProjectResponses, RemoveOrganizationMemberData, RemoveOrganizationMemberErrors, RemoveOrganizationMemberResponses, ResetProjectBranchRolePasswordData, ResetProjectBranchRolePasswordErrors, ResetProjectBranchRolePasswordResponses, RestartProjectEndpointData, RestartProjectEndpointErrors, RestartProjectEndpointResponses, RestoreProjectBranchData, RestoreProjectBranchErrors, RestoreProjectBranchResponses, RestoreSnapshotData, RestoreSnapshotErrors, RestoreSnapshotResponses, RevokeApiKeyData, RevokeApiKeyErrors, RevokeApiKeyResponses, RevokeOrgApiKeyData, RevokeOrgApiKeyErrors, RevokeOrgApiKeyResponses, RevokePermissionFromProjectData, RevokePermissionFromProjectErrors, RevokePermissionFromProjectResponses, SendNeonAuthTestEmailData, SendNeonAuthTestEmailErrors, SendNeonAuthTestEmailResponses, SetDefaultProjectBranchData, SetDefaultProjectBranchErrors, SetDefaultProjectBranchResponses, SetOrganizationSpendingLimitData, SetOrganizationSpendingLimitErrors, SetOrganizationSpendingLimitResponses, 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, UpdateNeonAuthOauthProviderData, UpdateNeonAuthOauthProviderErrors, UpdateNeonAuthOauthProviderResponses, UpdateNeonAuthOrganizationPluginData, UpdateNeonAuthOrganizationPluginErrors, UpdateNeonAuthOrganizationPluginResponses, UpdateNeonAuthPhoneNumberPluginData, UpdateNeonAuthPhoneNumberPluginErrors, UpdateNeonAuthPhoneNumberPluginResponses, UpdateNeonAuthUserRoleData, UpdateNeonAuthUserRoleErrors, UpdateNeonAuthUserRoleResponses, UpdateNeonAuthWebhookConfigData, UpdateNeonAuthWebhookConfigErrors, UpdateNeonAuthWebhookConfigResponses, UpdateOrganizationMemberData, UpdateOrganizationMemberErrors, UpdateOrganizationMemberResponses, UpdateProjectBranchData, UpdateProjectBranchDataApiData, UpdateProjectBranchDataApiErrors, UpdateProjectBranchDataApiResponses, UpdateProjectBranchDatabaseData, UpdateProjectBranchDatabaseErrors, UpdateProjectBranchDatabaseResponses, UpdateProjectBranchErrors, UpdateProjectBranchResponses, UpdateProjectData, UpdateProjectEndpointData, UpdateProjectEndpointErrors, UpdateProjectEndpointResponses, UpdateProjectErrors, UpdateProjectResponses, UpdateSnapshotData, UpdateSnapshotErrors, UpdateSnapshotResponses } from "./types.gen.js";
|
|
4
|
+
|
|
5
|
+
//#region src/client/sdk.gen.d.ts
|
|
6
|
+
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
|
|
7
|
+
/**
|
|
8
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
9
|
+
* individual options. This might be also useful if you want to implement a
|
|
10
|
+
* custom client.
|
|
11
|
+
*/
|
|
12
|
+
client?: Client;
|
|
13
|
+
/**
|
|
14
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
15
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
16
|
+
*/
|
|
17
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Get advisor issues
|
|
21
|
+
*
|
|
22
|
+
* Analyzes the database for security and performance issues.
|
|
23
|
+
* Returns a list of issues categorized by severity (ERROR, WARN, INFO).
|
|
24
|
+
*
|
|
25
|
+
* Requires read access to the project and Data API enabled.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
declare const getProjectAdvisorSecurityIssues: <ThrowOnError extends boolean = false>(options: Options<GetProjectAdvisorSecurityIssuesData, ThrowOnError>) => RequestResult<GetProjectAdvisorSecurityIssuesResponses, GetProjectAdvisorSecurityIssuesErrors, ThrowOnError>;
|
|
29
|
+
/**
|
|
30
|
+
* List API keys
|
|
31
|
+
*
|
|
32
|
+
* Retrieves the API keys for your Neon account.
|
|
33
|
+
* The response does not include API key tokens. A token is only provided when creating an API key.
|
|
34
|
+
* API keys can also be managed in the Neon Console.
|
|
35
|
+
* For more information, see [Manage API keys](https://neon.com/docs/manage/api-keys/).
|
|
36
|
+
*
|
|
37
|
+
*/
|
|
38
|
+
declare const listApiKeys: <ThrowOnError extends boolean = false>(options?: Options<ListApiKeysData, ThrowOnError>) => RequestResult<ListApiKeysResponses, ListApiKeysErrors, ThrowOnError>;
|
|
39
|
+
/**
|
|
40
|
+
* Create API key
|
|
41
|
+
*
|
|
42
|
+
* Creates an API key.
|
|
43
|
+
* The `key_name` is a user-specified name for the key.
|
|
44
|
+
* Returns an `id` and `key`; the `key` is a randomly generated, 64-bit token required to access the Neon API.
|
|
45
|
+
* Store the key securely — it is only returned once.
|
|
46
|
+
* API keys can also be managed in the Neon Console.
|
|
47
|
+
* See [Manage API keys](https://neon.com/docs/manage/api-keys/).
|
|
48
|
+
*
|
|
49
|
+
*/
|
|
50
|
+
declare const createApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateApiKeyData, ThrowOnError>) => RequestResult<CreateApiKeyResponses, CreateApiKeyErrors, ThrowOnError>;
|
|
51
|
+
/**
|
|
52
|
+
* Revoke API key
|
|
53
|
+
*
|
|
54
|
+
* Revokes the specified API key.
|
|
55
|
+
* An API key that is no longer needed can be revoked.
|
|
56
|
+
* This action cannot be reversed.
|
|
57
|
+
* API keys can also be managed in the Neon Console.
|
|
58
|
+
* See [Manage API keys](https://neon.com/docs/manage/api-keys/).
|
|
59
|
+
*
|
|
60
|
+
*/
|
|
61
|
+
declare const revokeApiKey: <ThrowOnError extends boolean = false>(options: Options<RevokeApiKeyData, ThrowOnError>) => RequestResult<RevokeApiKeyResponses, RevokeApiKeyErrors, ThrowOnError>;
|
|
62
|
+
/**
|
|
63
|
+
* Retrieve operation details
|
|
64
|
+
*
|
|
65
|
+
* Retrieves details for the specified operation.
|
|
66
|
+
* An operation is an action performed on a Neon project resource.
|
|
67
|
+
*
|
|
68
|
+
*/
|
|
69
|
+
declare const getProjectOperation: <ThrowOnError extends boolean = false>(options: Options<GetProjectOperationData, ThrowOnError>) => RequestResult<GetProjectOperationResponses, GetProjectOperationErrors, ThrowOnError>;
|
|
70
|
+
/**
|
|
71
|
+
* List projects
|
|
72
|
+
*
|
|
73
|
+
* Retrieves a list of projects for the specified organization.
|
|
74
|
+
* If using a personal API key, include the `org_id` parameter to specify which organization to work with.
|
|
75
|
+
* If using an org API key, `org_id` is automatically inferred from the key.
|
|
76
|
+
* For more information, see [Manage organizations using the Neon API](https://neon.com/docs/manage/orgs-api)
|
|
77
|
+
* and [Manage projects](https://neon.com/docs/manage/projects/).
|
|
78
|
+
*
|
|
79
|
+
*/
|
|
80
|
+
declare const listProjects: <ThrowOnError extends boolean = false>(options?: Options<ListProjectsData, ThrowOnError>) => RequestResult<ListProjectsResponses, ListProjectsErrors, ThrowOnError>;
|
|
81
|
+
/**
|
|
82
|
+
* Create project
|
|
83
|
+
*
|
|
84
|
+
* Creates a Neon project within an organization.
|
|
85
|
+
* If using a personal API key, include the `org_id` parameter to specify which organization to create the project in.
|
|
86
|
+
* If using an org API key, `org_id` is automatically inferred from the key.
|
|
87
|
+
* Plan limits define how many projects you can create.
|
|
88
|
+
* For more information, see [Manage projects](https://neon.com/docs/manage/projects/).
|
|
89
|
+
*
|
|
90
|
+
* You can specify a region and Postgres version in the request body.
|
|
91
|
+
* Neon currently supports PostgreSQL 14, 15, 16, 17, and 18.
|
|
92
|
+
* For supported regions and `region_id` values, see [Regions](https://neon.com/docs/introduction/regions/).
|
|
93
|
+
*
|
|
94
|
+
*/
|
|
95
|
+
declare const createProject: <ThrowOnError extends boolean = false>(options: Options<CreateProjectData, ThrowOnError>) => RequestResult<CreateProjectResponses, CreateProjectErrors, ThrowOnError>;
|
|
96
|
+
/**
|
|
97
|
+
* List shared projects
|
|
98
|
+
*
|
|
99
|
+
* Retrieves a list of projects shared with your Neon account.
|
|
100
|
+
* For more information, see [Manage projects](https://neon.com/docs/manage/projects/).
|
|
101
|
+
*
|
|
102
|
+
*/
|
|
103
|
+
declare const listSharedProjects: <ThrowOnError extends boolean = false>(options?: Options<ListSharedProjectsData, ThrowOnError>) => RequestResult<ListSharedProjectsResponses, ListSharedProjectsErrors, ThrowOnError>;
|
|
104
|
+
/**
|
|
105
|
+
* Delete project
|
|
106
|
+
*
|
|
107
|
+
* Deletes the specified project and all its endpoints, branches, databases, and users.
|
|
108
|
+
* Deleted projects can be recovered within 7 days using `POST /projects/{project_id}/recover`.
|
|
109
|
+
* To list recoverable projects, use `GET /projects?recoverable=true`.
|
|
110
|
+
*
|
|
111
|
+
*/
|
|
112
|
+
declare const deleteProject: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectData, ThrowOnError>) => RequestResult<DeleteProjectResponses, DeleteProjectErrors, ThrowOnError>;
|
|
113
|
+
/**
|
|
114
|
+
* Retrieve project details
|
|
115
|
+
*
|
|
116
|
+
* Retrieves information about the specified project.
|
|
117
|
+
* Returned details include the project settings, compute configuration, history retention, owner information, and current usage metrics.
|
|
118
|
+
*
|
|
119
|
+
*/
|
|
120
|
+
declare const getProject: <ThrowOnError extends boolean = false>(options: Options<GetProjectData, ThrowOnError>) => RequestResult<GetProjectResponses, GetProjectErrors, ThrowOnError>;
|
|
121
|
+
/**
|
|
122
|
+
* Update project
|
|
123
|
+
*
|
|
124
|
+
* Updates the specified project.
|
|
125
|
+
* Configurable properties include the project name, default compute settings, history retention period, and IP allowlist.
|
|
126
|
+
*
|
|
127
|
+
*/
|
|
128
|
+
declare const updateProject: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectData, ThrowOnError>) => RequestResult<UpdateProjectResponses, UpdateProjectErrors, ThrowOnError>;
|
|
129
|
+
/**
|
|
130
|
+
* Recover a deleted project
|
|
131
|
+
*
|
|
132
|
+
* Recovers a deleted project within the 7-day deletion recovery period.
|
|
133
|
+
* Restores branches, endpoints, settings, and connection strings.
|
|
134
|
+
* Some integrations require manual reconfiguration after recovery.
|
|
135
|
+
* To list recoverable projects, use `GET /projects?recoverable=true`.
|
|
136
|
+
*
|
|
137
|
+
*/
|
|
138
|
+
declare const recoverProject: <ThrowOnError extends boolean = false>(options: Options<RecoverProjectData, ThrowOnError>) => RequestResult<RecoverProjectResponses, RecoverProjectErrors, ThrowOnError>;
|
|
139
|
+
/**
|
|
140
|
+
* List operations
|
|
141
|
+
*
|
|
142
|
+
* Retrieves a list of operations for the specified Neon project.
|
|
143
|
+
* The number of operations returned can be large.
|
|
144
|
+
* To paginate the response, issue an initial request with a `limit` value.
|
|
145
|
+
* Then, add the `cursor` value that was returned in the response to the next request.
|
|
146
|
+
* Operations older than 6 months may be deleted from our systems.
|
|
147
|
+
* If you need more history than that, you should store your own history.
|
|
148
|
+
*
|
|
149
|
+
*/
|
|
150
|
+
declare const listProjectOperations: <ThrowOnError extends boolean = false>(options: Options<ListProjectOperationsData, ThrowOnError>) => RequestResult<ListProjectOperationsResponses, ListProjectOperationsErrors, ThrowOnError>;
|
|
151
|
+
/**
|
|
152
|
+
* List project access
|
|
153
|
+
*
|
|
154
|
+
* 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.
|
|
155
|
+
*/
|
|
156
|
+
declare const listProjectPermissions: <ThrowOnError extends boolean = false>(options: Options<ListProjectPermissionsData, ThrowOnError>) => RequestResult<ListProjectPermissionsResponses, ListProjectPermissionsErrors, ThrowOnError>;
|
|
157
|
+
/**
|
|
158
|
+
* Grant project access
|
|
159
|
+
*
|
|
160
|
+
* Grants project access to the account associated with the specified email address.
|
|
161
|
+
*
|
|
162
|
+
*/
|
|
163
|
+
declare const grantPermissionToProject: <ThrowOnError extends boolean = false>(options: Options<GrantPermissionToProjectData, ThrowOnError>) => RequestResult<GrantPermissionToProjectResponses, GrantPermissionToProjectErrors, ThrowOnError>;
|
|
164
|
+
/**
|
|
165
|
+
* Revoke project access
|
|
166
|
+
*
|
|
167
|
+
* Revokes project access from the user associated with the specified permission `id`. You can retrieve a user's permission `id` by listing project access.
|
|
168
|
+
*/
|
|
169
|
+
declare const revokePermissionFromProject: <ThrowOnError extends boolean = false>(options: Options<RevokePermissionFromProjectData, ThrowOnError>) => RequestResult<RevokePermissionFromProjectResponses, RevokePermissionFromProjectErrors, ThrowOnError>;
|
|
170
|
+
/**
|
|
171
|
+
* List available shared preload libraries
|
|
172
|
+
*
|
|
173
|
+
* Returns the shared preload libraries available for the specified project's Postgres version.
|
|
174
|
+
* Shared preload libraries are Postgres extensions that require the `shared_preload_libraries`
|
|
175
|
+
* setting and a compute restart to activate.
|
|
176
|
+
* Use this list to determine which libraries can be enabled in the project's
|
|
177
|
+
* `settings.preload_libraries` configuration.
|
|
178
|
+
*
|
|
179
|
+
*/
|
|
180
|
+
declare const getAvailablePreloadLibraries: <ThrowOnError extends boolean = false>(options: Options<GetAvailablePreloadLibrariesData, ThrowOnError>) => RequestResult<GetAvailablePreloadLibrariesResponses, GetAvailablePreloadLibrariesErrors, ThrowOnError>;
|
|
181
|
+
/**
|
|
182
|
+
* Create a project transfer request
|
|
183
|
+
*
|
|
184
|
+
* Creates a transfer request for the specified project. The request expires after a set period.
|
|
185
|
+
* To accept the request, the recipient calls `PUT /projects/{project_id}/transfer_requests/{request_id}`
|
|
186
|
+
* or uses the Neon Console claim link.
|
|
187
|
+
* The optional `ru` parameter redirects the recipient after acceptance.
|
|
188
|
+
*
|
|
189
|
+
*/
|
|
190
|
+
declare const createProjectTransferRequest: <ThrowOnError extends boolean = false>(options: Options<CreateProjectTransferRequestData, ThrowOnError>) => RequestResult<CreateProjectTransferRequestResponses, CreateProjectTransferRequestErrors, ThrowOnError>;
|
|
191
|
+
/**
|
|
192
|
+
* Accept a project transfer request
|
|
193
|
+
*
|
|
194
|
+
* Accepts a transfer request for the specified project, transferring it to the specified organization
|
|
195
|
+
* or user. If org_id is not passed, the project will be transferred to the current user or organization account.
|
|
196
|
+
*
|
|
197
|
+
*/
|
|
198
|
+
declare const acceptProjectTransferRequest: <ThrowOnError extends boolean = false>(options: Options<AcceptProjectTransferRequestData, ThrowOnError>) => RequestResult<AcceptProjectTransferRequestResponses, AcceptProjectTransferRequestErrors, ThrowOnError>;
|
|
199
|
+
/**
|
|
200
|
+
* List JWKS URLs
|
|
201
|
+
*
|
|
202
|
+
* Returns the JWKS URLs available for verifying JWTs used as the authentication mechanism for the specified project.
|
|
203
|
+
*
|
|
204
|
+
*/
|
|
205
|
+
declare const getProjectJwks: <ThrowOnError extends boolean = false>(options: Options<GetProjectJwksData, ThrowOnError>) => RequestResult<GetProjectJwksResponses, GetProjectJwksErrors, ThrowOnError>;
|
|
206
|
+
/**
|
|
207
|
+
* Add JWKS URL
|
|
208
|
+
*
|
|
209
|
+
* Adds a JWKS URL to the specified project for verifying JWTs used as the authentication mechanism.
|
|
210
|
+
*
|
|
211
|
+
* The URL must be a valid HTTPS URL that returns a JSON Web Key Set.
|
|
212
|
+
*
|
|
213
|
+
* The `provider_name` field allows you to specify which authentication provider you're using (e.g., Clerk, Auth0, AWS Cognito).
|
|
214
|
+
*
|
|
215
|
+
* The `branch_id` scopes the JWKS URL to specific branches; if not specified, it applies to all branches.
|
|
216
|
+
*
|
|
217
|
+
* The `role_names` scopes the URL to specific roles; if not specified, default roles are used (`authenticator`, `authenticated`, `anonymous`).
|
|
218
|
+
*
|
|
219
|
+
* The `jwt_audience` specifies which `aud` values are accepted in JWTs.
|
|
220
|
+
*
|
|
221
|
+
*/
|
|
222
|
+
declare const addProjectJwks: <ThrowOnError extends boolean = false>(options: Options<AddProjectJwksData, ThrowOnError>) => RequestResult<AddProjectJwksResponses, AddProjectJwksErrors, ThrowOnError>;
|
|
223
|
+
/**
|
|
224
|
+
* Delete JWKS URL
|
|
225
|
+
*
|
|
226
|
+
* Removes the specified JWKS URL from the project.
|
|
227
|
+
* JWTs signed by keys from the removed URL can no longer authenticate to the project's endpoints.
|
|
228
|
+
*
|
|
229
|
+
*/
|
|
230
|
+
declare const deleteProjectJwks: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectJwksData, ThrowOnError>) => RequestResult<DeleteProjectJwksResponses, DeleteProjectJwksErrors, ThrowOnError>;
|
|
231
|
+
/**
|
|
232
|
+
* Delete Neon Data API
|
|
233
|
+
*
|
|
234
|
+
* Deletes the Neon Data API for the specified branch.
|
|
235
|
+
* Existing connections using the Data API endpoint will fail after deletion.
|
|
236
|
+
*
|
|
237
|
+
*/
|
|
238
|
+
declare const deleteProjectBranchDataApi: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectBranchDataApiData, ThrowOnError>) => RequestResult<DeleteProjectBranchDataApiResponses, DeleteProjectBranchDataApiErrors, ThrowOnError>;
|
|
239
|
+
/**
|
|
240
|
+
* Retrieve Neon Data API configuration
|
|
241
|
+
*
|
|
242
|
+
* Retrieves the Neon Data API configuration for the specified branch,
|
|
243
|
+
* including endpoint URL, enabled state, and database settings.
|
|
244
|
+
*
|
|
245
|
+
*/
|
|
246
|
+
declare const getProjectBranchDataApi: <ThrowOnError extends boolean = false>(options: Options<GetProjectBranchDataApiData, ThrowOnError>) => RequestResult<GetProjectBranchDataApiResponses, GetProjectBranchDataApiErrors, ThrowOnError>;
|
|
247
|
+
/**
|
|
248
|
+
* Update Neon Data API
|
|
249
|
+
*
|
|
250
|
+
* Updates the Neon Data API configuration for the specified branch.
|
|
251
|
+
* You can optionally provide settings to update the Data API configuration.
|
|
252
|
+
* The schema cache is always refreshed as part of this operation.
|
|
253
|
+
*
|
|
254
|
+
*/
|
|
255
|
+
declare const updateProjectBranchDataApi: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectBranchDataApiData, ThrowOnError>) => RequestResult<UpdateProjectBranchDataApiResponses, UpdateProjectBranchDataApiErrors, ThrowOnError>;
|
|
256
|
+
/**
|
|
257
|
+
* Create Neon Data API
|
|
258
|
+
*
|
|
259
|
+
* Creates a new instance of Neon Data API in the specified branch.
|
|
260
|
+
* The Data API exposes a REST interface over the branch database. The `database_name` path parameter determines which database the API serves.
|
|
261
|
+
*
|
|
262
|
+
*/
|
|
263
|
+
declare const createProjectBranchDataApi: <ThrowOnError extends boolean = false>(options: Options<CreateProjectBranchDataApiData, ThrowOnError>) => RequestResult<CreateProjectBranchDataApiResponses, CreateProjectBranchDataApiErrors, ThrowOnError>;
|
|
264
|
+
/**
|
|
265
|
+
* Create Neon Auth integration
|
|
266
|
+
*
|
|
267
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth` instead. Creates a project on a third-party authentication provider's platform for use with Neon Auth.
|
|
268
|
+
* Use this endpoint if the frontend integration flow can't be used.
|
|
269
|
+
*
|
|
270
|
+
*
|
|
271
|
+
* @deprecated
|
|
272
|
+
*/
|
|
273
|
+
declare const createNeonAuthIntegration: <ThrowOnError extends boolean = false>(options: Options<CreateNeonAuthIntegrationData, ThrowOnError>) => RequestResult<CreateNeonAuthIntegrationResponses, CreateNeonAuthIntegrationErrors, ThrowOnError>;
|
|
274
|
+
/**
|
|
275
|
+
* Disable Neon Auth for the branch
|
|
276
|
+
*
|
|
277
|
+
* Disables the Neon Auth integration for the specified branch, removing the connection
|
|
278
|
+
* to the authentication provider.
|
|
279
|
+
* If `delete_data` is `true`, also deletes the `neon_auth` schema and all associated tables
|
|
280
|
+
* from the branch database.
|
|
281
|
+
* The integration can be re-enabled by calling `POST /projects/{project_id}/branches/{branch_id}/auth`.
|
|
282
|
+
*
|
|
283
|
+
*/
|
|
284
|
+
declare const disableNeonAuth: <ThrowOnError extends boolean = false>(options: Options<DisableNeonAuthData, ThrowOnError>) => RequestResult<DisableNeonAuthResponses, DisableNeonAuthErrors, ThrowOnError>;
|
|
285
|
+
/**
|
|
286
|
+
* Retrieve Neon Auth details for the branch
|
|
287
|
+
*
|
|
288
|
+
* Retrieves the Neon Auth integration details for the specified branch,
|
|
289
|
+
* including the auth provider type and integration status.
|
|
290
|
+
*
|
|
291
|
+
*/
|
|
292
|
+
declare const getNeonAuth: <ThrowOnError extends boolean = false>(options: Options<GetNeonAuthData, ThrowOnError>) => RequestResult<GetNeonAuthResponses, GetNeonAuthErrors, ThrowOnError>;
|
|
293
|
+
/**
|
|
294
|
+
* Enable Neon Auth for the branch
|
|
295
|
+
*
|
|
296
|
+
* Enables Neon Auth for the specified branch by connecting it to an authentication provider.
|
|
297
|
+
* Creating the integration provisions the `neon_auth` schema in the branch database, which stores user identity data synchronized from the provider.
|
|
298
|
+
*
|
|
299
|
+
*/
|
|
300
|
+
declare const createNeonAuth: <ThrowOnError extends boolean = false>(options: Options<CreateNeonAuthData, ThrowOnError>) => RequestResult<CreateNeonAuthResponses, CreateNeonAuthErrors, ThrowOnError>;
|
|
301
|
+
/**
|
|
302
|
+
* Delete trusted redirect URI domain
|
|
303
|
+
*
|
|
304
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Deletes a domain from the redirect_uri whitelist for the specified project.
|
|
305
|
+
*
|
|
306
|
+
*
|
|
307
|
+
* @deprecated
|
|
308
|
+
*/
|
|
309
|
+
declare const deleteNeonAuthDomainFromRedirectUriWhitelist: <ThrowOnError extends boolean = false>(options: Options<DeleteNeonAuthDomainFromRedirectUriWhitelistData, ThrowOnError>) => RequestResult<DeleteNeonAuthDomainFromRedirectUriWhitelistResponses, DeleteNeonAuthDomainFromRedirectUriWhitelistErrors, ThrowOnError>;
|
|
310
|
+
/**
|
|
311
|
+
* List trusted redirect URI domains
|
|
312
|
+
*
|
|
313
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Lists the domains in the redirect_uri whitelist for the specified project.
|
|
314
|
+
*
|
|
315
|
+
*
|
|
316
|
+
* @deprecated
|
|
317
|
+
*/
|
|
318
|
+
declare const listNeonAuthRedirectUriWhitelistDomains: <ThrowOnError extends boolean = false>(options: Options<ListNeonAuthRedirectUriWhitelistDomainsData, ThrowOnError>) => RequestResult<ListNeonAuthRedirectUriWhitelistDomainsResponses, ListNeonAuthRedirectUriWhitelistDomainsErrors, ThrowOnError>;
|
|
319
|
+
/**
|
|
320
|
+
* Add trusted redirect URI domain
|
|
321
|
+
*
|
|
322
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/domains` instead. Adds a domain to the redirect_uri whitelist for the specified project.
|
|
323
|
+
*
|
|
324
|
+
*
|
|
325
|
+
* @deprecated
|
|
326
|
+
*/
|
|
327
|
+
declare const addNeonAuthDomainToRedirectUriWhitelist: <ThrowOnError extends boolean = false>(options: Options<AddNeonAuthDomainToRedirectUriWhitelistData, ThrowOnError>) => RequestResult<AddNeonAuthDomainToRedirectUriWhitelistResponses, AddNeonAuthDomainToRedirectUriWhitelistErrors, ThrowOnError>;
|
|
328
|
+
/**
|
|
329
|
+
* Delete domain from redirect_uri whitelist
|
|
330
|
+
*
|
|
331
|
+
* Removes a domain from the redirect URI whitelist for the specified branch.
|
|
332
|
+
* After removal, the domain can no longer be used as a redirect target after authentication.
|
|
333
|
+
*
|
|
334
|
+
*/
|
|
335
|
+
declare const deleteBranchNeonAuthTrustedDomain: <ThrowOnError extends boolean = false>(options: Options<DeleteBranchNeonAuthTrustedDomainData, ThrowOnError>) => RequestResult<DeleteBranchNeonAuthTrustedDomainResponses, DeleteBranchNeonAuthTrustedDomainErrors, ThrowOnError>;
|
|
336
|
+
/**
|
|
337
|
+
* List domains in redirect_uri whitelist
|
|
338
|
+
*
|
|
339
|
+
* Lists the trusted domains in the redirect URI whitelist for the specified branch.
|
|
340
|
+
* Only domains in this list are permitted as redirect targets after authentication.
|
|
341
|
+
*
|
|
342
|
+
*/
|
|
343
|
+
declare const listBranchNeonAuthTrustedDomains: <ThrowOnError extends boolean = false>(options: Options<ListBranchNeonAuthTrustedDomainsData, ThrowOnError>) => RequestResult<ListBranchNeonAuthTrustedDomainsResponses, ListBranchNeonAuthTrustedDomainsErrors, ThrowOnError>;
|
|
344
|
+
/**
|
|
345
|
+
* Add domain to redirect_uri whitelist
|
|
346
|
+
*
|
|
347
|
+
* Adds a domain to the redirect URI whitelist for the specified branch.
|
|
348
|
+
* Only domains in this list are permitted as redirect targets after authentication.
|
|
349
|
+
*
|
|
350
|
+
*/
|
|
351
|
+
declare const addBranchNeonAuthTrustedDomain: <ThrowOnError extends boolean = false>(options: Options<AddBranchNeonAuthTrustedDomainData, ThrowOnError>) => RequestResult<AddBranchNeonAuthTrustedDomainResponses, AddBranchNeonAuthTrustedDomainErrors, ThrowOnError>;
|
|
352
|
+
/**
|
|
353
|
+
* Create Auth Provider SDK keys
|
|
354
|
+
*
|
|
355
|
+
* Generates SDK or API Keys for the auth provider. These might be called different things depending
|
|
356
|
+
* on the auth provider you're using, but are generally used for setting up the frontend and backend SDKs.
|
|
357
|
+
*
|
|
358
|
+
*/
|
|
359
|
+
declare const createNeonAuthProviderSdkKeys: <ThrowOnError extends boolean = false>(options: Options<CreateNeonAuthProviderSdkKeysData, ThrowOnError>) => RequestResult<CreateNeonAuthProviderSdkKeysResponses, CreateNeonAuthProviderSdkKeysErrors, ThrowOnError>;
|
|
360
|
+
/**
|
|
361
|
+
* Create new auth user
|
|
362
|
+
*
|
|
363
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/users` instead. Creates a new user in Neon Auth.
|
|
364
|
+
* 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.
|
|
365
|
+
*
|
|
366
|
+
*
|
|
367
|
+
* @deprecated
|
|
368
|
+
*/
|
|
369
|
+
declare const createNeonAuthNewUser: <ThrowOnError extends boolean = false>(options: Options<CreateNeonAuthNewUserData, ThrowOnError>) => RequestResult<CreateNeonAuthNewUserResponses, CreateNeonAuthNewUserErrors, ThrowOnError>;
|
|
370
|
+
/**
|
|
371
|
+
* Create new auth user
|
|
372
|
+
*
|
|
373
|
+
* Creates a new user in the Neon Auth user directory for the specified branch.
|
|
374
|
+
* The user is created in the `neon_auth.users_sync` table and can immediately authenticate
|
|
375
|
+
* using the branch's configured auth providers.
|
|
376
|
+
*
|
|
377
|
+
*/
|
|
378
|
+
declare const createBranchNeonAuthNewUser: <ThrowOnError extends boolean = false>(options: Options<CreateBranchNeonAuthNewUserData, ThrowOnError>) => RequestResult<CreateBranchNeonAuthNewUserResponses, CreateBranchNeonAuthNewUserErrors, ThrowOnError>;
|
|
379
|
+
/**
|
|
380
|
+
* Delete auth user
|
|
381
|
+
*
|
|
382
|
+
* Deletes the specified user from the Neon Auth user directory for the specified branch.
|
|
383
|
+
* Removes the user record from `neon_auth.users_sync`. This action cannot be undone.
|
|
384
|
+
*
|
|
385
|
+
*/
|
|
386
|
+
declare const deleteBranchNeonAuthUser: <ThrowOnError extends boolean = false>(options: Options<DeleteBranchNeonAuthUserData, ThrowOnError>) => RequestResult<DeleteBranchNeonAuthUserResponses, DeleteBranchNeonAuthUserErrors, ThrowOnError>;
|
|
387
|
+
/**
|
|
388
|
+
* Update auth user role
|
|
389
|
+
*
|
|
390
|
+
* Updates the role of a user in the Neon Auth user directory for the specified branch.
|
|
391
|
+
* The role controls the user's level of access within the Neon Auth integration.
|
|
392
|
+
*
|
|
393
|
+
*/
|
|
394
|
+
declare const updateNeonAuthUserRole: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthUserRoleData, ThrowOnError>) => RequestResult<UpdateNeonAuthUserRoleResponses, UpdateNeonAuthUserRoleErrors, ThrowOnError>;
|
|
395
|
+
/**
|
|
396
|
+
* Delete auth user
|
|
397
|
+
*
|
|
398
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/users/{auth_user_id}` instead. Deletes the auth user for the specified project.
|
|
399
|
+
*
|
|
400
|
+
*
|
|
401
|
+
* @deprecated
|
|
402
|
+
*/
|
|
403
|
+
declare const deleteNeonAuthUser: <ThrowOnError extends boolean = false>(options: Options<DeleteNeonAuthUserData, ThrowOnError>) => RequestResult<DeleteNeonAuthUserResponses, DeleteNeonAuthUserErrors, ThrowOnError>;
|
|
404
|
+
/**
|
|
405
|
+
* Transfer Neon-managed auth project to your own account
|
|
406
|
+
*
|
|
407
|
+
* Transfers ownership of your Neon-managed auth project to your own auth provider account.
|
|
408
|
+
*
|
|
409
|
+
*/
|
|
410
|
+
declare const transferNeonAuthProviderProject: <ThrowOnError extends boolean = false>(options: Options<TransferNeonAuthProviderProjectData, ThrowOnError>) => RequestResult<TransferNeonAuthProviderProjectResponses, TransferNeonAuthProviderProjectErrors, ThrowOnError>;
|
|
411
|
+
/**
|
|
412
|
+
* List active integrations with auth providers
|
|
413
|
+
*
|
|
414
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth` instead.
|
|
415
|
+
*
|
|
416
|
+
* @deprecated
|
|
417
|
+
*/
|
|
418
|
+
declare const listNeonAuthIntegrations: <ThrowOnError extends boolean = false>(options: Options<ListNeonAuthIntegrationsData, ThrowOnError>) => RequestResult<ListNeonAuthIntegrationsResponses, ListNeonAuthIntegrationsErrors, ThrowOnError>;
|
|
419
|
+
/**
|
|
420
|
+
* List OAuth providers
|
|
421
|
+
*
|
|
422
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers` instead. Lists the OAuth providers for the specified project.
|
|
423
|
+
*
|
|
424
|
+
*
|
|
425
|
+
* @deprecated
|
|
426
|
+
*/
|
|
427
|
+
declare const listNeonAuthOauthProviders: <ThrowOnError extends boolean = false>(options: Options<ListNeonAuthOauthProvidersData, ThrowOnError>) => RequestResult<ListNeonAuthOauthProvidersResponses, ListNeonAuthOauthProvidersErrors, ThrowOnError>;
|
|
428
|
+
/**
|
|
429
|
+
* Add an OAuth provider
|
|
430
|
+
*
|
|
431
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers` instead.
|
|
432
|
+
* Adds an OAuth provider to the specified project.
|
|
433
|
+
*
|
|
434
|
+
*
|
|
435
|
+
* @deprecated
|
|
436
|
+
*/
|
|
437
|
+
declare const addNeonAuthOauthProvider: <ThrowOnError extends boolean = false>(options: Options<AddNeonAuthOauthProviderData, ThrowOnError>) => RequestResult<AddNeonAuthOauthProviderResponses, AddNeonAuthOauthProviderErrors, ThrowOnError>;
|
|
438
|
+
/**
|
|
439
|
+
* List OAuth providers for the branch
|
|
440
|
+
*
|
|
441
|
+
* Lists the OAuth providers configured for the specified branch's Neon Auth integration.
|
|
442
|
+
*
|
|
443
|
+
*/
|
|
444
|
+
declare const listBranchNeonAuthOauthProviders: <ThrowOnError extends boolean = false>(options: Options<ListBranchNeonAuthOauthProvidersData, ThrowOnError>) => RequestResult<ListBranchNeonAuthOauthProvidersResponses, ListBranchNeonAuthOauthProvidersErrors, ThrowOnError>;
|
|
445
|
+
/**
|
|
446
|
+
* Add an OAuth provider
|
|
447
|
+
*
|
|
448
|
+
* Adds an OAuth provider configuration to the specified branch's Neon Auth integration.
|
|
449
|
+
* After adding, users can authenticate using the configured provider.
|
|
450
|
+
*
|
|
451
|
+
*/
|
|
452
|
+
declare const addBranchNeonAuthOauthProvider: <ThrowOnError extends boolean = false>(options: Options<AddBranchNeonAuthOauthProviderData, ThrowOnError>) => RequestResult<AddBranchNeonAuthOauthProviderResponses, AddBranchNeonAuthOauthProviderErrors, ThrowOnError>;
|
|
453
|
+
/**
|
|
454
|
+
* Delete OAuth provider
|
|
455
|
+
*
|
|
456
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}` instead. Deletes a OAuth provider from the specified project.
|
|
457
|
+
*
|
|
458
|
+
*
|
|
459
|
+
* @deprecated
|
|
460
|
+
*/
|
|
461
|
+
declare const deleteNeonAuthOauthProvider: <ThrowOnError extends boolean = false>(options: Options<DeleteNeonAuthOauthProviderData, ThrowOnError>) => RequestResult<DeleteNeonAuthOauthProviderResponses, DeleteNeonAuthOauthProviderErrors, ThrowOnError>;
|
|
462
|
+
/**
|
|
463
|
+
* Update OAuth provider
|
|
464
|
+
*
|
|
465
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/oauth_providers/{oauth_provider_id}` instead. Updates a OAuth provider for the specified project.
|
|
466
|
+
*
|
|
467
|
+
*
|
|
468
|
+
* @deprecated
|
|
469
|
+
*/
|
|
470
|
+
declare const updateNeonAuthOauthProvider: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthOauthProviderData, ThrowOnError>) => RequestResult<UpdateNeonAuthOauthProviderResponses, UpdateNeonAuthOauthProviderErrors, ThrowOnError>;
|
|
471
|
+
/**
|
|
472
|
+
* Delete OAuth provider
|
|
473
|
+
*
|
|
474
|
+
* Deletes a OAuth provider from the specified project.
|
|
475
|
+
*
|
|
476
|
+
*/
|
|
477
|
+
declare const deleteBranchNeonAuthOauthProvider: <ThrowOnError extends boolean = false>(options: Options<DeleteBranchNeonAuthOauthProviderData, ThrowOnError>) => RequestResult<DeleteBranchNeonAuthOauthProviderResponses, DeleteBranchNeonAuthOauthProviderErrors, ThrowOnError>;
|
|
478
|
+
/**
|
|
479
|
+
* Update OAuth provider
|
|
480
|
+
*
|
|
481
|
+
* Updates a OAuth provider for the specified project.
|
|
482
|
+
*
|
|
483
|
+
*/
|
|
484
|
+
declare const updateBranchNeonAuthOauthProvider: <ThrowOnError extends boolean = false>(options: Options<UpdateBranchNeonAuthOauthProviderData, ThrowOnError>) => RequestResult<UpdateBranchNeonAuthOauthProviderResponses, UpdateBranchNeonAuthOauthProviderErrors, ThrowOnError>;
|
|
485
|
+
/**
|
|
486
|
+
* Retrieve email server configuration
|
|
487
|
+
*
|
|
488
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/email_provider` instead. Gets the email server configuration for the specified project.
|
|
489
|
+
*
|
|
490
|
+
*
|
|
491
|
+
* @deprecated
|
|
492
|
+
*/
|
|
493
|
+
declare const getNeonAuthEmailServer: <ThrowOnError extends boolean = false>(options: Options<GetNeonAuthEmailServerData, ThrowOnError>) => RequestResult<GetNeonAuthEmailServerResponses, GetNeonAuthEmailServerErrors, ThrowOnError>;
|
|
494
|
+
/**
|
|
495
|
+
* Update email server configuration
|
|
496
|
+
*
|
|
497
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth/email_provider` instead. Updates the email server configuration for the specified project.
|
|
498
|
+
*
|
|
499
|
+
*
|
|
500
|
+
* @deprecated
|
|
501
|
+
*/
|
|
502
|
+
declare const updateNeonAuthEmailServer: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthEmailServerData, ThrowOnError>) => RequestResult<UpdateNeonAuthEmailServerResponses, UpdateNeonAuthEmailServerErrors, ThrowOnError>;
|
|
503
|
+
/**
|
|
504
|
+
* Send test email
|
|
505
|
+
*
|
|
506
|
+
* Sends a test email using the configured email server settings to verify SMTP connectivity and credentials.
|
|
507
|
+
* The request body must include the SMTP server settings
|
|
508
|
+
* (`host`, `port`, `username`, `password`, `sender_email`, `sender_name`) and the `recipient_email` address.
|
|
509
|
+
*
|
|
510
|
+
*/
|
|
511
|
+
declare const sendNeonAuthTestEmail: <ThrowOnError extends boolean = false>(options: Options<SendNeonAuthTestEmailData, ThrowOnError>) => RequestResult<SendNeonAuthTestEmailResponses, SendNeonAuthTestEmailErrors, ThrowOnError>;
|
|
512
|
+
/**
|
|
513
|
+
* Retrieve email and password configuration
|
|
514
|
+
*
|
|
515
|
+
* Retrieves the email and password authentication configuration for the specified branch's Neon Auth integration,
|
|
516
|
+
* including whether it is enabled and the email verification method.
|
|
517
|
+
*
|
|
518
|
+
*/
|
|
519
|
+
declare const getNeonAuthEmailAndPasswordConfig: <ThrowOnError extends boolean = false>(options: Options<GetNeonAuthEmailAndPasswordConfigData, ThrowOnError>) => RequestResult<GetNeonAuthEmailAndPasswordConfigResponses, GetNeonAuthEmailAndPasswordConfigErrors, ThrowOnError>;
|
|
520
|
+
/**
|
|
521
|
+
* Update email and password configuration
|
|
522
|
+
*
|
|
523
|
+
* Updates the email and password authentication configuration for the specified branch's Neon Auth integration.
|
|
524
|
+
* Only the fields provided in the request body are updated.
|
|
525
|
+
*
|
|
526
|
+
*/
|
|
527
|
+
declare const updateNeonAuthEmailAndPasswordConfig: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthEmailAndPasswordConfigData, ThrowOnError>) => RequestResult<UpdateNeonAuthEmailAndPasswordConfigResponses, UpdateNeonAuthEmailAndPasswordConfigErrors, ThrowOnError>;
|
|
528
|
+
/**
|
|
529
|
+
* Retrieve email provider configuration
|
|
530
|
+
*
|
|
531
|
+
* Retrieves the email provider configuration for the specified branch's Neon Auth integration,
|
|
532
|
+
* including the provider type and server settings.
|
|
533
|
+
*
|
|
534
|
+
*/
|
|
535
|
+
declare const getNeonAuthEmailProvider: <ThrowOnError extends boolean = false>(options: Options<GetNeonAuthEmailProviderData, ThrowOnError>) => RequestResult<GetNeonAuthEmailProviderResponses, GetNeonAuthEmailProviderErrors, ThrowOnError>;
|
|
536
|
+
/**
|
|
537
|
+
* Update email provider configuration
|
|
538
|
+
*
|
|
539
|
+
* Updates the email provider configuration for the specified branch's Neon Auth integration.
|
|
540
|
+
* The email provider handles transactional messages such as verification emails and password reset links.
|
|
541
|
+
*
|
|
542
|
+
*/
|
|
543
|
+
declare const updateNeonAuthEmailProvider: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthEmailProviderData, ThrowOnError>) => RequestResult<UpdateNeonAuthEmailProviderResponses, UpdateNeonAuthEmailProviderErrors, ThrowOnError>;
|
|
544
|
+
/**
|
|
545
|
+
* Delete integration with auth provider
|
|
546
|
+
*
|
|
547
|
+
* DEPRECATED, use `/projects/{project_id}/branches/{branch_id}/auth` instead.
|
|
548
|
+
*
|
|
549
|
+
* @deprecated
|
|
550
|
+
*/
|
|
551
|
+
declare const deleteNeonAuthIntegration: <ThrowOnError extends boolean = false>(options: Options<DeleteNeonAuthIntegrationData, ThrowOnError>) => RequestResult<DeleteNeonAuthIntegrationResponses, DeleteNeonAuthIntegrationErrors, ThrowOnError>;
|
|
552
|
+
/**
|
|
553
|
+
* Retrieve connection URI
|
|
554
|
+
*
|
|
555
|
+
* Retrieves a connection URI for the specified database.
|
|
556
|
+
* The URI uses the standard PostgreSQL connection string format. Set `pooled=true` to include the `-pooler` suffix for a connection pooler URI.
|
|
557
|
+
*
|
|
558
|
+
*/
|
|
559
|
+
declare const getConnectionUri: <ThrowOnError extends boolean = false>(options: Options<GetConnectionUriData, ThrowOnError>) => RequestResult<GetConnectionUriResponses, GetConnectionUriErrors, ThrowOnError>;
|
|
560
|
+
/**
|
|
561
|
+
* Retrieve localhost allow setting
|
|
562
|
+
*
|
|
563
|
+
* Retrieves the localhost allow setting for the specified branch's Neon Auth integration.
|
|
564
|
+
* When enabled, authentication flows work from `localhost` without adding it to the redirect URI whitelist.
|
|
565
|
+
*
|
|
566
|
+
*/
|
|
567
|
+
declare const getNeonAuthAllowLocalhost: <ThrowOnError extends boolean = false>(options: Options<GetNeonAuthAllowLocalhostData, ThrowOnError>) => RequestResult<GetNeonAuthAllowLocalhostResponses, GetNeonAuthAllowLocalhostErrors, ThrowOnError>;
|
|
568
|
+
/**
|
|
569
|
+
* Update localhost allow setting
|
|
570
|
+
*
|
|
571
|
+
* Updates the localhost allow setting for the specified branch's Neon Auth integration.
|
|
572
|
+
* When enabled, authentication flows work from `localhost` without adding it to the redirect URI whitelist.
|
|
573
|
+
*
|
|
574
|
+
*/
|
|
575
|
+
declare const updateNeonAuthAllowLocalhost: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthAllowLocalhostData, ThrowOnError>) => RequestResult<UpdateNeonAuthAllowLocalhostResponses, UpdateNeonAuthAllowLocalhostErrors, ThrowOnError>;
|
|
576
|
+
/**
|
|
577
|
+
* Retrieve Neon Auth plugin configurations
|
|
578
|
+
*
|
|
579
|
+
* Returns all plugin configurations for Neon Auth in a single response.
|
|
580
|
+
* This endpoint aggregates organization, email provider, email and password,
|
|
581
|
+
* OAuth providers, and localhost settings.
|
|
582
|
+
*
|
|
583
|
+
*/
|
|
584
|
+
declare const getNeonAuthPluginConfigs: <ThrowOnError extends boolean = false>(options: Options<GetNeonAuthPluginConfigsData, ThrowOnError>) => RequestResult<GetNeonAuthPluginConfigsResponses, GetNeonAuthPluginConfigsErrors, ThrowOnError>;
|
|
585
|
+
/**
|
|
586
|
+
* Update organization plugin configuration
|
|
587
|
+
*
|
|
588
|
+
* Updates the organization plugin configuration for Neon Auth.
|
|
589
|
+
* The organization plugin enables multi-tenant organization support.
|
|
590
|
+
*
|
|
591
|
+
*/
|
|
592
|
+
declare const updateNeonAuthOrganizationPlugin: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthOrganizationPluginData, ThrowOnError>) => RequestResult<UpdateNeonAuthOrganizationPluginResponses, UpdateNeonAuthOrganizationPluginErrors, ThrowOnError>;
|
|
593
|
+
/**
|
|
594
|
+
* Update auth configuration
|
|
595
|
+
*
|
|
596
|
+
* Updates the auth configuration for the branch.
|
|
597
|
+
* Currently supports updating the application name used in auth emails.
|
|
598
|
+
*
|
|
599
|
+
*/
|
|
600
|
+
declare const updateNeonAuthConfig: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthConfigData, ThrowOnError>) => RequestResult<UpdateNeonAuthConfigResponses, UpdateNeonAuthConfigErrors, ThrowOnError>;
|
|
601
|
+
/**
|
|
602
|
+
* Update magic link plugin configuration
|
|
603
|
+
*
|
|
604
|
+
* Updates the magic link plugin configuration for Neon Auth.
|
|
605
|
+
* The magic link plugin enables passwordless authentication via email magic links.
|
|
606
|
+
*
|
|
607
|
+
*/
|
|
608
|
+
declare const updateNeonAuthMagicLinkPlugin: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthMagicLinkPluginData, ThrowOnError>) => RequestResult<UpdateNeonAuthMagicLinkPluginResponses, UpdateNeonAuthMagicLinkPluginErrors, ThrowOnError>;
|
|
609
|
+
/**
|
|
610
|
+
* Retrieve phone number plugin configuration
|
|
611
|
+
*
|
|
612
|
+
* Returns the phone number plugin configuration for Neon Auth.
|
|
613
|
+
* The phone number plugin enables phone-based OTP authentication.
|
|
614
|
+
*
|
|
615
|
+
*/
|
|
616
|
+
declare const getNeonAuthPhoneNumberPlugin: <ThrowOnError extends boolean = false>(options: Options<GetNeonAuthPhoneNumberPluginData, ThrowOnError>) => RequestResult<GetNeonAuthPhoneNumberPluginResponses, GetNeonAuthPhoneNumberPluginErrors, ThrowOnError>;
|
|
617
|
+
/**
|
|
618
|
+
* Update phone number plugin configuration
|
|
619
|
+
*
|
|
620
|
+
* Updates the phone number plugin configuration for Neon Auth.
|
|
621
|
+
* Only the fields provided in the request body are updated; omitted fields retain their current values.
|
|
622
|
+
* The phone number plugin enables phone-based OTP authentication.
|
|
623
|
+
* OTP codes are delivered via the `send.otp` webhook event with `delivery_preference: "sms"`.
|
|
624
|
+
* A webhook must be configured with the `send.otp` event enabled for SMS delivery to work.
|
|
625
|
+
*
|
|
626
|
+
*/
|
|
627
|
+
declare const updateNeonAuthPhoneNumberPlugin: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthPhoneNumberPluginData, ThrowOnError>) => RequestResult<UpdateNeonAuthPhoneNumberPluginResponses, UpdateNeonAuthPhoneNumberPluginErrors, ThrowOnError>;
|
|
628
|
+
/**
|
|
629
|
+
* Retrieve Neon Auth webhook configuration
|
|
630
|
+
*
|
|
631
|
+
* Returns the webhook configuration for the specified branch's Neon Auth integration,
|
|
632
|
+
* including the endpoint URL and the events that trigger it.
|
|
633
|
+
*
|
|
634
|
+
*/
|
|
635
|
+
declare const getNeonAuthWebhookConfig: <ThrowOnError extends boolean = false>(options: Options<GetNeonAuthWebhookConfigData, ThrowOnError>) => RequestResult<GetNeonAuthWebhookConfigResponses, GetNeonAuthWebhookConfigErrors, ThrowOnError>;
|
|
636
|
+
/**
|
|
637
|
+
* Update Neon Auth webhook configuration
|
|
638
|
+
*
|
|
639
|
+
* Updates the webhook configuration for the specified branch's Neon Auth integration.
|
|
640
|
+
* Webhooks notify an external endpoint when auth events occur, such as user creation or sign-in.
|
|
641
|
+
*
|
|
642
|
+
*/
|
|
643
|
+
declare const updateNeonAuthWebhookConfig: <ThrowOnError extends boolean = false>(options: Options<UpdateNeonAuthWebhookConfigData, ThrowOnError>) => RequestResult<UpdateNeonAuthWebhookConfigResponses, UpdateNeonAuthWebhookConfigErrors, ThrowOnError>;
|
|
644
|
+
/**
|
|
645
|
+
* List branches
|
|
646
|
+
*
|
|
647
|
+
* Retrieves a list of branches for the specified project.
|
|
648
|
+
*
|
|
649
|
+
* Each Neon project has a root branch named `main`.
|
|
650
|
+
* A `branch_id` value has a `br-` prefix.
|
|
651
|
+
* A project may contain child branches that were branched from `main` or from another branch.
|
|
652
|
+
* A parent branch is identified by the `parent_id` value, which is the `id` of the parent branch.
|
|
653
|
+
* For related information, see [Manage branches](https://neon.com/docs/manage/branches/).
|
|
654
|
+
*
|
|
655
|
+
*/
|
|
656
|
+
declare const listProjectBranches: <ThrowOnError extends boolean = false>(options: Options<ListProjectBranchesData, ThrowOnError>) => RequestResult<ListProjectBranchesResponses, ListProjectBranchesErrors, ThrowOnError>;
|
|
657
|
+
/**
|
|
658
|
+
* Create branch
|
|
659
|
+
*
|
|
660
|
+
* Creates a branch in the specified project.
|
|
661
|
+
* No request body is required, but you can specify one to create a compute endpoint or select a non-default parent branch.
|
|
662
|
+
* By default, the branch is created from the project's default branch with no compute endpoint, and the branch name is auto-generated.
|
|
663
|
+
* To access the branch, add a `read_write` endpoint.
|
|
664
|
+
* Each branch supports one read-write endpoint and multiple read-only endpoints.
|
|
665
|
+
* For related information, see [Manage branches](https://neon.com/docs/manage/branches/).
|
|
666
|
+
*
|
|
667
|
+
*/
|
|
668
|
+
declare const createProjectBranch: <ThrowOnError extends boolean = false>(options: Options<CreateProjectBranchData, ThrowOnError>) => RequestResult<CreateProjectBranchResponses, CreateProjectBranchErrors, ThrowOnError>;
|
|
669
|
+
/**
|
|
670
|
+
* Create anonymized branch
|
|
671
|
+
*
|
|
672
|
+
* Creates a new branch with anonymized data using PostgreSQL Anonymizer for static masking.
|
|
673
|
+
* This allows developers to work with masked production data.
|
|
674
|
+
* Optionally, provide `masking_rules` to set initial masking rules for the branch
|
|
675
|
+
* and `start_anonymization` to automatically start anonymization after creation. This
|
|
676
|
+
* combines functionality of updating masking rules and starting anonymization into the
|
|
677
|
+
* branch creation request.
|
|
678
|
+
*
|
|
679
|
+
* **Note**: This endpoint is currently in Beta.
|
|
680
|
+
*
|
|
681
|
+
*/
|
|
682
|
+
declare const createProjectBranchAnonymized: <ThrowOnError extends boolean = false>(options: Options<CreateProjectBranchAnonymizedData, ThrowOnError>) => RequestResult<CreateProjectBranchAnonymizedResponses, CreateProjectBranchAnonymizedErrors, ThrowOnError>;
|
|
683
|
+
/**
|
|
684
|
+
* Retrieve number of branches
|
|
685
|
+
*
|
|
686
|
+
* Retrieves the total number of branches in the specified project.
|
|
687
|
+
* Supports an optional `search` parameter to count branches matching a name filter.
|
|
688
|
+
*
|
|
689
|
+
*/
|
|
690
|
+
declare const countProjectBranches: <ThrowOnError extends boolean = false>(options: Options<CountProjectBranchesData, ThrowOnError>) => RequestResult<CountProjectBranchesResponses, CountProjectBranchesErrors, ThrowOnError>;
|
|
691
|
+
/**
|
|
692
|
+
* Delete branch
|
|
693
|
+
*
|
|
694
|
+
* Deletes the specified branch from a project and places all compute endpoints into an idle state, breaking existing client connections.
|
|
695
|
+
*
|
|
696
|
+
* The deletion completes after all operations finish.
|
|
697
|
+
* You cannot delete a project's root or default branch, or a branch that has a child branch.
|
|
698
|
+
* A project must have at least one branch.
|
|
699
|
+
*
|
|
700
|
+
* By default, deleted branches can be recovered within a 7-day grace period.
|
|
701
|
+
* Use the `hard_delete` parameter to permanently delete the branch immediately.
|
|
702
|
+
* For related information, see [Manage branches](https://neon.com/docs/manage/branches/).
|
|
703
|
+
*
|
|
704
|
+
*/
|
|
705
|
+
declare const deleteProjectBranch: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectBranchData, ThrowOnError>) => RequestResult<DeleteProjectBranchResponses, DeleteProjectBranchErrors, ThrowOnError>;
|
|
706
|
+
/**
|
|
707
|
+
* Retrieve branch details
|
|
708
|
+
*
|
|
709
|
+
* Retrieves information about the specified branch.
|
|
710
|
+
* A `branch_id` value has a `br-` prefix.
|
|
711
|
+
*
|
|
712
|
+
* Each Neon project is initially created with a root and default branch named `main`.
|
|
713
|
+
* A project can contain one or more branches.
|
|
714
|
+
* A parent branch is identified by a `parent_id` value, which is the `id` of the parent branch.
|
|
715
|
+
* For related information, see [Manage branches](https://neon.com/docs/manage/branches/).
|
|
716
|
+
*
|
|
717
|
+
*/
|
|
718
|
+
declare const getProjectBranch: <ThrowOnError extends boolean = false>(options: Options<GetProjectBranchData, ThrowOnError>) => RequestResult<GetProjectBranchResponses, GetProjectBranchErrors, ThrowOnError>;
|
|
719
|
+
/**
|
|
720
|
+
* Update branch
|
|
721
|
+
*
|
|
722
|
+
* Updates the specified branch.
|
|
723
|
+
* For more information, see [Manage branches](https://neon.com/docs/manage/branches/).
|
|
724
|
+
*
|
|
725
|
+
*/
|
|
726
|
+
declare const updateProjectBranch: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectBranchData, ThrowOnError>) => RequestResult<UpdateProjectBranchResponses, UpdateProjectBranchErrors, ThrowOnError>;
|
|
727
|
+
/**
|
|
728
|
+
* Restore branch to a historical state
|
|
729
|
+
*
|
|
730
|
+
* Restores a branch to an earlier state in its own or another branch's history
|
|
731
|
+
* by specifying an LSN or timestamp.
|
|
732
|
+
* Creates a new branch from the historical state.
|
|
733
|
+
*
|
|
734
|
+
*/
|
|
735
|
+
declare const restoreProjectBranch: <ThrowOnError extends boolean = false>(options: Options<RestoreProjectBranchData, ThrowOnError>) => RequestResult<RestoreProjectBranchResponses, RestoreProjectBranchErrors, ThrowOnError>;
|
|
736
|
+
/**
|
|
737
|
+
* Retrieve database schema
|
|
738
|
+
*
|
|
739
|
+
* Retrieves the schema from the specified database. The `lsn` and `timestamp` values cannot be specified at the same time. If both are omitted, the database schema is retrieved from database's head.
|
|
740
|
+
*/
|
|
741
|
+
declare const getProjectBranchSchema: <ThrowOnError extends boolean = false>(options: Options<GetProjectBranchSchemaData, ThrowOnError>) => RequestResult<GetProjectBranchSchemaResponses, GetProjectBranchSchemaErrors, ThrowOnError>;
|
|
742
|
+
/**
|
|
743
|
+
* Compare database schema
|
|
744
|
+
*
|
|
745
|
+
* Compares the schema from the specified database with another branch's schema.
|
|
746
|
+
*/
|
|
747
|
+
declare const getProjectBranchSchemaComparison: <ThrowOnError extends boolean = false>(options: Options<GetProjectBranchSchemaComparisonData, ThrowOnError>) => RequestResult<GetProjectBranchSchemaComparisonResponses, GetProjectBranchSchemaComparisonErrors, ThrowOnError>;
|
|
748
|
+
/**
|
|
749
|
+
* Retrieve masking rules
|
|
750
|
+
*
|
|
751
|
+
* Retrieves the masking rules for the specified anonymized branch.
|
|
752
|
+
* Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer.
|
|
753
|
+
*
|
|
754
|
+
* **Note**: This endpoint is currently in Beta.
|
|
755
|
+
*
|
|
756
|
+
*/
|
|
757
|
+
declare const getMaskingRules: <ThrowOnError extends boolean = false>(options: Options<GetMaskingRulesData, ThrowOnError>) => RequestResult<GetMaskingRulesResponses, GetMaskingRulesErrors, ThrowOnError>;
|
|
758
|
+
/**
|
|
759
|
+
* Update masking rules
|
|
760
|
+
*
|
|
761
|
+
* Updates the masking rules for the specified anonymized branch.
|
|
762
|
+
* Masking rules define how sensitive data should be anonymized using PostgreSQL Anonymizer.
|
|
763
|
+
*
|
|
764
|
+
* **Note**: This endpoint is currently in Beta.
|
|
765
|
+
*
|
|
766
|
+
*/
|
|
767
|
+
declare const updateMaskingRules: <ThrowOnError extends boolean = false>(options: Options<UpdateMaskingRulesData, ThrowOnError>) => RequestResult<UpdateMaskingRulesResponses, UpdateMaskingRulesErrors, ThrowOnError>;
|
|
768
|
+
/**
|
|
769
|
+
* Retrieve anonymized branch status
|
|
770
|
+
*
|
|
771
|
+
* Retrieves the current status of an anonymized branch, including its state and progress information.
|
|
772
|
+
* This endpoint allows you to monitor the anonymization process from initialization through completion.
|
|
773
|
+
* Only anonymized branches will have status information available.
|
|
774
|
+
*
|
|
775
|
+
* **Note**: This endpoint is currently in Beta.
|
|
776
|
+
*
|
|
777
|
+
*/
|
|
778
|
+
declare const getAnonymizedBranchStatus: <ThrowOnError extends boolean = false>(options: Options<GetAnonymizedBranchStatusData, ThrowOnError>) => RequestResult<GetAnonymizedBranchStatusResponses, GetAnonymizedBranchStatusErrors, ThrowOnError>;
|
|
779
|
+
/**
|
|
780
|
+
* Start anonymization
|
|
781
|
+
*
|
|
782
|
+
* Starts the anonymization process for an anonymized branch that is in the initialized, error, or anonymized state.
|
|
783
|
+
* This will apply all defined masking rules to anonymize sensitive data in the branch databases.
|
|
784
|
+
* The branch must be an anonymized branch to start anonymization.
|
|
785
|
+
*
|
|
786
|
+
* **Note**: This endpoint is currently in Beta.
|
|
787
|
+
*
|
|
788
|
+
*/
|
|
789
|
+
declare const startAnonymization: <ThrowOnError extends boolean = false>(options: Options<StartAnonymizationData, ThrowOnError>) => RequestResult<StartAnonymizationResponses, StartAnonymizationErrors, ThrowOnError>;
|
|
790
|
+
/**
|
|
791
|
+
* Set branch as default
|
|
792
|
+
*
|
|
793
|
+
* Sets the specified branch as the project's default branch.
|
|
794
|
+
* The default designation is automatically removed from the previous default branch.
|
|
795
|
+
* For more information, see [Manage branches](https://neon.com/docs/manage/branches/).
|
|
796
|
+
*
|
|
797
|
+
*/
|
|
798
|
+
declare const setDefaultProjectBranch: <ThrowOnError extends boolean = false>(options: Options<SetDefaultProjectBranchData, ThrowOnError>) => RequestResult<SetDefaultProjectBranchResponses, SetDefaultProjectBranchErrors, ThrowOnError>;
|
|
799
|
+
/**
|
|
800
|
+
* Finalize branch restore from snapshot
|
|
801
|
+
*
|
|
802
|
+
* Finalize the restore operation for a branch created from a snapshot.
|
|
803
|
+
* This operation updates the branch so it functions as the original branch it replaced.
|
|
804
|
+
* This includes:
|
|
805
|
+
* - Reassigning any computes from the original branch to the restored branch (this will restart the computes)
|
|
806
|
+
* - Renaming the restored branch to the original branch's name
|
|
807
|
+
* - Renaming the original branch so it no longer uses the original name
|
|
808
|
+
*
|
|
809
|
+
* This operation only applies to branches created using the `restoreSnapshot` endpoint with `finalize_restore: false`.
|
|
810
|
+
*
|
|
811
|
+
* **Note**: This endpoint is currently in Beta.
|
|
812
|
+
*
|
|
813
|
+
*/
|
|
814
|
+
declare const finalizeRestoreBranch: <ThrowOnError extends boolean = false>(options: Options<FinalizeRestoreBranchData, ThrowOnError>) => RequestResult<FinalizeRestoreBranchResponses, FinalizeRestoreBranchErrors, ThrowOnError>;
|
|
815
|
+
/**
|
|
816
|
+
* List branch endpoints
|
|
817
|
+
*
|
|
818
|
+
* Retrieves a list of compute endpoints for the specified branch.
|
|
819
|
+
* Neon permits only one read-write compute endpoint per branch.
|
|
820
|
+
* A branch can have multiple read-only compute endpoints.
|
|
821
|
+
*
|
|
822
|
+
*/
|
|
823
|
+
declare const listProjectBranchEndpoints: <ThrowOnError extends boolean = false>(options: Options<ListProjectBranchEndpointsData, ThrowOnError>) => RequestResult<ListProjectBranchEndpointsResponses, ListProjectBranchEndpointsErrors, ThrowOnError>;
|
|
824
|
+
/**
|
|
825
|
+
* List databases
|
|
826
|
+
*
|
|
827
|
+
* Retrieves a list of databases for the specified branch.
|
|
828
|
+
* A branch can have multiple databases.
|
|
829
|
+
* For related information, see [Manage databases](https://neon.com/docs/manage/databases/).
|
|
830
|
+
*
|
|
831
|
+
*/
|
|
832
|
+
declare const listProjectBranchDatabases: <ThrowOnError extends boolean = false>(options: Options<ListProjectBranchDatabasesData, ThrowOnError>) => RequestResult<ListProjectBranchDatabasesResponses, ListProjectBranchDatabasesErrors, ThrowOnError>;
|
|
833
|
+
/**
|
|
834
|
+
* Create database
|
|
835
|
+
*
|
|
836
|
+
* Creates a database in the specified branch.
|
|
837
|
+
* A branch can have multiple databases.
|
|
838
|
+
* For related information, see [Manage databases](https://neon.com/docs/manage/databases/).
|
|
839
|
+
*
|
|
840
|
+
*/
|
|
841
|
+
declare const createProjectBranchDatabase: <ThrowOnError extends boolean = false>(options: Options<CreateProjectBranchDatabaseData, ThrowOnError>) => RequestResult<CreateProjectBranchDatabaseResponses, CreateProjectBranchDatabaseErrors, ThrowOnError>;
|
|
842
|
+
/**
|
|
843
|
+
* Delete database
|
|
844
|
+
*
|
|
845
|
+
* Deletes the specified database from the branch.
|
|
846
|
+
* For related information, see [Manage databases](https://neon.com/docs/manage/databases/).
|
|
847
|
+
*
|
|
848
|
+
*/
|
|
849
|
+
declare const deleteProjectBranchDatabase: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectBranchDatabaseData, ThrowOnError>) => RequestResult<DeleteProjectBranchDatabaseResponses, DeleteProjectBranchDatabaseErrors, ThrowOnError>;
|
|
850
|
+
/**
|
|
851
|
+
* Retrieve database details
|
|
852
|
+
*
|
|
853
|
+
* Retrieves information about the specified database.
|
|
854
|
+
* For related information, see [Manage databases](https://neon.com/docs/manage/databases/).
|
|
855
|
+
*
|
|
856
|
+
*/
|
|
857
|
+
declare const getProjectBranchDatabase: <ThrowOnError extends boolean = false>(options: Options<GetProjectBranchDatabaseData, ThrowOnError>) => RequestResult<GetProjectBranchDatabaseResponses, GetProjectBranchDatabaseErrors, ThrowOnError>;
|
|
858
|
+
/**
|
|
859
|
+
* Update database
|
|
860
|
+
*
|
|
861
|
+
* Updates the specified database in the branch.
|
|
862
|
+
* For related information, see [Manage databases](https://neon.com/docs/manage/databases/).
|
|
863
|
+
*
|
|
864
|
+
*/
|
|
865
|
+
declare const updateProjectBranchDatabase: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectBranchDatabaseData, ThrowOnError>) => RequestResult<UpdateProjectBranchDatabaseResponses, UpdateProjectBranchDatabaseErrors, ThrowOnError>;
|
|
866
|
+
/**
|
|
867
|
+
* List roles
|
|
868
|
+
*
|
|
869
|
+
* Retrieves a list of Postgres roles from the specified branch.
|
|
870
|
+
* For related information, see [Manage roles](https://neon.com/docs/manage/roles/).
|
|
871
|
+
*
|
|
872
|
+
*/
|
|
873
|
+
declare const listProjectBranchRoles: <ThrowOnError extends boolean = false>(options: Options<ListProjectBranchRolesData, ThrowOnError>) => RequestResult<ListProjectBranchRolesResponses, ListProjectBranchRolesErrors, ThrowOnError>;
|
|
874
|
+
/**
|
|
875
|
+
* Create role
|
|
876
|
+
*
|
|
877
|
+
* Creates a Postgres role in the specified branch.
|
|
878
|
+
* For related information, see [Manage roles](https://neon.com/docs/manage/roles/).
|
|
879
|
+
*
|
|
880
|
+
* Connections established to the active compute endpoint will be dropped.
|
|
881
|
+
* If the compute endpoint is idle, the endpoint becomes active for a short period of time and is suspended afterward.
|
|
882
|
+
*
|
|
883
|
+
*/
|
|
884
|
+
declare const createProjectBranchRole: <ThrowOnError extends boolean = false>(options: Options<CreateProjectBranchRoleData, ThrowOnError>) => RequestResult<CreateProjectBranchRoleResponses, CreateProjectBranchRoleErrors, ThrowOnError>;
|
|
885
|
+
/**
|
|
886
|
+
* Delete role
|
|
887
|
+
*
|
|
888
|
+
* Deletes the specified Postgres role from the branch.
|
|
889
|
+
* For related information, see [Manage roles](https://neon.com/docs/manage/roles/).
|
|
890
|
+
*
|
|
891
|
+
*/
|
|
892
|
+
declare const deleteProjectBranchRole: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectBranchRoleData, ThrowOnError>) => RequestResult<DeleteProjectBranchRoleResponses, DeleteProjectBranchRoleErrors, ThrowOnError>;
|
|
893
|
+
/**
|
|
894
|
+
* Retrieve role details
|
|
895
|
+
*
|
|
896
|
+
* Retrieves details about the specified role.
|
|
897
|
+
* In Neon, the terms "role" and "user" are synonymous.
|
|
898
|
+
* For related information, see [Manage roles](https://neon.com/docs/manage/roles/).
|
|
899
|
+
*
|
|
900
|
+
*/
|
|
901
|
+
declare const getProjectBranchRole: <ThrowOnError extends boolean = false>(options: Options<GetProjectBranchRoleData, ThrowOnError>) => RequestResult<GetProjectBranchRoleResponses, GetProjectBranchRoleErrors, ThrowOnError>;
|
|
902
|
+
/**
|
|
903
|
+
* Retrieve role password
|
|
904
|
+
*
|
|
905
|
+
* Retrieves the password for the specified Postgres role, if possible.
|
|
906
|
+
* For related information, see [Manage roles](https://neon.com/docs/manage/roles/).
|
|
907
|
+
*
|
|
908
|
+
*/
|
|
909
|
+
declare const getProjectBranchRolePassword: <ThrowOnError extends boolean = false>(options: Options<GetProjectBranchRolePasswordData, ThrowOnError>) => RequestResult<GetProjectBranchRolePasswordResponses, GetProjectBranchRolePasswordErrors, ThrowOnError>;
|
|
910
|
+
/**
|
|
911
|
+
* Reset role password
|
|
912
|
+
*
|
|
913
|
+
* Resets the password for the specified Postgres role.
|
|
914
|
+
* Returns a new password and operations. The new password is ready to use when the last operation finishes.
|
|
915
|
+
* The old password remains valid until last operation finishes.
|
|
916
|
+
* Connections to the compute endpoint are dropped. If idle,
|
|
917
|
+
* the compute endpoint becomes active for a short period of time.
|
|
918
|
+
*
|
|
919
|
+
* For related information, see [Manage roles](https://neon.com/docs/manage/roles/).
|
|
920
|
+
*
|
|
921
|
+
*/
|
|
922
|
+
declare const resetProjectBranchRolePassword: <ThrowOnError extends boolean = false>(options: Options<ResetProjectBranchRolePasswordData, ThrowOnError>) => RequestResult<ResetProjectBranchRolePasswordResponses, ResetProjectBranchRolePasswordErrors, ThrowOnError>;
|
|
923
|
+
/**
|
|
924
|
+
* List VPC endpoint restrictions
|
|
925
|
+
*
|
|
926
|
+
* Lists VPC endpoint restrictions for the specified Neon project.
|
|
927
|
+
*
|
|
928
|
+
*/
|
|
929
|
+
declare const listProjectVpcEndpoints: <ThrowOnError extends boolean = false>(options: Options<ListProjectVpcEndpointsData, ThrowOnError>) => RequestResult<ListProjectVpcEndpointsResponses, ListProjectVpcEndpointsErrors, ThrowOnError>;
|
|
930
|
+
/**
|
|
931
|
+
* Delete VPC endpoint restriction
|
|
932
|
+
*
|
|
933
|
+
* Removes the specified VPC endpoint restriction from a Neon project.
|
|
934
|
+
*
|
|
935
|
+
*/
|
|
936
|
+
declare const deleteProjectVpcEndpoint: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectVpcEndpointData, ThrowOnError>) => RequestResult<DeleteProjectVpcEndpointResponses, DeleteProjectVpcEndpointErrors, ThrowOnError>;
|
|
937
|
+
/**
|
|
938
|
+
* Set VPC endpoint restriction
|
|
939
|
+
*
|
|
940
|
+
* Sets or updates a VPC endpoint restriction for a Neon project.
|
|
941
|
+
* When a VPC endpoint restriction is set, the project only accepts connections
|
|
942
|
+
* from the specified VPC.
|
|
943
|
+
* A VPC endpoint can be set as a restriction only after it is assigned to the
|
|
944
|
+
* parent organization of the Neon project.
|
|
945
|
+
*
|
|
946
|
+
*/
|
|
947
|
+
declare const assignProjectVpcEndpoint: <ThrowOnError extends boolean = false>(options: Options<AssignProjectVpcEndpointData, ThrowOnError>) => RequestResult<AssignProjectVpcEndpointResponses, AssignProjectVpcEndpointErrors, ThrowOnError>;
|
|
948
|
+
/**
|
|
949
|
+
* List compute endpoints
|
|
950
|
+
*
|
|
951
|
+
* Retrieves a list of compute endpoints for the specified project.
|
|
952
|
+
* A compute endpoint is a Neon compute instance.
|
|
953
|
+
* For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/).
|
|
954
|
+
*
|
|
955
|
+
*/
|
|
956
|
+
declare const listProjectEndpoints: <ThrowOnError extends boolean = false>(options: Options<ListProjectEndpointsData, ThrowOnError>) => RequestResult<ListProjectEndpointsResponses, ListProjectEndpointsErrors, ThrowOnError>;
|
|
957
|
+
/**
|
|
958
|
+
* Create compute endpoint
|
|
959
|
+
*
|
|
960
|
+
* Creates a compute endpoint for the specified branch.
|
|
961
|
+
* A compute endpoint is a Neon compute instance.
|
|
962
|
+
* There is a maximum of one read-write compute endpoint per branch.
|
|
963
|
+
* If the specified branch already has a read-write compute endpoint, the operation fails.
|
|
964
|
+
* A branch can have multiple read-only compute endpoints.
|
|
965
|
+
*
|
|
966
|
+
* For more information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/).
|
|
967
|
+
*
|
|
968
|
+
*/
|
|
969
|
+
declare const createProjectEndpoint: <ThrowOnError extends boolean = false>(options: Options<CreateProjectEndpointData, ThrowOnError>) => RequestResult<CreateProjectEndpointResponses, CreateProjectEndpointErrors, ThrowOnError>;
|
|
970
|
+
/**
|
|
971
|
+
* Delete compute endpoint
|
|
972
|
+
*
|
|
973
|
+
* Deletes the specified compute endpoint.
|
|
974
|
+
* A compute endpoint is a Neon compute instance.
|
|
975
|
+
* Deleting a compute endpoint drops existing network connections to the compute endpoint.
|
|
976
|
+
* The deletion is completed when the last operation in the chain finishes successfully.
|
|
977
|
+
*
|
|
978
|
+
* An `endpoint_id` has an `ep-` prefix.
|
|
979
|
+
* For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/).
|
|
980
|
+
*
|
|
981
|
+
*/
|
|
982
|
+
declare const deleteProjectEndpoint: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectEndpointData, ThrowOnError>) => RequestResult<DeleteProjectEndpointResponses, DeleteProjectEndpointErrors, ThrowOnError>;
|
|
983
|
+
/**
|
|
984
|
+
* Retrieve compute endpoint details
|
|
985
|
+
*
|
|
986
|
+
* Retrieves information about the specified compute endpoint.
|
|
987
|
+
* A compute endpoint is a Neon compute instance.
|
|
988
|
+
* An `endpoint_id` has an `ep-` prefix.
|
|
989
|
+
* For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/).
|
|
990
|
+
*
|
|
991
|
+
*/
|
|
992
|
+
declare const getProjectEndpoint: <ThrowOnError extends boolean = false>(options: Options<GetProjectEndpointData, ThrowOnError>) => RequestResult<GetProjectEndpointResponses, GetProjectEndpointErrors, ThrowOnError>;
|
|
993
|
+
/**
|
|
994
|
+
* Update compute endpoint
|
|
995
|
+
*
|
|
996
|
+
* Updates the specified compute endpoint.
|
|
997
|
+
*
|
|
998
|
+
* An `endpoint_id` has an `ep-` prefix. A `branch_id` has a `br-` prefix.
|
|
999
|
+
* For more information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/).
|
|
1000
|
+
*
|
|
1001
|
+
* If the returned list of operations is not empty, the compute endpoint is not ready to use.
|
|
1002
|
+
* The client must wait for the last operation to finish before using the compute endpoint.
|
|
1003
|
+
* If the compute endpoint was idle before the update, it becomes active for a short period of time,
|
|
1004
|
+
* and the control plane suspends it again after the update.
|
|
1005
|
+
*
|
|
1006
|
+
*/
|
|
1007
|
+
declare const updateProjectEndpoint: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectEndpointData, ThrowOnError>) => RequestResult<UpdateProjectEndpointResponses, UpdateProjectEndpointErrors, ThrowOnError>;
|
|
1008
|
+
/**
|
|
1009
|
+
* Start compute endpoint
|
|
1010
|
+
*
|
|
1011
|
+
* Starts a compute endpoint.
|
|
1012
|
+
* The compute endpoint is ready to use after the last operation in the chain finishes successfully.
|
|
1013
|
+
*
|
|
1014
|
+
* An `endpoint_id` has an `ep-` prefix.
|
|
1015
|
+
* For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/).
|
|
1016
|
+
*
|
|
1017
|
+
*/
|
|
1018
|
+
declare const startProjectEndpoint: <ThrowOnError extends boolean = false>(options: Options<StartProjectEndpointData, ThrowOnError>) => RequestResult<StartProjectEndpointResponses, StartProjectEndpointErrors, ThrowOnError>;
|
|
1019
|
+
/**
|
|
1020
|
+
* Suspend compute endpoint
|
|
1021
|
+
*
|
|
1022
|
+
* Suspends the specified compute endpoint.
|
|
1023
|
+
* An `endpoint_id` has an `ep-` prefix.
|
|
1024
|
+
* For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/).
|
|
1025
|
+
*
|
|
1026
|
+
*/
|
|
1027
|
+
declare const suspendProjectEndpoint: <ThrowOnError extends boolean = false>(options: Options<SuspendProjectEndpointData, ThrowOnError>) => RequestResult<SuspendProjectEndpointResponses, SuspendProjectEndpointErrors, ThrowOnError>;
|
|
1028
|
+
/**
|
|
1029
|
+
* Restart compute endpoint
|
|
1030
|
+
*
|
|
1031
|
+
* Restarts the specified compute endpoint by immediately suspending it and then starting it again.
|
|
1032
|
+
* An `endpoint_id` has an `ep-` prefix.
|
|
1033
|
+
* For information about compute endpoints, see [Manage computes](https://neon.com/docs/manage/endpoints/).
|
|
1034
|
+
*
|
|
1035
|
+
*/
|
|
1036
|
+
declare const restartProjectEndpoint: <ThrowOnError extends boolean = false>(options: Options<RestartProjectEndpointData, ThrowOnError>) => RequestResult<RestartProjectEndpointResponses, RestartProjectEndpointErrors, ThrowOnError>;
|
|
1037
|
+
/**
|
|
1038
|
+
* Retrieve project consumption metrics (legacy plans)
|
|
1039
|
+
*
|
|
1040
|
+
* Retrieves consumption metrics for Scale, Business, and Enterprise plan projects. History begins at the time of upgrade.
|
|
1041
|
+
* Results are ordered by time in ascending order (oldest to newest).
|
|
1042
|
+
* Issuing a call to this API does not wake a project's compute endpoint.
|
|
1043
|
+
*
|
|
1044
|
+
*/
|
|
1045
|
+
declare const getConsumptionHistoryPerProject: <ThrowOnError extends boolean = false>(options: Options<GetConsumptionHistoryPerProjectData, ThrowOnError>) => RequestResult<GetConsumptionHistoryPerProjectResponses, GetConsumptionHistoryPerProjectErrors, ThrowOnError>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Retrieve project consumption metrics
|
|
1048
|
+
*
|
|
1049
|
+
* Returns consumption metrics for up to `limit` projects per page. If `project_ids` is omitted,
|
|
1050
|
+
* projects in the organization are included across pages (use `cursor`). If `project_ids` is
|
|
1051
|
+
* provided, the response is limited to those projects (up to 100). Available for accounts on
|
|
1052
|
+
* Launch, Scale, Agent, Business, and Enterprise plans.
|
|
1053
|
+
*
|
|
1054
|
+
* History starts when the account upgrades to an eligible plan.
|
|
1055
|
+
*
|
|
1056
|
+
* The `metrics` query parameter is required. Supported values:
|
|
1057
|
+
* `compute_unit_seconds`, `root_branch_bytes_month`, `child_branch_bytes_month`,
|
|
1058
|
+
* `instant_restore_bytes_month`, `public_network_transfer_bytes`, `private_network_transfer_bytes`,
|
|
1059
|
+
* `extra_branches_month`, `snapshot_storage_bytes_month`.
|
|
1060
|
+
*
|
|
1061
|
+
* Consumption metrics within each project are returned in ascending time order (oldest first).
|
|
1062
|
+
* This request does not wake project computes.
|
|
1063
|
+
*
|
|
1064
|
+
*/
|
|
1065
|
+
declare const getConsumptionHistoryPerProjectV2: <ThrowOnError extends boolean = false>(options: Options<GetConsumptionHistoryPerProjectV2Data, ThrowOnError>) => RequestResult<GetConsumptionHistoryPerProjectV2Responses, GetConsumptionHistoryPerProjectV2Errors, ThrowOnError>;
|
|
1066
|
+
/**
|
|
1067
|
+
* Retrieve branch consumption metrics
|
|
1068
|
+
*
|
|
1069
|
+
* Returns consumption metrics for each branch across one or more projects listed in
|
|
1070
|
+
* `project_ids` (1 to 100 projects). Available for accounts on paid usage-based Launch, Scale,
|
|
1071
|
+
* Agent, and Enterprise plans.
|
|
1072
|
+
*
|
|
1073
|
+
* History starts when the account first ingests branch-level consumption data.
|
|
1074
|
+
*
|
|
1075
|
+
* The `metrics` query parameter is required. Only these six values are supported on this
|
|
1076
|
+
* endpoint:
|
|
1077
|
+
* `compute_unit_seconds`, `root_branch_bytes_month`, `child_branch_bytes_month`,
|
|
1078
|
+
* `instant_restore_bytes_month`, `public_network_transfer_bytes`, `private_network_transfer_bytes`.
|
|
1079
|
+
*
|
|
1080
|
+
* This endpoint does not support `extra_branches_month` or `snapshot_storage_bytes_month`.
|
|
1081
|
+
* Use `GET /consumption_history/v2/projects` for those.
|
|
1082
|
+
*
|
|
1083
|
+
* Consumption metrics within each branch are returned in ascending time order (oldest first).
|
|
1084
|
+
* This request does not wake project computes.
|
|
1085
|
+
*
|
|
1086
|
+
*/
|
|
1087
|
+
declare const getConsumptionHistoryPerBranchV2: <ThrowOnError extends boolean = false>(options: Options<GetConsumptionHistoryPerBranchV2Data, ThrowOnError>) => RequestResult<GetConsumptionHistoryPerBranchV2Responses, GetConsumptionHistoryPerBranchV2Errors, ThrowOnError>;
|
|
1088
|
+
/**
|
|
1089
|
+
* Retrieve organization details
|
|
1090
|
+
*
|
|
1091
|
+
* Retrieves details for the specified organization, including its name, plan, and configuration.
|
|
1092
|
+
*
|
|
1093
|
+
*/
|
|
1094
|
+
declare const getOrganization: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationData, ThrowOnError>) => RequestResult<GetOrganizationResponses, GetOrganizationErrors, ThrowOnError>;
|
|
1095
|
+
/**
|
|
1096
|
+
* List organization API keys
|
|
1097
|
+
*
|
|
1098
|
+
* Retrieves the API keys for the specified organization.
|
|
1099
|
+
* The response does not include API key tokens. A token is only provided when creating an API key.
|
|
1100
|
+
* API keys can also be managed in the Neon Console.
|
|
1101
|
+
* For more information, see [Manage API keys](https://neon.com/docs/manage/api-keys/).
|
|
1102
|
+
*
|
|
1103
|
+
*/
|
|
1104
|
+
declare const listOrgApiKeys: <ThrowOnError extends boolean = false>(options: Options<ListOrgApiKeysData, ThrowOnError>) => RequestResult<ListOrgApiKeysResponses, ListOrgApiKeysErrors, ThrowOnError>;
|
|
1105
|
+
/**
|
|
1106
|
+
* Create organization API key
|
|
1107
|
+
*
|
|
1108
|
+
* Creates an API key for the specified organization.
|
|
1109
|
+
* The `key_name` is a user-specified name for the key.
|
|
1110
|
+
* Returns an `id` and `key`; the `key` is a randomly generated, 64-bit token required to access the Neon API.
|
|
1111
|
+
* Store the key securely — it is only returned once.
|
|
1112
|
+
* API keys can also be managed in the Neon Console.
|
|
1113
|
+
* See [Manage API keys](https://neon.com/docs/manage/api-keys/).
|
|
1114
|
+
*
|
|
1115
|
+
*/
|
|
1116
|
+
declare const createOrgApiKey: <ThrowOnError extends boolean = false>(options: Options<CreateOrgApiKeyData, ThrowOnError>) => RequestResult<CreateOrgApiKeyResponses, CreateOrgApiKeyErrors, ThrowOnError>;
|
|
1117
|
+
/**
|
|
1118
|
+
* Revoke organization API key
|
|
1119
|
+
*
|
|
1120
|
+
* Revokes the specified organization API key.
|
|
1121
|
+
* An API key that is no longer needed can be revoked.
|
|
1122
|
+
* This action cannot be reversed.
|
|
1123
|
+
* API keys can also be managed in the Neon Console.
|
|
1124
|
+
* See [Manage API keys](https://neon.com/docs/manage/api-keys/).
|
|
1125
|
+
*
|
|
1126
|
+
*/
|
|
1127
|
+
declare const revokeOrgApiKey: <ThrowOnError extends boolean = false>(options: Options<RevokeOrgApiKeyData, ThrowOnError>) => RequestResult<RevokeOrgApiKeyResponses, RevokeOrgApiKeyErrors, ThrowOnError>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Remove organization spending limit
|
|
1130
|
+
*
|
|
1131
|
+
* Removes the configured monthly spending limit for the specified organization.
|
|
1132
|
+
* Idempotent — removing an already-unset limit still succeeds.
|
|
1133
|
+
* Available to organization admins on Launch and Scale plans only.
|
|
1134
|
+
*
|
|
1135
|
+
*/
|
|
1136
|
+
declare const deleteOrganizationSpendingLimit: <ThrowOnError extends boolean = false>(options: Options<DeleteOrganizationSpendingLimitData, ThrowOnError>) => RequestResult<DeleteOrganizationSpendingLimitResponses, DeleteOrganizationSpendingLimitErrors, ThrowOnError>;
|
|
1137
|
+
/**
|
|
1138
|
+
* Retrieve organization spending limit
|
|
1139
|
+
*
|
|
1140
|
+
* Returns the configured monthly spending limit for the specified organization.
|
|
1141
|
+
* `spending_limit_cents: null` indicates that no limit is currently set.
|
|
1142
|
+
* Available to organization members with read access on Launch and Scale plans only.
|
|
1143
|
+
*
|
|
1144
|
+
*/
|
|
1145
|
+
declare const getOrganizationSpendingLimit: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationSpendingLimitData, ThrowOnError>) => RequestResult<GetOrganizationSpendingLimitResponses, GetOrganizationSpendingLimitErrors, ThrowOnError>;
|
|
1146
|
+
/**
|
|
1147
|
+
* Set organization spending limit
|
|
1148
|
+
*
|
|
1149
|
+
* Sets the monthly spending limit for the specified organization.
|
|
1150
|
+
* To remove a previously configured limit, send a DELETE request to this endpoint.
|
|
1151
|
+
* When a limit is configured, email notifications are sent at 80% and 100% of the limit.
|
|
1152
|
+
* Computes are not suspended when the limit is reached.
|
|
1153
|
+
* Available to organization admins on Launch and Scale plans only.
|
|
1154
|
+
*
|
|
1155
|
+
*/
|
|
1156
|
+
declare const setOrganizationSpendingLimit: <ThrowOnError extends boolean = false>(options: Options<SetOrganizationSpendingLimitData, ThrowOnError>) => RequestResult<SetOrganizationSpendingLimitResponses, SetOrganizationSpendingLimitErrors, ThrowOnError>;
|
|
1157
|
+
/**
|
|
1158
|
+
* List organization members
|
|
1159
|
+
*
|
|
1160
|
+
* Retrieves a paginated list of members for the specified organization.
|
|
1161
|
+
*
|
|
1162
|
+
*/
|
|
1163
|
+
declare const getOrganizationMembers: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationMembersData, ThrowOnError>) => RequestResult<GetOrganizationMembersResponses, GetOrganizationMembersErrors, ThrowOnError>;
|
|
1164
|
+
/**
|
|
1165
|
+
* Remove organization member
|
|
1166
|
+
*
|
|
1167
|
+
* Removes the specified member from the organization.
|
|
1168
|
+
* Only organization admins can perform this action.
|
|
1169
|
+
* The last admin in an organization cannot be removed.
|
|
1170
|
+
*
|
|
1171
|
+
*/
|
|
1172
|
+
declare const removeOrganizationMember: <ThrowOnError extends boolean = false>(options: Options<RemoveOrganizationMemberData, ThrowOnError>) => RequestResult<RemoveOrganizationMemberResponses, RemoveOrganizationMemberErrors, ThrowOnError>;
|
|
1173
|
+
/**
|
|
1174
|
+
* Retrieve organization member details
|
|
1175
|
+
*
|
|
1176
|
+
* Retrieves information about the specified organization member.
|
|
1177
|
+
*
|
|
1178
|
+
*/
|
|
1179
|
+
declare const getOrganizationMember: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationMemberData, ThrowOnError>) => RequestResult<GetOrganizationMemberResponses, GetOrganizationMemberErrors, ThrowOnError>;
|
|
1180
|
+
/**
|
|
1181
|
+
* Update role for organization member
|
|
1182
|
+
*
|
|
1183
|
+
* Updates the role of an existing member in the specified organization.
|
|
1184
|
+
* The requested role must be valid for the organization.
|
|
1185
|
+
* Only organization admins can call this endpoint.
|
|
1186
|
+
*
|
|
1187
|
+
*/
|
|
1188
|
+
declare const updateOrganizationMember: <ThrowOnError extends boolean = false>(options: Options<UpdateOrganizationMemberData, ThrowOnError>) => RequestResult<UpdateOrganizationMemberResponses, UpdateOrganizationMemberErrors, ThrowOnError>;
|
|
1189
|
+
/**
|
|
1190
|
+
* List organization invitations
|
|
1191
|
+
*
|
|
1192
|
+
* Retrieves pending and accepted invitations for the specified organization.
|
|
1193
|
+
*
|
|
1194
|
+
*/
|
|
1195
|
+
declare const getOrganizationInvitations: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationInvitationsData, ThrowOnError>) => RequestResult<GetOrganizationInvitationsResponses, GetOrganizationInvitationsErrors, ThrowOnError>;
|
|
1196
|
+
/**
|
|
1197
|
+
* Create organization invitations
|
|
1198
|
+
*
|
|
1199
|
+
* Creates invitations for a specific organization.
|
|
1200
|
+
* If the invited user has an existing account, they automatically join as a member.
|
|
1201
|
+
* If they don't yet have an account, they are invited to create one, after which they become a member.
|
|
1202
|
+
* Each invited user receives an email notification.
|
|
1203
|
+
*
|
|
1204
|
+
*/
|
|
1205
|
+
declare const createOrganizationInvitations: <ThrowOnError extends boolean = false>(options: Options<CreateOrganizationInvitationsData, ThrowOnError>) => RequestResult<CreateOrganizationInvitationsResponses, CreateOrganizationInvitationsErrors, ThrowOnError>;
|
|
1206
|
+
/**
|
|
1207
|
+
* Transfer projects between organizations
|
|
1208
|
+
*
|
|
1209
|
+
* Transfers selected projects, identified by their IDs, from your organization to another specified organization.
|
|
1210
|
+
*
|
|
1211
|
+
*/
|
|
1212
|
+
declare const transferProjectsFromOrgToOrg: <ThrowOnError extends boolean = false>(options: Options<TransferProjectsFromOrgToOrgData, ThrowOnError>) => RequestResult<TransferProjectsFromOrgToOrgResponses, TransferProjectsFromOrgToOrgErrors, ThrowOnError>;
|
|
1213
|
+
/**
|
|
1214
|
+
* List VPC endpoints across all regions
|
|
1215
|
+
*
|
|
1216
|
+
* Retrieves the list of VPC endpoints for the specified Neon organization across all regions.
|
|
1217
|
+
*
|
|
1218
|
+
*/
|
|
1219
|
+
declare const listOrganizationVpcEndpointsAllRegions: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationVpcEndpointsAllRegionsData, ThrowOnError>) => RequestResult<ListOrganizationVpcEndpointsAllRegionsResponses, ListOrganizationVpcEndpointsAllRegionsErrors, ThrowOnError>;
|
|
1220
|
+
/**
|
|
1221
|
+
* List VPC endpoints
|
|
1222
|
+
*
|
|
1223
|
+
* Retrieves the list of VPC endpoints for the specified Neon organization.
|
|
1224
|
+
*
|
|
1225
|
+
*/
|
|
1226
|
+
declare const listOrganizationVpcEndpoints: <ThrowOnError extends boolean = false>(options: Options<ListOrganizationVpcEndpointsData, ThrowOnError>) => RequestResult<ListOrganizationVpcEndpointsResponses, ListOrganizationVpcEndpointsErrors, ThrowOnError>;
|
|
1227
|
+
/**
|
|
1228
|
+
* Delete VPC endpoint
|
|
1229
|
+
*
|
|
1230
|
+
* Deletes the VPC endpoint from the specified Neon organization.
|
|
1231
|
+
* If you delete a VPC endpoint from a Neon organization, that VPC endpoint cannot
|
|
1232
|
+
* be added back to the Neon organization.
|
|
1233
|
+
*
|
|
1234
|
+
*/
|
|
1235
|
+
declare const deleteOrganizationVpcEndpoint: <ThrowOnError extends boolean = false>(options: Options<DeleteOrganizationVpcEndpointData, ThrowOnError>) => RequestResult<DeleteOrganizationVpcEndpointResponses, DeleteOrganizationVpcEndpointErrors, ThrowOnError>;
|
|
1236
|
+
/**
|
|
1237
|
+
* Retrieve VPC endpoint details
|
|
1238
|
+
*
|
|
1239
|
+
* Retrieves the current state and configuration details of a specified VPC endpoint.
|
|
1240
|
+
*
|
|
1241
|
+
*/
|
|
1242
|
+
declare const getOrganizationVpcEndpointDetails: <ThrowOnError extends boolean = false>(options: Options<GetOrganizationVpcEndpointDetailsData, ThrowOnError>) => RequestResult<GetOrganizationVpcEndpointDetailsResponses, GetOrganizationVpcEndpointDetailsErrors, ThrowOnError>;
|
|
1243
|
+
/**
|
|
1244
|
+
* Assign or update VPC endpoint
|
|
1245
|
+
*
|
|
1246
|
+
* Assigns a VPC endpoint to a Neon organization or updates its existing assignment.
|
|
1247
|
+
*
|
|
1248
|
+
*/
|
|
1249
|
+
declare const assignOrganizationVpcEndpoint: <ThrowOnError extends boolean = false>(options: Options<AssignOrganizationVpcEndpointData, ThrowOnError>) => RequestResult<AssignOrganizationVpcEndpointResponses, AssignOrganizationVpcEndpointErrors, ThrowOnError>;
|
|
1250
|
+
/**
|
|
1251
|
+
* List supported regions
|
|
1252
|
+
*
|
|
1253
|
+
* Lists supported Neon regions.
|
|
1254
|
+
*
|
|
1255
|
+
* **Note:** Not all regions are available to all organizations. Pass the `org_id`
|
|
1256
|
+
* parameter to get an accurate list of regions available to your organization.
|
|
1257
|
+
*
|
|
1258
|
+
*/
|
|
1259
|
+
declare const getActiveRegions: <ThrowOnError extends boolean = false>(options?: Options<GetActiveRegionsData, ThrowOnError>) => RequestResult<GetActiveRegionsResponses, GetActiveRegionsErrors, ThrowOnError>;
|
|
1260
|
+
/**
|
|
1261
|
+
* Retrieve current user details
|
|
1262
|
+
*
|
|
1263
|
+
* Retrieves information about the currently authenticated Neon user,
|
|
1264
|
+
* including account identifiers, plan details, and linked auth accounts.
|
|
1265
|
+
*
|
|
1266
|
+
*/
|
|
1267
|
+
declare const getCurrentUserInfo: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserInfoData, ThrowOnError>) => RequestResult<GetCurrentUserInfoResponses, GetCurrentUserInfoErrors, ThrowOnError>;
|
|
1268
|
+
/**
|
|
1269
|
+
* List organizations for the current user
|
|
1270
|
+
*
|
|
1271
|
+
* Retrieves the organizations that the currently authenticated user belongs to.
|
|
1272
|
+
*
|
|
1273
|
+
*/
|
|
1274
|
+
declare const getCurrentUserOrganizations: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentUserOrganizationsData, ThrowOnError>) => RequestResult<GetCurrentUserOrganizationsResponses, GetCurrentUserOrganizationsErrors, ThrowOnError>;
|
|
1275
|
+
/**
|
|
1276
|
+
* Transfer projects from personal account to organization
|
|
1277
|
+
*
|
|
1278
|
+
* DEPRECATED. Personal accounts have been migrated to organizations, making this operation no longer applicable.
|
|
1279
|
+
*
|
|
1280
|
+
*
|
|
1281
|
+
* @deprecated
|
|
1282
|
+
*/
|
|
1283
|
+
declare const transferProjectsFromUserToOrg: <ThrowOnError extends boolean = false>(options: Options<TransferProjectsFromUserToOrgData, ThrowOnError>) => RequestResult<TransferProjectsFromUserToOrgResponses, TransferProjectsFromUserToOrgErrors, ThrowOnError>;
|
|
1284
|
+
/**
|
|
1285
|
+
* Retrieve request authentication details
|
|
1286
|
+
*
|
|
1287
|
+
* Returns authentication details for the credentials used in the request,
|
|
1288
|
+
* including the credential type (API key, Bearer token, or OAuth session)
|
|
1289
|
+
* and the associated identity.
|
|
1290
|
+
*
|
|
1291
|
+
*/
|
|
1292
|
+
declare const getAuthDetails: <ThrowOnError extends boolean = false>(options?: Options<GetAuthDetailsData, ThrowOnError>) => RequestResult<GetAuthDetailsResponses, GetAuthDetailsErrors, ThrowOnError>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Create snapshot
|
|
1295
|
+
*
|
|
1296
|
+
* Creates a snapshot from the specified branch.
|
|
1297
|
+
* This operation may initiate an asynchronous process.
|
|
1298
|
+
*
|
|
1299
|
+
* **Note**: This endpoint is currently in Beta.
|
|
1300
|
+
*
|
|
1301
|
+
*/
|
|
1302
|
+
declare const createSnapshot: <ThrowOnError extends boolean = false>(options: Options<CreateSnapshotData, ThrowOnError>) => RequestResult<CreateSnapshotResponses, CreateSnapshotErrors, ThrowOnError>;
|
|
1303
|
+
/**
|
|
1304
|
+
* List project snapshots
|
|
1305
|
+
*
|
|
1306
|
+
* Lists the snapshots for the specified project.
|
|
1307
|
+
* Each snapshot represents a point-in-time backup of the project data.
|
|
1308
|
+
*
|
|
1309
|
+
* **Note**: This endpoint is currently in Beta.
|
|
1310
|
+
*
|
|
1311
|
+
*/
|
|
1312
|
+
declare const listSnapshots: <ThrowOnError extends boolean = false>(options: Options<ListSnapshotsData, ThrowOnError>) => RequestResult<ListSnapshotsResponses, ListSnapshotsErrors, ThrowOnError>;
|
|
1313
|
+
/**
|
|
1314
|
+
* Delete snapshot
|
|
1315
|
+
*
|
|
1316
|
+
* Deletes the specified snapshot.
|
|
1317
|
+
*
|
|
1318
|
+
* **Note**: This endpoint is currently in Beta.
|
|
1319
|
+
*
|
|
1320
|
+
*/
|
|
1321
|
+
declare const deleteSnapshot: <ThrowOnError extends boolean = false>(options: Options<DeleteSnapshotData, ThrowOnError>) => RequestResult<DeleteSnapshotResponses, DeleteSnapshotErrors, ThrowOnError>;
|
|
1322
|
+
/**
|
|
1323
|
+
* Update snapshot
|
|
1324
|
+
*
|
|
1325
|
+
* Updates the specified snapshot.
|
|
1326
|
+
*
|
|
1327
|
+
* **Note**: This endpoint is currently in Beta.
|
|
1328
|
+
*
|
|
1329
|
+
*/
|
|
1330
|
+
declare const updateSnapshot: <ThrowOnError extends boolean = false>(options: Options<UpdateSnapshotData, ThrowOnError>) => RequestResult<UpdateSnapshotResponses, UpdateSnapshotErrors, ThrowOnError>;
|
|
1331
|
+
/**
|
|
1332
|
+
* Restore snapshot
|
|
1333
|
+
*
|
|
1334
|
+
* Restores the specified snapshot to a new branch,
|
|
1335
|
+
* and optionally finalizes the restore operation to replace the original branch.
|
|
1336
|
+
*
|
|
1337
|
+
* **Note**: This endpoint is currently in Beta.
|
|
1338
|
+
*
|
|
1339
|
+
*/
|
|
1340
|
+
declare const restoreSnapshot: <ThrowOnError extends boolean = false>(options: Options<RestoreSnapshotData, ThrowOnError>) => RequestResult<RestoreSnapshotResponses, RestoreSnapshotErrors, ThrowOnError>;
|
|
1341
|
+
/**
|
|
1342
|
+
* Retrieve backup schedule
|
|
1343
|
+
*
|
|
1344
|
+
* Returns the backup schedule for the specified branch, including the configured snapshot frequencies.
|
|
1345
|
+
*
|
|
1346
|
+
* **Note**: This endpoint is currently in Beta.
|
|
1347
|
+
*
|
|
1348
|
+
*/
|
|
1349
|
+
declare const getSnapshotSchedule: <ThrowOnError extends boolean = false>(options: Options<GetSnapshotScheduleData, ThrowOnError>) => RequestResult<GetSnapshotScheduleResponses, GetSnapshotScheduleErrors, ThrowOnError>;
|
|
1350
|
+
/**
|
|
1351
|
+
* Update backup schedule
|
|
1352
|
+
*
|
|
1353
|
+
* Updates the backup schedule for the specified branch.
|
|
1354
|
+
* The schedule defines how often automatic snapshots are created (e.g., `hourly`, `daily`).
|
|
1355
|
+
*
|
|
1356
|
+
* **Note**: This endpoint is currently in Beta.
|
|
1357
|
+
*
|
|
1358
|
+
*/
|
|
1359
|
+
declare const setSnapshotSchedule: <ThrowOnError extends boolean = false>(options: Options<SetSnapshotScheduleData, ThrowOnError>) => RequestResult<SetSnapshotScheduleResponses, SetSnapshotScheduleErrors, ThrowOnError>;
|
|
1360
|
+
//#endregion
|
|
1361
|
+
export { Options, acceptProjectTransferRequest, addBranchNeonAuthOauthProvider, addBranchNeonAuthTrustedDomain, addNeonAuthDomainToRedirectUriWhitelist, addNeonAuthOauthProvider, addProjectJwks, assignOrganizationVpcEndpoint, assignProjectVpcEndpoint, countProjectBranches, createApiKey, createBranchNeonAuthNewUser, createNeonAuth, createNeonAuthIntegration, createNeonAuthNewUser, createNeonAuthProviderSdkKeys, createOrgApiKey, createOrganizationInvitations, createProject, createProjectBranch, createProjectBranchAnonymized, createProjectBranchDataApi, createProjectBranchDatabase, createProjectBranchRole, createProjectEndpoint, createProjectTransferRequest, createSnapshot, deleteBranchNeonAuthOauthProvider, deleteBranchNeonAuthTrustedDomain, deleteBranchNeonAuthUser, deleteNeonAuthDomainFromRedirectUriWhitelist, deleteNeonAuthIntegration, deleteNeonAuthOauthProvider, deleteNeonAuthUser, deleteOrganizationSpendingLimit, deleteOrganizationVpcEndpoint, deleteProject, deleteProjectBranch, deleteProjectBranchDataApi, deleteProjectBranchDatabase, deleteProjectBranchRole, deleteProjectEndpoint, deleteProjectJwks, deleteProjectVpcEndpoint, deleteSnapshot, disableNeonAuth, finalizeRestoreBranch, getActiveRegions, getAnonymizedBranchStatus, getAuthDetails, getAvailablePreloadLibraries, getConnectionUri, getConsumptionHistoryPerBranchV2, getConsumptionHistoryPerProject, getConsumptionHistoryPerProjectV2, getCurrentUserInfo, getCurrentUserOrganizations, getMaskingRules, getNeonAuth, getNeonAuthAllowLocalhost, getNeonAuthEmailAndPasswordConfig, getNeonAuthEmailProvider, getNeonAuthEmailServer, getNeonAuthPhoneNumberPlugin, getNeonAuthPluginConfigs, getNeonAuthWebhookConfig, getOrganization, getOrganizationInvitations, getOrganizationMember, getOrganizationMembers, getOrganizationSpendingLimit, getOrganizationVpcEndpointDetails, getProject, getProjectAdvisorSecurityIssues, getProjectBranch, getProjectBranchDataApi, getProjectBranchDatabase, getProjectBranchRole, getProjectBranchRolePassword, getProjectBranchSchema, getProjectBranchSchemaComparison, getProjectEndpoint, getProjectJwks, getProjectOperation, getSnapshotSchedule, grantPermissionToProject, listApiKeys, listBranchNeonAuthOauthProviders, listBranchNeonAuthTrustedDomains, listNeonAuthIntegrations, listNeonAuthOauthProviders, listNeonAuthRedirectUriWhitelistDomains, listOrgApiKeys, listOrganizationVpcEndpoints, listOrganizationVpcEndpointsAllRegions, listProjectBranchDatabases, listProjectBranchEndpoints, listProjectBranchRoles, listProjectBranches, listProjectEndpoints, listProjectOperations, listProjectPermissions, listProjectVpcEndpoints, listProjects, listSharedProjects, listSnapshots, recoverProject, removeOrganizationMember, resetProjectBranchRolePassword, restartProjectEndpoint, restoreProjectBranch, restoreSnapshot, revokeApiKey, revokeOrgApiKey, revokePermissionFromProject, sendNeonAuthTestEmail, setDefaultProjectBranch, setOrganizationSpendingLimit, setSnapshotSchedule, startAnonymization, startProjectEndpoint, suspendProjectEndpoint, transferNeonAuthProviderProject, transferProjectsFromOrgToOrg, transferProjectsFromUserToOrg, updateBranchNeonAuthOauthProvider, updateMaskingRules, updateNeonAuthAllowLocalhost, updateNeonAuthConfig, updateNeonAuthEmailAndPasswordConfig, updateNeonAuthEmailProvider, updateNeonAuthEmailServer, updateNeonAuthMagicLinkPlugin, updateNeonAuthOauthProvider, updateNeonAuthOrganizationPlugin, updateNeonAuthPhoneNumberPlugin, updateNeonAuthUserRole, updateNeonAuthWebhookConfig, updateOrganizationMember, updateProject, updateProjectBranch, updateProjectBranchDataApi, updateProjectBranchDatabase, updateProjectEndpoint, updateSnapshot };
|
|
1362
|
+
//# sourceMappingURL=sdk.gen.d.ts.map
|