shoal-web-sdk 1.0.120 → 1.0.122

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.
@@ -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, CloneEnvironmentData, CloneEnvironmentError, CloneEnvironmentResponse, CreateApiKeyData, CreateApiKeyError, CreateApiKeyResponse2, CreateBlueprintData, CreateBlueprintError, CreateBlueprintResponse, CreateBugReportData, CreateBugReportError, CreateBugReportResponse, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateNeonBranchData, CreateNeonBranchError, CreateNeonBranchResponse, CreateNeonDatabaseData, CreateNeonDatabaseError, CreateNeonDatabaseResponse, CreateNeonProjectData, CreateNeonProjectError, CreateNeonProjectM2mData, CreateNeonProjectM2mError, CreateNeonProjectM2mResponse, CreateNeonProjectResponse, CreateNodeCredentialData, CreateNodeCredentialError, CreateNodeCredentialResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSecretData, CreateSecretError, CreateSecretM2mData, CreateSecretM2mError, CreateSecretM2mResponse, CreateSecretResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteBlueprintData, DeleteBlueprintError, DeleteBlueprintResponse, DeleteEnvironmentData, DeleteEnvironmentError, DeleteEnvironmentM2mData, DeleteEnvironmentM2mError, DeleteEnvironmentM2mResponse, DeleteEnvironmentResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeleteNeonDatabaseData, DeleteNeonDatabaseError, DeleteNeonDatabaseResponse, DeployVersionData, DeployVersionError, FetchGraphM2mData, FetchMongoOrganizationsData, FetchMongoOrganizationTierData, FetchMongoRegionsData, FetchNeonConnectionUriData, FetchNeonOrganizationsData, FetchNeonRegionsData, FetchNodeM2mData, GetApiKeysData, GetBlueprintData, GetBlueprintM2mData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVariablesM2mData, GetEnvironmentVersionsData, GetFeatureFlagsData, GetGraphOverviewData, GetNodeEnvironmentVariablesData, GetProjectEnvironmentsData, GetProjectOverviewData, GetPublicInviteData, GetSecretValueData, GetServiceHealthData, GetSoftDeletedEnvironmentsM2mData, GetSpaceInvitesData, GetSpaceM2mData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpacePropertiesData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, GetVersionData, GetVersionM2mData, ImportBlueprintData, ImportBlueprintError, JoinSpaceData, JoinSpaceError, KickSpaceMemberData, KickSpaceMemberError, LeaveSpaceData, LeaveSpaceError, ListInstallationBranchesData, ListInstallationRepositoriesData, ListMongoClustersData, ListMongoProjectsData, ListNeonBranchesData, ListNeonDatabasesData, ListNeonProjectsData, ListNeonRolesData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, LookupApiKeyData, NukeEnvironmentM2mData, NukeEnvironmentM2mError, NukeEnvironmentM2mResponse, PingNodeData, PreviewBlueprintData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedDownloadUrlData, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeApiKeyData, RevokeApiKeyError, RevokeApiKeyResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdError, SetSpacePropertyData, SetSpacePropertyError, 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, CloneEnvironmentData, CloneEnvironmentError, CloneEnvironmentResponse, CreateApiKeyData, CreateApiKeyError, CreateApiKeyResponse2, CreateBlueprintData, CreateBlueprintError, CreateBlueprintResponse, CreateBugReportData, CreateBugReportError, CreateBugReportResponse, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateNeonBranchData, CreateNeonBranchError, CreateNeonBranchResponse, CreateNeonDatabaseData, CreateNeonDatabaseError, CreateNeonDatabaseResponse, CreateNeonProjectData, CreateNeonProjectError, CreateNeonProjectM2mData, CreateNeonProjectM2mError, CreateNeonProjectM2mResponse, CreateNeonProjectResponse, CreateNodeCredentialData, CreateNodeCredentialError, CreateNodeCredentialResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSecretData, CreateSecretError, CreateSecretM2mData, CreateSecretM2mError, CreateSecretM2mResponse, CreateSecretResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteBlueprintData, DeleteBlueprintError, DeleteBlueprintResponse, DeleteEnvironmentData, DeleteEnvironmentError, DeleteEnvironmentM2mData, DeleteEnvironmentM2mError, DeleteEnvironmentM2mResponse, DeleteEnvironmentResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeleteNeonDatabaseData, DeleteNeonDatabaseError, DeleteNeonDatabaseResponse, DeployVersionData, DeployVersionError, FetchGraphM2mData, FetchMongoOrganizationsData, FetchMongoOrganizationTierData, FetchMongoRegionsData, FetchNeonConnectionUriData, FetchNeonOrganizationsData, FetchNeonRegionsData, FetchNodeM2mData, GetApiKeysData, GetBlueprintData, GetBlueprintM2mData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVariablesM2mData, GetEnvironmentVersionsData, GetFeatureFlagsData, GetGraphOverviewData, GetNodeEnvironmentVariablesData, GetProjectEnvironmentsData, GetProjectOverviewData, GetPublicInviteData, GetSecretValueData, GetServiceHealthData, GetSoftDeletedEnvironmentsM2mData, GetSpaceInvitesData, GetSpaceM2mData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpacePropertiesData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, GetVersionData, GetVersionM2mData, ImportBlueprintData, ImportBlueprintError, JoinSpaceData, JoinSpaceError, KickSpaceMemberData, KickSpaceMemberError, LeaveSpaceData, LeaveSpaceError, ListInstallationBranchesData, ListInstallationRepositoriesData, ListMongoClustersData, ListMongoProjectsData, ListNeonBranchesData, ListNeonDatabasesData, ListNeonProjectsData, ListNeonRolesData, ListSpaceMemberRolesData, ListSpaceMembersData, ListSubdomainsData, ListUserInstallationsData, ListUserSpacesData, LookupApiKeyData, NukeEnvironmentM2mData, NukeEnvironmentM2mError, NukeEnvironmentM2mResponse, PingNodeData, PreviewBlueprintData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RegisterCustomerDomainData, RegisterCustomerDomainError, RegisterCustomerDomainResponse, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedDownloadUrlData, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeApiKeyData, RevokeApiKeyError, RevokeApiKeyResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdError, SetSpacePropertyData, SetSpacePropertyError, 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;
@@ -2030,3 +2030,59 @@ export declare const getSpacePropertiesOptions: (options: Options<GetSpaceProper
2030
2030
  * Set a space property on the space in Kinde.
2031
2031
  */
2032
2032
  export declare const setSpacePropertyMutation: (options?: Partial<Options<SetSpacePropertyData>>) => UseMutationOptions<unknown, SetSpacePropertyError, Options<SetSpacePropertyData>>;
2033
+ export declare const listSubdomainsQueryKey: (options: Options<ListSubdomainsData>) => [Pick<Options<ListSubdomainsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2034
+ _id: string;
2035
+ _infinite?: boolean;
2036
+ tags?: ReadonlyArray<string>;
2037
+ }];
2038
+ /**
2039
+ * List the shoal subdomains claimed by this space.
2040
+ */
2041
+ export declare const listSubdomainsOptions: (options: Options<ListSubdomainsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedSubdomains, Error, import("../types.gen").PaginatedSubdomains, [Pick<Options<ListSubdomainsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2042
+ _id: string;
2043
+ _infinite?: boolean;
2044
+ tags?: ReadonlyArray<string>;
2045
+ }]>, "queryFn"> & {
2046
+ queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaginatedSubdomains, [Pick<Options<ListSubdomainsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2047
+ _id: string;
2048
+ _infinite?: boolean;
2049
+ tags?: ReadonlyArray<string>;
2050
+ }], never> | undefined;
2051
+ } & {
2052
+ queryKey: [Pick<Options<ListSubdomainsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2053
+ _id: string;
2054
+ _infinite?: boolean;
2055
+ tags?: ReadonlyArray<string>;
2056
+ }] & {
2057
+ [dataTagSymbol]: import("../types.gen").PaginatedSubdomains;
2058
+ [dataTagErrorSymbol]: Error;
2059
+ };
2060
+ };
2061
+ export declare const listSubdomainsInfiniteQueryKey: (options: Options<ListSubdomainsData>) => QueryKey<Options<ListSubdomainsData>>;
2062
+ /**
2063
+ * List the shoal subdomains claimed by this space.
2064
+ */
2065
+ export declare const listSubdomainsInfiniteOptions: (options: Options<ListSubdomainsData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedSubdomains, import("../types.gen").ErrorResponse, InfiniteData<import("../types.gen").PaginatedSubdomains, unknown>, QueryKey<Options<ListSubdomainsData>>, number | Pick<Pick<Options<ListSubdomainsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2066
+ _id: string;
2067
+ _infinite?: boolean;
2068
+ tags?: ReadonlyArray<string>;
2069
+ }, "query" | "body" | "headers" | "path">> & {
2070
+ initialData: InfiniteData<import("../types.gen").PaginatedSubdomains, number | Pick<Pick<Options<ListSubdomainsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2071
+ _id: string;
2072
+ _infinite?: boolean;
2073
+ tags?: ReadonlyArray<string>;
2074
+ }, "query" | "body" | "headers" | "path">> | (() => InfiniteData<import("../types.gen").PaginatedSubdomains, number | Pick<Pick<Options<ListSubdomainsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2075
+ _id: string;
2076
+ _infinite?: boolean;
2077
+ tags?: ReadonlyArray<string>;
2078
+ }, "query" | "body" | "headers" | "path">>) | undefined;
2079
+ } & {
2080
+ queryKey: QueryKey<Options<ListSubdomainsData>> & {
2081
+ [dataTagSymbol]: InfiniteData<import("../types.gen").PaginatedSubdomains, unknown>;
2082
+ [dataTagErrorSymbol]: import("../types.gen").ErrorResponse;
2083
+ };
2084
+ };
2085
+ /**
2086
+ * Register a customer hostname against a claimed subdomain.
2087
+ */
2088
+ export declare const registerCustomerDomainMutation: (options?: Partial<Options<RegisterCustomerDomainData>>) => UseMutationOptions<RegisterCustomerDomainResponse, RegisterCustomerDomainError, Options<RegisterCustomerDomainData>>;
@@ -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, cloneEnvironment, createApiKey, createBlueprint, createBugReport, createEnvironment, createEnvironmentVariable, createFeatureRequest, createNeonBranch, createNeonDatabase, createNeonProject, createNeonProjectM2M, createNodeCredential, createProject, createSecret, createSecretM2M, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteBlueprint, deleteEnvironment, deleteEnvironmentM2M, deleteEnvironmentVariable, deleteNeonDatabase, deployVersion, fetchGraphM2M, fetchMongoOrganizations, fetchMongoOrganizationTier, fetchMongoRegions, fetchNeonConnectionUri, fetchNeonOrganizations, fetchNeonRegions, fetchNodeM2M, getApiKeys, getBlueprint, getBlueprintM2M, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVariablesM2M, getEnvironmentVersions, getFeatureFlags, getGraphOverview, getNodeEnvironmentVariables, getProjectEnvironments, getProjectOverview, getPublicInvite, getSecretValue, getServiceHealth, getSoftDeletedEnvironmentsM2M, getSpaceInvites, getSpaceM2M, getSpaceOrgCode, getSpaceOverview, getSpaceProperties, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, getVersion, getVersionM2M, importBlueprint, joinSpace, kickSpaceMember, leaveSpace, listInstallationBranches, listInstallationRepositories, listMongoClusters, listMongoProjects, listNeonBranches, listNeonDatabases, listNeonProjects, listNeonRoles, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, lookupApiKey, nukeEnvironmentM2M, pingNode, previewBlueprint, recordOnboardingAnalytics, rejectSpaceInvite, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeApiKey, revokeSpaceInvite, setEnvironmentGcpProjectId, setSpaceProperty, updateBlueprint, updateConnectedAppToken, updateDeploymentStatusM2M, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateUsername, updateUserProfile, viewBlueprints, viewBlueprintsM2M } from '../sdk.gen';
4
+ import { checkSubdomainUniqueness, cloneEnvironment, createApiKey, createBlueprint, createBugReport, createEnvironment, createEnvironmentVariable, createFeatureRequest, createNeonBranch, createNeonDatabase, createNeonProject, createNeonProjectM2M, createNodeCredential, createProject, createSecret, createSecretM2M, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteBlueprint, deleteEnvironment, deleteEnvironmentM2M, deleteEnvironmentVariable, deleteNeonDatabase, deployVersion, fetchGraphM2M, fetchMongoOrganizations, fetchMongoOrganizationTier, fetchMongoRegions, fetchNeonConnectionUri, fetchNeonOrganizations, fetchNeonRegions, fetchNodeM2M, getApiKeys, getBlueprint, getBlueprintM2M, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVariablesM2M, getEnvironmentVersions, getFeatureFlags, getGraphOverview, getNodeEnvironmentVariables, getProjectEnvironments, getProjectOverview, getPublicInvite, getSecretValue, getServiceHealth, getSoftDeletedEnvironmentsM2M, getSpaceInvites, getSpaceM2M, getSpaceOrgCode, getSpaceOverview, getSpaceProperties, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, getVersion, getVersionM2M, importBlueprint, joinSpace, kickSpaceMember, leaveSpace, listInstallationBranches, listInstallationRepositories, listMongoClusters, listMongoProjects, listNeonBranches, listNeonDatabases, listNeonProjects, listNeonRoles, listSpaceMemberRoles, listSpaceMembers, listSubdomains, listUserInstallations, listUserSpaces, lookupApiKey, nukeEnvironmentM2M, pingNode, previewBlueprint, recordOnboardingAnalytics, registerCustomerDomain, rejectSpaceInvite, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeApiKey, revokeSpaceInvite, setEnvironmentGcpProjectId, setSpaceProperty, 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) {
@@ -2131,3 +2131,64 @@ export const setSpacePropertyMutation = (options) => {
2131
2131
  };
2132
2132
  return mutationOptions;
2133
2133
  };
2134
+ export const listSubdomainsQueryKey = (options) => createQueryKey('listSubdomains', options);
2135
+ /**
2136
+ * List the shoal subdomains claimed by this space.
2137
+ */
2138
+ export const listSubdomainsOptions = (options) => {
2139
+ return queryOptions({
2140
+ queryFn: async ({ queryKey, signal }) => {
2141
+ const { data } = await listSubdomains({
2142
+ ...options,
2143
+ ...queryKey[0],
2144
+ signal,
2145
+ throwOnError: true
2146
+ });
2147
+ return data;
2148
+ },
2149
+ queryKey: listSubdomainsQueryKey(options)
2150
+ });
2151
+ };
2152
+ export const listSubdomainsInfiniteQueryKey = (options) => createQueryKey('listSubdomains', options, true);
2153
+ /**
2154
+ * List the shoal subdomains claimed by this space.
2155
+ */
2156
+ export const listSubdomainsInfiniteOptions = (options) => {
2157
+ return infiniteQueryOptions(
2158
+ // @ts-ignore
2159
+ {
2160
+ queryFn: async ({ pageParam, queryKey, signal }) => {
2161
+ // @ts-ignore
2162
+ const page = typeof pageParam === 'object' ? pageParam : {
2163
+ query: {
2164
+ page: pageParam
2165
+ }
2166
+ };
2167
+ const params = createInfiniteParams(queryKey, page);
2168
+ const { data } = await listSubdomains({
2169
+ ...options,
2170
+ ...params,
2171
+ signal,
2172
+ throwOnError: true
2173
+ });
2174
+ return data;
2175
+ },
2176
+ queryKey: listSubdomainsInfiniteQueryKey(options)
2177
+ });
2178
+ };
2179
+ /**
2180
+ * Register a customer hostname against a claimed subdomain.
2181
+ */
2182
+ export const registerCustomerDomainMutation = (options) => {
2183
+ const mutationOptions = {
2184
+ mutationFn: async (fnOptions) => {
2185
+ const { data } = await registerCustomerDomain({
2186
+ ...options,
2187
+ ...fnOptions,
2188
+ throwOnError: true
2189
+ });
2190
+ return data;
2191
+ }
2192
+ };
2193
+ return mutationOptions;
2194
+ };
@@ -1,5 +1,5 @@
1
1
  import type { Client, Options as Options2, TDataShape } from './client';
2
- import type { CheckSubdomainUniquenessData, CheckSubdomainUniquenessErrors, CheckSubdomainUniquenessResponses, CloneEnvironmentData, CloneEnvironmentErrors, CloneEnvironmentResponses, CreateApiKeyData, CreateApiKeyErrors, CreateApiKeyResponses, CreateBlueprintData, CreateBlueprintErrors, CreateBlueprintResponses, CreateBugReportData, CreateBugReportErrors, CreateBugReportResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateFeatureRequestData, CreateFeatureRequestErrors, CreateFeatureRequestResponses, CreateNeonBranchData, CreateNeonBranchErrors, CreateNeonBranchResponses, CreateNeonDatabaseData, CreateNeonDatabaseErrors, CreateNeonDatabaseResponses, CreateNeonProjectData, CreateNeonProjectErrors, CreateNeonProjectM2mData, CreateNeonProjectM2mErrors, CreateNeonProjectM2mResponses, CreateNeonProjectResponses, CreateNodeCredentialData, CreateNodeCredentialErrors, CreateNodeCredentialResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSecretData, CreateSecretErrors, CreateSecretM2mData, CreateSecretM2mErrors, CreateSecretM2mResponses, CreateSecretResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteBlueprintData, DeleteBlueprintErrors, DeleteBlueprintResponses, DeleteEnvironmentData, DeleteEnvironmentErrors, DeleteEnvironmentM2mData, DeleteEnvironmentM2mErrors, DeleteEnvironmentM2mResponses, DeleteEnvironmentResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeleteNeonDatabaseData, DeleteNeonDatabaseErrors, DeleteNeonDatabaseResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchMongoOrganizationsData, FetchMongoOrganizationsErrors, FetchMongoOrganizationsResponses, FetchMongoOrganizationTierData, FetchMongoOrganizationTierErrors, FetchMongoOrganizationTierResponses, FetchMongoRegionsData, FetchMongoRegionsErrors, FetchMongoRegionsResponses, FetchNeonConnectionUriData, FetchNeonConnectionUriErrors, FetchNeonConnectionUriResponses, FetchNeonOrganizationsData, FetchNeonOrganizationsErrors, FetchNeonOrganizationsResponses, FetchNeonRegionsData, FetchNeonRegionsErrors, FetchNeonRegionsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetApiKeysData, GetApiKeysErrors, GetApiKeysResponses, GetBlueprintData, GetBlueprintErrors, GetBlueprintM2mData, GetBlueprintM2mErrors, GetBlueprintM2mResponses, GetBlueprintResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetEnvironmentVariablesData, GetEnvironmentVariablesErrors, GetEnvironmentVariablesM2mData, GetEnvironmentVariablesM2mErrors, GetEnvironmentVariablesM2mResponses, GetEnvironmentVariablesResponses, GetEnvironmentVersionsData, GetEnvironmentVersionsResponses, GetFeatureFlagsData, GetFeatureFlagsErrors, GetFeatureFlagsResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetNodeEnvironmentVariablesData, GetNodeEnvironmentVariablesErrors, GetNodeEnvironmentVariablesResponses, GetProjectEnvironmentsData, GetProjectEnvironmentsErrors, GetProjectEnvironmentsResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetPublicInviteData, GetPublicInviteErrors, GetPublicInviteResponses, GetSecretValueData, GetSecretValueErrors, GetSecretValueResponses, GetServiceHealthData, GetServiceHealthResponses, GetSoftDeletedEnvironmentsM2mData, GetSoftDeletedEnvironmentsM2mErrors, GetSoftDeletedEnvironmentsM2mResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceM2mData, GetSpaceM2mErrors, GetSpaceM2mResponses, 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, KickSpaceMemberData, KickSpaceMemberErrors, KickSpaceMemberResponses, LeaveSpaceData, LeaveSpaceErrors, LeaveSpaceResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListMongoClustersData, ListMongoClustersErrors, ListMongoClustersResponses, ListMongoProjectsData, ListMongoProjectsErrors, ListMongoProjectsResponses, ListNeonBranchesData, ListNeonBranchesErrors, ListNeonBranchesResponses, ListNeonDatabasesData, ListNeonDatabasesErrors, ListNeonDatabasesResponses, ListNeonProjectsData, ListNeonProjectsErrors, ListNeonProjectsResponses, ListNeonRolesData, ListNeonRolesErrors, ListNeonRolesResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, LookupApiKeyData, LookupApiKeyErrors, LookupApiKeyResponses, NukeEnvironmentM2mData, NukeEnvironmentM2mErrors, NukeEnvironmentM2mResponses, PingNodeData, PingNodeErrors, PingNodeResponses, PreviewBlueprintData, PreviewBlueprintErrors, PreviewBlueprintResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsErrors, RecordOnboardingAnalyticsResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedDownloadUrlData, RequestSignedDownloadUrlErrors, RequestSignedDownloadUrlResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeApiKeyData, RevokeApiKeyErrors, RevokeApiKeyResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdErrors, SetEnvironmentGcpProjectIdResponses, SetSpacePropertyData, SetSpacePropertyErrors, SetSpacePropertyResponses, 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, CloneEnvironmentData, CloneEnvironmentErrors, CloneEnvironmentResponses, CreateApiKeyData, CreateApiKeyErrors, CreateApiKeyResponses, CreateBlueprintData, CreateBlueprintErrors, CreateBlueprintResponses, CreateBugReportData, CreateBugReportErrors, CreateBugReportResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateFeatureRequestData, CreateFeatureRequestErrors, CreateFeatureRequestResponses, CreateNeonBranchData, CreateNeonBranchErrors, CreateNeonBranchResponses, CreateNeonDatabaseData, CreateNeonDatabaseErrors, CreateNeonDatabaseResponses, CreateNeonProjectData, CreateNeonProjectErrors, CreateNeonProjectM2mData, CreateNeonProjectM2mErrors, CreateNeonProjectM2mResponses, CreateNeonProjectResponses, CreateNodeCredentialData, CreateNodeCredentialErrors, CreateNodeCredentialResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSecretData, CreateSecretErrors, CreateSecretM2mData, CreateSecretM2mErrors, CreateSecretM2mResponses, CreateSecretResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteBlueprintData, DeleteBlueprintErrors, DeleteBlueprintResponses, DeleteEnvironmentData, DeleteEnvironmentErrors, DeleteEnvironmentM2mData, DeleteEnvironmentM2mErrors, DeleteEnvironmentM2mResponses, DeleteEnvironmentResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeleteNeonDatabaseData, DeleteNeonDatabaseErrors, DeleteNeonDatabaseResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchMongoOrganizationsData, FetchMongoOrganizationsErrors, FetchMongoOrganizationsResponses, FetchMongoOrganizationTierData, FetchMongoOrganizationTierErrors, FetchMongoOrganizationTierResponses, FetchMongoRegionsData, FetchMongoRegionsErrors, FetchMongoRegionsResponses, FetchNeonConnectionUriData, FetchNeonConnectionUriErrors, FetchNeonConnectionUriResponses, FetchNeonOrganizationsData, FetchNeonOrganizationsErrors, FetchNeonOrganizationsResponses, FetchNeonRegionsData, FetchNeonRegionsErrors, FetchNeonRegionsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetApiKeysData, GetApiKeysErrors, GetApiKeysResponses, GetBlueprintData, GetBlueprintErrors, GetBlueprintM2mData, GetBlueprintM2mErrors, GetBlueprintM2mResponses, GetBlueprintResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetEnvironmentVariablesData, GetEnvironmentVariablesErrors, GetEnvironmentVariablesM2mData, GetEnvironmentVariablesM2mErrors, GetEnvironmentVariablesM2mResponses, GetEnvironmentVariablesResponses, GetEnvironmentVersionsData, GetEnvironmentVersionsResponses, GetFeatureFlagsData, GetFeatureFlagsErrors, GetFeatureFlagsResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetNodeEnvironmentVariablesData, GetNodeEnvironmentVariablesErrors, GetNodeEnvironmentVariablesResponses, GetProjectEnvironmentsData, GetProjectEnvironmentsErrors, GetProjectEnvironmentsResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetPublicInviteData, GetPublicInviteErrors, GetPublicInviteResponses, GetSecretValueData, GetSecretValueErrors, GetSecretValueResponses, GetServiceHealthData, GetServiceHealthResponses, GetSoftDeletedEnvironmentsM2mData, GetSoftDeletedEnvironmentsM2mErrors, GetSoftDeletedEnvironmentsM2mResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceM2mData, GetSpaceM2mErrors, GetSpaceM2mResponses, 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, KickSpaceMemberData, KickSpaceMemberErrors, KickSpaceMemberResponses, LeaveSpaceData, LeaveSpaceErrors, LeaveSpaceResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListMongoClustersData, ListMongoClustersErrors, ListMongoClustersResponses, ListMongoProjectsData, ListMongoProjectsErrors, ListMongoProjectsResponses, ListNeonBranchesData, ListNeonBranchesErrors, ListNeonBranchesResponses, ListNeonDatabasesData, ListNeonDatabasesErrors, ListNeonDatabasesResponses, ListNeonProjectsData, ListNeonProjectsErrors, ListNeonProjectsResponses, ListNeonRolesData, ListNeonRolesErrors, ListNeonRolesResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListSubdomainsData, ListSubdomainsErrors, ListSubdomainsResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, LookupApiKeyData, LookupApiKeyErrors, LookupApiKeyResponses, NukeEnvironmentM2mData, NukeEnvironmentM2mErrors, NukeEnvironmentM2mResponses, PingNodeData, PingNodeErrors, PingNodeResponses, PreviewBlueprintData, PreviewBlueprintErrors, PreviewBlueprintResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsErrors, RecordOnboardingAnalyticsResponses, RegisterCustomerDomainData, RegisterCustomerDomainErrors, RegisterCustomerDomainResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedDownloadUrlData, RequestSignedDownloadUrlErrors, RequestSignedDownloadUrlResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeApiKeyData, RevokeApiKeyErrors, RevokeApiKeyResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdErrors, SetEnvironmentGcpProjectIdResponses, SetSpacePropertyData, SetSpacePropertyErrors, SetSpacePropertyResponses, 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
@@ -403,3 +403,11 @@ export declare const getSpaceProperties: <ThrowOnError extends boolean = false>(
403
403
  * Set a space property on the space in Kinde.
404
404
  */
405
405
  export declare const setSpaceProperty: <ThrowOnError extends boolean = false>(options: Options<SetSpacePropertyData, ThrowOnError>) => import("./client").RequestResult<SetSpacePropertyResponses, SetSpacePropertyErrors, ThrowOnError, "fields">;
406
+ /**
407
+ * List the shoal subdomains claimed by this space.
408
+ */
409
+ export declare const listSubdomains: <ThrowOnError extends boolean = false>(options: Options<ListSubdomainsData, ThrowOnError>) => import("./client").RequestResult<ListSubdomainsResponses, ListSubdomainsErrors, ThrowOnError, "fields">;
410
+ /**
411
+ * Register a customer hostname against a claimed subdomain.
412
+ */
413
+ export declare const registerCustomerDomain: <ThrowOnError extends boolean = false>(options: Options<RegisterCustomerDomainData, ThrowOnError>) => import("./client").RequestResult<RegisterCustomerDomainResponses, RegisterCustomerDomainErrors, ThrowOnError, "fields">;
@@ -2002,3 +2002,45 @@ export const setSpaceProperty = (options) => {
2002
2002
  }
2003
2003
  });
2004
2004
  };
2005
+ /**
2006
+ * List the shoal subdomains claimed by this space.
2007
+ */
2008
+ export const listSubdomains = (options) => {
2009
+ return (options.client ?? client).get({
2010
+ security: [
2011
+ {
2012
+ scheme: 'bearer',
2013
+ type: 'http'
2014
+ },
2015
+ {
2016
+ name: 'X-Api-Key',
2017
+ type: 'apiKey'
2018
+ }
2019
+ ],
2020
+ url: '/auth/{spaceHandle}/subdomains',
2021
+ ...options
2022
+ });
2023
+ };
2024
+ /**
2025
+ * Register a customer hostname against a claimed subdomain.
2026
+ */
2027
+ export const registerCustomerDomain = (options) => {
2028
+ return (options.client ?? client).post({
2029
+ security: [
2030
+ {
2031
+ scheme: 'bearer',
2032
+ type: 'http'
2033
+ },
2034
+ {
2035
+ name: 'X-Api-Key',
2036
+ type: 'apiKey'
2037
+ }
2038
+ ],
2039
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/domains',
2040
+ ...options,
2041
+ headers: {
2042
+ 'Content-Type': 'application/json',
2043
+ ...options.headers
2044
+ }
2045
+ });
2046
+ };
@@ -84,7 +84,7 @@ export type SecretValue = {
84
84
  value: string;
85
85
  version: string;
86
86
  };
87
- export type ErrorCode = 'UNKNOWN_ERROR' | 'AUTHORISATION_ERROR' | 'CONTENT_NOT_FOUND' | 'INVALID_PAGINATION' | 'INVALID_REQUEST_BODY' | 'INVALID_PATH_PARAM' | 'MISSING_CONTEXT_VALUE' | 'CONSTRAINT_ERROR' | 'PROJECT_CREATION_ERROR' | 'INVALID_QUERY_PARAM' | 'EXPIRED' | 'IDENTITY_NOT_FOUND' | 'NODE_TYPE_DISABLED';
87
+ export type ErrorCode = 'UNKNOWN_ERROR' | 'AUTHORISATION_ERROR' | 'CONTENT_NOT_FOUND' | 'INVALID_PAGINATION' | 'INVALID_REQUEST_BODY' | 'INVALID_PATH_PARAM' | 'MISSING_CONTEXT_VALUE' | 'CONSTRAINT_ERROR' | 'PROJECT_CREATION_ERROR' | 'INVALID_QUERY_PARAM' | 'EXPIRED' | 'IDENTITY_NOT_FOUND' | 'NODE_TYPE_DISABLED' | 'NOT_ALLOWED';
88
88
  export type ErrorResponse = {
89
89
  message: string;
90
90
  internalCode: ErrorCode;
@@ -1010,6 +1010,71 @@ export type CreateNeonDatabase = {
1010
1010
  name: string;
1011
1011
  owner_name: string;
1012
1012
  };
1013
+ /**
1014
+ * Lifecycle state of a registered customer hostname, passed through from the proxy binder.
1015
+ * One of `pending_dns` (the required DNS records have not been observed yet), `active` (a
1016
+ * certificate is installed and traffic is served), `failed` (reconciliation exhausted its
1017
+ * retries) or `unspecified`. Not modelled as an enum because the generated constants would
1018
+ * collide with the environment and deployment status enums in the same package.
1019
+ *
1020
+ */
1021
+ export type CustomerDomainStatus = string;
1022
+ /**
1023
+ * A DNS record the customer must publish in their own zone.
1024
+ */
1025
+ export type CustomerDomainRecord = {
1026
+ type: string;
1027
+ name: string;
1028
+ value: string;
1029
+ };
1030
+ /**
1031
+ * A customer owned hostname fronted by a shoal subdomain. Registration only starts the
1032
+ * process; the hostname stays `pending_dns` until the records below resolve and a
1033
+ * certificate is issued.
1034
+ *
1035
+ */
1036
+ export type CustomerDomain = {
1037
+ hostname: string;
1038
+ /**
1039
+ * Subdomain the hostname is fronted by, and the CNAME target.
1040
+ */
1041
+ fqdn: string;
1042
+ status: CustomerDomainStatus;
1043
+ records: Array<CustomerDomainRecord>;
1044
+ };
1045
+ export type RegisterCustomerDomain = {
1046
+ /**
1047
+ * Label of the claimed shoal subdomain the hostname is fronted by.
1048
+ */
1049
+ subdomain: string;
1050
+ /**
1051
+ * Customer owned hostname, normalised by the proxy binder before use.
1052
+ */
1053
+ hostname: string;
1054
+ };
1055
+ export type SubdomainPath = {
1056
+ path: string;
1057
+ scheme: string;
1058
+ host: string;
1059
+ port: number;
1060
+ rewrite?: string;
1061
+ upstream: string;
1062
+ };
1063
+ export type Subdomain = {
1064
+ label: string;
1065
+ project: string;
1066
+ environment: string;
1067
+ /**
1068
+ * Graph node the subdomain is bound to.
1069
+ */
1070
+ gatewayId: string;
1071
+ createdAt: string;
1072
+ paths: Array<SubdomainPath>;
1073
+ customerDomain?: CustomerDomain;
1074
+ };
1075
+ export type PaginatedSubdomains = Pagination & {
1076
+ subdomains: Array<Subdomain>;
1077
+ };
1013
1078
  /**
1014
1079
  * Clients known etag of the version.
1015
1080
  */
@@ -1229,7 +1294,7 @@ export type SessionId = string;
1229
1294
  /**
1230
1295
  * The proxy subdomain to check for uniqueness.
1231
1296
  */
1232
- export type Subdomain = string;
1297
+ export type Subdomain2 = string;
1233
1298
  /**
1234
1299
  * Connected app key reference code.
1235
1300
  */
@@ -5576,3 +5641,102 @@ export type SetSpacePropertyResponses = {
5576
5641
  */
5577
5642
  202: unknown;
5578
5643
  };
5644
+ export type ListSubdomainsData = {
5645
+ body?: never;
5646
+ path: {
5647
+ /**
5648
+ * The space handle. This must be globally unique.
5649
+ */
5650
+ spaceHandle: string;
5651
+ };
5652
+ query?: {
5653
+ /**
5654
+ * Page number (1-based).
5655
+ */
5656
+ page?: number;
5657
+ /**
5658
+ * Page size (max 100).
5659
+ */
5660
+ limit?: number;
5661
+ };
5662
+ url: '/auth/{spaceHandle}/subdomains';
5663
+ };
5664
+ export type ListSubdomainsErrors = {
5665
+ /**
5666
+ * Invalid pagination.
5667
+ */
5668
+ 400: ErrorResponse;
5669
+ /**
5670
+ * Unauthorised user.
5671
+ */
5672
+ 401: ErrorResponse;
5673
+ /**
5674
+ * Invalid credentials.
5675
+ */
5676
+ 403: ErrorResponse;
5677
+ /**
5678
+ * Unexpected error.
5679
+ */
5680
+ 500: ErrorResponse;
5681
+ };
5682
+ export type ListSubdomainsError = ListSubdomainsErrors[keyof ListSubdomainsErrors];
5683
+ export type ListSubdomainsResponses = {
5684
+ /**
5685
+ * A page of subdomains.
5686
+ */
5687
+ 200: PaginatedSubdomains;
5688
+ };
5689
+ export type ListSubdomainsResponse = ListSubdomainsResponses[keyof ListSubdomainsResponses];
5690
+ export type RegisterCustomerDomainData = {
5691
+ body: RegisterCustomerDomain;
5692
+ path: {
5693
+ /**
5694
+ * The space handle. This must be globally unique.
5695
+ */
5696
+ spaceHandle: string;
5697
+ /**
5698
+ * A project name. This must be unique to a space.
5699
+ */
5700
+ projectHandle: string;
5701
+ /**
5702
+ * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
5703
+ */
5704
+ environmentHandle: string;
5705
+ };
5706
+ query?: never;
5707
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/domains';
5708
+ };
5709
+ export type RegisterCustomerDomainErrors = {
5710
+ /**
5711
+ * Invalid request body.
5712
+ */
5713
+ 400: ErrorResponse;
5714
+ /**
5715
+ * Unauthorised user.
5716
+ */
5717
+ 401: ErrorResponse;
5718
+ /**
5719
+ * Invalid credentials.
5720
+ */
5721
+ 403: ErrorResponse;
5722
+ /**
5723
+ * No such subdomain is claimed by this space.
5724
+ */
5725
+ 404: ErrorResponse;
5726
+ /**
5727
+ * The hostname is already registered.
5728
+ */
5729
+ 409: ErrorResponse;
5730
+ /**
5731
+ * Unexpected error.
5732
+ */
5733
+ 500: ErrorResponse;
5734
+ };
5735
+ export type RegisterCustomerDomainError = RegisterCustomerDomainErrors[keyof RegisterCustomerDomainErrors];
5736
+ export type RegisterCustomerDomainResponses = {
5737
+ /**
5738
+ * The hostname was registered and is awaiting DNS verification.
5739
+ */
5740
+ 201: CustomerDomain;
5741
+ };
5742
+ export type RegisterCustomerDomainResponse = RegisterCustomerDomainResponses[keyof RegisterCustomerDomainResponses];
@@ -105,6 +105,7 @@ export declare const zErrorCode: z.ZodEnum<{
105
105
  EXPIRED: "EXPIRED";
106
106
  IDENTITY_NOT_FOUND: "IDENTITY_NOT_FOUND";
107
107
  NODE_TYPE_DISABLED: "NODE_TYPE_DISABLED";
108
+ NOT_ALLOWED: "NOT_ALLOWED";
108
109
  }>;
109
110
  export declare const zErrorResponse: z.ZodObject<{
110
111
  message: z.ZodString;
@@ -122,6 +123,7 @@ export declare const zErrorResponse: z.ZodObject<{
122
123
  EXPIRED: "EXPIRED";
123
124
  IDENTITY_NOT_FOUND: "IDENTITY_NOT_FOUND";
124
125
  NODE_TYPE_DISABLED: "NODE_TYPE_DISABLED";
126
+ NOT_ALLOWED: "NOT_ALLOWED";
125
127
  }>;
126
128
  }, z.core.$strip>;
127
129
  export declare const zNeonOrganization: z.ZodObject<{
@@ -2456,6 +2458,107 @@ export declare const zCreateNeonDatabase: z.ZodObject<{
2456
2458
  name: z.ZodString;
2457
2459
  owner_name: z.ZodString;
2458
2460
  }, z.core.$strip>;
2461
+ /**
2462
+ * Lifecycle state of a registered customer hostname, passed through from the proxy binder.
2463
+ * One of `pending_dns` (the required DNS records have not been observed yet), `active` (a
2464
+ * certificate is installed and traffic is served), `failed` (reconciliation exhausted its
2465
+ * retries) or `unspecified`. Not modelled as an enum because the generated constants would
2466
+ * collide with the environment and deployment status enums in the same package.
2467
+ *
2468
+ */
2469
+ export declare const zCustomerDomainStatus: z.ZodString;
2470
+ /**
2471
+ * A DNS record the customer must publish in their own zone.
2472
+ */
2473
+ export declare const zCustomerDomainRecord: z.ZodObject<{
2474
+ type: z.ZodString;
2475
+ name: z.ZodString;
2476
+ value: z.ZodString;
2477
+ }, z.core.$strip>;
2478
+ /**
2479
+ * A customer owned hostname fronted by a shoal subdomain. Registration only starts the
2480
+ * process; the hostname stays `pending_dns` until the records below resolve and a
2481
+ * certificate is issued.
2482
+ *
2483
+ */
2484
+ export declare const zCustomerDomain: z.ZodObject<{
2485
+ hostname: z.ZodString;
2486
+ fqdn: z.ZodString;
2487
+ status: z.ZodString;
2488
+ records: z.ZodArray<z.ZodObject<{
2489
+ type: z.ZodString;
2490
+ name: z.ZodString;
2491
+ value: z.ZodString;
2492
+ }, z.core.$strip>>;
2493
+ }, z.core.$strip>;
2494
+ export declare const zRegisterCustomerDomain: z.ZodObject<{
2495
+ subdomain: z.ZodString;
2496
+ hostname: z.ZodString;
2497
+ }, z.core.$strip>;
2498
+ export declare const zSubdomainPath: z.ZodObject<{
2499
+ path: z.ZodString;
2500
+ scheme: z.ZodString;
2501
+ host: z.ZodString;
2502
+ port: z.ZodInt;
2503
+ rewrite: z.ZodOptional<z.ZodString>;
2504
+ upstream: z.ZodString;
2505
+ }, z.core.$strip>;
2506
+ export declare const zSubdomain: z.ZodObject<{
2507
+ label: z.ZodString;
2508
+ project: z.ZodString;
2509
+ environment: z.ZodString;
2510
+ gatewayId: z.ZodString;
2511
+ createdAt: z.ZodISODateTime;
2512
+ paths: z.ZodArray<z.ZodObject<{
2513
+ path: z.ZodString;
2514
+ scheme: z.ZodString;
2515
+ host: z.ZodString;
2516
+ port: z.ZodInt;
2517
+ rewrite: z.ZodOptional<z.ZodString>;
2518
+ upstream: z.ZodString;
2519
+ }, z.core.$strip>>;
2520
+ customerDomain: z.ZodOptional<z.ZodObject<{
2521
+ hostname: z.ZodString;
2522
+ fqdn: z.ZodString;
2523
+ status: z.ZodString;
2524
+ records: z.ZodArray<z.ZodObject<{
2525
+ type: z.ZodString;
2526
+ name: z.ZodString;
2527
+ value: z.ZodString;
2528
+ }, z.core.$strip>>;
2529
+ }, z.core.$strip>>;
2530
+ }, z.core.$strip>;
2531
+ export declare const zPaginatedSubdomains: z.ZodIntersection<z.ZodObject<{
2532
+ page: z.ZodInt;
2533
+ limit: z.ZodInt;
2534
+ total: z.ZodInt;
2535
+ }, z.core.$strip>, z.ZodObject<{
2536
+ subdomains: z.ZodArray<z.ZodObject<{
2537
+ label: z.ZodString;
2538
+ project: z.ZodString;
2539
+ environment: z.ZodString;
2540
+ gatewayId: z.ZodString;
2541
+ createdAt: z.ZodISODateTime;
2542
+ paths: z.ZodArray<z.ZodObject<{
2543
+ path: z.ZodString;
2544
+ scheme: z.ZodString;
2545
+ host: z.ZodString;
2546
+ port: z.ZodInt;
2547
+ rewrite: z.ZodOptional<z.ZodString>;
2548
+ upstream: z.ZodString;
2549
+ }, z.core.$strip>>;
2550
+ customerDomain: z.ZodOptional<z.ZodObject<{
2551
+ hostname: z.ZodString;
2552
+ fqdn: z.ZodString;
2553
+ status: z.ZodString;
2554
+ records: z.ZodArray<z.ZodObject<{
2555
+ type: z.ZodString;
2556
+ name: z.ZodString;
2557
+ value: z.ZodString;
2558
+ }, z.core.$strip>>;
2559
+ }, z.core.$strip>>;
2560
+ }, z.core.$strip>>;
2561
+ }, z.core.$strip>>;
2459
2562
  /**
2460
2563
  * Clients known etag of the version.
2461
2564
  */
@@ -2698,7 +2801,7 @@ export declare const zSessionId: z.ZodString;
2698
2801
  /**
2699
2802
  * The proxy subdomain to check for uniqueness.
2700
2803
  */
2701
- export declare const zSubdomain: z.ZodString;
2804
+ export declare const zSubdomain2: z.ZodString;
2702
2805
  /**
2703
2806
  * Connected app key reference code.
2704
2807
  */
@@ -6970,3 +7073,72 @@ export declare const zSetSpacePropertyData: z.ZodObject<{
6970
7073
  }, z.core.$strip>;
6971
7074
  query: z.ZodOptional<z.ZodNever>;
6972
7075
  }, z.core.$strip>;
7076
+ export declare const zListSubdomainsData: z.ZodObject<{
7077
+ body: z.ZodOptional<z.ZodNever>;
7078
+ path: z.ZodObject<{
7079
+ spaceHandle: z.ZodString;
7080
+ }, z.core.$strip>;
7081
+ query: z.ZodOptional<z.ZodObject<{
7082
+ page: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
7083
+ limit: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
7084
+ }, z.core.$strip>>;
7085
+ }, z.core.$strip>;
7086
+ /**
7087
+ * A page of subdomains.
7088
+ */
7089
+ export declare const zListSubdomainsResponse: z.ZodIntersection<z.ZodObject<{
7090
+ page: z.ZodInt;
7091
+ limit: z.ZodInt;
7092
+ total: z.ZodInt;
7093
+ }, z.core.$strip>, z.ZodObject<{
7094
+ subdomains: z.ZodArray<z.ZodObject<{
7095
+ label: z.ZodString;
7096
+ project: z.ZodString;
7097
+ environment: z.ZodString;
7098
+ gatewayId: z.ZodString;
7099
+ createdAt: z.ZodISODateTime;
7100
+ paths: z.ZodArray<z.ZodObject<{
7101
+ path: z.ZodString;
7102
+ scheme: z.ZodString;
7103
+ host: z.ZodString;
7104
+ port: z.ZodInt;
7105
+ rewrite: z.ZodOptional<z.ZodString>;
7106
+ upstream: z.ZodString;
7107
+ }, z.core.$strip>>;
7108
+ customerDomain: z.ZodOptional<z.ZodObject<{
7109
+ hostname: z.ZodString;
7110
+ fqdn: z.ZodString;
7111
+ status: z.ZodString;
7112
+ records: z.ZodArray<z.ZodObject<{
7113
+ type: z.ZodString;
7114
+ name: z.ZodString;
7115
+ value: z.ZodString;
7116
+ }, z.core.$strip>>;
7117
+ }, z.core.$strip>>;
7118
+ }, z.core.$strip>>;
7119
+ }, z.core.$strip>>;
7120
+ export declare const zRegisterCustomerDomainData: z.ZodObject<{
7121
+ body: z.ZodObject<{
7122
+ subdomain: z.ZodString;
7123
+ hostname: z.ZodString;
7124
+ }, z.core.$strip>;
7125
+ path: z.ZodObject<{
7126
+ spaceHandle: z.ZodString;
7127
+ projectHandle: z.ZodString;
7128
+ environmentHandle: z.ZodString;
7129
+ }, z.core.$strip>;
7130
+ query: z.ZodOptional<z.ZodNever>;
7131
+ }, z.core.$strip>;
7132
+ /**
7133
+ * The hostname was registered and is awaiting DNS verification.
7134
+ */
7135
+ export declare const zRegisterCustomerDomainResponse: z.ZodObject<{
7136
+ hostname: z.ZodString;
7137
+ fqdn: z.ZodString;
7138
+ status: z.ZodString;
7139
+ records: z.ZodArray<z.ZodObject<{
7140
+ type: z.ZodString;
7141
+ name: z.ZodString;
7142
+ value: z.ZodString;
7143
+ }, z.core.$strip>>;
7144
+ }, z.core.$strip>;
@@ -97,7 +97,8 @@ export const zErrorCode = z.enum([
97
97
  'INVALID_QUERY_PARAM',
98
98
  'EXPIRED',
99
99
  'IDENTITY_NOT_FOUND',
100
- 'NODE_TYPE_DISABLED'
100
+ 'NODE_TYPE_DISABLED',
101
+ 'NOT_ALLOWED'
101
102
  ]);
102
103
  export const zErrorResponse = z.object({
103
104
  message: z.string(),
@@ -976,6 +977,59 @@ export const zCreateNeonDatabase = z.object({
976
977
  name: z.string(),
977
978
  owner_name: z.string()
978
979
  });
980
+ /**
981
+ * Lifecycle state of a registered customer hostname, passed through from the proxy binder.
982
+ * One of `pending_dns` (the required DNS records have not been observed yet), `active` (a
983
+ * certificate is installed and traffic is served), `failed` (reconciliation exhausted its
984
+ * retries) or `unspecified`. Not modelled as an enum because the generated constants would
985
+ * collide with the environment and deployment status enums in the same package.
986
+ *
987
+ */
988
+ export const zCustomerDomainStatus = z.string();
989
+ /**
990
+ * A DNS record the customer must publish in their own zone.
991
+ */
992
+ export const zCustomerDomainRecord = z.object({
993
+ type: z.string(),
994
+ name: z.string(),
995
+ value: z.string()
996
+ });
997
+ /**
998
+ * A customer owned hostname fronted by a shoal subdomain. Registration only starts the
999
+ * process; the hostname stays `pending_dns` until the records below resolve and a
1000
+ * certificate is issued.
1001
+ *
1002
+ */
1003
+ export const zCustomerDomain = z.object({
1004
+ hostname: z.string(),
1005
+ fqdn: z.string(),
1006
+ status: zCustomerDomainStatus,
1007
+ records: z.array(zCustomerDomainRecord)
1008
+ });
1009
+ export const zRegisterCustomerDomain = z.object({
1010
+ subdomain: z.string(),
1011
+ hostname: z.string()
1012
+ });
1013
+ export const zSubdomainPath = z.object({
1014
+ path: z.string(),
1015
+ scheme: z.string(),
1016
+ host: z.string(),
1017
+ port: z.int(),
1018
+ rewrite: z.optional(z.string()),
1019
+ upstream: z.string()
1020
+ });
1021
+ export const zSubdomain = z.object({
1022
+ label: z.string(),
1023
+ project: z.string(),
1024
+ environment: z.string(),
1025
+ gatewayId: z.string(),
1026
+ createdAt: z.iso.datetime(),
1027
+ paths: z.array(zSubdomainPath),
1028
+ customerDomain: z.optional(zCustomerDomain)
1029
+ });
1030
+ export const zPaginatedSubdomains = zPagination.and(z.object({
1031
+ subdomains: z.array(zSubdomain)
1032
+ }));
979
1033
  /**
980
1034
  * Clients known etag of the version.
981
1035
  */
@@ -1198,7 +1252,7 @@ export const zSessionId = z.string();
1198
1252
  /**
1199
1253
  * The proxy subdomain to check for uniqueness.
1200
1254
  */
1201
- export const zSubdomain = z.string();
1255
+ export const zSubdomain2 = z.string();
1202
1256
  /**
1203
1257
  * Connected app key reference code.
1204
1258
  */
@@ -2439,3 +2493,30 @@ export const zSetSpacePropertyData = z.object({
2439
2493
  }),
2440
2494
  query: z.optional(z.never())
2441
2495
  });
2496
+ export const zListSubdomainsData = z.object({
2497
+ body: z.optional(z.never()),
2498
+ path: z.object({
2499
+ spaceHandle: z.string()
2500
+ }),
2501
+ query: z.optional(z.object({
2502
+ page: z.optional(z.int().gte(1)).default(1),
2503
+ limit: z.optional(z.int().gte(1).lte(100)).default(10)
2504
+ }))
2505
+ });
2506
+ /**
2507
+ * A page of subdomains.
2508
+ */
2509
+ export const zListSubdomainsResponse = zPaginatedSubdomains;
2510
+ export const zRegisterCustomerDomainData = z.object({
2511
+ body: zRegisterCustomerDomain,
2512
+ path: z.object({
2513
+ spaceHandle: z.string(),
2514
+ projectHandle: z.string(),
2515
+ environmentHandle: z.string()
2516
+ }),
2517
+ query: z.optional(z.never())
2518
+ });
2519
+ /**
2520
+ * The hostname was registered and is awaiting DNS verification.
2521
+ */
2522
+ export const zRegisterCustomerDomainResponse = zCustomerDomain;
@@ -1,6 +1,6 @@
1
1
  import { useMutation } from "@tanstack/react-query";
2
2
  import { GetSuccessResponse } from "../util";
3
- import { GetServiceHealthData, GetSoftDeletedEnvironmentsM2mData, NukeEnvironmentM2mData, NukeEnvironmentM2mResponses, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchGraphM2mData, 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, FetchMongoOrganizationTierData, FetchNeonConnectionUriData, ListNeonProjectsData, CreateNeonProjectData, CreateNeonProjectResponses, ListNeonBranchesData, CreateNeonBranchData, CreateNeonBranchResponses, ListNeonDatabasesData, CreateNeonDatabaseData, CreateNeonDatabaseResponses, ListNeonRolesData, DeleteNeonDatabaseData, DeleteNeonDatabaseResponses, ListUserSpacesData, GetFeatureFlagsData, LookupApiKeyData, CreateFeatureRequestData, CreateFeatureRequestResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, PreviewBlueprintData, ViewBlueprintsData, GetBlueprintData, CreateSpaceData, CreateSpaceResponses, GetPublicInviteData, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, GetSpaceStatsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, GetApiKeysData, CreateApiKeyData, CreateApiKeyResponses, RevokeApiKeyData, RevokeApiKeyResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, KickSpaceMemberData, KickSpaceMemberResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, GetProjectEnvironmentsData, CreateEnvironmentData, CreateEnvironmentResponses, CreateSecretData, CreateSecretResponses, GetSecretValueData, DeleteEnvironmentData, DeleteEnvironmentResponses, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, DeleteBlueprintData, DeleteBlueprintResponses, UpdateBlueprintData, UpdateBlueprintResponses, CreateBlueprintData, CreateBlueprintResponses, GetVersionData, ImportBlueprintData, ImportBlueprintResponses, CloneEnvironmentData, CloneEnvironmentResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedDownloadUrlData, GetNodeEnvironmentVariablesData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, CheckSubdomainUniquenessData, PingNodeData, CreateNodeCredentialData, CreateNodeCredentialResponses, CreateBugReportData, CreateBugReportResponses, GetSpacePropertiesData, SetSpacePropertyData, SetSpacePropertyResponses } from "../../sdk/types.gen";
3
+ import { GetServiceHealthData, GetSoftDeletedEnvironmentsM2mData, NukeEnvironmentM2mData, NukeEnvironmentM2mResponses, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchGraphM2mData, 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, FetchMongoOrganizationTierData, FetchNeonConnectionUriData, ListNeonProjectsData, CreateNeonProjectData, CreateNeonProjectResponses, ListNeonBranchesData, CreateNeonBranchData, CreateNeonBranchResponses, ListNeonDatabasesData, CreateNeonDatabaseData, CreateNeonDatabaseResponses, ListNeonRolesData, DeleteNeonDatabaseData, DeleteNeonDatabaseResponses, ListUserSpacesData, GetFeatureFlagsData, LookupApiKeyData, CreateFeatureRequestData, CreateFeatureRequestResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, PreviewBlueprintData, ViewBlueprintsData, GetBlueprintData, CreateSpaceData, CreateSpaceResponses, GetPublicInviteData, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, GetSpaceStatsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, GetApiKeysData, CreateApiKeyData, CreateApiKeyResponses, RevokeApiKeyData, RevokeApiKeyResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, KickSpaceMemberData, KickSpaceMemberResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, GetProjectEnvironmentsData, CreateEnvironmentData, CreateEnvironmentResponses, CreateSecretData, CreateSecretResponses, GetSecretValueData, DeleteEnvironmentData, DeleteEnvironmentResponses, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, DeleteBlueprintData, DeleteBlueprintResponses, UpdateBlueprintData, UpdateBlueprintResponses, CreateBlueprintData, CreateBlueprintResponses, GetVersionData, ImportBlueprintData, ImportBlueprintResponses, CloneEnvironmentData, CloneEnvironmentResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedDownloadUrlData, GetNodeEnvironmentVariablesData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, CheckSubdomainUniquenessData, PingNodeData, CreateNodeCredentialData, CreateNodeCredentialResponses, CreateBugReportData, CreateBugReportResponses, GetSpacePropertiesData, SetSpacePropertyData, SetSpacePropertyResponses, ListSubdomainsData, RegisterCustomerDomainData, RegisterCustomerDomainResponses } from "../../sdk/types.gen";
4
4
  export declare const useGetServiceHealth: (options?: Omit<GetServiceHealthData, "url"> & {
5
5
  enabled?: boolean;
6
6
  }) => {
@@ -11117,3 +11117,218 @@ export declare const useSetSpaceProperty: (config?: {
11117
11117
  data: unknown;
11118
11118
  headers: Record<string, string>;
11119
11119
  }, unknown, Omit<SetSpacePropertyData, "url">, unknown>;
11120
+ export declare const useListSubdomains: (options: Omit<ListSubdomainsData, "url"> & {
11121
+ enabled?: boolean;
11122
+ }) => {
11123
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11124
+ headers: Record<string, string> | undefined;
11125
+ error: Error;
11126
+ isError: true;
11127
+ isPending: false;
11128
+ isLoading: false;
11129
+ isLoadingError: false;
11130
+ isRefetchError: true;
11131
+ isSuccess: false;
11132
+ isPlaceholderData: false;
11133
+ status: "error";
11134
+ dataUpdatedAt: number;
11135
+ errorUpdatedAt: number;
11136
+ failureCount: number;
11137
+ failureReason: Error | null;
11138
+ errorUpdateCount: number;
11139
+ isFetched: boolean;
11140
+ isFetchedAfterMount: boolean;
11141
+ isFetching: boolean;
11142
+ isInitialLoading: boolean;
11143
+ isPaused: boolean;
11144
+ isRefetching: boolean;
11145
+ isStale: boolean;
11146
+ isEnabled: boolean;
11147
+ refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
11148
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11149
+ headers: Record<string, string>;
11150
+ } | undefined, Error>>;
11151
+ fetchStatus: import("@tanstack/react-query").FetchStatus;
11152
+ promise: Promise<{
11153
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11154
+ headers: Record<string, string>;
11155
+ } | undefined>;
11156
+ } | {
11157
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11158
+ headers: Record<string, string> | undefined;
11159
+ error: null;
11160
+ isError: false;
11161
+ isPending: false;
11162
+ isLoading: false;
11163
+ isLoadingError: false;
11164
+ isRefetchError: false;
11165
+ isSuccess: true;
11166
+ isPlaceholderData: false;
11167
+ status: "success";
11168
+ dataUpdatedAt: number;
11169
+ errorUpdatedAt: number;
11170
+ failureCount: number;
11171
+ failureReason: Error | null;
11172
+ errorUpdateCount: number;
11173
+ isFetched: boolean;
11174
+ isFetchedAfterMount: boolean;
11175
+ isFetching: boolean;
11176
+ isInitialLoading: boolean;
11177
+ isPaused: boolean;
11178
+ isRefetching: boolean;
11179
+ isStale: boolean;
11180
+ isEnabled: boolean;
11181
+ refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
11182
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11183
+ headers: Record<string, string>;
11184
+ } | undefined, Error>>;
11185
+ fetchStatus: import("@tanstack/react-query").FetchStatus;
11186
+ promise: Promise<{
11187
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11188
+ headers: Record<string, string>;
11189
+ } | undefined>;
11190
+ } | {
11191
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11192
+ headers: Record<string, string> | undefined;
11193
+ error: Error;
11194
+ isError: true;
11195
+ isPending: false;
11196
+ isLoading: false;
11197
+ isLoadingError: true;
11198
+ isRefetchError: false;
11199
+ isSuccess: false;
11200
+ isPlaceholderData: false;
11201
+ status: "error";
11202
+ dataUpdatedAt: number;
11203
+ errorUpdatedAt: number;
11204
+ failureCount: number;
11205
+ failureReason: Error | null;
11206
+ errorUpdateCount: number;
11207
+ isFetched: boolean;
11208
+ isFetchedAfterMount: boolean;
11209
+ isFetching: boolean;
11210
+ isInitialLoading: boolean;
11211
+ isPaused: boolean;
11212
+ isRefetching: boolean;
11213
+ isStale: boolean;
11214
+ isEnabled: boolean;
11215
+ refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
11216
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11217
+ headers: Record<string, string>;
11218
+ } | undefined, Error>>;
11219
+ fetchStatus: import("@tanstack/react-query").FetchStatus;
11220
+ promise: Promise<{
11221
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11222
+ headers: Record<string, string>;
11223
+ } | undefined>;
11224
+ } | {
11225
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11226
+ headers: Record<string, string> | undefined;
11227
+ error: null;
11228
+ isError: false;
11229
+ isPending: true;
11230
+ isLoading: true;
11231
+ isLoadingError: false;
11232
+ isRefetchError: false;
11233
+ isSuccess: false;
11234
+ isPlaceholderData: false;
11235
+ status: "pending";
11236
+ dataUpdatedAt: number;
11237
+ errorUpdatedAt: number;
11238
+ failureCount: number;
11239
+ failureReason: Error | null;
11240
+ errorUpdateCount: number;
11241
+ isFetched: boolean;
11242
+ isFetchedAfterMount: boolean;
11243
+ isFetching: boolean;
11244
+ isInitialLoading: boolean;
11245
+ isPaused: boolean;
11246
+ isRefetching: boolean;
11247
+ isStale: boolean;
11248
+ isEnabled: boolean;
11249
+ refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
11250
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11251
+ headers: Record<string, string>;
11252
+ } | undefined, Error>>;
11253
+ fetchStatus: import("@tanstack/react-query").FetchStatus;
11254
+ promise: Promise<{
11255
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11256
+ headers: Record<string, string>;
11257
+ } | undefined>;
11258
+ } | {
11259
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11260
+ headers: Record<string, string> | undefined;
11261
+ error: null;
11262
+ isError: false;
11263
+ isPending: true;
11264
+ isLoadingError: false;
11265
+ isRefetchError: false;
11266
+ isSuccess: false;
11267
+ isPlaceholderData: false;
11268
+ status: "pending";
11269
+ dataUpdatedAt: number;
11270
+ errorUpdatedAt: number;
11271
+ failureCount: number;
11272
+ failureReason: Error | null;
11273
+ errorUpdateCount: number;
11274
+ isFetched: boolean;
11275
+ isFetchedAfterMount: boolean;
11276
+ isFetching: boolean;
11277
+ isLoading: boolean;
11278
+ isInitialLoading: boolean;
11279
+ isPaused: boolean;
11280
+ isRefetching: boolean;
11281
+ isStale: boolean;
11282
+ isEnabled: boolean;
11283
+ refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
11284
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11285
+ headers: Record<string, string>;
11286
+ } | undefined, Error>>;
11287
+ fetchStatus: import("@tanstack/react-query").FetchStatus;
11288
+ promise: Promise<{
11289
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11290
+ headers: Record<string, string>;
11291
+ } | undefined>;
11292
+ } | {
11293
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11294
+ headers: Record<string, string> | undefined;
11295
+ isError: false;
11296
+ error: null;
11297
+ isPending: false;
11298
+ isLoading: false;
11299
+ isLoadingError: false;
11300
+ isRefetchError: false;
11301
+ isSuccess: true;
11302
+ isPlaceholderData: true;
11303
+ status: "success";
11304
+ dataUpdatedAt: number;
11305
+ errorUpdatedAt: number;
11306
+ failureCount: number;
11307
+ failureReason: Error | null;
11308
+ errorUpdateCount: number;
11309
+ isFetched: boolean;
11310
+ isFetchedAfterMount: boolean;
11311
+ isFetching: boolean;
11312
+ isInitialLoading: boolean;
11313
+ isPaused: boolean;
11314
+ isRefetching: boolean;
11315
+ isStale: boolean;
11316
+ isEnabled: boolean;
11317
+ refetch: (options?: import("@tanstack/react-query").RefetchOptions) => Promise<import("@tanstack/react-query").QueryObserverResult<{
11318
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11319
+ headers: Record<string, string>;
11320
+ } | undefined, Error>>;
11321
+ fetchStatus: import("@tanstack/react-query").FetchStatus;
11322
+ promise: Promise<{
11323
+ data: import("../../sdk/types.gen").PaginatedSubdomains | undefined;
11324
+ headers: Record<string, string>;
11325
+ } | undefined>;
11326
+ };
11327
+ export declare const useRegisterCustomerDomain: (config?: {
11328
+ onSuccess?: (data: GetSuccessResponse<RegisterCustomerDomainResponses>, headers: Record<string, string>) => void;
11329
+ onError?: Parameters<typeof useMutation>["0"]["onError"];
11330
+ retry?: boolean;
11331
+ }) => import("@tanstack/react-query").UseMutationResult<{
11332
+ data: import("../../sdk/types.gen").CustomerDomain | undefined;
11333
+ headers: Record<string, string>;
11334
+ }, unknown, Omit<RegisterCustomerDomainData, "url">, unknown>;
@@ -2,7 +2,7 @@
2
2
  import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
3
3
  import { isPromise, headersToObject } from "../util";
4
4
  import { useToken } from "../../provider/token-provider";
5
- import { getServiceHealth, getSoftDeletedEnvironmentsM2M, nukeEnvironmentM2M, updateGraphM2M, fetchGraphM2M, fetchNodeM2M, updateNodeM2M, viewBlueprintsM2M, createSecretM2M, getBlueprintM2M, createNeonProjectM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, fetchNeonOrganizations, fetchNeonRegions, fetchMongoOrganizations, fetchMongoRegions, listMongoProjects, listMongoClusters, fetchMongoOrganizationTier, fetchNeonConnectionUri, listNeonProjects, createNeonProject, listNeonBranches, createNeonBranch, listNeonDatabases, createNeonDatabase, listNeonRoles, deleteNeonDatabase, listUserSpaces, getFeatureFlags, lookupApiKey, createFeatureRequest, recordOnboardingAnalytics, previewBlueprint, viewBlueprints, getBlueprint, createSpace, getPublicInvite, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, getApiKeys, createApiKey, revokeApiKey, listSpaceMembers, listSpaceMemberRoles, leaveSpace, kickSpaceMember, createProject, getProjectOverview, getProjectEnvironments, createEnvironment, createSecret, getSecretValue, deleteEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, deleteBlueprint, updateBlueprint, createBlueprint, getVersion, importBlueprint, cloneEnvironment, getGraphOverview, updateGraphState, deployVersion, requestSignedDownloadUrl, getNodeEnvironmentVariables, requestSignedUploadUrl, checkSubdomainUniqueness, pingNode, createNodeCredential, createBugReport, getSpaceProperties, setSpaceProperty } from "../../sdk/sdk.gen";
5
+ import { getServiceHealth, getSoftDeletedEnvironmentsM2M, nukeEnvironmentM2M, updateGraphM2M, fetchGraphM2M, fetchNodeM2M, updateNodeM2M, viewBlueprintsM2M, createSecretM2M, getBlueprintM2M, createNeonProjectM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, fetchNeonOrganizations, fetchNeonRegions, fetchMongoOrganizations, fetchMongoRegions, listMongoProjects, listMongoClusters, fetchMongoOrganizationTier, fetchNeonConnectionUri, listNeonProjects, createNeonProject, listNeonBranches, createNeonBranch, listNeonDatabases, createNeonDatabase, listNeonRoles, deleteNeonDatabase, listUserSpaces, getFeatureFlags, lookupApiKey, createFeatureRequest, recordOnboardingAnalytics, previewBlueprint, viewBlueprints, getBlueprint, createSpace, getPublicInvite, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, getApiKeys, createApiKey, revokeApiKey, listSpaceMembers, listSpaceMemberRoles, leaveSpace, kickSpaceMember, createProject, getProjectOverview, getProjectEnvironments, createEnvironment, createSecret, getSecretValue, deleteEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, deleteBlueprint, updateBlueprint, createBlueprint, getVersion, importBlueprint, cloneEnvironment, getGraphOverview, updateGraphState, deployVersion, requestSignedDownloadUrl, getNodeEnvironmentVariables, requestSignedUploadUrl, checkSubdomainUniqueness, pingNode, createNodeCredential, createBugReport, getSpaceProperties, setSpaceProperty, listSubdomains, registerCustomerDomain } from "../../sdk/sdk.gen";
6
6
  export const useGetServiceHealth = (options) => {
7
7
  const token = useToken();
8
8
  let { enabled, ...rest } = options || { enabled: true };
@@ -1965,3 +1965,44 @@ export const useSetSpaceProperty = (config) => {
1965
1965
  retry: config?.retry
1966
1966
  });
1967
1967
  };
1968
+ export const useListSubdomains = (options) => {
1969
+ const token = useToken();
1970
+ let { enabled, ...rest } = options || { enabled: true };
1971
+ const opts = { throwOnError: true, url: "/auth/{spaceHandle}/subdomains" };
1972
+ const funcer = async () => {
1973
+ const auth = isPromise(token) ? (await token) || "" : token || "";
1974
+ if (isPromise(token) && !token)
1975
+ return;
1976
+ const res = await listSubdomains({ ...opts, ...rest, auth });
1977
+ return { data: res.data, headers: headersToObject(res.response.headers) };
1978
+ };
1979
+ if (!token)
1980
+ enabled = false;
1981
+ const query = useQuery({
1982
+ queryKey: [options?.path?.spaceHandle, "subdomains", options.query ?? {}],
1983
+ queryFn: funcer,
1984
+ enabled,
1985
+ retry: false,
1986
+ staleTime: 600000
1987
+ });
1988
+ return { ...query, data: query.data?.data, headers: query.data?.headers };
1989
+ };
1990
+ export const useRegisterCustomerDomain = (config) => {
1991
+ const token = useToken();
1992
+ const queryClient = useQueryClient();
1993
+ const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/domains" };
1994
+ const funcer = async (options) => {
1995
+ const auth = isPromise(token) ? (await token) || "" : token || "";
1996
+ const res = await registerCustomerDomain({ ...opts, ...options, auth });
1997
+ return { data: res.data, headers: headersToObject(res.response.headers) };
1998
+ };
1999
+ return useMutation({
2000
+ mutationFn: funcer,
2001
+ onSuccess: (res, options, c, ctx) => {
2002
+ queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, "domains"] });
2003
+ config?.onSuccess && config.onSuccess(res.data, res.headers);
2004
+ },
2005
+ onError: config?.onError,
2006
+ retry: config?.retry
2007
+ });
2008
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoal-web-sdk",
3
- "version": "1.0.120",
3
+ "version": "1.0.122",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "build-hooks": "npx tsx tanstack-codegen/generator.ts",