shoal-web-sdk 0.0.154 → 0.0.156

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, 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, GetSpaceStatsData, 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, UpdateNodeM2mData, UpdateNodeM2mError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, VersionStatusData } from '../types.gen';
3
+ import type { CheckSubdomainUniquenessData, 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, GetPublicInviteData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpaceStatsData, 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, UpdateNodeM2mData, UpdateNodeM2mError, 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;
@@ -424,6 +424,34 @@ export declare const recordOnboardingAnalyticsMutation: (options?: Partial<Optio
424
424
  * Create a space.
425
425
  */
426
426
  export declare const createSpaceMutation: (options?: Partial<Options<CreateSpaceData>>) => UseMutationOptions<CreateSpaceResponse, CreateSpaceError, Options<CreateSpaceData>>;
427
+ export declare const getPublicInviteQueryKey: (options: Options<GetPublicInviteData>) => [Pick<Options<GetPublicInviteData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
428
+ _id: string;
429
+ _infinite?: boolean;
430
+ tags?: ReadonlyArray<string>;
431
+ }];
432
+ /**
433
+ * Fetch public invite details by UUID without authentication.
434
+ */
435
+ export declare const getPublicInviteOptions: (options: Options<GetPublicInviteData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PublicInvite, Error, import("../types.gen").PublicInvite, [Pick<Options<GetPublicInviteData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
436
+ _id: string;
437
+ _infinite?: boolean;
438
+ tags?: ReadonlyArray<string>;
439
+ }]>, "queryFn"> & {
440
+ queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PublicInvite, [Pick<Options<GetPublicInviteData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
441
+ _id: string;
442
+ _infinite?: boolean;
443
+ tags?: ReadonlyArray<string>;
444
+ }], never> | undefined;
445
+ } & {
446
+ queryKey: [Pick<Options<GetPublicInviteData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
447
+ _id: string;
448
+ _infinite?: boolean;
449
+ tags?: ReadonlyArray<string>;
450
+ }] & {
451
+ [dataTagSymbol]: import("../types.gen").PublicInvite;
452
+ [dataTagErrorSymbol]: Error;
453
+ };
454
+ };
427
455
  export declare const getUserInvitesQueryKey: (options?: Options<GetUserInvitesData>) => [Pick<Options<GetUserInvitesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
428
456
  _id: string;
429
457
  _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, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteEnvironmentVariable, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVersions, getGraphOverview, getProjectOverview, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getSpaceStats, 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, updateNodeM2M, updateUsername, updateUserProfile, versionStatus } from '../sdk.gen';
4
+ import { checkSubdomainUniqueness, createEnvironment, createEnvironmentVariable, 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, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, 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) {
@@ -504,6 +504,24 @@ export const createSpaceMutation = (options) => {
504
504
  };
505
505
  return mutationOptions;
506
506
  };
507
+ export const getPublicInviteQueryKey = (options) => createQueryKey('getPublicInvite', options);
508
+ /**
509
+ * Fetch public invite details by UUID without authentication.
510
+ */
511
+ export const getPublicInviteOptions = (options) => {
512
+ return queryOptions({
513
+ queryFn: async ({ queryKey, signal }) => {
514
+ const { data } = await getPublicInvite({
515
+ ...options,
516
+ ...queryKey[0],
517
+ signal,
518
+ throwOnError: true
519
+ });
520
+ return data;
521
+ },
522
+ queryKey: getPublicInviteQueryKey(options)
523
+ });
524
+ };
507
525
  export const getUserInvitesQueryKey = (options) => createQueryKey('getUserInvites', options);
508
526
  /**
509
527
  * The pending invites a user has for a set of spaces
@@ -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, 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, GetSpaceStatsData, GetSpaceStatsErrors, GetSpaceStatsResponses, 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, UpdateNodeM2mData, UpdateNodeM2mErrors, UpdateNodeM2mResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, VersionStatusData, VersionStatusErrors, VersionStatusResponses } from './types.gen';
2
+ import type { CheckSubdomainUniquenessData, CheckSubdomainUniquenessErrors, CheckSubdomainUniquenessResponses, 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, 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, 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, UpdateNodeM2mData, UpdateNodeM2mErrors, UpdateNodeM2mResponses, 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
@@ -93,6 +93,10 @@ export declare const recordOnboardingAnalytics: <ThrowOnError extends boolean =
93
93
  * Create a space.
94
94
  */
95
95
  export declare const createSpace: <ThrowOnError extends boolean = false>(options: Options<CreateSpaceData, ThrowOnError>) => import("./client").RequestResult<CreateSpaceResponses, CreateSpaceErrors, ThrowOnError, "fields">;
96
+ /**
97
+ * Fetch public invite details by UUID without authentication.
98
+ */
99
+ export declare const getPublicInvite: <ThrowOnError extends boolean = false>(options: Options<GetPublicInviteData, ThrowOnError>) => import("./client").RequestResult<GetPublicInviteResponses, GetPublicInviteErrors, ThrowOnError, "fields">;
96
100
  /**
97
101
  * The pending invites a user has for a set of spaces
98
102
  */
@@ -328,6 +328,21 @@ export const createSpace = (options) => {
328
328
  }
329
329
  });
330
330
  };
331
+ /**
332
+ * Fetch public invite details by UUID without authentication.
333
+ */
334
+ export const getPublicInvite = (options) => {
335
+ return (options.client ?? client).get({
336
+ security: [
337
+ {
338
+ scheme: 'bearer',
339
+ type: 'http'
340
+ }
341
+ ],
342
+ url: '/invites/{inviteUUID}',
343
+ ...options
344
+ });
345
+ };
331
346
  /**
332
347
  * The pending invites a user has for a set of spaces
333
348
  */
@@ -61,6 +61,13 @@ export type Invite = {
61
61
  expiry: string;
62
62
  expired: boolean;
63
63
  };
64
+ export type PublicInvite = {
65
+ spaceName: string;
66
+ to: string;
67
+ from: string;
68
+ expiry: string;
69
+ expired: boolean;
70
+ };
64
71
  export type CreateInvite = {
65
72
  to: string;
66
73
  role: string;
@@ -538,6 +545,10 @@ export type PlanPriceResponse = {
538
545
  */
539
546
  interval: string;
540
547
  };
548
+ /**
549
+ * Determine whether space code should be read by space handle
550
+ */
551
+ export type SpaceByHandle = string;
541
552
  /**
542
553
  * Environment variable name.
543
554
  */
@@ -1340,7 +1351,12 @@ export type RecordOnboardingAnalyticsResponses = {
1340
1351
  export type CreateSpaceData = {
1341
1352
  body: CreateSpace;
1342
1353
  path?: never;
1343
- query?: never;
1354
+ query?: {
1355
+ /**
1356
+ * Determine whether space code should be read by space handle
1357
+ */
1358
+ spaceByHandle?: string;
1359
+ };
1344
1360
  url: '/auth/spaces/create';
1345
1361
  };
1346
1362
  export type CreateSpaceErrors = {
@@ -1369,6 +1385,39 @@ export type CreateSpaceResponses = {
1369
1385
  201: SpaceOverview;
1370
1386
  };
1371
1387
  export type CreateSpaceResponse = CreateSpaceResponses[keyof CreateSpaceResponses];
1388
+ export type GetPublicInviteData = {
1389
+ body?: never;
1390
+ path: {
1391
+ /**
1392
+ * An invite UUID.
1393
+ */
1394
+ inviteUUID: string;
1395
+ };
1396
+ query?: never;
1397
+ url: '/invites/{inviteUUID}';
1398
+ };
1399
+ export type GetPublicInviteErrors = {
1400
+ /**
1401
+ * Bad request.
1402
+ */
1403
+ 400: ErrorResponse;
1404
+ /**
1405
+ * Invite not found.
1406
+ */
1407
+ 404: ErrorResponse;
1408
+ /**
1409
+ * Unexpected error.
1410
+ */
1411
+ 500: ErrorResponse;
1412
+ };
1413
+ export type GetPublicInviteError = GetPublicInviteErrors[keyof GetPublicInviteErrors];
1414
+ export type GetPublicInviteResponses = {
1415
+ /**
1416
+ * The invite details needed to render the invite landing page.
1417
+ */
1418
+ 200: PublicInvite;
1419
+ };
1420
+ export type GetPublicInviteResponse = GetPublicInviteResponses[keyof GetPublicInviteResponses];
1372
1421
  export type GetUserInvitesData = {
1373
1422
  body?: never;
1374
1423
  path?: never;
@@ -117,6 +117,13 @@ export declare const zPaginatedInvites: z.ZodIntersection<z.ZodObject<{
117
117
  expired: z.ZodBoolean;
118
118
  }, z.core.$strip>>;
119
119
  }, z.core.$strip>>;
120
+ export declare const zPublicInvite: z.ZodObject<{
121
+ spaceName: z.ZodString;
122
+ to: z.ZodString;
123
+ from: z.ZodString;
124
+ expiry: z.ZodISODateTime;
125
+ expired: z.ZodBoolean;
126
+ }, z.core.$strip>;
120
127
  export declare const zCreateInvite: z.ZodObject<{
121
128
  to: z.ZodString;
122
129
  role: z.ZodString;
@@ -1058,6 +1065,10 @@ export declare const zPlanPriceResponse: z.ZodObject<{
1058
1065
  currency: z.ZodString;
1059
1066
  interval: z.ZodString;
1060
1067
  }, z.core.$strip>;
1068
+ /**
1069
+ * Determine whether space code should be read by space handle
1070
+ */
1071
+ export declare const zSpaceByHandle: z.ZodString;
1061
1072
  /**
1062
1073
  * Environment variable name.
1063
1074
  */
@@ -1933,7 +1944,9 @@ export declare const zCreateSpaceData: z.ZodObject<{
1933
1944
  billingPlanCode: z.ZodUnknown;
1934
1945
  }, z.core.$strip>;
1935
1946
  path: z.ZodOptional<z.ZodNever>;
1936
- query: z.ZodOptional<z.ZodNever>;
1947
+ query: z.ZodOptional<z.ZodObject<{
1948
+ spaceByHandle: z.ZodOptional<z.ZodString>;
1949
+ }, z.core.$strip>>;
1937
1950
  }, z.core.$strip>;
1938
1951
  /**
1939
1952
  * Successfully created a space.
@@ -1961,6 +1974,23 @@ export declare const zCreateSpaceResponse: z.ZodObject<{
1961
1974
  }, z.core.$strip>>;
1962
1975
  }, z.core.$strip>>;
1963
1976
  }, z.core.$strip>;
1977
+ export declare const zGetPublicInviteData: z.ZodObject<{
1978
+ body: z.ZodOptional<z.ZodNever>;
1979
+ path: z.ZodObject<{
1980
+ inviteUUID: z.ZodUUID;
1981
+ }, z.core.$strip>;
1982
+ query: z.ZodOptional<z.ZodNever>;
1983
+ }, z.core.$strip>;
1984
+ /**
1985
+ * The invite details needed to render the invite landing page.
1986
+ */
1987
+ export declare const zGetPublicInviteResponse: z.ZodObject<{
1988
+ spaceName: z.ZodString;
1989
+ to: z.ZodString;
1990
+ from: z.ZodString;
1991
+ expiry: z.ZodISODateTime;
1992
+ expired: z.ZodBoolean;
1993
+ }, z.core.$strip>;
1964
1994
  export declare const zGetUserInvitesData: z.ZodObject<{
1965
1995
  body: z.ZodOptional<z.ZodNever>;
1966
1996
  path: z.ZodOptional<z.ZodNever>;
@@ -80,6 +80,13 @@ export const zInvite = z.object({
80
80
  export const zPaginatedInvites = zPagination.and(z.object({
81
81
  invites: z.array(zInvite)
82
82
  }));
83
+ export const zPublicInvite = z.object({
84
+ spaceName: z.string(),
85
+ to: z.string(),
86
+ from: z.string(),
87
+ expiry: z.iso.datetime(),
88
+ expired: z.boolean()
89
+ });
83
90
  export const zCreateInvite = z.object({
84
91
  to: z.string(),
85
92
  role: z.string()
@@ -524,6 +531,10 @@ export const zPlanPriceResponse = z.object({
524
531
  currency: z.string(),
525
532
  interval: z.string()
526
533
  });
534
+ /**
535
+ * Determine whether space code should be read by space handle
536
+ */
537
+ export const zSpaceByHandle = z.string();
527
538
  /**
528
539
  * Environment variable name.
529
540
  */
@@ -811,12 +822,25 @@ export const zRecordOnboardingAnalyticsData = z.object({
811
822
  export const zCreateSpaceData = z.object({
812
823
  body: zCreateSpace,
813
824
  path: z.optional(z.never()),
814
- query: z.optional(z.never())
825
+ query: z.optional(z.object({
826
+ spaceByHandle: z.optional(z.string())
827
+ }))
815
828
  });
816
829
  /**
817
830
  * Successfully created a space.
818
831
  */
819
832
  export const zCreateSpaceResponse = zSpaceOverview;
833
+ export const zGetPublicInviteData = z.object({
834
+ body: z.optional(z.never()),
835
+ path: z.object({
836
+ inviteUUID: z.uuid()
837
+ }),
838
+ query: z.optional(z.never())
839
+ });
840
+ /**
841
+ * The invite details needed to render the invite landing page.
842
+ */
843
+ export const zGetPublicInviteResponse = zPublicInvite;
820
844
  export const zGetUserInvitesData = z.object({
821
845
  body: z.optional(z.never()),
822
846
  path: z.optional(z.never()),
@@ -1,6 +1,6 @@
1
1
  import { useMutation } from "@tanstack/react-query";
2
2
  import { GetSuccessResponse } from "../util";
3
- import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchNodeM2mData, UpdateNodeM2mData, UpdateNodeM2mResponses, 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, GetSpaceStatsData, 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, CheckSubdomainUniquenessData, 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, UpdateNodeM2mData, UpdateNodeM2mResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, CreateSpaceData, CreateSpaceResponses, GetPublicInviteData, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, GetSpaceStatsData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, VersionStatusData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, CheckSubdomainUniquenessData, 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>;
@@ -81,6 +81,9 @@ export declare const useCreateSpace: (config?: {
81
81
  onError?: Parameters<typeof useMutation>["0"]["onError"];
82
82
  retry?: boolean;
83
83
  }) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").SpaceOverview | undefined, unknown, Omit<CreateSpaceData, "url">, unknown>;
84
+ export declare const useGetPublicInvite: (options: Omit<GetPublicInviteData, "url"> & {
85
+ enabled?: boolean;
86
+ }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").PublicInvite | undefined, Error>;
84
87
  export declare const useGetUserInvites: (options?: Omit<GetUserInvitesData, "url"> & {
85
88
  enabled?: boolean;
86
89
  }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").PaginatedInvites | undefined, Error>;
@@ -2,7 +2,7 @@
2
2
  import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
3
3
  import { isPromise } from "../util";
4
4
  import { useToken } from "../../provider/token-provider";
5
- import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, updateNodeM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, recordOnboardingAnalytics, createSpace, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, getGraphOverview, updateGraphState, deployVersion, versionStatus, requestSignedUploadUrl, checkSubdomainUniqueness, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices } from "../../sdk/sdk.gen";
5
+ import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, updateNodeM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, recordOnboardingAnalytics, createSpace, getPublicInvite, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, getGraphOverview, updateGraphState, deployVersion, versionStatus, requestSignedUploadUrl, checkSubdomainUniqueness, 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 };
@@ -403,6 +403,27 @@ export const useCreateSpace = (config) => {
403
403
  retry: config?.retry
404
404
  });
405
405
  };
406
+ export const useGetPublicInvite = (options) => {
407
+ const token = useToken();
408
+ let { enabled, ...rest } = options || { enabled: true };
409
+ const opts = { throwOnError: true, url: "/invites/{inviteUUID}" };
410
+ const funcer = async () => {
411
+ const auth = isPromise(token) ? (await token) || "" : token || "";
412
+ if (isPromise(token) && !token)
413
+ return;
414
+ const res = await getPublicInvite({ ...opts, ...rest, auth });
415
+ return res.data;
416
+ };
417
+ if (!token)
418
+ enabled = false;
419
+ return useQuery({
420
+ queryKey: ["invites", options?.path?.inviteUUID, options.query ?? {}],
421
+ queryFn: funcer,
422
+ enabled,
423
+ retry: false,
424
+ staleTime: 600000
425
+ });
426
+ };
406
427
  export const useGetUserInvites = (options) => {
407
428
  const token = useToken();
408
429
  let { enabled, ...rest } = options || { enabled: true };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoal-web-sdk",
3
- "version": "0.0.154",
3
+ "version": "0.0.156",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "build-hooks": "npx tsx tanstack-codegen/generator.ts",