shoal-web-sdk 1.0.11 → 1.0.12

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, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVersionsData, GetGraphOverviewData, GetProjectOverviewData, GetPublicInviteData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, GetVersionData, GetVersionM2mData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedDownloadUrlData, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateNodeM2mData, UpdateNodeM2mError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError } from '../types.gen';
3
+ import type { CheckSubdomainUniquenessData, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateTemplateData, CreateTemplateError, CreateTemplateResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeleteTemplateData, DeleteTemplateError, DeleteTemplateResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVersionsData, GetGraphOverviewData, GetProjectOverviewData, GetPublicInviteData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpacePropertiesData, GetSpaceStatsData, GetTemplateData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, GetVersionData, GetVersionM2mData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, 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, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateNodeM2mData, UpdateNodeM2mError, UpdateTemplateData, UpdateTemplateError, UpdateTemplateResponse, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, ViewTemplatesData } 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,6 +450,84 @@ 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 viewTemplatesQueryKey: (options?: Options<ViewTemplatesData>) => [Pick<Options<ViewTemplatesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
454
+ _id: string;
455
+ _infinite?: boolean;
456
+ tags?: ReadonlyArray<string>;
457
+ }];
458
+ export declare const viewTemplatesOptions: (options?: Options<ViewTemplatesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedTemplates, Error, import("../types.gen").PaginatedTemplates, [Pick<Options<ViewTemplatesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
459
+ _id: string;
460
+ _infinite?: boolean;
461
+ tags?: ReadonlyArray<string>;
462
+ }]>, "queryFn"> & {
463
+ queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaginatedTemplates, [Pick<Options<ViewTemplatesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
464
+ _id: string;
465
+ _infinite?: boolean;
466
+ tags?: ReadonlyArray<string>;
467
+ }], never> | undefined;
468
+ } & {
469
+ queryKey: [Pick<Options<ViewTemplatesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
470
+ _id: string;
471
+ _infinite?: boolean;
472
+ tags?: ReadonlyArray<string>;
473
+ }] & {
474
+ [dataTagSymbol]: import("../types.gen").PaginatedTemplates;
475
+ [dataTagErrorSymbol]: Error;
476
+ };
477
+ };
478
+ export declare const viewTemplatesInfiniteQueryKey: (options?: Options<ViewTemplatesData>) => QueryKey<Options<ViewTemplatesData>>;
479
+ export declare const viewTemplatesInfiniteOptions: (options?: Options<ViewTemplatesData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedTemplates, import("../types.gen").ErrorResponse, InfiniteData<import("../types.gen").PaginatedTemplates, unknown>, QueryKey<Options<ViewTemplatesData>>, number | Pick<Pick<Options<ViewTemplatesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
480
+ _id: string;
481
+ _infinite?: boolean;
482
+ tags?: ReadonlyArray<string>;
483
+ }, "query" | "body" | "headers" | "path">> & {
484
+ initialData: InfiniteData<import("../types.gen").PaginatedTemplates, number | Pick<Pick<Options<ViewTemplatesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
485
+ _id: string;
486
+ _infinite?: boolean;
487
+ tags?: ReadonlyArray<string>;
488
+ }, "query" | "body" | "headers" | "path">> | (() => InfiniteData<import("../types.gen").PaginatedTemplates, number | Pick<Pick<Options<ViewTemplatesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
489
+ _id: string;
490
+ _infinite?: boolean;
491
+ tags?: ReadonlyArray<string>;
492
+ }, "query" | "body" | "headers" | "path">>) | undefined;
493
+ } & {
494
+ queryKey: QueryKey<Options<ViewTemplatesData>> & {
495
+ [dataTagSymbol]: InfiniteData<import("../types.gen").PaginatedTemplates, unknown>;
496
+ [dataTagErrorSymbol]: import("../types.gen").ErrorResponse;
497
+ };
498
+ };
499
+ export declare const getTemplateQueryKey: (options: Options<GetTemplateData>) => [Pick<Options<GetTemplateData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
500
+ _id: string;
501
+ _infinite?: boolean;
502
+ tags?: ReadonlyArray<string>;
503
+ }];
504
+ /**
505
+ * Retrieve a template record.
506
+ */
507
+ export declare const getTemplateOptions: (options: Options<GetTemplateData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Template, Error, import("../types.gen").Template, [Pick<Options<GetTemplateData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
508
+ _id: string;
509
+ _infinite?: boolean;
510
+ tags?: ReadonlyArray<string>;
511
+ }]>, "queryFn"> & {
512
+ queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Template, [Pick<Options<GetTemplateData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
513
+ _id: string;
514
+ _infinite?: boolean;
515
+ tags?: ReadonlyArray<string>;
516
+ }], never> | undefined;
517
+ } & {
518
+ queryKey: [Pick<Options<GetTemplateData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
519
+ _id: string;
520
+ _infinite?: boolean;
521
+ tags?: ReadonlyArray<string>;
522
+ }] & {
523
+ [dataTagSymbol]: import("../types.gen").Template;
524
+ [dataTagErrorSymbol]: Error;
525
+ };
526
+ };
527
+ /**
528
+ * Update a template record.
529
+ */
530
+ export declare const updateTemplateMutation: (options?: Partial<Options<UpdateTemplateData>>) => UseMutationOptions<UpdateTemplateResponse, UpdateTemplateError, Options<UpdateTemplateData>>;
453
531
  /**
454
532
  * Create a space.
455
533
  */
@@ -954,6 +1032,14 @@ export declare const updateEnvironmentVariableMutation: (options?: Partial<Optio
954
1032
  * Create an environment variable. These are globally unique per project environment.
955
1033
  */
956
1034
  export declare const createEnvironmentVariableMutation: (options?: Partial<Options<CreateEnvironmentVariableData>>) => UseMutationOptions<unknown, CreateEnvironmentVariableError, Options<CreateEnvironmentVariableData>>;
1035
+ /**
1036
+ * Delete a template record.
1037
+ */
1038
+ export declare const deleteTemplateMutation: (options?: Partial<Options<DeleteTemplateData>>) => UseMutationOptions<DeleteTemplateResponse, DeleteTemplateError, Options<DeleteTemplateData>>;
1039
+ /**
1040
+ * Create a template. A template references the HEAD version of an environment.
1041
+ */
1042
+ export declare const createTemplateMutation: (options?: Partial<Options<CreateTemplateData>>) => UseMutationOptions<CreateTemplateResponse, CreateTemplateError, Options<CreateTemplateData>>;
957
1043
  export declare const getVersionQueryKey: (options: Options<GetVersionData>) => [Pick<Options<GetVersionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
958
1044
  _id: string;
959
1045
  _infinite?: boolean;
@@ -1238,3 +1324,35 @@ export declare const listBillingInvoicesOptions: (options: Options<ListBillingIn
1238
1324
  [dataTagErrorSymbol]: Error;
1239
1325
  };
1240
1326
  };
1327
+ export declare const getSpacePropertiesQueryKey: (options: Options<GetSpacePropertiesData>) => [Pick<Options<GetSpacePropertiesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
1328
+ _id: string;
1329
+ _infinite?: boolean;
1330
+ tags?: ReadonlyArray<string>;
1331
+ }];
1332
+ /**
1333
+ * List all space properties for the space from Kinde.
1334
+ */
1335
+ export declare const getSpacePropertiesOptions: (options: Options<GetSpacePropertiesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").SpacePropertiesResponse, Error, import("../types.gen").SpacePropertiesResponse, [Pick<Options<GetSpacePropertiesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
1336
+ _id: string;
1337
+ _infinite?: boolean;
1338
+ tags?: ReadonlyArray<string>;
1339
+ }]>, "queryFn"> & {
1340
+ queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").SpacePropertiesResponse, [Pick<Options<GetSpacePropertiesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
1341
+ _id: string;
1342
+ _infinite?: boolean;
1343
+ tags?: ReadonlyArray<string>;
1344
+ }], never> | undefined;
1345
+ } & {
1346
+ queryKey: [Pick<Options<GetSpacePropertiesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
1347
+ _id: string;
1348
+ _infinite?: boolean;
1349
+ tags?: ReadonlyArray<string>;
1350
+ }] & {
1351
+ [dataTagSymbol]: import("../types.gen").SpacePropertiesResponse;
1352
+ [dataTagErrorSymbol]: Error;
1353
+ };
1354
+ };
1355
+ /**
1356
+ * Set a space property on the space in Kinde.
1357
+ */
1358
+ export declare const setSpacePropertyMutation: (options?: Partial<Options<SetSpacePropertyData>>) => UseMutationOptions<unknown, SetSpacePropertyError, Options<SetSpacePropertyData>>;
@@ -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, createUsername, deleteAccountIdentity, deleteEnvironmentVariable, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVersions, getGraphOverview, getProjectOverview, getPublicInvite, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, getVersion, getVersionM2M, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateDeploymentStatusM2M, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateUsername, updateUserProfile } from '../sdk.gen';
4
+ import { checkSubdomainUniqueness, createEnvironment, createEnvironmentVariable, createFeatureRequest, createProject, createSetupIntent, createSpace, createSpaceInvite, createTemplate, createUsername, deleteAccountIdentity, deleteEnvironmentVariable, deleteTemplate, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVersions, getGraphOverview, getProjectOverview, getPublicInvite, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getSpaceProperties, getSpaceStats, getTemplate, getUserIdentities, getUserInvites, getUserProfile, getVersion, getVersionM2M, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, setSpaceProperty, updateBillingPlan, updateConnectedAppToken, updateDeploymentStatusM2M, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateTemplate, updateUsername, updateUserProfile, viewTemplates } 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,6 +532,79 @@ export const recordOnboardingAnalyticsMutation = (options) => {
532
532
  };
533
533
  return mutationOptions;
534
534
  };
535
+ export const viewTemplatesQueryKey = (options) => createQueryKey('viewTemplates', options);
536
+ export const viewTemplatesOptions = (options) => {
537
+ return queryOptions({
538
+ queryFn: async ({ queryKey, signal }) => {
539
+ const { data } = await viewTemplates({
540
+ ...options,
541
+ ...queryKey[0],
542
+ signal,
543
+ throwOnError: true
544
+ });
545
+ return data;
546
+ },
547
+ queryKey: viewTemplatesQueryKey(options)
548
+ });
549
+ };
550
+ export const viewTemplatesInfiniteQueryKey = (options) => createQueryKey('viewTemplates', options, true);
551
+ export const viewTemplatesInfiniteOptions = (options) => {
552
+ return infiniteQueryOptions(
553
+ // @ts-ignore
554
+ {
555
+ queryFn: async ({ pageParam, queryKey, signal }) => {
556
+ // @ts-ignore
557
+ const page = typeof pageParam === 'object' ? pageParam : {
558
+ query: {
559
+ page: pageParam
560
+ }
561
+ };
562
+ const params = createInfiniteParams(queryKey, page);
563
+ const { data } = await viewTemplates({
564
+ ...options,
565
+ ...params,
566
+ signal,
567
+ throwOnError: true
568
+ });
569
+ return data;
570
+ },
571
+ queryKey: viewTemplatesInfiniteQueryKey(options)
572
+ });
573
+ };
574
+ export const getTemplateQueryKey = (options) => createQueryKey('getTemplate', options);
575
+ /**
576
+ * Retrieve a template record.
577
+ */
578
+ export const getTemplateOptions = (options) => {
579
+ return queryOptions({
580
+ queryFn: async ({ queryKey, signal }) => {
581
+ const { data } = await getTemplate({
582
+ ...options,
583
+ ...queryKey[0],
584
+ signal,
585
+ throwOnError: true
586
+ });
587
+ return data;
588
+ },
589
+ queryKey: getTemplateQueryKey(options)
590
+ });
591
+ };
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
+ };
535
608
  /**
536
609
  * Create a space.
537
610
  */
@@ -1050,6 +1123,38 @@ export const createEnvironmentVariableMutation = (options) => {
1050
1123
  };
1051
1124
  return mutationOptions;
1052
1125
  };
1126
+ /**
1127
+ * Delete a template record.
1128
+ */
1129
+ export const deleteTemplateMutation = (options) => {
1130
+ const mutationOptions = {
1131
+ mutationFn: async (fnOptions) => {
1132
+ const { data } = await deleteTemplate({
1133
+ ...options,
1134
+ ...fnOptions,
1135
+ throwOnError: true
1136
+ });
1137
+ return data;
1138
+ }
1139
+ };
1140
+ return mutationOptions;
1141
+ };
1142
+ /**
1143
+ * Create a template. A template references the HEAD version of an environment.
1144
+ */
1145
+ export const createTemplateMutation = (options) => {
1146
+ const mutationOptions = {
1147
+ mutationFn: async (fnOptions) => {
1148
+ const { data } = await createTemplate({
1149
+ ...options,
1150
+ ...fnOptions,
1151
+ throwOnError: true
1152
+ });
1153
+ return data;
1154
+ }
1155
+ };
1156
+ return mutationOptions;
1157
+ };
1053
1158
  export const getVersionQueryKey = (options) => createQueryKey('getVersion', options);
1054
1159
  /**
1055
1160
  * Get a version inside an environment.
@@ -1340,3 +1445,37 @@ export const listBillingInvoicesOptions = (options) => {
1340
1445
  queryKey: listBillingInvoicesQueryKey(options)
1341
1446
  });
1342
1447
  };
1448
+ export const getSpacePropertiesQueryKey = (options) => createQueryKey('getSpaceProperties', options);
1449
+ /**
1450
+ * List all space properties for the space from Kinde.
1451
+ */
1452
+ export const getSpacePropertiesOptions = (options) => {
1453
+ return queryOptions({
1454
+ queryFn: async ({ queryKey, signal }) => {
1455
+ const { data } = await getSpaceProperties({
1456
+ ...options,
1457
+ ...queryKey[0],
1458
+ signal,
1459
+ throwOnError: true
1460
+ });
1461
+ return data;
1462
+ },
1463
+ queryKey: getSpacePropertiesQueryKey(options)
1464
+ });
1465
+ };
1466
+ /**
1467
+ * Set a space property on the space in Kinde.
1468
+ */
1469
+ export const setSpacePropertyMutation = (options) => {
1470
+ const mutationOptions = {
1471
+ mutationFn: async (fnOptions) => {
1472
+ const { data } = await setSpaceProperty({
1473
+ ...options,
1474
+ ...fnOptions,
1475
+ throwOnError: true
1476
+ });
1477
+ return data;
1478
+ }
1479
+ };
1480
+ return mutationOptions;
1481
+ };
@@ -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, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, 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, GetSpaceStatsData, GetSpaceStatsErrors, GetSpaceStatsResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, GetVersionData, GetVersionErrors, GetVersionM2mData, GetVersionM2mErrors, GetVersionM2mResponses, GetVersionResponses, 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, 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, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mErrors, UpdateDeploymentStatusM2mResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateNodeM2mData, UpdateNodeM2mErrors, UpdateNodeM2mResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses } from './types.gen';
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, CreateTemplateData, CreateTemplateErrors, CreateTemplateResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeleteTemplateData, DeleteTemplateErrors, DeleteTemplateResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, 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, GetTemplateData, GetTemplateErrors, GetTemplateResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, GetVersionData, GetVersionErrors, GetVersionM2mData, GetVersionM2mErrors, GetVersionM2mResponses, GetVersionResponses, 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, 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, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mErrors, UpdateDeploymentStatusM2mResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateNodeM2mData, UpdateNodeM2mErrors, UpdateNodeM2mResponses, UpdateTemplateData, UpdateTemplateErrors, UpdateTemplateResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, ViewTemplatesData, ViewTemplatesErrors, ViewTemplatesResponses } 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,6 +95,15 @@ 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 viewTemplates: <ThrowOnError extends boolean = false>(options?: Options<ViewTemplatesData, ThrowOnError>) => import("./client").RequestResult<ViewTemplatesResponses, ViewTemplatesErrors, ThrowOnError, "fields">;
99
+ /**
100
+ * Retrieve a template record.
101
+ */
102
+ export declare const getTemplate: <ThrowOnError extends boolean = false>(options: Options<GetTemplateData, ThrowOnError>) => import("./client").RequestResult<GetTemplateResponses, GetTemplateErrors, ThrowOnError, "fields">;
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">;
98
107
  /**
99
108
  * Create a space.
100
109
  */
@@ -191,6 +200,14 @@ export declare const updateEnvironmentVariable: <ThrowOnError extends boolean =
191
200
  * Create an environment variable. These are globally unique per project environment.
192
201
  */
193
202
  export declare const createEnvironmentVariable: <ThrowOnError extends boolean = false>(options: Options<CreateEnvironmentVariableData, ThrowOnError>) => import("./client").RequestResult<CreateEnvironmentVariableResponses, CreateEnvironmentVariableErrors, ThrowOnError, "fields">;
203
+ /**
204
+ * Delete a template record.
205
+ */
206
+ export declare const deleteTemplate: <ThrowOnError extends boolean = false>(options: Options<DeleteTemplateData, ThrowOnError>) => import("./client").RequestResult<DeleteTemplateResponses, DeleteTemplateErrors, ThrowOnError, "fields">;
207
+ /**
208
+ * Create a template. A template references the HEAD version of an environment.
209
+ */
210
+ export declare const createTemplate: <ThrowOnError extends boolean = false>(options: Options<CreateTemplateData, ThrowOnError>) => import("./client").RequestResult<CreateTemplateResponses, CreateTemplateErrors, ThrowOnError, "fields">;
194
211
  /**
195
212
  * Get a version inside an environment.
196
213
  */
@@ -259,3 +276,11 @@ export declare const fetchBillingPrices: <ThrowOnError extends boolean = false>(
259
276
  * List past invoices for the space, newest first.
260
277
  */
261
278
  export declare const listBillingInvoices: <ThrowOnError extends boolean = false>(options: Options<ListBillingInvoicesData, ThrowOnError>) => import("./client").RequestResult<ListBillingInvoicesResponses, ListBillingInvoicesErrors, ThrowOnError, "fields">;
279
+ /**
280
+ * List all space properties for the space from Kinde.
281
+ */
282
+ export declare const getSpaceProperties: <ThrowOnError extends boolean = false>(options: Options<GetSpacePropertiesData, ThrowOnError>) => import("./client").RequestResult<GetSpacePropertiesResponses, GetSpacePropertiesErrors, ThrowOnError, "fields">;
283
+ /**
284
+ * Set a space property on the space in Kinde.
285
+ */
286
+ export declare const setSpaceProperty: <ThrowOnError extends boolean = false>(options: Options<SetSpacePropertyData, ThrowOnError>) => import("./client").RequestResult<SetSpacePropertyResponses, SetSpacePropertyErrors, ThrowOnError, "fields">;
@@ -356,6 +356,52 @@ export const recordOnboardingAnalytics = (options) => {
356
356
  }
357
357
  });
358
358
  };
359
+ export const viewTemplates = (options) => {
360
+ return (options?.client ?? client).get({
361
+ security: [
362
+ {
363
+ scheme: 'bearer',
364
+ type: 'http'
365
+ }
366
+ ],
367
+ url: '/templates/view',
368
+ ...options
369
+ });
370
+ };
371
+ /**
372
+ * Retrieve a template record.
373
+ */
374
+ export const getTemplate = (options) => {
375
+ return (options.client ?? client).get({
376
+ security: [
377
+ {
378
+ scheme: 'bearer',
379
+ type: 'http'
380
+ }
381
+ ],
382
+ url: '/templates/{template}',
383
+ ...options
384
+ });
385
+ };
386
+ /**
387
+ * Update a template record.
388
+ */
389
+ export const updateTemplate = (options) => {
390
+ return (options.client ?? client).patch({
391
+ security: [
392
+ {
393
+ scheme: 'bearer',
394
+ type: 'http'
395
+ }
396
+ ],
397
+ url: '/templates/{template}',
398
+ ...options,
399
+ headers: {
400
+ 'Content-Type': 'application/json',
401
+ ...options.headers
402
+ }
403
+ });
404
+ };
359
405
  /**
360
406
  * Create a space.
361
407
  */
@@ -740,6 +786,40 @@ export const createEnvironmentVariable = (options) => {
740
786
  }
741
787
  });
742
788
  };
789
+ /**
790
+ * Delete a template record.
791
+ */
792
+ export const deleteTemplate = (options) => {
793
+ return (options.client ?? client).delete({
794
+ security: [
795
+ {
796
+ scheme: 'bearer',
797
+ type: 'http'
798
+ }
799
+ ],
800
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{template}',
801
+ ...options
802
+ });
803
+ };
804
+ /**
805
+ * Create a template. A template references the HEAD version of an environment.
806
+ */
807
+ export const createTemplate = (options) => {
808
+ return (options.client ?? client).post({
809
+ security: [
810
+ {
811
+ scheme: 'bearer',
812
+ type: 'http'
813
+ }
814
+ ],
815
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/templates/create',
816
+ ...options,
817
+ headers: {
818
+ 'Content-Type': 'application/json',
819
+ ...options.headers
820
+ }
821
+ });
822
+ };
743
823
  /**
744
824
  * Get a version inside an environment.
745
825
  */
@@ -1007,3 +1087,37 @@ export const listBillingInvoices = (options) => {
1007
1087
  ...options
1008
1088
  });
1009
1089
  };
1090
+ /**
1091
+ * List all space properties for the space from Kinde.
1092
+ */
1093
+ export const getSpaceProperties = (options) => {
1094
+ return (options.client ?? client).get({
1095
+ security: [
1096
+ {
1097
+ scheme: 'bearer',
1098
+ type: 'http'
1099
+ }
1100
+ ],
1101
+ url: '/auth/{spaceHandle}/properties',
1102
+ ...options
1103
+ });
1104
+ };
1105
+ /**
1106
+ * Set a space property on the space in Kinde.
1107
+ */
1108
+ export const setSpaceProperty = (options) => {
1109
+ return (options.client ?? client).put({
1110
+ security: [
1111
+ {
1112
+ scheme: 'bearer',
1113
+ type: 'http'
1114
+ }
1115
+ ],
1116
+ url: '/auth/{spaceHandle}/properties',
1117
+ ...options,
1118
+ headers: {
1119
+ 'Content-Type': 'application/json',
1120
+ ...options.headers
1121
+ }
1122
+ });
1123
+ };