shoal-web-sdk 1.0.36 → 1.0.37

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, 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, FetchNeonConnectionUriData, FetchNeonOrganizationsData, FetchNeonRegionsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetBlueprintData, 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, 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, SetSpacePropertyData, SetSpacePropertyError, UpdateBillingPlanData, UpdateBillingPlanError, UpdateBlueprintData, UpdateBlueprintError, UpdateBlueprintResponse, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateNodeM2mData, UpdateNodeM2mError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, ViewBlueprintsData } 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, 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, 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, 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;
@@ -151,10 +151,90 @@ export declare const fetchNodeM2mOptions: (options: Options<FetchNodeM2mData>) =
151
151
  * Update a node by id with its props for M2M.
152
152
  */
153
153
  export declare const updateNodeM2mMutation: (options?: Partial<Options<UpdateNodeM2mData>>) => UseMutationOptions<unknown, UpdateNodeM2mError, Options<UpdateNodeM2mData>>;
154
+ export declare const viewBlueprintsM2mQueryKey: (options?: Options<ViewBlueprintsM2mData>) => [Pick<Options<ViewBlueprintsM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
155
+ _id: string;
156
+ _infinite?: boolean;
157
+ tags?: ReadonlyArray<string>;
158
+ }];
159
+ /**
160
+ * View all blueprints for M2M. Returns name and short description only (no long description).
161
+ */
162
+ export declare const viewBlueprintsM2mOptions: (options?: Options<ViewBlueprintsM2mData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedBlueprintSummaries, Error, import("../types.gen").PaginatedBlueprintSummaries, [Pick<Options<ViewBlueprintsM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
163
+ _id: string;
164
+ _infinite?: boolean;
165
+ tags?: ReadonlyArray<string>;
166
+ }]>, "queryFn"> & {
167
+ queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaginatedBlueprintSummaries, [Pick<Options<ViewBlueprintsM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
168
+ _id: string;
169
+ _infinite?: boolean;
170
+ tags?: ReadonlyArray<string>;
171
+ }], never> | undefined;
172
+ } & {
173
+ queryKey: [Pick<Options<ViewBlueprintsM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
174
+ _id: string;
175
+ _infinite?: boolean;
176
+ tags?: ReadonlyArray<string>;
177
+ }] & {
178
+ [dataTagSymbol]: import("../types.gen").PaginatedBlueprintSummaries;
179
+ [dataTagErrorSymbol]: Error;
180
+ };
181
+ };
182
+ export declare const viewBlueprintsM2mInfiniteQueryKey: (options?: Options<ViewBlueprintsM2mData>) => QueryKey<Options<ViewBlueprintsM2mData>>;
183
+ /**
184
+ * View all blueprints for M2M. Returns name and short description only (no long description).
185
+ */
186
+ export declare const viewBlueprintsM2mInfiniteOptions: (options?: Options<ViewBlueprintsM2mData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedBlueprintSummaries, Error, InfiniteData<import("../types.gen").PaginatedBlueprintSummaries, unknown>, QueryKey<Options<ViewBlueprintsM2mData>>, number | Pick<Pick<Options<ViewBlueprintsM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
187
+ _id: string;
188
+ _infinite?: boolean;
189
+ tags?: ReadonlyArray<string>;
190
+ }, "query" | "body" | "headers" | "path">> & {
191
+ initialData: InfiniteData<import("../types.gen").PaginatedBlueprintSummaries, number | Pick<Pick<Options<ViewBlueprintsM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
192
+ _id: string;
193
+ _infinite?: boolean;
194
+ tags?: ReadonlyArray<string>;
195
+ }, "query" | "body" | "headers" | "path">> | (() => InfiniteData<import("../types.gen").PaginatedBlueprintSummaries, number | Pick<Pick<Options<ViewBlueprintsM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
196
+ _id: string;
197
+ _infinite?: boolean;
198
+ tags?: ReadonlyArray<string>;
199
+ }, "query" | "body" | "headers" | "path">>) | undefined;
200
+ } & {
201
+ queryKey: QueryKey<Options<ViewBlueprintsM2mData>> & {
202
+ [dataTagSymbol]: InfiniteData<import("../types.gen").PaginatedBlueprintSummaries, unknown>;
203
+ [dataTagErrorSymbol]: Error;
204
+ };
205
+ };
154
206
  /**
155
207
  * Save a reference to a GCP secret that has already been created in Secret Manager.
156
208
  */
157
209
  export declare const createSecretM2mMutation: (options?: Partial<Options<CreateSecretM2mData>>) => UseMutationOptions<CreateSecretM2mResponse, CreateSecretM2mError, Options<CreateSecretM2mData>>;
210
+ export declare const getBlueprintM2mQueryKey: (options: Options<GetBlueprintM2mData>) => [Pick<Options<GetBlueprintM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
211
+ _id: string;
212
+ _infinite?: boolean;
213
+ tags?: ReadonlyArray<string>;
214
+ }];
215
+ /**
216
+ * Retrieve a blueprint record with its full long description for M2M.
217
+ */
218
+ export declare const getBlueprintM2mOptions: (options: Options<GetBlueprintM2mData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").BlueprintDetail, Error, import("../types.gen").BlueprintDetail, [Pick<Options<GetBlueprintM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
219
+ _id: string;
220
+ _infinite?: boolean;
221
+ tags?: ReadonlyArray<string>;
222
+ }]>, "queryFn"> & {
223
+ queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").BlueprintDetail, [Pick<Options<GetBlueprintM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
224
+ _id: string;
225
+ _infinite?: boolean;
226
+ tags?: ReadonlyArray<string>;
227
+ }], never> | undefined;
228
+ } & {
229
+ queryKey: [Pick<Options<GetBlueprintM2mData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
230
+ _id: string;
231
+ _infinite?: boolean;
232
+ tags?: ReadonlyArray<string>;
233
+ }] & {
234
+ [dataTagSymbol]: import("../types.gen").BlueprintDetail;
235
+ [dataTagErrorSymbol]: Error;
236
+ };
237
+ };
158
238
  /**
159
239
  * Create a new Neon project for M2M.
160
240
  */
@@ -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, fetchNeonConnectionUri, fetchNeonOrganizations, fetchNeonRegions, fetchNodeM2M, getBillingPlan, getBillingUsage, getBlueprint, 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, listNeonBranches, listNeonDatabases, listNeonProjects, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, previewBlueprint, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, setSpaceProperty, updateBillingPlan, updateBlueprint, updateConnectedAppToken, updateDeploymentStatusM2M, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateUsername, updateUserProfile, viewBlueprints } 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, 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, listNeonBranches, listNeonDatabases, listNeonProjects, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, previewBlueprint, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, 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) {
@@ -155,6 +155,81 @@ export const updateNodeM2mMutation = (options) => {
155
155
  };
156
156
  return mutationOptions;
157
157
  };
158
+ export const viewBlueprintsM2mQueryKey = (options) => createQueryKey('viewBlueprintsM2M', options);
159
+ /**
160
+ * View all blueprints for M2M. Returns name and short description only (no long description).
161
+ */
162
+ export const viewBlueprintsM2mOptions = (options) => {
163
+ return queryOptions({
164
+ queryFn: async ({ queryKey, signal }) => {
165
+ const { data } = await viewBlueprintsM2M({
166
+ ...options,
167
+ ...queryKey[0],
168
+ signal,
169
+ throwOnError: true
170
+ });
171
+ return data;
172
+ },
173
+ queryKey: viewBlueprintsM2mQueryKey(options)
174
+ });
175
+ };
176
+ const createInfiniteParams = (queryKey, page) => {
177
+ const params = {
178
+ ...queryKey[0]
179
+ };
180
+ if (page.body) {
181
+ params.body = {
182
+ ...queryKey[0].body,
183
+ ...page.body
184
+ };
185
+ }
186
+ if (page.headers) {
187
+ params.headers = {
188
+ ...queryKey[0].headers,
189
+ ...page.headers
190
+ };
191
+ }
192
+ if (page.path) {
193
+ params.path = {
194
+ ...queryKey[0].path,
195
+ ...page.path
196
+ };
197
+ }
198
+ if (page.query) {
199
+ params.query = {
200
+ ...queryKey[0].query,
201
+ ...page.query
202
+ };
203
+ }
204
+ return params;
205
+ };
206
+ export const viewBlueprintsM2mInfiniteQueryKey = (options) => createQueryKey('viewBlueprintsM2M', options, true);
207
+ /**
208
+ * View all blueprints for M2M. Returns name and short description only (no long description).
209
+ */
210
+ export const viewBlueprintsM2mInfiniteOptions = (options) => {
211
+ return infiniteQueryOptions(
212
+ // @ts-ignore
213
+ {
214
+ queryFn: async ({ pageParam, queryKey, signal }) => {
215
+ // @ts-ignore
216
+ const page = typeof pageParam === 'object' ? pageParam : {
217
+ query: {
218
+ page: pageParam
219
+ }
220
+ };
221
+ const params = createInfiniteParams(queryKey, page);
222
+ const { data } = await viewBlueprintsM2M({
223
+ ...options,
224
+ ...params,
225
+ signal,
226
+ throwOnError: true
227
+ });
228
+ return data;
229
+ },
230
+ queryKey: viewBlueprintsM2mInfiniteQueryKey(options)
231
+ });
232
+ };
158
233
  /**
159
234
  * Save a reference to a GCP secret that has already been created in Secret Manager.
160
235
  */
@@ -171,6 +246,24 @@ export const createSecretM2mMutation = (options) => {
171
246
  };
172
247
  return mutationOptions;
173
248
  };
249
+ export const getBlueprintM2mQueryKey = (options) => createQueryKey('getBlueprintM2M', options);
250
+ /**
251
+ * Retrieve a blueprint record with its full long description for M2M.
252
+ */
253
+ export const getBlueprintM2mOptions = (options) => {
254
+ return queryOptions({
255
+ queryFn: async ({ queryKey, signal }) => {
256
+ const { data } = await getBlueprintM2M({
257
+ ...options,
258
+ ...queryKey[0],
259
+ signal,
260
+ throwOnError: true
261
+ });
262
+ return data;
263
+ },
264
+ queryKey: getBlueprintM2mQueryKey(options)
265
+ });
266
+ };
174
267
  /**
175
268
  * Create a new Neon project for M2M.
176
269
  */
@@ -355,36 +448,6 @@ export const listInstallationRepositoriesOptions = (options) => {
355
448
  queryKey: listInstallationRepositoriesQueryKey(options)
356
449
  });
357
450
  };
358
- const createInfiniteParams = (queryKey, page) => {
359
- const params = {
360
- ...queryKey[0]
361
- };
362
- if (page.body) {
363
- params.body = {
364
- ...queryKey[0].body,
365
- ...page.body
366
- };
367
- }
368
- if (page.headers) {
369
- params.headers = {
370
- ...queryKey[0].headers,
371
- ...page.headers
372
- };
373
- }
374
- if (page.path) {
375
- params.path = {
376
- ...queryKey[0].path,
377
- ...page.path
378
- };
379
- }
380
- if (page.query) {
381
- params.query = {
382
- ...queryKey[0].query,
383
- ...page.query
384
- };
385
- }
386
- return params;
387
- };
388
451
  export const listInstallationRepositoriesInfiniteQueryKey = (options) => createQueryKey('listInstallationRepositories', options, true);
389
452
  /**
390
453
  * List repositories accessible to a GitHub App installation.
@@ -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, FetchNeonConnectionUriData, FetchNeonConnectionUriErrors, FetchNeonConnectionUriResponses, FetchNeonOrganizationsData, FetchNeonOrganizationsErrors, FetchNeonOrganizationsResponses, FetchNeonRegionsData, FetchNeonRegionsErrors, FetchNeonRegionsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetBlueprintData, GetBlueprintErrors, 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, 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, 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, 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, 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, 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, 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
@@ -36,10 +36,18 @@ export declare const fetchNodeM2M: <ThrowOnError extends boolean = false>(option
36
36
  * Update a node by id with its props for M2M.
37
37
  */
38
38
  export declare const updateNodeM2M: <ThrowOnError extends boolean = false>(options: Options<UpdateNodeM2mData, ThrowOnError>) => import("./client").RequestResult<UpdateNodeM2mResponses, UpdateNodeM2mErrors, ThrowOnError, "fields">;
39
+ /**
40
+ * View all blueprints for M2M. Returns name and short description only (no long description).
41
+ */
42
+ export declare const viewBlueprintsM2M: <ThrowOnError extends boolean = false>(options?: Options<ViewBlueprintsM2mData, ThrowOnError>) => import("./client").RequestResult<ViewBlueprintsM2mResponses, ViewBlueprintsM2mErrors, ThrowOnError, "fields">;
39
43
  /**
40
44
  * Save a reference to a GCP secret that has already been created in Secret Manager.
41
45
  */
42
46
  export declare const createSecretM2M: <ThrowOnError extends boolean = false>(options: Options<CreateSecretM2mData, ThrowOnError>) => import("./client").RequestResult<CreateSecretM2mResponses, CreateSecretM2mErrors, ThrowOnError, "fields">;
47
+ /**
48
+ * Retrieve a blueprint record with its full long description for M2M.
49
+ */
50
+ export declare const getBlueprintM2M: <ThrowOnError extends boolean = false>(options: Options<GetBlueprintM2mData, ThrowOnError>) => import("./client").RequestResult<GetBlueprintM2mResponses, GetBlueprintM2mErrors, ThrowOnError, "fields">;
43
51
  /**
44
52
  * Create a new Neon project for M2M.
45
53
  */
@@ -123,6 +123,21 @@ export const updateNodeM2M = (options) => {
123
123
  }
124
124
  });
125
125
  };
126
+ /**
127
+ * View all blueprints for M2M. Returns name and short description only (no long description).
128
+ */
129
+ export const viewBlueprintsM2M = (options) => {
130
+ return (options?.client ?? client).get({
131
+ security: [
132
+ {
133
+ scheme: 'bearer',
134
+ type: 'http'
135
+ }
136
+ ],
137
+ url: '/m2m/blueprints/view',
138
+ ...options
139
+ });
140
+ };
126
141
  /**
127
142
  * Save a reference to a GCP secret that has already been created in Secret Manager.
128
143
  */
@@ -142,6 +157,21 @@ export const createSecretM2M = (options) => {
142
157
  }
143
158
  });
144
159
  };
160
+ /**
161
+ * Retrieve a blueprint record with its full long description for M2M.
162
+ */
163
+ export const getBlueprintM2M = (options) => {
164
+ return (options.client ?? client).get({
165
+ security: [
166
+ {
167
+ scheme: 'bearer',
168
+ type: 'http'
169
+ }
170
+ ],
171
+ url: '/m2m/blueprints/{blueprint}',
172
+ ...options
173
+ });
174
+ };
145
175
  /**
146
176
  * Create a new Neon project for M2M.
147
177
  */
@@ -109,8 +109,35 @@ export type Pagination = {
109
109
  limit: number;
110
110
  total: number;
111
111
  };
112
+ export type BlueprintListItem = {
113
+ id: string;
114
+ environment: string;
115
+ ref: string;
116
+ updatedAt: string;
117
+ createdAt: string;
118
+ author: string;
119
+ updatedBy: string;
120
+ name: string;
121
+ shortDescription: string;
122
+ exported: Array<EnvironmentVariable>;
123
+ };
112
124
  export type PaginatedBlueprints = Pagination & {
113
- blueprints: Array<Blueprint>;
125
+ blueprints: Array<BlueprintListItem>;
126
+ };
127
+ export type BlueprintSummary = {
128
+ id: string;
129
+ name: string;
130
+ shortDescription: string;
131
+ };
132
+ export type PaginatedBlueprintSummaries = Pagination & {
133
+ blueprints: Array<BlueprintSummary>;
134
+ };
135
+ export type BlueprintDetail = {
136
+ id: string;
137
+ name: string;
138
+ shortDescription: string;
139
+ description: string;
140
+ graph: Graph;
114
141
  };
115
142
  export type PaginatedInvites = Pagination & {
116
143
  invites: Array<Invite>;
@@ -1214,6 +1241,42 @@ export type UpdateNodeM2mResponses = {
1214
1241
  */
1215
1242
  202: unknown;
1216
1243
  };
1244
+ export type ViewBlueprintsM2mData = {
1245
+ body?: never;
1246
+ path?: never;
1247
+ query?: {
1248
+ /**
1249
+ * Page size (max 100).
1250
+ */
1251
+ limit?: number;
1252
+ /**
1253
+ * Page number (1-based).
1254
+ */
1255
+ page?: number;
1256
+ /**
1257
+ * Search value for a searchable field on an endpoint.
1258
+ */
1259
+ search?: string;
1260
+ /**
1261
+ * The order results will appear in.
1262
+ */
1263
+ order?: 'asc' | 'desc';
1264
+ };
1265
+ url: '/m2m/blueprints/view';
1266
+ };
1267
+ export type ViewBlueprintsM2mErrors = {
1268
+ /**
1269
+ * Bad request.
1270
+ */
1271
+ 400: unknown;
1272
+ };
1273
+ export type ViewBlueprintsM2mResponses = {
1274
+ /**
1275
+ * Paginated blueprint summaries.
1276
+ */
1277
+ 200: PaginatedBlueprintSummaries;
1278
+ };
1279
+ export type ViewBlueprintsM2mResponse = ViewBlueprintsM2mResponses[keyof ViewBlueprintsM2mResponses];
1217
1280
  export type CreateSecretM2mData = {
1218
1281
  body: CreateSecret;
1219
1282
  path: {
@@ -1255,6 +1318,30 @@ export type CreateSecretM2mResponses = {
1255
1318
  201: Secret;
1256
1319
  };
1257
1320
  export type CreateSecretM2mResponse = CreateSecretM2mResponses[keyof CreateSecretM2mResponses];
1321
+ export type GetBlueprintM2mData = {
1322
+ body?: never;
1323
+ path: {
1324
+ /**
1325
+ * Blueprint UUID.
1326
+ */
1327
+ blueprint: string;
1328
+ };
1329
+ query?: never;
1330
+ url: '/m2m/blueprints/{blueprint}';
1331
+ };
1332
+ export type GetBlueprintM2mErrors = {
1333
+ /**
1334
+ * Bad request.
1335
+ */
1336
+ 400: unknown;
1337
+ };
1338
+ export type GetBlueprintM2mResponses = {
1339
+ /**
1340
+ * The blueprint with its full long description.
1341
+ */
1342
+ 200: BlueprintDetail;
1343
+ };
1344
+ export type GetBlueprintM2mResponse = GetBlueprintM2mResponses[keyof GetBlueprintM2mResponses];
1258
1345
  export type CreateNeonProjectM2mData = {
1259
1346
  body: CreateNeonProject;
1260
1347
  headers: {
@@ -1285,6 +1372,10 @@ export type CreateNeonProjectM2mErrors = {
1285
1372
  * Invalid credentials or missing Neon API key.
1286
1373
  */
1287
1374
  403: ErrorResponse;
1375
+ /**
1376
+ * Related content not found.
1377
+ */
1378
+ 404: ErrorResponse;
1288
1379
  /**
1289
1380
  * Unexpected error.
1290
1381
  */
@@ -132,6 +132,23 @@ export declare const zPagination: z.ZodObject<{
132
132
  limit: z.ZodInt;
133
133
  total: z.ZodInt;
134
134
  }, z.core.$strip>;
135
+ export declare const zBlueprintListItem: z.ZodObject<{
136
+ id: z.ZodUUID;
137
+ environment: z.ZodUUID;
138
+ ref: z.ZodUUID;
139
+ updatedAt: z.ZodISODateTime;
140
+ createdAt: z.ZodISODateTime;
141
+ author: z.ZodString;
142
+ updatedBy: z.ZodString;
143
+ name: z.ZodString;
144
+ shortDescription: z.ZodString;
145
+ exported: z.ZodArray<z.ZodObject<{
146
+ key: z.ZodString;
147
+ value: z.ZodString;
148
+ isExported: z.ZodBoolean;
149
+ isOutput: z.ZodBoolean;
150
+ }, z.core.$strip>>;
151
+ }, z.core.$strip>;
135
152
  export declare const zPaginatedBlueprints: z.ZodIntersection<z.ZodObject<{
136
153
  page: z.ZodInt;
137
154
  limit: z.ZodInt;
@@ -147,7 +164,6 @@ export declare const zPaginatedBlueprints: z.ZodIntersection<z.ZodObject<{
147
164
  updatedBy: z.ZodString;
148
165
  name: z.ZodString;
149
166
  shortDescription: z.ZodString;
150
- description: z.ZodString;
151
167
  exported: z.ZodArray<z.ZodObject<{
152
168
  key: z.ZodString;
153
169
  value: z.ZodString;
@@ -156,6 +172,22 @@ export declare const zPaginatedBlueprints: z.ZodIntersection<z.ZodObject<{
156
172
  }, z.core.$strip>>;
157
173
  }, z.core.$strip>>;
158
174
  }, z.core.$strip>>;
175
+ export declare const zBlueprintSummary: z.ZodObject<{
176
+ id: z.ZodUUID;
177
+ name: z.ZodString;
178
+ shortDescription: z.ZodString;
179
+ }, z.core.$strip>;
180
+ export declare const zPaginatedBlueprintSummaries: z.ZodIntersection<z.ZodObject<{
181
+ page: z.ZodInt;
182
+ limit: z.ZodInt;
183
+ total: z.ZodInt;
184
+ }, z.core.$strip>, z.ZodObject<{
185
+ blueprints: z.ZodArray<z.ZodObject<{
186
+ id: z.ZodUUID;
187
+ name: z.ZodString;
188
+ shortDescription: z.ZodString;
189
+ }, z.core.$strip>>;
190
+ }, z.core.$strip>>;
159
191
  export declare const zInvite: z.ZodObject<{
160
192
  id: z.ZodUUID;
161
193
  spaceName: z.ZodString;
@@ -1226,6 +1258,183 @@ export declare const zGraph: z.ZodObject<{
1226
1258
  }, z.core.$strip>>]>>;
1227
1259
  }, z.core.$strip>>;
1228
1260
  }, z.core.$strip>;
1261
+ export declare const zBlueprintDetail: z.ZodObject<{
1262
+ id: z.ZodUUID;
1263
+ name: z.ZodString;
1264
+ shortDescription: z.ZodString;
1265
+ description: z.ZodString;
1266
+ graph: z.ZodObject<{
1267
+ versionUUID: z.ZodUUID;
1268
+ version: z.ZodInt;
1269
+ nodes: z.ZodArray<z.ZodObject<{
1270
+ id: z.ZodUUID;
1271
+ name: z.ZodOptional<z.ZodString>;
1272
+ description: z.ZodOptional<z.ZodString>;
1273
+ x: z.ZodNumber;
1274
+ y: z.ZodNumber;
1275
+ width: z.ZodInt;
1276
+ height: z.ZodInt;
1277
+ edges: z.ZodOptional<z.ZodArray<z.ZodObject<{
1278
+ id: z.ZodUUID;
1279
+ src: z.ZodUUID;
1280
+ dst: z.ZodUUID;
1281
+ typ: z.ZodEnum<{
1282
+ network: "network";
1283
+ route: "route";
1284
+ output: "output";
1285
+ }>;
1286
+ props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
1287
+ typ: z.ZodLiteral<"network">;
1288
+ }, z.core.$strip>, z.ZodObject<{
1289
+ a: z.ZodOptional<z.ZodString>;
1290
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1291
+ typ: z.ZodLiteral<"route">;
1292
+ }, z.core.$strip>, z.ZodObject<{
1293
+ path: z.ZodOptional<z.ZodString>;
1294
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1295
+ typ: z.ZodLiteral<"output">;
1296
+ }, z.core.$strip>, z.ZodObject<{
1297
+ keys: z.ZodArray<z.ZodString>;
1298
+ }, z.core.$strip>>]>>;
1299
+ }, z.core.$strip>>>;
1300
+ typ: z.ZodEnum<{
1301
+ function: "function";
1302
+ cache: "cache";
1303
+ comment: "comment";
1304
+ container: "container";
1305
+ cronjob: "cronjob";
1306
+ database: "database";
1307
+ neondb: "neondb";
1308
+ queue: "queue";
1309
+ proxy: "proxy";
1310
+ vm: "vm";
1311
+ scheduler: "scheduler";
1312
+ }>;
1313
+ props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
1314
+ typ: z.ZodLiteral<"comment">;
1315
+ }, z.core.$strip>, z.ZodObject<{
1316
+ comment: z.ZodOptional<z.ZodString>;
1317
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1318
+ typ: z.ZodLiteral<"cache">;
1319
+ }, z.core.$strip>, z.ZodObject<{
1320
+ size: z.ZodOptional<z.ZodInt>;
1321
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1322
+ typ: z.ZodLiteral<"container">;
1323
+ }, z.core.$strip>, z.ZodObject<{
1324
+ region: z.ZodEnum<{
1325
+ "europe-west2": "europe-west2";
1326
+ }>;
1327
+ port: z.ZodInt;
1328
+ cpu: z.ZodEnum<{
1329
+ 1: "1";
1330
+ 2: "2";
1331
+ }>;
1332
+ memory: z.ZodEnum<{
1333
+ "512Mi": "512Mi";
1334
+ "1Gi": "1Gi";
1335
+ "2Gi": "2Gi";
1336
+ }>;
1337
+ serviceName: z.ZodOptional<z.ZodString>;
1338
+ ingress: z.ZodEnum<{
1339
+ INGRESS_TRAFFIC_ALL: "INGRESS_TRAFFIC_ALL";
1340
+ INGRESS_TRAFFIC_INTERNAL_ONLY: "INGRESS_TRAFFIC_INTERNAL_ONLY";
1341
+ INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER: "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER";
1342
+ }>;
1343
+ timeoutSeconds: z.ZodOptional<z.ZodInt>;
1344
+ maxInstances: z.ZodOptional<z.ZodInt>;
1345
+ minInstances: z.ZodOptional<z.ZodInt>;
1346
+ concurrency: z.ZodOptional<z.ZodInt>;
1347
+ allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
1348
+ uri: z.ZodOptional<z.ZodString>;
1349
+ installationId: z.ZodOptional<z.ZodString>;
1350
+ language: z.ZodOptional<z.ZodString>;
1351
+ framework: z.ZodOptional<z.ZodString>;
1352
+ runtimeVersion: z.ZodOptional<z.ZodString>;
1353
+ env: z.ZodOptional<z.ZodArray<z.ZodString>>;
1354
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1355
+ typ: z.ZodLiteral<"cronjob">;
1356
+ }, z.core.$strip>, z.ZodObject<{
1357
+ cronTab: z.ZodOptional<z.ZodString>;
1358
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1359
+ typ: z.ZodLiteral<"database">;
1360
+ }, z.core.$strip>, z.ZodObject<{
1361
+ space: z.ZodOptional<z.ZodInt>;
1362
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1363
+ typ: z.ZodLiteral<"function">;
1364
+ }, z.core.$strip>, z.ZodObject<{
1365
+ region: z.ZodEnum<{
1366
+ "europe-west2": "europe-west2";
1367
+ }>;
1368
+ language: z.ZodString;
1369
+ runtimeVersion: z.ZodString;
1370
+ serviceName: z.ZodOptional<z.ZodString>;
1371
+ cpu: z.ZodEnum<{
1372
+ 1: "1";
1373
+ 2: "2";
1374
+ }>;
1375
+ memory: z.ZodEnum<{
1376
+ "512Mi": "512Mi";
1377
+ "1Gi": "1Gi";
1378
+ "2Gi": "2Gi";
1379
+ }>;
1380
+ concurrency: z.ZodOptional<z.ZodInt>;
1381
+ timeoutSeconds: z.ZodOptional<z.ZodInt>;
1382
+ minInstances: z.ZodOptional<z.ZodInt>;
1383
+ maxInstances: z.ZodOptional<z.ZodInt>;
1384
+ entryPoint: z.ZodString;
1385
+ uri: z.ZodOptional<z.ZodString>;
1386
+ installationId: z.ZodOptional<z.ZodString>;
1387
+ env: z.ZodOptional<z.ZodArray<z.ZodString>>;
1388
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1389
+ typ: z.ZodLiteral<"neondb">;
1390
+ }, z.core.$strip>, z.ZodObject<{
1391
+ orgId: z.ZodOptional<z.ZodString>;
1392
+ orgName: z.ZodOptional<z.ZodString>;
1393
+ projectId: z.ZodOptional<z.ZodString>;
1394
+ projectName: z.ZodOptional<z.ZodString>;
1395
+ branchId: z.ZodOptional<z.ZodString>;
1396
+ branchName: z.ZodOptional<z.ZodString>;
1397
+ dbName: z.ZodOptional<z.ZodString>;
1398
+ roleName: z.ZodOptional<z.ZodString>;
1399
+ regionId: z.ZodOptional<z.ZodString>;
1400
+ pgVersion: z.ZodOptional<z.ZodInt>;
1401
+ autoscalingLimitMinCu: z.ZodOptional<z.ZodNumber>;
1402
+ autoscalingLimitMaxCu: z.ZodOptional<z.ZodNumber>;
1403
+ suspendTimeoutSeconds: z.ZodOptional<z.ZodInt>;
1404
+ connectionUri: z.ZodOptional<z.ZodString>;
1405
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1406
+ typ: z.ZodLiteral<"queue">;
1407
+ }, z.core.$strip>, z.ZodObject<{
1408
+ foobar: z.ZodOptional<z.ZodString>;
1409
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1410
+ typ: z.ZodLiteral<"proxy">;
1411
+ }, z.core.$strip>, z.ZodObject<{
1412
+ subdomain: z.ZodOptional<z.ZodString>;
1413
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1414
+ typ: z.ZodLiteral<"vm">;
1415
+ }, z.core.$strip>, z.ZodObject<{
1416
+ os: z.ZodOptional<z.ZodString>;
1417
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1418
+ typ: z.ZodLiteral<"scheduler">;
1419
+ }, z.core.$strip>, z.ZodObject<{
1420
+ expression: z.ZodString;
1421
+ timezone: z.ZodOptional<z.ZodString>;
1422
+ requestMethod: z.ZodOptional<z.ZodEnum<{
1423
+ DELETE: "DELETE";
1424
+ GET: "GET";
1425
+ HEAD: "HEAD";
1426
+ OPTIONS: "OPTIONS";
1427
+ PATCH: "PATCH";
1428
+ POST: "POST";
1429
+ PUT: "PUT";
1430
+ }>>;
1431
+ requestPayload: z.ZodOptional<z.ZodString>;
1432
+ requestHeaders: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
1433
+ paused: z.ZodBoolean;
1434
+ }, z.core.$strip>>]>>;
1435
+ }, z.core.$strip>>;
1436
+ }, z.core.$strip>;
1437
+ }, z.core.$strip>;
1229
1438
  export declare const zSignedUrlDownloadResponse: z.ZodObject<{
1230
1439
  signedUrl: z.ZodString;
1231
1440
  }, z.core.$strip>;
@@ -2491,6 +2700,33 @@ export declare const zUpdateNodeM2mData: z.ZodObject<{
2491
2700
  }, z.core.$strip>;
2492
2701
  query: z.ZodOptional<z.ZodNever>;
2493
2702
  }, z.core.$strip>;
2703
+ export declare const zViewBlueprintsM2mData: z.ZodObject<{
2704
+ body: z.ZodOptional<z.ZodNever>;
2705
+ path: z.ZodOptional<z.ZodNever>;
2706
+ query: z.ZodOptional<z.ZodObject<{
2707
+ limit: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
2708
+ page: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
2709
+ search: z.ZodOptional<z.ZodString>;
2710
+ order: z.ZodOptional<z.ZodEnum<{
2711
+ asc: "asc";
2712
+ desc: "desc";
2713
+ }>>;
2714
+ }, z.core.$strip>>;
2715
+ }, z.core.$strip>;
2716
+ /**
2717
+ * Paginated blueprint summaries.
2718
+ */
2719
+ export declare const zViewBlueprintsM2mResponse: z.ZodIntersection<z.ZodObject<{
2720
+ page: z.ZodInt;
2721
+ limit: z.ZodInt;
2722
+ total: z.ZodInt;
2723
+ }, z.core.$strip>, z.ZodObject<{
2724
+ blueprints: z.ZodArray<z.ZodObject<{
2725
+ id: z.ZodUUID;
2726
+ name: z.ZodString;
2727
+ shortDescription: z.ZodString;
2728
+ }, z.core.$strip>>;
2729
+ }, z.core.$strip>>;
2494
2730
  export declare const zCreateSecretM2mData: z.ZodObject<{
2495
2731
  body: z.ZodObject<{
2496
2732
  secretId: z.ZodString;
@@ -2510,6 +2746,193 @@ export declare const zCreateSecretM2mResponse: z.ZodObject<{
2510
2746
  projectId: z.ZodString;
2511
2747
  createdAt: z.ZodISODateTime;
2512
2748
  }, z.core.$strip>;
2749
+ export declare const zGetBlueprintM2mData: z.ZodObject<{
2750
+ body: z.ZodOptional<z.ZodNever>;
2751
+ path: z.ZodObject<{
2752
+ blueprint: z.ZodUUID;
2753
+ }, z.core.$strip>;
2754
+ query: z.ZodOptional<z.ZodNever>;
2755
+ }, z.core.$strip>;
2756
+ /**
2757
+ * The blueprint with its full long description.
2758
+ */
2759
+ export declare const zGetBlueprintM2mResponse: z.ZodObject<{
2760
+ id: z.ZodUUID;
2761
+ name: z.ZodString;
2762
+ shortDescription: z.ZodString;
2763
+ description: z.ZodString;
2764
+ graph: z.ZodObject<{
2765
+ versionUUID: z.ZodUUID;
2766
+ version: z.ZodInt;
2767
+ nodes: z.ZodArray<z.ZodObject<{
2768
+ id: z.ZodUUID;
2769
+ name: z.ZodOptional<z.ZodString>;
2770
+ description: z.ZodOptional<z.ZodString>;
2771
+ x: z.ZodNumber;
2772
+ y: z.ZodNumber;
2773
+ width: z.ZodInt;
2774
+ height: z.ZodInt;
2775
+ edges: z.ZodOptional<z.ZodArray<z.ZodObject<{
2776
+ id: z.ZodUUID;
2777
+ src: z.ZodUUID;
2778
+ dst: z.ZodUUID;
2779
+ typ: z.ZodEnum<{
2780
+ network: "network";
2781
+ route: "route";
2782
+ output: "output";
2783
+ }>;
2784
+ props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
2785
+ typ: z.ZodLiteral<"network">;
2786
+ }, z.core.$strip>, z.ZodObject<{
2787
+ a: z.ZodOptional<z.ZodString>;
2788
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2789
+ typ: z.ZodLiteral<"route">;
2790
+ }, z.core.$strip>, z.ZodObject<{
2791
+ path: z.ZodOptional<z.ZodString>;
2792
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2793
+ typ: z.ZodLiteral<"output">;
2794
+ }, z.core.$strip>, z.ZodObject<{
2795
+ keys: z.ZodArray<z.ZodString>;
2796
+ }, z.core.$strip>>]>>;
2797
+ }, z.core.$strip>>>;
2798
+ typ: z.ZodEnum<{
2799
+ function: "function";
2800
+ cache: "cache";
2801
+ comment: "comment";
2802
+ container: "container";
2803
+ cronjob: "cronjob";
2804
+ database: "database";
2805
+ neondb: "neondb";
2806
+ queue: "queue";
2807
+ proxy: "proxy";
2808
+ vm: "vm";
2809
+ scheduler: "scheduler";
2810
+ }>;
2811
+ props: z.ZodOptional<z.ZodUnion<readonly [z.ZodIntersection<z.ZodObject<{
2812
+ typ: z.ZodLiteral<"comment">;
2813
+ }, z.core.$strip>, z.ZodObject<{
2814
+ comment: z.ZodOptional<z.ZodString>;
2815
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2816
+ typ: z.ZodLiteral<"cache">;
2817
+ }, z.core.$strip>, z.ZodObject<{
2818
+ size: z.ZodOptional<z.ZodInt>;
2819
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2820
+ typ: z.ZodLiteral<"container">;
2821
+ }, z.core.$strip>, z.ZodObject<{
2822
+ region: z.ZodEnum<{
2823
+ "europe-west2": "europe-west2";
2824
+ }>;
2825
+ port: z.ZodInt;
2826
+ cpu: z.ZodEnum<{
2827
+ 1: "1";
2828
+ 2: "2";
2829
+ }>;
2830
+ memory: z.ZodEnum<{
2831
+ "512Mi": "512Mi";
2832
+ "1Gi": "1Gi";
2833
+ "2Gi": "2Gi";
2834
+ }>;
2835
+ serviceName: z.ZodOptional<z.ZodString>;
2836
+ ingress: z.ZodEnum<{
2837
+ INGRESS_TRAFFIC_ALL: "INGRESS_TRAFFIC_ALL";
2838
+ INGRESS_TRAFFIC_INTERNAL_ONLY: "INGRESS_TRAFFIC_INTERNAL_ONLY";
2839
+ INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER: "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER";
2840
+ }>;
2841
+ timeoutSeconds: z.ZodOptional<z.ZodInt>;
2842
+ maxInstances: z.ZodOptional<z.ZodInt>;
2843
+ minInstances: z.ZodOptional<z.ZodInt>;
2844
+ concurrency: z.ZodOptional<z.ZodInt>;
2845
+ allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
2846
+ uri: z.ZodOptional<z.ZodString>;
2847
+ installationId: z.ZodOptional<z.ZodString>;
2848
+ language: z.ZodOptional<z.ZodString>;
2849
+ framework: z.ZodOptional<z.ZodString>;
2850
+ runtimeVersion: z.ZodOptional<z.ZodString>;
2851
+ env: z.ZodOptional<z.ZodArray<z.ZodString>>;
2852
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2853
+ typ: z.ZodLiteral<"cronjob">;
2854
+ }, z.core.$strip>, z.ZodObject<{
2855
+ cronTab: z.ZodOptional<z.ZodString>;
2856
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2857
+ typ: z.ZodLiteral<"database">;
2858
+ }, z.core.$strip>, z.ZodObject<{
2859
+ space: z.ZodOptional<z.ZodInt>;
2860
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2861
+ typ: z.ZodLiteral<"function">;
2862
+ }, z.core.$strip>, z.ZodObject<{
2863
+ region: z.ZodEnum<{
2864
+ "europe-west2": "europe-west2";
2865
+ }>;
2866
+ language: z.ZodString;
2867
+ runtimeVersion: z.ZodString;
2868
+ serviceName: z.ZodOptional<z.ZodString>;
2869
+ cpu: z.ZodEnum<{
2870
+ 1: "1";
2871
+ 2: "2";
2872
+ }>;
2873
+ memory: z.ZodEnum<{
2874
+ "512Mi": "512Mi";
2875
+ "1Gi": "1Gi";
2876
+ "2Gi": "2Gi";
2877
+ }>;
2878
+ concurrency: z.ZodOptional<z.ZodInt>;
2879
+ timeoutSeconds: z.ZodOptional<z.ZodInt>;
2880
+ minInstances: z.ZodOptional<z.ZodInt>;
2881
+ maxInstances: z.ZodOptional<z.ZodInt>;
2882
+ entryPoint: z.ZodString;
2883
+ uri: z.ZodOptional<z.ZodString>;
2884
+ installationId: z.ZodOptional<z.ZodString>;
2885
+ env: z.ZodOptional<z.ZodArray<z.ZodString>>;
2886
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2887
+ typ: z.ZodLiteral<"neondb">;
2888
+ }, z.core.$strip>, z.ZodObject<{
2889
+ orgId: z.ZodOptional<z.ZodString>;
2890
+ orgName: z.ZodOptional<z.ZodString>;
2891
+ projectId: z.ZodOptional<z.ZodString>;
2892
+ projectName: z.ZodOptional<z.ZodString>;
2893
+ branchId: z.ZodOptional<z.ZodString>;
2894
+ branchName: z.ZodOptional<z.ZodString>;
2895
+ dbName: z.ZodOptional<z.ZodString>;
2896
+ roleName: z.ZodOptional<z.ZodString>;
2897
+ regionId: z.ZodOptional<z.ZodString>;
2898
+ pgVersion: z.ZodOptional<z.ZodInt>;
2899
+ autoscalingLimitMinCu: z.ZodOptional<z.ZodNumber>;
2900
+ autoscalingLimitMaxCu: z.ZodOptional<z.ZodNumber>;
2901
+ suspendTimeoutSeconds: z.ZodOptional<z.ZodInt>;
2902
+ connectionUri: z.ZodOptional<z.ZodString>;
2903
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2904
+ typ: z.ZodLiteral<"queue">;
2905
+ }, z.core.$strip>, z.ZodObject<{
2906
+ foobar: z.ZodOptional<z.ZodString>;
2907
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2908
+ typ: z.ZodLiteral<"proxy">;
2909
+ }, z.core.$strip>, z.ZodObject<{
2910
+ subdomain: z.ZodOptional<z.ZodString>;
2911
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2912
+ typ: z.ZodLiteral<"vm">;
2913
+ }, z.core.$strip>, z.ZodObject<{
2914
+ os: z.ZodOptional<z.ZodString>;
2915
+ }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2916
+ typ: z.ZodLiteral<"scheduler">;
2917
+ }, z.core.$strip>, z.ZodObject<{
2918
+ expression: z.ZodString;
2919
+ timezone: z.ZodOptional<z.ZodString>;
2920
+ requestMethod: z.ZodOptional<z.ZodEnum<{
2921
+ DELETE: "DELETE";
2922
+ GET: "GET";
2923
+ HEAD: "HEAD";
2924
+ OPTIONS: "OPTIONS";
2925
+ PATCH: "PATCH";
2926
+ POST: "POST";
2927
+ PUT: "PUT";
2928
+ }>>;
2929
+ requestPayload: z.ZodOptional<z.ZodString>;
2930
+ requestHeaders: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
2931
+ paused: z.ZodBoolean;
2932
+ }, z.core.$strip>>]>>;
2933
+ }, z.core.$strip>>;
2934
+ }, z.core.$strip>;
2935
+ }, z.core.$strip>;
2513
2936
  export declare const zCreateNeonProjectM2mData: z.ZodObject<{
2514
2937
  body: z.ZodObject<{
2515
2938
  org_id: z.ZodString;
@@ -3233,7 +3656,6 @@ export declare const zViewBlueprintsResponse: z.ZodIntersection<z.ZodObject<{
3233
3656
  updatedBy: z.ZodString;
3234
3657
  name: z.ZodString;
3235
3658
  shortDescription: z.ZodString;
3236
- description: z.ZodString;
3237
3659
  exported: z.ZodArray<z.ZodObject<{
3238
3660
  key: z.ZodString;
3239
3661
  value: z.ZodString;
@@ -110,8 +110,28 @@ export const zPagination = z.object({
110
110
  limit: z.int(),
111
111
  total: z.int()
112
112
  });
113
+ export const zBlueprintListItem = z.object({
114
+ id: z.uuid(),
115
+ environment: z.uuid(),
116
+ ref: z.uuid(),
117
+ updatedAt: z.iso.datetime(),
118
+ createdAt: z.iso.datetime(),
119
+ author: z.string(),
120
+ updatedBy: z.string(),
121
+ name: z.string(),
122
+ shortDescription: z.string(),
123
+ exported: z.array(zEnvironmentVariable)
124
+ });
113
125
  export const zPaginatedBlueprints = zPagination.and(z.object({
114
- blueprints: z.array(zBlueprint)
126
+ blueprints: z.array(zBlueprintListItem)
127
+ }));
128
+ export const zBlueprintSummary = z.object({
129
+ id: z.uuid(),
130
+ name: z.string(),
131
+ shortDescription: z.string()
132
+ });
133
+ export const zPaginatedBlueprintSummaries = zPagination.and(z.object({
134
+ blueprints: z.array(zBlueprintSummary)
115
135
  }));
116
136
  export const zInvite = z.object({
117
137
  id: z.uuid(),
@@ -553,6 +573,13 @@ export const zGraph = z.object({
553
573
  version: z.int(),
554
574
  nodes: z.array(zNode)
555
575
  });
576
+ export const zBlueprintDetail = z.object({
577
+ id: z.uuid(),
578
+ name: z.string(),
579
+ shortDescription: z.string(),
580
+ description: z.string(),
581
+ graph: zGraph
582
+ });
556
583
  export const zSignedUrlDownloadResponse = z.object({
557
584
  signedUrl: z.string()
558
585
  });
@@ -975,6 +1002,23 @@ export const zUpdateNodeM2mData = z.object({
975
1002
  }),
976
1003
  query: z.optional(z.never())
977
1004
  });
1005
+ export const zViewBlueprintsM2mData = z.object({
1006
+ body: z.optional(z.never()),
1007
+ path: z.optional(z.never()),
1008
+ query: z.optional(z.object({
1009
+ limit: z.optional(z.int().gte(1).lte(100)).default(10),
1010
+ page: z.optional(z.int().gte(1)).default(1),
1011
+ search: z.optional(z.string()),
1012
+ order: z.optional(z.enum([
1013
+ 'asc',
1014
+ 'desc'
1015
+ ]))
1016
+ }))
1017
+ });
1018
+ /**
1019
+ * Paginated blueprint summaries.
1020
+ */
1021
+ export const zViewBlueprintsM2mResponse = zPaginatedBlueprintSummaries;
978
1022
  export const zCreateSecretM2mData = z.object({
979
1023
  body: zCreateSecret,
980
1024
  path: z.object({
@@ -986,6 +1030,17 @@ export const zCreateSecretM2mData = z.object({
986
1030
  * Secret reference created.
987
1031
  */
988
1032
  export const zCreateSecretM2mResponse = zSecret;
1033
+ export const zGetBlueprintM2mData = z.object({
1034
+ body: z.optional(z.never()),
1035
+ path: z.object({
1036
+ blueprint: z.uuid()
1037
+ }),
1038
+ query: z.optional(z.never())
1039
+ });
1040
+ /**
1041
+ * The blueprint with its full long description.
1042
+ */
1043
+ export const zGetBlueprintM2mResponse = zBlueprintDetail;
989
1044
  export const zCreateNeonProjectM2mData = z.object({
990
1045
  body: zCreateNeonProject,
991
1046
  path: z.object({
@@ -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, CreateSecretM2mData, CreateSecretM2mResponses, CreateNeonProjectM2mData, CreateNeonProjectM2mResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, FetchNeonOrganizationsData, FetchNeonRegionsData, 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, 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";
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>;
@@ -26,6 +26,9 @@ export declare const useUpdateNodeM2M: (config?: {
26
26
  data: unknown;
27
27
  headers: Headers;
28
28
  }, unknown, Omit<UpdateNodeM2mData, "url">, unknown>;
29
+ export declare const useViewBlueprintsM2M: (options?: Omit<ViewBlueprintsM2mData, "url"> & {
30
+ enabled?: boolean;
31
+ }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").PaginatedBlueprintSummaries | undefined, Error>;
29
32
  export declare const useCreateSecretM2M: (config?: {
30
33
  onSuccess?: (data: GetSuccessResponse<CreateSecretM2mResponses>, headers: Headers) => void;
31
34
  onError?: Parameters<typeof useMutation>["0"]["onError"];
@@ -34,6 +37,9 @@ export declare const useCreateSecretM2M: (config?: {
34
37
  data: import("../../sdk/types.gen").Secret | undefined;
35
38
  headers: Headers;
36
39
  }, unknown, Omit<CreateSecretM2mData, "url">, unknown>;
40
+ export declare const useGetBlueprintM2M: (options: Omit<GetBlueprintM2mData, "url"> & {
41
+ enabled?: boolean;
42
+ }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").BlueprintDetail | undefined, Error>;
37
43
  export declare const useCreateNeonProjectM2M: (config?: {
38
44
  onSuccess?: (data: GetSuccessResponse<CreateNeonProjectM2mResponses>, headers: Headers) => void;
39
45
  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, createSecretM2M, createNeonProjectM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, fetchNeonOrganizations, fetchNeonRegions, 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, 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";
6
6
  export const useGetServiceHealth = (options) => {
7
7
  const token = useToken();
8
8
  let { enabled, ...rest } = options || { enabled: true };
@@ -104,6 +104,27 @@ export const useUpdateNodeM2M = (config) => {
104
104
  retry: config?.retry
105
105
  });
106
106
  };
107
+ export const useViewBlueprintsM2M = (options) => {
108
+ const token = useToken();
109
+ let { enabled, ...rest } = options || { enabled: true };
110
+ const opts = { throwOnError: true, url: "/m2m/blueprints/view" };
111
+ const funcer = async () => {
112
+ const auth = isPromise(token) ? (await token) || "" : token || "";
113
+ if (isPromise(token) && !token)
114
+ return;
115
+ const res = await viewBlueprintsM2M({ ...opts, ...rest, auth });
116
+ return res.data;
117
+ };
118
+ if (!token)
119
+ enabled = false;
120
+ return useQuery({
121
+ queryKey: ["m2m", "blueprints", "view", options?.query ?? {}],
122
+ queryFn: funcer,
123
+ enabled,
124
+ retry: false,
125
+ staleTime: 600000
126
+ });
127
+ };
107
128
  export const useCreateSecretM2M = (config) => {
108
129
  const token = useToken();
109
130
  const queryClient = useQueryClient();
@@ -123,6 +144,27 @@ export const useCreateSecretM2M = (config) => {
123
144
  retry: config?.retry
124
145
  });
125
146
  };
147
+ export const useGetBlueprintM2M = (options) => {
148
+ const token = useToken();
149
+ let { enabled, ...rest } = options || { enabled: true };
150
+ const opts = { throwOnError: true, url: "/m2m/blueprints/{blueprint}" };
151
+ const funcer = async () => {
152
+ const auth = isPromise(token) ? (await token) || "" : token || "";
153
+ if (isPromise(token) && !token)
154
+ return;
155
+ const res = await getBlueprintM2M({ ...opts, ...rest, auth });
156
+ return res.data;
157
+ };
158
+ if (!token)
159
+ enabled = false;
160
+ return useQuery({
161
+ queryKey: ["m2m", "blueprints", options?.path?.blueprint, options.query ?? {}],
162
+ queryFn: funcer,
163
+ enabled,
164
+ retry: false,
165
+ staleTime: 600000
166
+ });
167
+ };
126
168
  export const useCreateNeonProjectM2M = (config) => {
127
169
  const token = useToken();
128
170
  const queryClient = useQueryClient();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoal-web-sdk",
3
- "version": "1.0.36",
3
+ "version": "1.0.37",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "build-hooks": "npx tsx tanstack-codegen/generator.ts",