shoal-web-sdk 0.0.135 → 0.0.136

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 { CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, 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, GetGraphOverviewData, GetProjectOverviewData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, VersionStatusData } from '../types.gen';
3
+ import type { CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, 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, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, VersionStatusData } from '../types.gen';
4
4
  export type QueryKey<TOptions extends Options> = [
5
5
  Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
6
6
  _id: string;
@@ -772,6 +772,34 @@ export declare const getEnvironmentOverviewOptions: (options: Options<GetEnviron
772
772
  [dataTagErrorSymbol]: Error;
773
773
  };
774
774
  };
775
+ export declare const getEnvironmentVersionsQueryKey: (options: Options<GetEnvironmentVersionsData>) => [Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
776
+ _id: string;
777
+ _infinite?: boolean;
778
+ tags?: ReadonlyArray<string>;
779
+ }];
780
+ /**
781
+ * Get all the environment versions.
782
+ */
783
+ export declare const getEnvironmentVersionsOptions: (options: Options<GetEnvironmentVersionsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").EnvironmentVersion[], Error, import("../types.gen").EnvironmentVersion[], [Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
784
+ _id: string;
785
+ _infinite?: boolean;
786
+ tags?: ReadonlyArray<string>;
787
+ }]>, "queryFn"> & {
788
+ queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").EnvironmentVersion[], [Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
789
+ _id: string;
790
+ _infinite?: boolean;
791
+ tags?: ReadonlyArray<string>;
792
+ }], never> | undefined;
793
+ } & {
794
+ queryKey: [Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
795
+ _id: string;
796
+ _infinite?: boolean;
797
+ tags?: ReadonlyArray<string>;
798
+ }] & {
799
+ [dataTagSymbol]: import("../types.gen").EnvironmentVersion[];
800
+ [dataTagErrorSymbol]: Error;
801
+ };
802
+ };
775
803
  /**
776
804
  * Delete an environment variable.
777
805
  */
@@ -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 { createEnvironment, createEnvironmentVariable, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteEnvironmentVariable, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getGraphOverview, getProjectOverview, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getUserIdentities, getUserInvites, getUserProfile, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateUsername, updateUserProfile, versionStatus } from '../sdk.gen';
4
+ import { createEnvironment, createEnvironmentVariable, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteEnvironmentVariable, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVersions, getGraphOverview, getProjectOverview, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getUserIdentities, getUserInvites, getUserProfile, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateUsername, updateUserProfile, versionStatus } 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) {
@@ -843,6 +843,24 @@ export const getEnvironmentOverviewOptions = (options) => {
843
843
  queryKey: getEnvironmentOverviewQueryKey(options)
844
844
  });
845
845
  };
846
+ export const getEnvironmentVersionsQueryKey = (options) => createQueryKey('getEnvironmentVersions', options);
847
+ /**
848
+ * Get all the environment versions.
849
+ */
850
+ export const getEnvironmentVersionsOptions = (options) => {
851
+ return queryOptions({
852
+ queryFn: async ({ queryKey, signal }) => {
853
+ const { data } = await getEnvironmentVersions({
854
+ ...options,
855
+ ...queryKey[0],
856
+ signal,
857
+ throwOnError: true
858
+ });
859
+ return data;
860
+ },
861
+ queryKey: getEnvironmentVersionsQueryKey(options)
862
+ });
863
+ };
846
864
  /**
847
865
  * Delete an environment variable.
848
866
  */
@@ -1,5 +1,5 @@
1
1
  import type { Client, Options as Options2, TDataShape } from './client';
2
- import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, 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, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceOrgCodeData, GetSpaceOrgCodeErrors, GetSpaceOrgCodeResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, 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, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, VersionStatusData, VersionStatusErrors, VersionStatusResponses } from './types.gen';
2
+ import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, 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, GetServiceHealthData, GetServiceHealthResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceOrgCodeData, GetSpaceOrgCodeErrors, GetSpaceOrgCodeResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, 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, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, VersionStatusData, VersionStatusErrors, VersionStatusResponses } 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
@@ -153,6 +153,10 @@ export declare const createEnvironment: <ThrowOnError extends boolean = false>(o
153
153
  * Get the environment overview.
154
154
  */
155
155
  export declare const getEnvironmentOverview: <ThrowOnError extends boolean = false>(options: Options<GetEnvironmentOverviewData, ThrowOnError>) => import("./client").RequestResult<GetEnvironmentOverviewResponses, GetEnvironmentOverviewErrors, ThrowOnError, "fields">;
156
+ /**
157
+ * Get all the environment versions.
158
+ */
159
+ export declare const getEnvironmentVersions: <ThrowOnError extends boolean = false>(options: Options<GetEnvironmentVersionsData, ThrowOnError>) => import("./client").RequestResult<GetEnvironmentVersionsResponses, unknown, ThrowOnError, "fields">;
156
160
  /**
157
161
  * Delete an environment variable.
158
162
  */
@@ -561,6 +561,21 @@ export const getEnvironmentOverview = (options) => {
561
561
  ...options
562
562
  });
563
563
  };
564
+ /**
565
+ * Get all the environment versions.
566
+ */
567
+ export const getEnvironmentVersions = (options) => {
568
+ return (options.client ?? client).get({
569
+ security: [
570
+ {
571
+ scheme: 'bearer',
572
+ type: 'http'
573
+ }
574
+ ],
575
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/versions',
576
+ ...options
577
+ });
578
+ };
564
579
  /**
565
580
  * Delete an environment variable.
566
581
  */
@@ -276,6 +276,18 @@ export type Nodes = {
276
276
  export type Uuids = {
277
277
  ids: Array<string>;
278
278
  };
279
+ export type EnvironmentVersion = {
280
+ id?: string;
281
+ created_at?: string;
282
+ last_updated_at?: string;
283
+ deployment_id?: string;
284
+ deployment_name?: string;
285
+ status?: string;
286
+ deployment_started_at?: string;
287
+ deployment_completed_at?: string;
288
+ message?: string;
289
+ retries?: number;
290
+ };
279
291
  export type Graph = {
280
292
  versionUUID: string;
281
293
  nodes: Array<Node>;
@@ -1956,6 +1968,32 @@ export type GetEnvironmentOverviewResponses = {
1956
1968
  200: EnvironmentOverview;
1957
1969
  };
1958
1970
  export type GetEnvironmentOverviewResponse = GetEnvironmentOverviewResponses[keyof GetEnvironmentOverviewResponses];
1971
+ export type GetEnvironmentVersionsData = {
1972
+ body?: never;
1973
+ path: {
1974
+ /**
1975
+ * The space handle. This must be globally unique.
1976
+ */
1977
+ spaceHandle: string;
1978
+ /**
1979
+ * A project name. This must be unique to a space.
1980
+ */
1981
+ projectHandle: string;
1982
+ /**
1983
+ * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
1984
+ */
1985
+ environmentHandle: string;
1986
+ };
1987
+ query?: never;
1988
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/versions';
1989
+ };
1990
+ export type GetEnvironmentVersionsResponses = {
1991
+ /**
1992
+ * Environment versions.
1993
+ */
1994
+ 200: Array<EnvironmentVersion>;
1995
+ };
1996
+ export type GetEnvironmentVersionsResponse = GetEnvironmentVersionsResponses[keyof GetEnvironmentVersionsResponses];
1959
1997
  export type DeleteEnvironmentVariableData = {
1960
1998
  body?: never;
1961
1999
  path: {
@@ -2025,10 +2063,6 @@ export type GetEnvironmentVariablesData = {
2025
2063
  * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
2026
2064
  */
2027
2065
  environmentHandle: string;
2028
- /**
2029
- * A version number with in an environment.
2030
- */
2031
- version: string;
2032
2066
  };
2033
2067
  query?: never;
2034
2068
  url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/variables';
@@ -467,6 +467,18 @@ export declare const zKindeOrganisationBillingAgreement: z.ZodObject<{
467
467
  export declare const zUuids: z.ZodObject<{
468
468
  ids: z.ZodArray<z.ZodUUID>;
469
469
  }, z.core.$strip>;
470
+ export declare const zEnvironmentVersion: z.ZodObject<{
471
+ id: z.ZodOptional<z.ZodUUID>;
472
+ created_at: z.ZodOptional<z.ZodISODateTime>;
473
+ last_updated_at: z.ZodOptional<z.ZodISODateTime>;
474
+ deployment_id: z.ZodOptional<z.ZodUUID>;
475
+ deployment_name: z.ZodOptional<z.ZodString>;
476
+ status: z.ZodOptional<z.ZodString>;
477
+ deployment_started_at: z.ZodOptional<z.ZodISODateTime>;
478
+ deployment_completed_at: z.ZodOptional<z.ZodISODateTime>;
479
+ message: z.ZodOptional<z.ZodString>;
480
+ retries: z.ZodOptional<z.ZodInt>;
481
+ }, z.core.$strip>;
470
482
  export declare const zNetworkEdgeProps: z.ZodObject<{
471
483
  a: z.ZodOptional<z.ZodString>;
472
484
  }, z.core.$strip>;
@@ -2433,6 +2445,30 @@ export declare const zGetEnvironmentOverviewResponse: z.ZodObject<{
2433
2445
  updatedAt: z.ZodISODateTime;
2434
2446
  versions: z.ZodInt;
2435
2447
  }, z.core.$strip>;
2448
+ export declare const zGetEnvironmentVersionsData: z.ZodObject<{
2449
+ body: z.ZodOptional<z.ZodNever>;
2450
+ path: z.ZodObject<{
2451
+ spaceHandle: z.ZodString;
2452
+ projectHandle: z.ZodString;
2453
+ environmentHandle: z.ZodString;
2454
+ }, z.core.$strip>;
2455
+ query: z.ZodOptional<z.ZodNever>;
2456
+ }, z.core.$strip>;
2457
+ /**
2458
+ * Environment versions.
2459
+ */
2460
+ export declare const zGetEnvironmentVersionsResponse: z.ZodArray<z.ZodObject<{
2461
+ id: z.ZodOptional<z.ZodUUID>;
2462
+ created_at: z.ZodOptional<z.ZodISODateTime>;
2463
+ last_updated_at: z.ZodOptional<z.ZodISODateTime>;
2464
+ deployment_id: z.ZodOptional<z.ZodUUID>;
2465
+ deployment_name: z.ZodOptional<z.ZodString>;
2466
+ status: z.ZodOptional<z.ZodString>;
2467
+ deployment_started_at: z.ZodOptional<z.ZodISODateTime>;
2468
+ deployment_completed_at: z.ZodOptional<z.ZodISODateTime>;
2469
+ message: z.ZodOptional<z.ZodString>;
2470
+ retries: z.ZodOptional<z.ZodInt>;
2471
+ }, z.core.$strip>>;
2436
2472
  export declare const zDeleteEnvironmentVariableData: z.ZodObject<{
2437
2473
  body: z.ZodOptional<z.ZodNever>;
2438
2474
  path: z.ZodObject<{
@@ -2460,7 +2496,6 @@ export declare const zGetEnvironmentVariablesData: z.ZodObject<{
2460
2496
  spaceHandle: z.ZodString;
2461
2497
  projectHandle: z.ZodString;
2462
2498
  environmentHandle: z.ZodString;
2463
- version: z.ZodString;
2464
2499
  }, z.core.$strip>;
2465
2500
  query: z.ZodOptional<z.ZodNever>;
2466
2501
  }, z.core.$strip>;
@@ -291,6 +291,18 @@ export const zKindeOrganisationBillingAgreement = z.object({
291
291
  export const zUuids = z.object({
292
292
  ids: z.array(z.uuid())
293
293
  });
294
+ export const zEnvironmentVersion = z.object({
295
+ id: z.optional(z.uuid()),
296
+ created_at: z.optional(z.iso.datetime()),
297
+ last_updated_at: z.optional(z.iso.datetime()),
298
+ deployment_id: z.optional(z.uuid()),
299
+ deployment_name: z.optional(z.string()),
300
+ status: z.optional(z.string()),
301
+ deployment_started_at: z.optional(z.iso.datetime()),
302
+ deployment_completed_at: z.optional(z.iso.datetime()),
303
+ message: z.optional(z.string()),
304
+ retries: z.optional(z.int())
305
+ });
294
306
  export const zNetworkEdgeProps = z.object({
295
307
  a: z.optional(z.string())
296
308
  });
@@ -995,6 +1007,19 @@ export const zGetEnvironmentOverviewData = z.object({
995
1007
  * Environment overview.
996
1008
  */
997
1009
  export const zGetEnvironmentOverviewResponse = zEnvironmentOverview;
1010
+ export const zGetEnvironmentVersionsData = z.object({
1011
+ body: z.optional(z.never()),
1012
+ path: z.object({
1013
+ spaceHandle: z.string(),
1014
+ projectHandle: z.string(),
1015
+ environmentHandle: z.string()
1016
+ }),
1017
+ query: z.optional(z.never())
1018
+ });
1019
+ /**
1020
+ * Environment versions.
1021
+ */
1022
+ export const zGetEnvironmentVersionsResponse = z.array(zEnvironmentVersion);
998
1023
  export const zDeleteEnvironmentVariableData = z.object({
999
1024
  body: z.optional(z.never()),
1000
1025
  path: z.object({
@@ -1016,8 +1041,7 @@ export const zGetEnvironmentVariablesData = z.object({
1016
1041
  path: z.object({
1017
1042
  spaceHandle: z.string(),
1018
1043
  projectHandle: z.string(),
1019
- environmentHandle: z.string(),
1020
- version: z.string()
1044
+ environmentHandle: z.string()
1021
1045
  }),
1022
1046
  query: z.optional(z.never())
1023
1047
  });
@@ -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, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, CreateSpaceData, CreateSpaceResponses, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, VersionStatusData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData } from "../../sdk/types.gen";
3
+ import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchNodeM2mData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, CreateSpaceData, CreateSpaceResponses, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, VersionStatusData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData } 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>;
@@ -138,6 +138,9 @@ export declare const useCreateEnvironment: (config?: {
138
138
  export declare const useGetEnvironmentOverview: (options: Omit<GetEnvironmentOverviewData, "url"> & {
139
139
  enabled?: boolean;
140
140
  }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").EnvironmentOverview | undefined, Error>;
141
+ export declare const useGetEnvironmentVersions: (options: Omit<GetEnvironmentVersionsData, "url"> & {
142
+ enabled?: boolean;
143
+ }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").EnvironmentVersion[] | undefined, Error>;
141
144
  export declare const useDeleteEnvironmentVariable: (config?: {
142
145
  onSuccess?: (data: GetSuccessResponse<DeleteEnvironmentVariableResponses>) => void;
143
146
  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, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, recordOnboardingAnalytics, createSpace, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, getGraphOverview, updateGraphState, deployVersion, versionStatus, requestSignedUploadUrl, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices } from "../../sdk/sdk.gen";
5
+ import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, recordOnboardingAnalytics, createSpace, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, getGraphOverview, updateGraphState, deployVersion, versionStatus, requestSignedUploadUrl, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices } from "../../sdk/sdk.gen";
6
6
  export const useGetServiceHealth = (options) => {
7
7
  const token = useToken();
8
8
  let { enabled, ...rest } = options || { enabled: true };
@@ -706,6 +706,27 @@ export const useGetEnvironmentOverview = (options) => {
706
706
  staleTime: 600000
707
707
  });
708
708
  };
709
+ export const useGetEnvironmentVersions = (options) => {
710
+ const token = useToken();
711
+ let { enabled, ...rest } = options || { enabled: true };
712
+ const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/versions" };
713
+ const funcer = async () => {
714
+ const auth = isPromise(token) ? (await token) || "" : token || "";
715
+ if (isPromise(token) && !token)
716
+ return;
717
+ const res = await getEnvironmentVersions({ ...opts, ...rest, auth });
718
+ return res.data;
719
+ };
720
+ if (!token)
721
+ enabled = false;
722
+ return useQuery({
723
+ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, "versions", options.query ?? {}],
724
+ queryFn: funcer,
725
+ enabled,
726
+ retry: false,
727
+ staleTime: 600000
728
+ });
729
+ };
709
730
  export const useDeleteEnvironmentVariable = (config) => {
710
731
  const token = useToken();
711
732
  const queryClient = useQueryClient();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoal-web-sdk",
3
- "version": "0.0.135",
3
+ "version": "0.0.136",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "build-hooks": "npx tsx tanstack-codegen/generator.ts",