shoal-web-sdk 1.0.12 → 1.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/sdk/@tanstack/react-query.gen.d.ts +55 -26
- package/dist/sdk/@tanstack/react-query.gen.js +67 -36
- package/dist/sdk/sdk.gen.d.ts +17 -12
- package/dist/sdk/sdk.gen.js +51 -24
- package/dist/sdk/types.gen.d.ts +183 -72
- package/dist/sdk/zod.gen.d.ts +263 -49
- package/dist/sdk/zod.gen.js +68 -33
- package/dist/tanstack-codegen/generated/generated.d.ts +26 -18
- package/dist/tanstack-codegen/generated/generated.js +51 -32
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type InfiniteData, type UseMutationOptions } from '@tanstack/react-query';
|
|
2
2
|
import { type Options } from '../sdk.gen';
|
|
3
|
-
import type { CheckSubdomainUniquenessData, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse,
|
|
3
|
+
import type { CheckSubdomainUniquenessData, CreateBlueprintData, CreateBlueprintError, CreateBlueprintResponse, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteBlueprintData, DeleteBlueprintError, DeleteBlueprintResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetBlueprintData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVersionsData, GetGraphOverviewData, GetProjectOverviewData, GetPublicInviteData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpacePropertiesData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, GetVersionData, GetVersionM2mData, ImportBlueprintData, ImportBlueprintError, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, 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';
|
|
4
4
|
export type QueryKey<TOptions extends Options> = [
|
|
5
5
|
Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
|
|
6
6
|
_id: string;
|
|
@@ -450,84 +450,105 @@ export declare const createFeatureRequestMutation: (options?: Partial<Options<Cr
|
|
|
450
450
|
* Record analytics data captured during the onboarding flow.
|
|
451
451
|
*/
|
|
452
452
|
export declare const recordOnboardingAnalyticsMutation: (options?: Partial<Options<RecordOnboardingAnalyticsData>>) => UseMutationOptions<unknown, RecordOnboardingAnalyticsError, Options<RecordOnboardingAnalyticsData>>;
|
|
453
|
-
export declare const
|
|
453
|
+
export declare const previewBlueprintQueryKey: (options: Options<PreviewBlueprintData>) => [Pick<Options<PreviewBlueprintData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
454
454
|
_id: string;
|
|
455
455
|
_infinite?: boolean;
|
|
456
456
|
tags?: ReadonlyArray<string>;
|
|
457
457
|
}];
|
|
458
|
-
export declare const
|
|
458
|
+
export declare const previewBlueprintOptions: (options: Options<PreviewBlueprintData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Nodes, Error, import("../types.gen").Nodes, [Pick<Options<PreviewBlueprintData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
459
459
|
_id: string;
|
|
460
460
|
_infinite?: boolean;
|
|
461
461
|
tags?: ReadonlyArray<string>;
|
|
462
462
|
}]>, "queryFn"> & {
|
|
463
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
463
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Nodes, [Pick<Options<PreviewBlueprintData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
464
464
|
_id: string;
|
|
465
465
|
_infinite?: boolean;
|
|
466
466
|
tags?: ReadonlyArray<string>;
|
|
467
467
|
}], never> | undefined;
|
|
468
468
|
} & {
|
|
469
|
-
queryKey: [Pick<Options<
|
|
469
|
+
queryKey: [Pick<Options<PreviewBlueprintData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
470
470
|
_id: string;
|
|
471
471
|
_infinite?: boolean;
|
|
472
472
|
tags?: ReadonlyArray<string>;
|
|
473
473
|
}] & {
|
|
474
|
-
[dataTagSymbol]: import("../types.gen").
|
|
474
|
+
[dataTagSymbol]: import("../types.gen").Nodes;
|
|
475
475
|
[dataTagErrorSymbol]: Error;
|
|
476
476
|
};
|
|
477
477
|
};
|
|
478
|
-
export declare const
|
|
479
|
-
|
|
478
|
+
export declare const viewBlueprintsQueryKey: (options?: Options<ViewBlueprintsData>) => [Pick<Options<ViewBlueprintsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
479
|
+
_id: string;
|
|
480
|
+
_infinite?: boolean;
|
|
481
|
+
tags?: ReadonlyArray<string>;
|
|
482
|
+
}];
|
|
483
|
+
export declare const viewBlueprintsOptions: (options?: Options<ViewBlueprintsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedBlueprints, Error, import("../types.gen").PaginatedBlueprints, [Pick<Options<ViewBlueprintsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
484
|
+
_id: string;
|
|
485
|
+
_infinite?: boolean;
|
|
486
|
+
tags?: ReadonlyArray<string>;
|
|
487
|
+
}]>, "queryFn"> & {
|
|
488
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaginatedBlueprints, [Pick<Options<ViewBlueprintsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
489
|
+
_id: string;
|
|
490
|
+
_infinite?: boolean;
|
|
491
|
+
tags?: ReadonlyArray<string>;
|
|
492
|
+
}], never> | undefined;
|
|
493
|
+
} & {
|
|
494
|
+
queryKey: [Pick<Options<ViewBlueprintsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
495
|
+
_id: string;
|
|
496
|
+
_infinite?: boolean;
|
|
497
|
+
tags?: ReadonlyArray<string>;
|
|
498
|
+
}] & {
|
|
499
|
+
[dataTagSymbol]: import("../types.gen").PaginatedBlueprints;
|
|
500
|
+
[dataTagErrorSymbol]: Error;
|
|
501
|
+
};
|
|
502
|
+
};
|
|
503
|
+
export declare const viewBlueprintsInfiniteQueryKey: (options?: Options<ViewBlueprintsData>) => QueryKey<Options<ViewBlueprintsData>>;
|
|
504
|
+
export declare const viewBlueprintsInfiniteOptions: (options?: Options<ViewBlueprintsData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedBlueprints, import("../types.gen").ErrorResponse, InfiniteData<import("../types.gen").PaginatedBlueprints, unknown>, QueryKey<Options<ViewBlueprintsData>>, number | Pick<Pick<Options<ViewBlueprintsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
480
505
|
_id: string;
|
|
481
506
|
_infinite?: boolean;
|
|
482
507
|
tags?: ReadonlyArray<string>;
|
|
483
508
|
}, "query" | "body" | "headers" | "path">> & {
|
|
484
|
-
initialData: InfiniteData<import("../types.gen").
|
|
509
|
+
initialData: InfiniteData<import("../types.gen").PaginatedBlueprints, number | Pick<Pick<Options<ViewBlueprintsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
485
510
|
_id: string;
|
|
486
511
|
_infinite?: boolean;
|
|
487
512
|
tags?: ReadonlyArray<string>;
|
|
488
|
-
}, "query" | "body" | "headers" | "path">> | (() => InfiniteData<import("../types.gen").
|
|
513
|
+
}, "query" | "body" | "headers" | "path">> | (() => InfiniteData<import("../types.gen").PaginatedBlueprints, number | Pick<Pick<Options<ViewBlueprintsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
489
514
|
_id: string;
|
|
490
515
|
_infinite?: boolean;
|
|
491
516
|
tags?: ReadonlyArray<string>;
|
|
492
517
|
}, "query" | "body" | "headers" | "path">>) | undefined;
|
|
493
518
|
} & {
|
|
494
|
-
queryKey: QueryKey<Options<
|
|
495
|
-
[dataTagSymbol]: InfiniteData<import("../types.gen").
|
|
519
|
+
queryKey: QueryKey<Options<ViewBlueprintsData>> & {
|
|
520
|
+
[dataTagSymbol]: InfiniteData<import("../types.gen").PaginatedBlueprints, unknown>;
|
|
496
521
|
[dataTagErrorSymbol]: import("../types.gen").ErrorResponse;
|
|
497
522
|
};
|
|
498
523
|
};
|
|
499
|
-
export declare const
|
|
524
|
+
export declare const getBlueprintQueryKey: (options: Options<GetBlueprintData>) => [Pick<Options<GetBlueprintData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
500
525
|
_id: string;
|
|
501
526
|
_infinite?: boolean;
|
|
502
527
|
tags?: ReadonlyArray<string>;
|
|
503
528
|
}];
|
|
504
529
|
/**
|
|
505
|
-
* Retrieve a
|
|
530
|
+
* Retrieve a blueprint record.
|
|
506
531
|
*/
|
|
507
|
-
export declare const
|
|
532
|
+
export declare const getBlueprintOptions: (options: Options<GetBlueprintData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Blueprint, Error, import("../types.gen").Blueprint, [Pick<Options<GetBlueprintData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
508
533
|
_id: string;
|
|
509
534
|
_infinite?: boolean;
|
|
510
535
|
tags?: ReadonlyArray<string>;
|
|
511
536
|
}]>, "queryFn"> & {
|
|
512
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
537
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Blueprint, [Pick<Options<GetBlueprintData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
513
538
|
_id: string;
|
|
514
539
|
_infinite?: boolean;
|
|
515
540
|
tags?: ReadonlyArray<string>;
|
|
516
541
|
}], never> | undefined;
|
|
517
542
|
} & {
|
|
518
|
-
queryKey: [Pick<Options<
|
|
543
|
+
queryKey: [Pick<Options<GetBlueprintData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
519
544
|
_id: string;
|
|
520
545
|
_infinite?: boolean;
|
|
521
546
|
tags?: ReadonlyArray<string>;
|
|
522
547
|
}] & {
|
|
523
|
-
[dataTagSymbol]: import("../types.gen").
|
|
548
|
+
[dataTagSymbol]: import("../types.gen").Blueprint;
|
|
524
549
|
[dataTagErrorSymbol]: Error;
|
|
525
550
|
};
|
|
526
551
|
};
|
|
527
|
-
/**
|
|
528
|
-
* Update a template record.
|
|
529
|
-
*/
|
|
530
|
-
export declare const updateTemplateMutation: (options?: Partial<Options<UpdateTemplateData>>) => UseMutationOptions<UpdateTemplateResponse, UpdateTemplateError, Options<UpdateTemplateData>>;
|
|
531
552
|
/**
|
|
532
553
|
* Create a space.
|
|
533
554
|
*/
|
|
@@ -1033,13 +1054,17 @@ export declare const updateEnvironmentVariableMutation: (options?: Partial<Optio
|
|
|
1033
1054
|
*/
|
|
1034
1055
|
export declare const createEnvironmentVariableMutation: (options?: Partial<Options<CreateEnvironmentVariableData>>) => UseMutationOptions<unknown, CreateEnvironmentVariableError, Options<CreateEnvironmentVariableData>>;
|
|
1035
1056
|
/**
|
|
1036
|
-
* Delete a
|
|
1057
|
+
* Delete a blueprint record.
|
|
1058
|
+
*/
|
|
1059
|
+
export declare const deleteBlueprintMutation: (options?: Partial<Options<DeleteBlueprintData>>) => UseMutationOptions<DeleteBlueprintResponse, DeleteBlueprintError, Options<DeleteBlueprintData>>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Update a blueprint record.
|
|
1037
1062
|
*/
|
|
1038
|
-
export declare const
|
|
1063
|
+
export declare const updateBlueprintMutation: (options?: Partial<Options<UpdateBlueprintData>>) => UseMutationOptions<UpdateBlueprintResponse, UpdateBlueprintError, Options<UpdateBlueprintData>>;
|
|
1039
1064
|
/**
|
|
1040
|
-
* Create a
|
|
1065
|
+
* Create a blueprint. A blueprint references the HEAD version of an environment.
|
|
1041
1066
|
*/
|
|
1042
|
-
export declare const
|
|
1067
|
+
export declare const createBlueprintMutation: (options?: Partial<Options<CreateBlueprintData>>) => UseMutationOptions<CreateBlueprintResponse, CreateBlueprintError, Options<CreateBlueprintData>>;
|
|
1043
1068
|
export declare const getVersionQueryKey: (options: Options<GetVersionData>) => [Pick<Options<GetVersionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1044
1069
|
_id: string;
|
|
1045
1070
|
_infinite?: boolean;
|
|
@@ -1068,6 +1093,10 @@ export declare const getVersionOptions: (options: Options<GetVersionData>) => im
|
|
|
1068
1093
|
[dataTagErrorSymbol]: Error;
|
|
1069
1094
|
};
|
|
1070
1095
|
};
|
|
1096
|
+
/**
|
|
1097
|
+
* Import a blueprint into an environment. This does not overwrite existing content. Please create an environment before importing.
|
|
1098
|
+
*/
|
|
1099
|
+
export declare const importBlueprintMutation: (options?: Partial<Options<ImportBlueprintData>>) => UseMutationOptions<unknown, ImportBlueprintError, Options<ImportBlueprintData>>;
|
|
1071
1100
|
export declare const getGraphOverviewQueryKey: (options: Options<GetGraphOverviewData>) => [Pick<Options<GetGraphOverviewData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1072
1101
|
_id: string;
|
|
1073
1102
|
_infinite?: boolean;
|
|
@@ -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, createEnvironment, createEnvironmentVariable, createFeatureRequest, createProject, createSetupIntent, createSpace, createSpaceInvite,
|
|
4
|
+
import { checkSubdomainUniqueness, createBlueprint, createEnvironment, createEnvironmentVariable, createFeatureRequest, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteBlueprint, deleteEnvironmentVariable, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getBlueprint, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVersions, getGraphOverview, getProjectOverview, getPublicInvite, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getSpaceProperties, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, getVersion, getVersionM2M, importBlueprint, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, 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';
|
|
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) {
|
|
@@ -532,11 +532,11 @@ export const recordOnboardingAnalyticsMutation = (options) => {
|
|
|
532
532
|
};
|
|
533
533
|
return mutationOptions;
|
|
534
534
|
};
|
|
535
|
-
export const
|
|
536
|
-
export const
|
|
535
|
+
export const previewBlueprintQueryKey = (options) => createQueryKey('previewBlueprint', options);
|
|
536
|
+
export const previewBlueprintOptions = (options) => {
|
|
537
537
|
return queryOptions({
|
|
538
538
|
queryFn: async ({ queryKey, signal }) => {
|
|
539
|
-
const { data } = await
|
|
539
|
+
const { data } = await previewBlueprint({
|
|
540
540
|
...options,
|
|
541
541
|
...queryKey[0],
|
|
542
542
|
signal,
|
|
@@ -544,11 +544,26 @@ export const viewTemplatesOptions = (options) => {
|
|
|
544
544
|
});
|
|
545
545
|
return data;
|
|
546
546
|
},
|
|
547
|
-
queryKey:
|
|
547
|
+
queryKey: previewBlueprintQueryKey(options)
|
|
548
548
|
});
|
|
549
549
|
};
|
|
550
|
-
export const
|
|
551
|
-
export const
|
|
550
|
+
export const viewBlueprintsQueryKey = (options) => createQueryKey('viewBlueprints', options);
|
|
551
|
+
export const viewBlueprintsOptions = (options) => {
|
|
552
|
+
return queryOptions({
|
|
553
|
+
queryFn: async ({ queryKey, signal }) => {
|
|
554
|
+
const { data } = await viewBlueprints({
|
|
555
|
+
...options,
|
|
556
|
+
...queryKey[0],
|
|
557
|
+
signal,
|
|
558
|
+
throwOnError: true
|
|
559
|
+
});
|
|
560
|
+
return data;
|
|
561
|
+
},
|
|
562
|
+
queryKey: viewBlueprintsQueryKey(options)
|
|
563
|
+
});
|
|
564
|
+
};
|
|
565
|
+
export const viewBlueprintsInfiniteQueryKey = (options) => createQueryKey('viewBlueprints', options, true);
|
|
566
|
+
export const viewBlueprintsInfiniteOptions = (options) => {
|
|
552
567
|
return infiniteQueryOptions(
|
|
553
568
|
// @ts-ignore
|
|
554
569
|
{
|
|
@@ -560,7 +575,7 @@ export const viewTemplatesInfiniteOptions = (options) => {
|
|
|
560
575
|
}
|
|
561
576
|
};
|
|
562
577
|
const params = createInfiniteParams(queryKey, page);
|
|
563
|
-
const { data } = await
|
|
578
|
+
const { data } = await viewBlueprints({
|
|
564
579
|
...options,
|
|
565
580
|
...params,
|
|
566
581
|
signal,
|
|
@@ -568,17 +583,17 @@ export const viewTemplatesInfiniteOptions = (options) => {
|
|
|
568
583
|
});
|
|
569
584
|
return data;
|
|
570
585
|
},
|
|
571
|
-
queryKey:
|
|
586
|
+
queryKey: viewBlueprintsInfiniteQueryKey(options)
|
|
572
587
|
});
|
|
573
588
|
};
|
|
574
|
-
export const
|
|
589
|
+
export const getBlueprintQueryKey = (options) => createQueryKey('getBlueprint', options);
|
|
575
590
|
/**
|
|
576
|
-
* Retrieve a
|
|
591
|
+
* Retrieve a blueprint record.
|
|
577
592
|
*/
|
|
578
|
-
export const
|
|
593
|
+
export const getBlueprintOptions = (options) => {
|
|
579
594
|
return queryOptions({
|
|
580
595
|
queryFn: async ({ queryKey, signal }) => {
|
|
581
|
-
const { data } = await
|
|
596
|
+
const { data } = await getBlueprint({
|
|
582
597
|
...options,
|
|
583
598
|
...queryKey[0],
|
|
584
599
|
signal,
|
|
@@ -586,25 +601,9 @@ export const getTemplateOptions = (options) => {
|
|
|
586
601
|
});
|
|
587
602
|
return data;
|
|
588
603
|
},
|
|
589
|
-
queryKey:
|
|
604
|
+
queryKey: getBlueprintQueryKey(options)
|
|
590
605
|
});
|
|
591
606
|
};
|
|
592
|
-
/**
|
|
593
|
-
* Update a template record.
|
|
594
|
-
*/
|
|
595
|
-
export const updateTemplateMutation = (options) => {
|
|
596
|
-
const mutationOptions = {
|
|
597
|
-
mutationFn: async (fnOptions) => {
|
|
598
|
-
const { data } = await updateTemplate({
|
|
599
|
-
...options,
|
|
600
|
-
...fnOptions,
|
|
601
|
-
throwOnError: true
|
|
602
|
-
});
|
|
603
|
-
return data;
|
|
604
|
-
}
|
|
605
|
-
};
|
|
606
|
-
return mutationOptions;
|
|
607
|
-
};
|
|
608
607
|
/**
|
|
609
608
|
* Create a space.
|
|
610
609
|
*/
|
|
@@ -1124,12 +1123,28 @@ export const createEnvironmentVariableMutation = (options) => {
|
|
|
1124
1123
|
return mutationOptions;
|
|
1125
1124
|
};
|
|
1126
1125
|
/**
|
|
1127
|
-
* Delete a
|
|
1126
|
+
* Delete a blueprint record.
|
|
1127
|
+
*/
|
|
1128
|
+
export const deleteBlueprintMutation = (options) => {
|
|
1129
|
+
const mutationOptions = {
|
|
1130
|
+
mutationFn: async (fnOptions) => {
|
|
1131
|
+
const { data } = await deleteBlueprint({
|
|
1132
|
+
...options,
|
|
1133
|
+
...fnOptions,
|
|
1134
|
+
throwOnError: true
|
|
1135
|
+
});
|
|
1136
|
+
return data;
|
|
1137
|
+
}
|
|
1138
|
+
};
|
|
1139
|
+
return mutationOptions;
|
|
1140
|
+
};
|
|
1141
|
+
/**
|
|
1142
|
+
* Update a blueprint record.
|
|
1128
1143
|
*/
|
|
1129
|
-
export const
|
|
1144
|
+
export const updateBlueprintMutation = (options) => {
|
|
1130
1145
|
const mutationOptions = {
|
|
1131
1146
|
mutationFn: async (fnOptions) => {
|
|
1132
|
-
const { data } = await
|
|
1147
|
+
const { data } = await updateBlueprint({
|
|
1133
1148
|
...options,
|
|
1134
1149
|
...fnOptions,
|
|
1135
1150
|
throwOnError: true
|
|
@@ -1140,12 +1155,12 @@ export const deleteTemplateMutation = (options) => {
|
|
|
1140
1155
|
return mutationOptions;
|
|
1141
1156
|
};
|
|
1142
1157
|
/**
|
|
1143
|
-
* Create a
|
|
1158
|
+
* Create a blueprint. A blueprint references the HEAD version of an environment.
|
|
1144
1159
|
*/
|
|
1145
|
-
export const
|
|
1160
|
+
export const createBlueprintMutation = (options) => {
|
|
1146
1161
|
const mutationOptions = {
|
|
1147
1162
|
mutationFn: async (fnOptions) => {
|
|
1148
|
-
const { data } = await
|
|
1163
|
+
const { data } = await createBlueprint({
|
|
1149
1164
|
...options,
|
|
1150
1165
|
...fnOptions,
|
|
1151
1166
|
throwOnError: true
|
|
@@ -1173,6 +1188,22 @@ export const getVersionOptions = (options) => {
|
|
|
1173
1188
|
queryKey: getVersionQueryKey(options)
|
|
1174
1189
|
});
|
|
1175
1190
|
};
|
|
1191
|
+
/**
|
|
1192
|
+
* Import a blueprint into an environment. This does not overwrite existing content. Please create an environment before importing.
|
|
1193
|
+
*/
|
|
1194
|
+
export const importBlueprintMutation = (options) => {
|
|
1195
|
+
const mutationOptions = {
|
|
1196
|
+
mutationFn: async (fnOptions) => {
|
|
1197
|
+
const { data } = await importBlueprint({
|
|
1198
|
+
...options,
|
|
1199
|
+
...fnOptions,
|
|
1200
|
+
throwOnError: true
|
|
1201
|
+
});
|
|
1202
|
+
return data;
|
|
1203
|
+
}
|
|
1204
|
+
};
|
|
1205
|
+
return mutationOptions;
|
|
1206
|
+
};
|
|
1176
1207
|
export const getGraphOverviewQueryKey = (options) => createQueryKey('getGraphOverview', options);
|
|
1177
1208
|
/**
|
|
1178
1209
|
* Get a graph for a version inside an environment.
|
package/dist/sdk/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
-
import type { CheckSubdomainUniquenessData, CheckSubdomainUniquenessErrors, CheckSubdomainUniquenessResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateFeatureRequestData, CreateFeatureRequestErrors, CreateFeatureRequestResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses,
|
|
2
|
+
import type { CheckSubdomainUniquenessData, CheckSubdomainUniquenessErrors, CheckSubdomainUniquenessResponses, CreateBlueprintData, CreateBlueprintErrors, CreateBlueprintResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateFeatureRequestData, CreateFeatureRequestErrors, CreateFeatureRequestResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteBlueprintData, DeleteBlueprintErrors, DeleteBlueprintResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetBlueprintData, GetBlueprintErrors, GetBlueprintResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetEnvironmentVariablesData, GetEnvironmentVariablesErrors, GetEnvironmentVariablesResponses, GetEnvironmentVersionsData, GetEnvironmentVersionsResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetPublicInviteData, GetPublicInviteErrors, GetPublicInviteResponses, 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, 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';
|
|
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
|
|
@@ -95,15 +95,12 @@ export declare const createFeatureRequest: <ThrowOnError extends boolean = false
|
|
|
95
95
|
* Record analytics data captured during the onboarding flow.
|
|
96
96
|
*/
|
|
97
97
|
export declare const recordOnboardingAnalytics: <ThrowOnError extends boolean = false>(options: Options<RecordOnboardingAnalyticsData, ThrowOnError>) => import("./client").RequestResult<RecordOnboardingAnalyticsResponses, RecordOnboardingAnalyticsErrors, ThrowOnError, "fields">;
|
|
98
|
-
export declare const
|
|
98
|
+
export declare const previewBlueprint: <ThrowOnError extends boolean = false>(options: Options<PreviewBlueprintData, ThrowOnError>) => import("./client").RequestResult<PreviewBlueprintResponses, PreviewBlueprintErrors, ThrowOnError, "fields">;
|
|
99
|
+
export declare const viewBlueprints: <ThrowOnError extends boolean = false>(options?: Options<ViewBlueprintsData, ThrowOnError>) => import("./client").RequestResult<ViewBlueprintsResponses, ViewBlueprintsErrors, ThrowOnError, "fields">;
|
|
99
100
|
/**
|
|
100
|
-
* Retrieve a
|
|
101
|
+
* Retrieve a blueprint record.
|
|
101
102
|
*/
|
|
102
|
-
export declare const
|
|
103
|
-
/**
|
|
104
|
-
* Update a template record.
|
|
105
|
-
*/
|
|
106
|
-
export declare const updateTemplate: <ThrowOnError extends boolean = false>(options: Options<UpdateTemplateData, ThrowOnError>) => import("./client").RequestResult<UpdateTemplateResponses, UpdateTemplateErrors, ThrowOnError, "fields">;
|
|
103
|
+
export declare const getBlueprint: <ThrowOnError extends boolean = false>(options: Options<GetBlueprintData, ThrowOnError>) => import("./client").RequestResult<GetBlueprintResponses, GetBlueprintErrors, ThrowOnError, "fields">;
|
|
107
104
|
/**
|
|
108
105
|
* Create a space.
|
|
109
106
|
*/
|
|
@@ -201,17 +198,25 @@ export declare const updateEnvironmentVariable: <ThrowOnError extends boolean =
|
|
|
201
198
|
*/
|
|
202
199
|
export declare const createEnvironmentVariable: <ThrowOnError extends boolean = false>(options: Options<CreateEnvironmentVariableData, ThrowOnError>) => import("./client").RequestResult<CreateEnvironmentVariableResponses, CreateEnvironmentVariableErrors, ThrowOnError, "fields">;
|
|
203
200
|
/**
|
|
204
|
-
* Delete a
|
|
201
|
+
* Delete a blueprint record.
|
|
202
|
+
*/
|
|
203
|
+
export declare const deleteBlueprint: <ThrowOnError extends boolean = false>(options: Options<DeleteBlueprintData, ThrowOnError>) => import("./client").RequestResult<DeleteBlueprintResponses, DeleteBlueprintErrors, ThrowOnError, "fields">;
|
|
204
|
+
/**
|
|
205
|
+
* Update a blueprint record.
|
|
205
206
|
*/
|
|
206
|
-
export declare const
|
|
207
|
+
export declare const updateBlueprint: <ThrowOnError extends boolean = false>(options: Options<UpdateBlueprintData, ThrowOnError>) => import("./client").RequestResult<UpdateBlueprintResponses, UpdateBlueprintErrors, ThrowOnError, "fields">;
|
|
207
208
|
/**
|
|
208
|
-
* Create a
|
|
209
|
+
* Create a blueprint. A blueprint references the HEAD version of an environment.
|
|
209
210
|
*/
|
|
210
|
-
export declare const
|
|
211
|
+
export declare const createBlueprint: <ThrowOnError extends boolean = false>(options: Options<CreateBlueprintData, ThrowOnError>) => import("./client").RequestResult<CreateBlueprintResponses, CreateBlueprintErrors, ThrowOnError, "fields">;
|
|
211
212
|
/**
|
|
212
213
|
* Get a version inside an environment.
|
|
213
214
|
*/
|
|
214
215
|
export declare const getVersion: <ThrowOnError extends boolean = false>(options: Options<GetVersionData, ThrowOnError>) => import("./client").RequestResult<GetVersionResponses, GetVersionErrors, ThrowOnError, "fields">;
|
|
216
|
+
/**
|
|
217
|
+
* Import a blueprint into an environment. This does not overwrite existing content. Please create an environment before importing.
|
|
218
|
+
*/
|
|
219
|
+
export declare const importBlueprint: <ThrowOnError extends boolean = false>(options: Options<ImportBlueprintData, ThrowOnError>) => import("./client").RequestResult<ImportBlueprintResponses, ImportBlueprintErrors, ThrowOnError, "fields">;
|
|
215
220
|
/**
|
|
216
221
|
* Get a graph for a version inside an environment.
|
|
217
222
|
*/
|
package/dist/sdk/sdk.gen.js
CHANGED
|
@@ -356,50 +356,43 @@ export const recordOnboardingAnalytics = (options) => {
|
|
|
356
356
|
}
|
|
357
357
|
});
|
|
358
358
|
};
|
|
359
|
-
export const
|
|
360
|
-
return (options
|
|
359
|
+
export const previewBlueprint = (options) => {
|
|
360
|
+
return (options.client ?? client).get({
|
|
361
361
|
security: [
|
|
362
362
|
{
|
|
363
363
|
scheme: 'bearer',
|
|
364
364
|
type: 'http'
|
|
365
365
|
}
|
|
366
366
|
],
|
|
367
|
-
url: '/
|
|
367
|
+
url: '/blueprints/preview/{blueprint}',
|
|
368
368
|
...options
|
|
369
369
|
});
|
|
370
370
|
};
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
*/
|
|
374
|
-
export const getTemplate = (options) => {
|
|
375
|
-
return (options.client ?? client).get({
|
|
371
|
+
export const viewBlueprints = (options) => {
|
|
372
|
+
return (options?.client ?? client).get({
|
|
376
373
|
security: [
|
|
377
374
|
{
|
|
378
375
|
scheme: 'bearer',
|
|
379
376
|
type: 'http'
|
|
380
377
|
}
|
|
381
378
|
],
|
|
382
|
-
url: '/
|
|
379
|
+
url: '/blueprints/view',
|
|
383
380
|
...options
|
|
384
381
|
});
|
|
385
382
|
};
|
|
386
383
|
/**
|
|
387
|
-
*
|
|
384
|
+
* Retrieve a blueprint record.
|
|
388
385
|
*/
|
|
389
|
-
export const
|
|
390
|
-
return (options.client ?? client).
|
|
386
|
+
export const getBlueprint = (options) => {
|
|
387
|
+
return (options.client ?? client).get({
|
|
391
388
|
security: [
|
|
392
389
|
{
|
|
393
390
|
scheme: 'bearer',
|
|
394
391
|
type: 'http'
|
|
395
392
|
}
|
|
396
393
|
],
|
|
397
|
-
url: '/
|
|
398
|
-
...options
|
|
399
|
-
headers: {
|
|
400
|
-
'Content-Type': 'application/json',
|
|
401
|
-
...options.headers
|
|
402
|
-
}
|
|
394
|
+
url: '/blueprints/{blueprint}',
|
|
395
|
+
...options
|
|
403
396
|
});
|
|
404
397
|
};
|
|
405
398
|
/**
|
|
@@ -787,9 +780,9 @@ export const createEnvironmentVariable = (options) => {
|
|
|
787
780
|
});
|
|
788
781
|
};
|
|
789
782
|
/**
|
|
790
|
-
* Delete a
|
|
783
|
+
* Delete a blueprint record.
|
|
791
784
|
*/
|
|
792
|
-
export const
|
|
785
|
+
export const deleteBlueprint = (options) => {
|
|
793
786
|
return (options.client ?? client).delete({
|
|
794
787
|
security: [
|
|
795
788
|
{
|
|
@@ -797,14 +790,33 @@ export const deleteTemplate = (options) => {
|
|
|
797
790
|
type: 'http'
|
|
798
791
|
}
|
|
799
792
|
],
|
|
800
|
-
url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{
|
|
793
|
+
url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{blueprint}',
|
|
801
794
|
...options
|
|
802
795
|
});
|
|
803
796
|
};
|
|
804
797
|
/**
|
|
805
|
-
*
|
|
798
|
+
* Update a blueprint record.
|
|
799
|
+
*/
|
|
800
|
+
export const updateBlueprint = (options) => {
|
|
801
|
+
return (options.client ?? client).patch({
|
|
802
|
+
security: [
|
|
803
|
+
{
|
|
804
|
+
scheme: 'bearer',
|
|
805
|
+
type: 'http'
|
|
806
|
+
}
|
|
807
|
+
],
|
|
808
|
+
url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{blueprint}',
|
|
809
|
+
...options,
|
|
810
|
+
headers: {
|
|
811
|
+
'Content-Type': 'application/json',
|
|
812
|
+
...options.headers
|
|
813
|
+
}
|
|
814
|
+
});
|
|
815
|
+
};
|
|
816
|
+
/**
|
|
817
|
+
* Create a blueprint. A blueprint references the HEAD version of an environment.
|
|
806
818
|
*/
|
|
807
|
-
export const
|
|
819
|
+
export const createBlueprint = (options) => {
|
|
808
820
|
return (options.client ?? client).post({
|
|
809
821
|
security: [
|
|
810
822
|
{
|
|
@@ -812,7 +824,7 @@ export const createTemplate = (options) => {
|
|
|
812
824
|
type: 'http'
|
|
813
825
|
}
|
|
814
826
|
],
|
|
815
|
-
url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/
|
|
827
|
+
url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/blueprints/create',
|
|
816
828
|
...options,
|
|
817
829
|
headers: {
|
|
818
830
|
'Content-Type': 'application/json',
|
|
@@ -835,6 +847,21 @@ export const getVersion = (options) => {
|
|
|
835
847
|
...options
|
|
836
848
|
});
|
|
837
849
|
};
|
|
850
|
+
/**
|
|
851
|
+
* Import a blueprint into an environment. This does not overwrite existing content. Please create an environment before importing.
|
|
852
|
+
*/
|
|
853
|
+
export const importBlueprint = (options) => {
|
|
854
|
+
return (options.client ?? client).patch({
|
|
855
|
+
security: [
|
|
856
|
+
{
|
|
857
|
+
scheme: 'bearer',
|
|
858
|
+
type: 'http'
|
|
859
|
+
}
|
|
860
|
+
],
|
|
861
|
+
url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/import',
|
|
862
|
+
...options
|
|
863
|
+
});
|
|
864
|
+
};
|
|
838
865
|
/**
|
|
839
866
|
* Get a graph for a version inside an environment.
|
|
840
867
|
*/
|