shoal-web-sdk 1.0.46 → 1.0.48
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/dist/sdk/@tanstack/react-query.gen.d.ts +29 -1
- package/dist/sdk/@tanstack/react-query.gen.js +19 -1
- package/dist/sdk/sdk.gen.d.ts +5 -1
- package/dist/sdk/sdk.gen.js +15 -0
- package/dist/sdk/types.gen.d.ts +85 -1
- package/dist/sdk/zod.gen.d.ts +31 -1
- package/dist/sdk/zod.gen.js +27 -1
- package/dist/tanstack-codegen/generated/generated.d.ts +4 -1
- package/dist/tanstack-codegen/generated/generated.js +22 -1
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type InfiniteData, type UseMutationOptions } from '@tanstack/react-query';
|
|
2
2
|
import { type Options } from '../sdk.gen';
|
|
3
|
-
import type { CheckSubdomainUniquenessData, CreateBlueprintData, CreateBlueprintError, CreateBlueprintResponse, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateNeonBranchData, CreateNeonBranchError, CreateNeonBranchResponse, CreateNeonDatabaseData, CreateNeonDatabaseError, CreateNeonDatabaseResponse, CreateNeonProjectData, CreateNeonProjectError, CreateNeonProjectM2mData, CreateNeonProjectM2mError, CreateNeonProjectM2mResponse, CreateNeonProjectResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSecretData, CreateSecretError, CreateSecretM2mData, CreateSecretM2mError, CreateSecretM2mResponse, CreateSecretResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteBlueprintData, DeleteBlueprintError, DeleteBlueprintResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeleteNeonDatabaseData, DeleteNeonDatabaseError, DeleteNeonDatabaseResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchMongoOrganizationsData, FetchMongoRegionsData, FetchNeonConnectionUriData, FetchNeonOrganizationsData, FetchNeonRegionsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetBlueprintData, GetBlueprintM2mData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVariablesM2mData, GetEnvironmentVersionsData, GetGraphOverviewData, GetNodeEnvironmentVariablesData, GetProjectOverviewData, GetPublicInviteData, GetSecretValueData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpacePropertiesData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, GetVersionData, GetVersionM2mData, ImportBlueprintData, ImportBlueprintError, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListMongoClustersData, ListMongoProjectsData, ListNeonBranchesData, ListNeonDatabasesData, ListNeonProjectsData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, PreviewBlueprintData, RecordCloudUsageData, RecordCloudUsageError, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedDownloadUrlData, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdError, SetSpacePropertyData, SetSpacePropertyError, UpdateBillingPlanData, UpdateBillingPlanError, UpdateBlueprintData, UpdateBlueprintError, UpdateBlueprintResponse, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateNodeM2mData, UpdateNodeM2mError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, ViewBlueprintsData, ViewBlueprintsM2mData } from '../types.gen';
|
|
3
|
+
import type { CheckSubdomainUniquenessData, CreateBlueprintData, CreateBlueprintError, CreateBlueprintResponse, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateNeonBranchData, CreateNeonBranchError, CreateNeonBranchResponse, CreateNeonDatabaseData, CreateNeonDatabaseError, CreateNeonDatabaseResponse, CreateNeonProjectData, CreateNeonProjectError, CreateNeonProjectM2mData, CreateNeonProjectM2mError, CreateNeonProjectM2mResponse, CreateNeonProjectResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSecretData, CreateSecretError, CreateSecretM2mData, CreateSecretM2mError, CreateSecretM2mResponse, CreateSecretResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteBlueprintData, DeleteBlueprintError, DeleteBlueprintResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeleteNeonDatabaseData, DeleteNeonDatabaseError, DeleteNeonDatabaseResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchMongoOrganizationsData, FetchMongoRegionsData, FetchNeonConnectionUriData, FetchNeonOrganizationsData, FetchNeonRegionsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetBlueprintData, GetBlueprintM2mData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVariablesM2mData, GetEnvironmentVersionsData, GetGraphOverviewData, GetNodeEnvironmentVariablesData, GetProjectOverviewData, GetPublicInviteData, GetSecretValueData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpacePropertiesData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, GetVersionData, GetVersionM2mData, ImportBlueprintData, ImportBlueprintError, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListMongoClustersData, ListMongoProjectsData, ListNeonBranchesData, ListNeonDatabasesData, ListNeonProjectsData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, PingNodeData, PreviewBlueprintData, RecordCloudUsageData, RecordCloudUsageError, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedDownloadUrlData, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdError, SetSpacePropertyData, SetSpacePropertyError, UpdateBillingPlanData, UpdateBillingPlanError, UpdateBlueprintData, UpdateBlueprintError, UpdateBlueprintResponse, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateNodeM2mData, UpdateNodeM2mError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, ViewBlueprintsData, ViewBlueprintsM2mData } from '../types.gen';
|
|
4
4
|
export type QueryKey<TOptions extends Options> = [
|
|
5
5
|
Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
|
|
6
6
|
_id: string;
|
|
@@ -1672,6 +1672,34 @@ export declare const checkSubdomainUniquenessOptions: (options: Options<CheckSub
|
|
|
1672
1672
|
[dataTagErrorSymbol]: Error;
|
|
1673
1673
|
};
|
|
1674
1674
|
};
|
|
1675
|
+
export declare const pingNodeQueryKey: (options: Options<PingNodeData>) => [Pick<Options<PingNodeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1676
|
+
_id: string;
|
|
1677
|
+
_infinite?: boolean;
|
|
1678
|
+
tags?: ReadonlyArray<string>;
|
|
1679
|
+
}];
|
|
1680
|
+
/**
|
|
1681
|
+
* Ping check a node's underlying provider resource depending on its type (e.g. Neon database, Mongo Atlas cluster).
|
|
1682
|
+
*/
|
|
1683
|
+
export declare const pingNodeOptions: (options: Options<PingNodeData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").NodePingResponse, Error, import("../types.gen").NodePingResponse, [Pick<Options<PingNodeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1684
|
+
_id: string;
|
|
1685
|
+
_infinite?: boolean;
|
|
1686
|
+
tags?: ReadonlyArray<string>;
|
|
1687
|
+
}]>, "queryFn"> & {
|
|
1688
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").NodePingResponse, [Pick<Options<PingNodeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1689
|
+
_id: string;
|
|
1690
|
+
_infinite?: boolean;
|
|
1691
|
+
tags?: ReadonlyArray<string>;
|
|
1692
|
+
}], never> | undefined;
|
|
1693
|
+
} & {
|
|
1694
|
+
queryKey: [Pick<Options<PingNodeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1695
|
+
_id: string;
|
|
1696
|
+
_infinite?: boolean;
|
|
1697
|
+
tags?: ReadonlyArray<string>;
|
|
1698
|
+
}] & {
|
|
1699
|
+
[dataTagSymbol]: import("../types.gen").NodePingResponse;
|
|
1700
|
+
[dataTagErrorSymbol]: Error;
|
|
1701
|
+
};
|
|
1702
|
+
};
|
|
1675
1703
|
/**
|
|
1676
1704
|
* Record a cloud usage event for a space (M2M only).
|
|
1677
1705
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
import { infiniteQueryOptions, queryOptions } from '@tanstack/react-query';
|
|
3
3
|
import { client } from '../client.gen';
|
|
4
|
-
import { checkSubdomainUniqueness, createBlueprint, createEnvironment, createEnvironmentVariable, createFeatureRequest, createNeonBranch, createNeonDatabase, createNeonProject, createNeonProjectM2M, createProject, createSecret, createSecretM2M, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteBlueprint, deleteEnvironmentVariable, deleteNeonDatabase, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchMongoOrganizations, fetchMongoRegions, fetchNeonConnectionUri, fetchNeonOrganizations, fetchNeonRegions, fetchNodeM2M, getBillingPlan, getBillingUsage, getBlueprint, getBlueprintM2M, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVariablesM2M, getEnvironmentVersions, getGraphOverview, getNodeEnvironmentVariables, getProjectOverview, getPublicInvite, getSecretValue, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getSpaceProperties, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, getVersion, getVersionM2M, importBlueprint, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listMongoClusters, listMongoProjects, listNeonBranches, listNeonDatabases, listNeonProjects, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, previewBlueprint, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, setEnvironmentGcpProjectId, setSpaceProperty, updateBillingPlan, updateBlueprint, updateConnectedAppToken, updateDeploymentStatusM2M, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateUsername, updateUserProfile, viewBlueprints, viewBlueprintsM2M } from '../sdk.gen';
|
|
4
|
+
import { checkSubdomainUniqueness, createBlueprint, createEnvironment, createEnvironmentVariable, createFeatureRequest, createNeonBranch, createNeonDatabase, createNeonProject, createNeonProjectM2M, createProject, createSecret, createSecretM2M, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteBlueprint, deleteEnvironmentVariable, deleteNeonDatabase, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchMongoOrganizations, fetchMongoRegions, fetchNeonConnectionUri, fetchNeonOrganizations, fetchNeonRegions, fetchNodeM2M, getBillingPlan, getBillingUsage, getBlueprint, getBlueprintM2M, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVariablesM2M, getEnvironmentVersions, getGraphOverview, getNodeEnvironmentVariables, getProjectOverview, getPublicInvite, getSecretValue, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getSpaceProperties, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, getVersion, getVersionM2M, importBlueprint, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listMongoClusters, listMongoProjects, listNeonBranches, listNeonDatabases, listNeonProjects, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, pingNode, previewBlueprint, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, setEnvironmentGcpProjectId, setSpaceProperty, updateBillingPlan, updateBlueprint, updateConnectedAppToken, updateDeploymentStatusM2M, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateUsername, updateUserProfile, viewBlueprints, viewBlueprintsM2M } from '../sdk.gen';
|
|
5
5
|
const createQueryKey = (id, options, infinite, tags) => {
|
|
6
6
|
const params = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl };
|
|
7
7
|
if (infinite) {
|
|
@@ -1734,6 +1734,24 @@ export const checkSubdomainUniquenessOptions = (options) => {
|
|
|
1734
1734
|
queryKey: checkSubdomainUniquenessQueryKey(options)
|
|
1735
1735
|
});
|
|
1736
1736
|
};
|
|
1737
|
+
export const pingNodeQueryKey = (options) => createQueryKey('pingNode', options);
|
|
1738
|
+
/**
|
|
1739
|
+
* Ping check a node's underlying provider resource depending on its type (e.g. Neon database, Mongo Atlas cluster).
|
|
1740
|
+
*/
|
|
1741
|
+
export const pingNodeOptions = (options) => {
|
|
1742
|
+
return queryOptions({
|
|
1743
|
+
queryFn: async ({ queryKey, signal }) => {
|
|
1744
|
+
const { data } = await pingNode({
|
|
1745
|
+
...options,
|
|
1746
|
+
...queryKey[0],
|
|
1747
|
+
signal,
|
|
1748
|
+
throwOnError: true
|
|
1749
|
+
});
|
|
1750
|
+
return data;
|
|
1751
|
+
},
|
|
1752
|
+
queryKey: pingNodeQueryKey(options)
|
|
1753
|
+
});
|
|
1754
|
+
};
|
|
1737
1755
|
/**
|
|
1738
1756
|
* Record a cloud usage event for a space (M2M only).
|
|
1739
1757
|
*/
|
package/dist/sdk/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
-
import type { CheckSubdomainUniquenessData, CheckSubdomainUniquenessErrors, CheckSubdomainUniquenessResponses, CreateBlueprintData, CreateBlueprintErrors, CreateBlueprintResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateFeatureRequestData, CreateFeatureRequestErrors, CreateFeatureRequestResponses, CreateNeonBranchData, CreateNeonBranchErrors, CreateNeonBranchResponses, CreateNeonDatabaseData, CreateNeonDatabaseErrors, CreateNeonDatabaseResponses, CreateNeonProjectData, CreateNeonProjectErrors, CreateNeonProjectM2mData, CreateNeonProjectM2mErrors, CreateNeonProjectM2mResponses, CreateNeonProjectResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSecretData, CreateSecretErrors, CreateSecretM2mData, CreateSecretM2mErrors, CreateSecretM2mResponses, CreateSecretResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteBlueprintData, DeleteBlueprintErrors, DeleteBlueprintResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeleteNeonDatabaseData, DeleteNeonDatabaseErrors, DeleteNeonDatabaseResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, FetchMongoOrganizationsData, FetchMongoOrganizationsErrors, FetchMongoOrganizationsResponses, FetchMongoRegionsData, FetchMongoRegionsErrors, FetchMongoRegionsResponses, FetchNeonConnectionUriData, FetchNeonConnectionUriErrors, FetchNeonConnectionUriResponses, FetchNeonOrganizationsData, FetchNeonOrganizationsErrors, FetchNeonOrganizationsResponses, FetchNeonRegionsData, FetchNeonRegionsErrors, FetchNeonRegionsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetBlueprintData, GetBlueprintErrors, GetBlueprintM2mData, GetBlueprintM2mErrors, GetBlueprintM2mResponses, GetBlueprintResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetEnvironmentVariablesData, GetEnvironmentVariablesErrors, GetEnvironmentVariablesM2mData, GetEnvironmentVariablesM2mErrors, GetEnvironmentVariablesM2mResponses, GetEnvironmentVariablesResponses, GetEnvironmentVersionsData, GetEnvironmentVersionsResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetNodeEnvironmentVariablesData, GetNodeEnvironmentVariablesErrors, GetNodeEnvironmentVariablesResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetPublicInviteData, GetPublicInviteErrors, GetPublicInviteResponses, GetSecretValueData, GetSecretValueErrors, GetSecretValueResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceOrgCodeData, GetSpaceOrgCodeErrors, GetSpaceOrgCodeResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetSpacePropertiesData, GetSpacePropertiesErrors, GetSpacePropertiesResponses, GetSpaceStatsData, GetSpaceStatsErrors, GetSpaceStatsResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, GetVersionData, GetVersionErrors, GetVersionM2mData, GetVersionM2mErrors, GetVersionM2mResponses, GetVersionResponses, ImportBlueprintData, ImportBlueprintErrors, ImportBlueprintResponses, JoinSpaceData, JoinSpaceErrors, JoinSpaceResponses, LeaveSpaceData, LeaveSpaceErrors, LeaveSpaceResponses, ListBillingInvoicesData, ListBillingInvoicesErrors, ListBillingInvoicesResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListMongoClustersData, ListMongoClustersErrors, ListMongoClustersResponses, ListMongoProjectsData, ListMongoProjectsErrors, ListMongoProjectsResponses, ListNeonBranchesData, ListNeonBranchesErrors, ListNeonBranchesResponses, ListNeonDatabasesData, ListNeonDatabasesErrors, ListNeonDatabasesResponses, ListNeonProjectsData, ListNeonProjectsErrors, ListNeonProjectsResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, PreviewBlueprintData, PreviewBlueprintErrors, PreviewBlueprintResponses, RecordCloudUsageData, RecordCloudUsageErrors, RecordCloudUsageResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsErrors, RecordOnboardingAnalyticsResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RemovePaymentMethodData, RemovePaymentMethodErrors, RemovePaymentMethodResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedDownloadUrlData, RequestSignedDownloadUrlErrors, RequestSignedDownloadUrlResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdErrors, SetEnvironmentGcpProjectIdResponses, SetSpacePropertyData, SetSpacePropertyErrors, SetSpacePropertyResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateBlueprintData, UpdateBlueprintErrors, UpdateBlueprintResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mErrors, UpdateDeploymentStatusM2mResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateNodeM2mData, UpdateNodeM2mErrors, UpdateNodeM2mResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, ViewBlueprintsData, ViewBlueprintsErrors, ViewBlueprintsM2mData, ViewBlueprintsM2mErrors, ViewBlueprintsM2mResponses, ViewBlueprintsResponses } from './types.gen';
|
|
2
|
+
import type { CheckSubdomainUniquenessData, CheckSubdomainUniquenessErrors, CheckSubdomainUniquenessResponses, CreateBlueprintData, CreateBlueprintErrors, CreateBlueprintResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateFeatureRequestData, CreateFeatureRequestErrors, CreateFeatureRequestResponses, CreateNeonBranchData, CreateNeonBranchErrors, CreateNeonBranchResponses, CreateNeonDatabaseData, CreateNeonDatabaseErrors, CreateNeonDatabaseResponses, CreateNeonProjectData, CreateNeonProjectErrors, CreateNeonProjectM2mData, CreateNeonProjectM2mErrors, CreateNeonProjectM2mResponses, CreateNeonProjectResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSecretData, CreateSecretErrors, CreateSecretM2mData, CreateSecretM2mErrors, CreateSecretM2mResponses, CreateSecretResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteBlueprintData, DeleteBlueprintErrors, DeleteBlueprintResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeleteNeonDatabaseData, DeleteNeonDatabaseErrors, DeleteNeonDatabaseResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, FetchMongoOrganizationsData, FetchMongoOrganizationsErrors, FetchMongoOrganizationsResponses, FetchMongoRegionsData, FetchMongoRegionsErrors, FetchMongoRegionsResponses, FetchNeonConnectionUriData, FetchNeonConnectionUriErrors, FetchNeonConnectionUriResponses, FetchNeonOrganizationsData, FetchNeonOrganizationsErrors, FetchNeonOrganizationsResponses, FetchNeonRegionsData, FetchNeonRegionsErrors, FetchNeonRegionsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetBlueprintData, GetBlueprintErrors, GetBlueprintM2mData, GetBlueprintM2mErrors, GetBlueprintM2mResponses, GetBlueprintResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetEnvironmentVariablesData, GetEnvironmentVariablesErrors, GetEnvironmentVariablesM2mData, GetEnvironmentVariablesM2mErrors, GetEnvironmentVariablesM2mResponses, GetEnvironmentVariablesResponses, GetEnvironmentVersionsData, GetEnvironmentVersionsResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetNodeEnvironmentVariablesData, GetNodeEnvironmentVariablesErrors, GetNodeEnvironmentVariablesResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetPublicInviteData, GetPublicInviteErrors, GetPublicInviteResponses, GetSecretValueData, GetSecretValueErrors, GetSecretValueResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceOrgCodeData, GetSpaceOrgCodeErrors, GetSpaceOrgCodeResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetSpacePropertiesData, GetSpacePropertiesErrors, GetSpacePropertiesResponses, GetSpaceStatsData, GetSpaceStatsErrors, GetSpaceStatsResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, GetVersionData, GetVersionErrors, GetVersionM2mData, GetVersionM2mErrors, GetVersionM2mResponses, GetVersionResponses, ImportBlueprintData, ImportBlueprintErrors, ImportBlueprintResponses, JoinSpaceData, JoinSpaceErrors, JoinSpaceResponses, LeaveSpaceData, LeaveSpaceErrors, LeaveSpaceResponses, ListBillingInvoicesData, ListBillingInvoicesErrors, ListBillingInvoicesResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListMongoClustersData, ListMongoClustersErrors, ListMongoClustersResponses, ListMongoProjectsData, ListMongoProjectsErrors, ListMongoProjectsResponses, ListNeonBranchesData, ListNeonBranchesErrors, ListNeonBranchesResponses, ListNeonDatabasesData, ListNeonDatabasesErrors, ListNeonDatabasesResponses, ListNeonProjectsData, ListNeonProjectsErrors, ListNeonProjectsResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, PingNodeData, PingNodeErrors, PingNodeResponses, PreviewBlueprintData, PreviewBlueprintErrors, PreviewBlueprintResponses, RecordCloudUsageData, RecordCloudUsageErrors, RecordCloudUsageResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsErrors, RecordOnboardingAnalyticsResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RemovePaymentMethodData, RemovePaymentMethodErrors, RemovePaymentMethodResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedDownloadUrlData, RequestSignedDownloadUrlErrors, RequestSignedDownloadUrlResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdErrors, SetEnvironmentGcpProjectIdResponses, SetSpacePropertyData, SetSpacePropertyErrors, SetSpacePropertyResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateBlueprintData, UpdateBlueprintErrors, UpdateBlueprintResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mErrors, UpdateDeploymentStatusM2mResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateNodeM2mData, UpdateNodeM2mErrors, UpdateNodeM2mResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, ViewBlueprintsData, ViewBlueprintsErrors, ViewBlueprintsM2mData, ViewBlueprintsM2mErrors, ViewBlueprintsM2mResponses, ViewBlueprintsResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -333,6 +333,10 @@ export declare const requestSignedUploadUrl: <ThrowOnError extends boolean = fal
|
|
|
333
333
|
* Check if a proxy subdomain is unique within the current version and environment.
|
|
334
334
|
*/
|
|
335
335
|
export declare const checkSubdomainUniqueness: <ThrowOnError extends boolean = false>(options: Options<CheckSubdomainUniquenessData, ThrowOnError>) => import("./client").RequestResult<CheckSubdomainUniquenessResponses, CheckSubdomainUniquenessErrors, ThrowOnError, "fields">;
|
|
336
|
+
/**
|
|
337
|
+
* Ping check a node's underlying provider resource depending on its type (e.g. Neon database, Mongo Atlas cluster).
|
|
338
|
+
*/
|
|
339
|
+
export declare const pingNode: <ThrowOnError extends boolean = false>(options: Options<PingNodeData, ThrowOnError>) => import("./client").RequestResult<PingNodeResponses, PingNodeErrors, ThrowOnError, "fields">;
|
|
336
340
|
/**
|
|
337
341
|
* Record a cloud usage event for a space (M2M only).
|
|
338
342
|
*/
|
package/dist/sdk/sdk.gen.js
CHANGED
|
@@ -1311,6 +1311,21 @@ export const checkSubdomainUniqueness = (options) => {
|
|
|
1311
1311
|
...options
|
|
1312
1312
|
});
|
|
1313
1313
|
};
|
|
1314
|
+
/**
|
|
1315
|
+
* Ping check a node's underlying provider resource depending on its type (e.g. Neon database, Mongo Atlas cluster).
|
|
1316
|
+
*/
|
|
1317
|
+
export const pingNode = (options) => {
|
|
1318
|
+
return (options.client ?? client).get({
|
|
1319
|
+
security: [
|
|
1320
|
+
{
|
|
1321
|
+
scheme: 'bearer',
|
|
1322
|
+
type: 'http'
|
|
1323
|
+
}
|
|
1324
|
+
],
|
|
1325
|
+
url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/{nodeUUID}/ping',
|
|
1326
|
+
...options
|
|
1327
|
+
});
|
|
1328
|
+
};
|
|
1314
1329
|
/**
|
|
1315
1330
|
* Record a cloud usage event for a space (M2M only).
|
|
1316
1331
|
*/
|
package/dist/sdk/types.gen.d.ts
CHANGED
|
@@ -615,6 +615,20 @@ export type MongoDbNodeProps = {
|
|
|
615
615
|
*/
|
|
616
616
|
connectionString?: string;
|
|
617
617
|
};
|
|
618
|
+
export type NodePingResponse = {
|
|
619
|
+
/**
|
|
620
|
+
* Whether the underlying provider resource is reachable and in a healthy state.
|
|
621
|
+
*/
|
|
622
|
+
healthy: boolean;
|
|
623
|
+
/**
|
|
624
|
+
* Provider specific status of the resource (e.g. the Atlas cluster state name).
|
|
625
|
+
*/
|
|
626
|
+
status?: string;
|
|
627
|
+
/**
|
|
628
|
+
* Human readable detail, populated when the resource is unreachable or unhealthy.
|
|
629
|
+
*/
|
|
630
|
+
message?: string;
|
|
631
|
+
};
|
|
618
632
|
export type FunctionNodeProps = {
|
|
619
633
|
region: Region;
|
|
620
634
|
language: string;
|
|
@@ -896,6 +910,10 @@ export type NeonDatabaseNamePath = string;
|
|
|
896
910
|
* The Neon organization ID.
|
|
897
911
|
*/
|
|
898
912
|
export type NeonOrganizationId = string;
|
|
913
|
+
/**
|
|
914
|
+
* Scope regions to a Neon organization, which may have access to additional regions. When omitted, globally available regions are returned.
|
|
915
|
+
*/
|
|
916
|
+
export type NeonOrganizationIdOptional = string;
|
|
899
917
|
/**
|
|
900
918
|
* The endpoint ID to connect to.
|
|
901
919
|
*/
|
|
@@ -2006,7 +2024,12 @@ export type FetchNeonRegionsData = {
|
|
|
2006
2024
|
'x-neon-api-key': string;
|
|
2007
2025
|
};
|
|
2008
2026
|
path?: never;
|
|
2009
|
-
query?:
|
|
2027
|
+
query?: {
|
|
2028
|
+
/**
|
|
2029
|
+
* Scope regions to a Neon organization, which may have access to additional regions. When omitted, globally available regions are returned.
|
|
2030
|
+
*/
|
|
2031
|
+
orgId?: string;
|
|
2032
|
+
};
|
|
2010
2033
|
url: '/auth/neon/regions';
|
|
2011
2034
|
};
|
|
2012
2035
|
export type FetchNeonRegionsErrors = {
|
|
@@ -4524,6 +4547,67 @@ export type CheckSubdomainUniquenessResponses = {
|
|
|
4524
4547
|
204: void;
|
|
4525
4548
|
};
|
|
4526
4549
|
export type CheckSubdomainUniquenessResponse = CheckSubdomainUniquenessResponses[keyof CheckSubdomainUniquenessResponses];
|
|
4550
|
+
export type PingNodeData = {
|
|
4551
|
+
body?: never;
|
|
4552
|
+
path: {
|
|
4553
|
+
/**
|
|
4554
|
+
* The space handle. This must be globally unique.
|
|
4555
|
+
*/
|
|
4556
|
+
spaceHandle: string;
|
|
4557
|
+
/**
|
|
4558
|
+
* A project name. This must be unique to a space.
|
|
4559
|
+
*/
|
|
4560
|
+
projectHandle: string;
|
|
4561
|
+
/**
|
|
4562
|
+
* An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
|
|
4563
|
+
*/
|
|
4564
|
+
environmentHandle: string;
|
|
4565
|
+
/**
|
|
4566
|
+
* A version number with in an environment.
|
|
4567
|
+
*/
|
|
4568
|
+
version: string;
|
|
4569
|
+
/**
|
|
4570
|
+
* The node ID this source ZIP is associated with.
|
|
4571
|
+
*/
|
|
4572
|
+
nodeUUID: string;
|
|
4573
|
+
};
|
|
4574
|
+
query?: never;
|
|
4575
|
+
url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/{nodeUUID}/ping';
|
|
4576
|
+
};
|
|
4577
|
+
export type PingNodeErrors = {
|
|
4578
|
+
/**
|
|
4579
|
+
* Invalid request parameters.
|
|
4580
|
+
*/
|
|
4581
|
+
400: ErrorResponse;
|
|
4582
|
+
/**
|
|
4583
|
+
* Unauthorised user.
|
|
4584
|
+
*/
|
|
4585
|
+
401: ErrorResponse;
|
|
4586
|
+
/**
|
|
4587
|
+
* Invalid credentials.
|
|
4588
|
+
*/
|
|
4589
|
+
403: ErrorResponse;
|
|
4590
|
+
/**
|
|
4591
|
+
* Node not found.
|
|
4592
|
+
*/
|
|
4593
|
+
404: ErrorResponse;
|
|
4594
|
+
/**
|
|
4595
|
+
* Node type does not support ping checks.
|
|
4596
|
+
*/
|
|
4597
|
+
422: ErrorResponse;
|
|
4598
|
+
/**
|
|
4599
|
+
* Unexpected error.
|
|
4600
|
+
*/
|
|
4601
|
+
500: ErrorResponse;
|
|
4602
|
+
};
|
|
4603
|
+
export type PingNodeError = PingNodeErrors[keyof PingNodeErrors];
|
|
4604
|
+
export type PingNodeResponses = {
|
|
4605
|
+
/**
|
|
4606
|
+
* The result of the ping check.
|
|
4607
|
+
*/
|
|
4608
|
+
200: NodePingResponse;
|
|
4609
|
+
};
|
|
4610
|
+
export type PingNodeResponse = PingNodeResponses[keyof PingNodeResponses];
|
|
4527
4611
|
export type RecordCloudUsageData = {
|
|
4528
4612
|
body: RecordUsageRequest;
|
|
4529
4613
|
path?: never;
|
package/dist/sdk/zod.gen.d.ts
CHANGED
|
@@ -763,6 +763,11 @@ export declare const zMongoDbNodeProps: z.ZodObject<{
|
|
|
763
763
|
backupEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
764
764
|
connectionString: z.ZodOptional<z.ZodString>;
|
|
765
765
|
}, z.core.$strip>;
|
|
766
|
+
export declare const zNodePingResponse: z.ZodObject<{
|
|
767
|
+
healthy: z.ZodBoolean;
|
|
768
|
+
status: z.ZodOptional<z.ZodString>;
|
|
769
|
+
message: z.ZodOptional<z.ZodString>;
|
|
770
|
+
}, z.core.$strip>;
|
|
766
771
|
export declare const zFunctionNodeProps: z.ZodObject<{
|
|
767
772
|
region: z.ZodEnum<{
|
|
768
773
|
"europe-west2": "europe-west2";
|
|
@@ -1902,6 +1907,10 @@ export declare const zNeonDatabaseNamePath: z.ZodString;
|
|
|
1902
1907
|
* The Neon organization ID.
|
|
1903
1908
|
*/
|
|
1904
1909
|
export declare const zNeonOrganizationId: z.ZodString;
|
|
1910
|
+
/**
|
|
1911
|
+
* Scope regions to a Neon organization, which may have access to additional regions. When omitted, globally available regions are returned.
|
|
1912
|
+
*/
|
|
1913
|
+
export declare const zNeonOrganizationIdOptional: z.ZodString;
|
|
1905
1914
|
/**
|
|
1906
1915
|
* The endpoint ID to connect to.
|
|
1907
1916
|
*/
|
|
@@ -3456,7 +3465,9 @@ export declare const zFetchNeonOrganizationsResponse: z.ZodArray<z.ZodObject<{
|
|
|
3456
3465
|
export declare const zFetchNeonRegionsData: z.ZodObject<{
|
|
3457
3466
|
body: z.ZodOptional<z.ZodNever>;
|
|
3458
3467
|
path: z.ZodOptional<z.ZodNever>;
|
|
3459
|
-
query: z.ZodOptional<z.
|
|
3468
|
+
query: z.ZodOptional<z.ZodObject<{
|
|
3469
|
+
orgId: z.ZodOptional<z.ZodString>;
|
|
3470
|
+
}, z.core.$strip>>;
|
|
3460
3471
|
headers: z.ZodObject<{
|
|
3461
3472
|
'x-neon-api-key': z.ZodString;
|
|
3462
3473
|
}, z.core.$strip>;
|
|
@@ -5252,6 +5263,25 @@ export declare const zCheckSubdomainUniquenessData: z.ZodObject<{
|
|
|
5252
5263
|
* Subdomain is unique and available.
|
|
5253
5264
|
*/
|
|
5254
5265
|
export declare const zCheckSubdomainUniquenessResponse: z.ZodVoid;
|
|
5266
|
+
export declare const zPingNodeData: z.ZodObject<{
|
|
5267
|
+
body: z.ZodOptional<z.ZodNever>;
|
|
5268
|
+
path: z.ZodObject<{
|
|
5269
|
+
spaceHandle: z.ZodString;
|
|
5270
|
+
projectHandle: z.ZodString;
|
|
5271
|
+
environmentHandle: z.ZodString;
|
|
5272
|
+
version: z.ZodString;
|
|
5273
|
+
nodeUUID: z.ZodUUID;
|
|
5274
|
+
}, z.core.$strip>;
|
|
5275
|
+
query: z.ZodOptional<z.ZodNever>;
|
|
5276
|
+
}, z.core.$strip>;
|
|
5277
|
+
/**
|
|
5278
|
+
* The result of the ping check.
|
|
5279
|
+
*/
|
|
5280
|
+
export declare const zPingNodeResponse: z.ZodObject<{
|
|
5281
|
+
healthy: z.ZodBoolean;
|
|
5282
|
+
status: z.ZodOptional<z.ZodString>;
|
|
5283
|
+
message: z.ZodOptional<z.ZodString>;
|
|
5284
|
+
}, z.core.$strip>;
|
|
5255
5285
|
export declare const zRecordCloudUsageData: z.ZodObject<{
|
|
5256
5286
|
body: z.ZodObject<{
|
|
5257
5287
|
orgCode: z.ZodString;
|
package/dist/sdk/zod.gen.js
CHANGED
|
@@ -538,6 +538,11 @@ export const zMongoDbNodeProps = z.object({
|
|
|
538
538
|
backupEnabled: z.optional(z.boolean()),
|
|
539
539
|
connectionString: z.optional(z.string())
|
|
540
540
|
});
|
|
541
|
+
export const zNodePingResponse = z.object({
|
|
542
|
+
healthy: z.boolean(),
|
|
543
|
+
status: z.optional(z.string()),
|
|
544
|
+
message: z.optional(z.string())
|
|
545
|
+
});
|
|
541
546
|
export const zFunctionNodeProps = z.object({
|
|
542
547
|
region: zRegion,
|
|
543
548
|
language: z.string(),
|
|
@@ -850,6 +855,10 @@ export const zNeonDatabaseNamePath = z.string();
|
|
|
850
855
|
* The Neon organization ID.
|
|
851
856
|
*/
|
|
852
857
|
export const zNeonOrganizationId = z.string();
|
|
858
|
+
/**
|
|
859
|
+
* Scope regions to a Neon organization, which may have access to additional regions. When omitted, globally available regions are returned.
|
|
860
|
+
*/
|
|
861
|
+
export const zNeonOrganizationIdOptional = z.string();
|
|
853
862
|
/**
|
|
854
863
|
* The endpoint ID to connect to.
|
|
855
864
|
*/
|
|
@@ -1263,7 +1272,9 @@ export const zFetchNeonOrganizationsResponse = z.array(zNeonOrganization);
|
|
|
1263
1272
|
export const zFetchNeonRegionsData = z.object({
|
|
1264
1273
|
body: z.optional(z.never()),
|
|
1265
1274
|
path: z.optional(z.never()),
|
|
1266
|
-
query: z.optional(z.
|
|
1275
|
+
query: z.optional(z.object({
|
|
1276
|
+
orgId: z.optional(z.string())
|
|
1277
|
+
})),
|
|
1267
1278
|
headers: z.object({
|
|
1268
1279
|
'x-neon-api-key': z.string()
|
|
1269
1280
|
})
|
|
@@ -1982,6 +1993,21 @@ export const zCheckSubdomainUniquenessData = z.object({
|
|
|
1982
1993
|
* Subdomain is unique and available.
|
|
1983
1994
|
*/
|
|
1984
1995
|
export const zCheckSubdomainUniquenessResponse = z.void();
|
|
1996
|
+
export const zPingNodeData = z.object({
|
|
1997
|
+
body: z.optional(z.never()),
|
|
1998
|
+
path: z.object({
|
|
1999
|
+
spaceHandle: z.string(),
|
|
2000
|
+
projectHandle: z.string(),
|
|
2001
|
+
environmentHandle: z.string(),
|
|
2002
|
+
version: z.string(),
|
|
2003
|
+
nodeUUID: z.uuid()
|
|
2004
|
+
}),
|
|
2005
|
+
query: z.optional(z.never())
|
|
2006
|
+
});
|
|
2007
|
+
/**
|
|
2008
|
+
* The result of the ping check.
|
|
2009
|
+
*/
|
|
2010
|
+
export const zPingNodeResponse = zNodePingResponse;
|
|
1985
2011
|
export const zRecordCloudUsageData = z.object({
|
|
1986
2012
|
body: zRecordUsageRequest,
|
|
1987
2013
|
path: z.optional(z.never()),
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { useMutation } from "@tanstack/react-query";
|
|
2
2
|
import { GetSuccessResponse } from "../util";
|
|
3
|
-
import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchNodeM2mData, UpdateNodeM2mData, UpdateNodeM2mResponses, ViewBlueprintsM2mData, CreateSecretM2mData, CreateSecretM2mResponses, GetBlueprintM2mData, CreateNeonProjectM2mData, CreateNeonProjectM2mResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, FetchNeonOrganizationsData, FetchNeonRegionsData, FetchMongoOrganizationsData, FetchMongoRegionsData, ListMongoProjectsData, ListMongoClustersData, FetchNeonConnectionUriData, ListNeonProjectsData, CreateNeonProjectData, CreateNeonProjectResponses, ListNeonBranchesData, CreateNeonBranchData, CreateNeonBranchResponses, ListNeonDatabasesData, CreateNeonDatabaseData, CreateNeonDatabaseResponses, DeleteNeonDatabaseData, DeleteNeonDatabaseResponses, ListUserSpacesData, CreateFeatureRequestData, CreateFeatureRequestResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, PreviewBlueprintData, ViewBlueprintsData, GetBlueprintData, CreateSpaceData, CreateSpaceResponses, GetPublicInviteData, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, GetSpaceStatsData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, CreateSecretData, CreateSecretResponses, GetSecretValueData, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, DeleteBlueprintData, DeleteBlueprintResponses, UpdateBlueprintData, UpdateBlueprintResponses, CreateBlueprintData, CreateBlueprintResponses, GetVersionData, ImportBlueprintData, ImportBlueprintResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedDownloadUrlData, GetNodeEnvironmentVariablesData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, CheckSubdomainUniquenessData, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData, GetSpacePropertiesData, SetSpacePropertyData, SetSpacePropertyResponses } from "../../sdk/types.gen";
|
|
3
|
+
import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchNodeM2mData, UpdateNodeM2mData, UpdateNodeM2mResponses, ViewBlueprintsM2mData, CreateSecretM2mData, CreateSecretM2mResponses, GetBlueprintM2mData, CreateNeonProjectM2mData, CreateNeonProjectM2mResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, FetchNeonOrganizationsData, FetchNeonRegionsData, FetchMongoOrganizationsData, FetchMongoRegionsData, ListMongoProjectsData, ListMongoClustersData, FetchNeonConnectionUriData, ListNeonProjectsData, CreateNeonProjectData, CreateNeonProjectResponses, ListNeonBranchesData, CreateNeonBranchData, CreateNeonBranchResponses, ListNeonDatabasesData, CreateNeonDatabaseData, CreateNeonDatabaseResponses, DeleteNeonDatabaseData, DeleteNeonDatabaseResponses, ListUserSpacesData, CreateFeatureRequestData, CreateFeatureRequestResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, PreviewBlueprintData, ViewBlueprintsData, GetBlueprintData, CreateSpaceData, CreateSpaceResponses, GetPublicInviteData, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, GetSpaceStatsData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, CreateSecretData, CreateSecretResponses, GetSecretValueData, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, DeleteBlueprintData, DeleteBlueprintResponses, UpdateBlueprintData, UpdateBlueprintResponses, CreateBlueprintData, CreateBlueprintResponses, GetVersionData, ImportBlueprintData, ImportBlueprintResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedDownloadUrlData, GetNodeEnvironmentVariablesData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, CheckSubdomainUniquenessData, PingNodeData, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData, GetSpacePropertiesData, SetSpacePropertyData, SetSpacePropertyResponses } from "../../sdk/types.gen";
|
|
4
4
|
export declare const useGetServiceHealth: (options?: Omit<GetServiceHealthData, "url"> & {
|
|
5
5
|
enabled?: boolean;
|
|
6
6
|
}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").HealthResponse | undefined, Error>;
|
|
@@ -413,6 +413,9 @@ export declare const useRequestSignedUploadUrl: (config?: {
|
|
|
413
413
|
export declare const useCheckSubdomainUniqueness: (options: Omit<CheckSubdomainUniquenessData, "url"> & {
|
|
414
414
|
enabled?: boolean;
|
|
415
415
|
}) => import("@tanstack/react-query").UseQueryResult<void, Error>;
|
|
416
|
+
export declare const usePingNode: (options: Omit<PingNodeData, "url"> & {
|
|
417
|
+
enabled?: boolean;
|
|
418
|
+
}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").NodePingResponse | undefined, Error>;
|
|
416
419
|
export declare const useRecordCloudUsage: (config?: {
|
|
417
420
|
onSuccess?: (data: GetSuccessResponse<RecordCloudUsageResponses>, headers: Headers) => void;
|
|
418
421
|
onError?: Parameters<typeof useMutation>["0"]["onError"];
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
|
|
3
3
|
import { isPromise } from "../util";
|
|
4
4
|
import { useToken } from "../../provider/token-provider";
|
|
5
|
-
import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, updateNodeM2M, viewBlueprintsM2M, createSecretM2M, getBlueprintM2M, createNeonProjectM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, fetchNeonOrganizations, fetchNeonRegions, fetchMongoOrganizations, fetchMongoRegions, listMongoProjects, listMongoClusters, fetchNeonConnectionUri, listNeonProjects, createNeonProject, listNeonBranches, createNeonBranch, listNeonDatabases, createNeonDatabase, deleteNeonDatabase, listUserSpaces, createFeatureRequest, recordOnboardingAnalytics, previewBlueprint, viewBlueprints, getBlueprint, createSpace, getPublicInvite, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, createSecret, getSecretValue, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, deleteBlueprint, updateBlueprint, createBlueprint, getVersion, importBlueprint, getGraphOverview, updateGraphState, deployVersion, requestSignedDownloadUrl, getNodeEnvironmentVariables, requestSignedUploadUrl, checkSubdomainUniqueness, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices, getSpaceProperties, setSpaceProperty } from "../../sdk/sdk.gen";
|
|
5
|
+
import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, updateNodeM2M, viewBlueprintsM2M, createSecretM2M, getBlueprintM2M, createNeonProjectM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, fetchNeonOrganizations, fetchNeonRegions, fetchMongoOrganizations, fetchMongoRegions, listMongoProjects, listMongoClusters, fetchNeonConnectionUri, listNeonProjects, createNeonProject, listNeonBranches, createNeonBranch, listNeonDatabases, createNeonDatabase, deleteNeonDatabase, listUserSpaces, createFeatureRequest, recordOnboardingAnalytics, previewBlueprint, viewBlueprints, getBlueprint, createSpace, getPublicInvite, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, createSecret, getSecretValue, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, deleteBlueprint, updateBlueprint, createBlueprint, getVersion, importBlueprint, getGraphOverview, updateGraphState, deployVersion, requestSignedDownloadUrl, getNodeEnvironmentVariables, requestSignedUploadUrl, checkSubdomainUniqueness, pingNode, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices, getSpaceProperties, setSpaceProperty } from "../../sdk/sdk.gen";
|
|
6
6
|
export const useGetServiceHealth = (options) => {
|
|
7
7
|
const token = useToken();
|
|
8
8
|
let { enabled, ...rest } = options || { enabled: true };
|
|
@@ -1574,6 +1574,27 @@ export const useCheckSubdomainUniqueness = (options) => {
|
|
|
1574
1574
|
staleTime: 600000
|
|
1575
1575
|
});
|
|
1576
1576
|
};
|
|
1577
|
+
export const usePingNode = (options) => {
|
|
1578
|
+
const token = useToken();
|
|
1579
|
+
let { enabled, ...rest } = options || { enabled: true };
|
|
1580
|
+
const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/{nodeUUID}/ping" };
|
|
1581
|
+
const funcer = async () => {
|
|
1582
|
+
const auth = isPromise(token) ? (await token) || "" : token || "";
|
|
1583
|
+
if (isPromise(token) && !token)
|
|
1584
|
+
return;
|
|
1585
|
+
const res = await pingNode({ ...opts, ...rest, auth });
|
|
1586
|
+
return res.data;
|
|
1587
|
+
};
|
|
1588
|
+
if (!token)
|
|
1589
|
+
enabled = false;
|
|
1590
|
+
return useQuery({
|
|
1591
|
+
queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "graph", options?.path?.nodeUUID, "ping", options.query ?? {}],
|
|
1592
|
+
queryFn: funcer,
|
|
1593
|
+
enabled,
|
|
1594
|
+
retry: false,
|
|
1595
|
+
staleTime: 600000
|
|
1596
|
+
});
|
|
1597
|
+
};
|
|
1577
1598
|
export const useRecordCloudUsage = (config) => {
|
|
1578
1599
|
const token = useToken();
|
|
1579
1600
|
const queryClient = useQueryClient();
|