shoal-web-sdk 1.0.106 → 1.0.108

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, CloneEnvironmentData, CloneEnvironmentError, CloneEnvironmentResponse, CreateApiKeyData, CreateApiKeyError, CreateApiKeyResponse2, CreateBlueprintData, CreateBlueprintError, CreateBlueprintResponse, CreateBugReportData, CreateBugReportError, CreateBugReportResponse, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateNeonBranchData, CreateNeonBranchError, CreateNeonBranchResponse, CreateNeonDatabaseData, CreateNeonDatabaseError, CreateNeonDatabaseResponse, CreateNeonProjectData, CreateNeonProjectError, CreateNeonProjectM2mData, CreateNeonProjectM2mError, CreateNeonProjectM2mResponse, CreateNeonProjectResponse, CreateNodeCredentialData, CreateNodeCredentialError, CreateNodeCredentialResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSecretData, CreateSecretError, CreateSecretM2mData, CreateSecretM2mError, CreateSecretM2mResponse, CreateSecretResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteBlueprintData, DeleteBlueprintError, DeleteBlueprintResponse, DeleteEnvironmentData, DeleteEnvironmentError, DeleteEnvironmentM2mData, DeleteEnvironmentM2mError, DeleteEnvironmentM2mResponse, DeleteEnvironmentResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeleteNeonDatabaseData, DeleteNeonDatabaseError, DeleteNeonDatabaseResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchMongoOrganizationsData, FetchMongoOrganizationTierData, FetchMongoRegionsData, FetchNeonConnectionUriData, FetchNeonOrganizationsData, FetchNeonRegionsData, FetchNodeM2mData, GetApiKeysData, GetBillingPlanData, GetBillingUsageData, GetBlueprintData, GetBlueprintM2mData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVariablesM2mData, GetEnvironmentVersionsData, GetFeatureFlagsData, GetGraphOverviewData, GetNodeEnvironmentVariablesData, GetProjectEnvironmentsData, GetProjectOverviewData, GetPublicInviteData, GetSecretValueData, GetServiceHealthData, GetSoftDeletedEnvironmentsM2mData, GetSpaceInvitesData, GetSpaceM2mData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpacePropertiesData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, GetVersionData, GetVersionM2mData, ImportBlueprintData, ImportBlueprintError, JoinSpaceData, JoinSpaceError, KickSpaceMemberData, KickSpaceMemberError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListMongoClustersData, ListMongoProjectsData, ListNeonBranchesData, ListNeonDatabasesData, ListNeonProjectsData, ListNeonRolesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, LookupApiKeyData, NukeEnvironmentM2mData, NukeEnvironmentM2mError, NukeEnvironmentM2mResponse, PingNodeData, PreviewBlueprintData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedDownloadUrlData, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeApiKeyData, RevokeApiKeyError, RevokeApiKeyResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdError, SetSpacePropertyData, SetSpacePropertyError, UpdateBillingPlanData, UpdateBillingPlanError, UpdateBlueprintData, UpdateBlueprintError, UpdateBlueprintResponse, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateNodeM2mData, UpdateNodeM2mError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, ViewBlueprintsData, ViewBlueprintsM2mData } from '../types.gen';
3
+ import type { CheckSubdomainUniquenessData, CloneEnvironmentData, CloneEnvironmentError, CloneEnvironmentResponse, CreateApiKeyData, CreateApiKeyError, CreateApiKeyResponse2, CreateBlueprintData, CreateBlueprintError, CreateBlueprintResponse, CreateBugReportData, CreateBugReportError, CreateBugReportResponse, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateFeatureRequestData, CreateFeatureRequestError, CreateNeonBranchData, CreateNeonBranchError, CreateNeonBranchResponse, CreateNeonDatabaseData, CreateNeonDatabaseError, CreateNeonDatabaseResponse, CreateNeonProjectData, CreateNeonProjectError, CreateNeonProjectM2mData, CreateNeonProjectM2mError, CreateNeonProjectM2mResponse, CreateNeonProjectResponse, CreateNodeCredentialData, CreateNodeCredentialError, CreateNodeCredentialResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSecretData, CreateSecretError, CreateSecretM2mData, CreateSecretM2mError, CreateSecretM2mResponse, CreateSecretResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteBlueprintData, DeleteBlueprintError, DeleteBlueprintResponse, DeleteEnvironmentData, DeleteEnvironmentError, DeleteEnvironmentM2mData, DeleteEnvironmentM2mError, DeleteEnvironmentM2mResponse, DeleteEnvironmentResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeleteNeonDatabaseData, DeleteNeonDatabaseError, DeleteNeonDatabaseResponse, DeployVersionData, DeployVersionError, FetchGraphM2mData, FetchMongoOrganizationsData, FetchMongoOrganizationTierData, FetchMongoRegionsData, FetchNeonConnectionUriData, FetchNeonOrganizationsData, FetchNeonRegionsData, FetchNodeM2mData, GetApiKeysData, GetBlueprintData, GetBlueprintM2mData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVariablesM2mData, GetEnvironmentVersionsData, GetFeatureFlagsData, GetGraphOverviewData, GetNodeEnvironmentVariablesData, GetProjectEnvironmentsData, GetProjectOverviewData, GetPublicInviteData, GetSecretValueData, GetServiceHealthData, GetSoftDeletedEnvironmentsM2mData, GetSpaceInvitesData, GetSpaceM2mData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpacePropertiesData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, GetVersionData, GetVersionM2mData, ImportBlueprintData, ImportBlueprintError, JoinSpaceData, JoinSpaceError, KickSpaceMemberData, KickSpaceMemberError, LeaveSpaceData, LeaveSpaceError, ListInstallationBranchesData, ListInstallationRepositoriesData, ListMongoClustersData, ListMongoProjectsData, ListNeonBranchesData, ListNeonDatabasesData, ListNeonProjectsData, ListNeonRolesData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, LookupApiKeyData, NukeEnvironmentM2mData, NukeEnvironmentM2mError, NukeEnvironmentM2mResponse, PingNodeData, PreviewBlueprintData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedDownloadUrlData, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeApiKeyData, RevokeApiKeyError, RevokeApiKeyResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetEnvironmentGcpProjectIdData, SetEnvironmentGcpProjectIdError, SetSpacePropertyData, SetSpacePropertyError, UpdateBlueprintData, UpdateBlueprintError, UpdateBlueprintResponse, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateDeploymentStatusM2mData, UpdateDeploymentStatusM2mError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateNodeM2mData, UpdateNodeM2mError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, ViewBlueprintsData, ViewBlueprintsM2mData } from '../types.gen';
4
4
  export type QueryKey<TOptions extends Options> = [
5
5
  Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
6
6
  _id: string;
@@ -1338,34 +1338,6 @@ export declare const getSpaceStatsOptions: (options: Options<GetSpaceStatsData>)
1338
1338
  [dataTagErrorSymbol]: Error;
1339
1339
  };
1340
1340
  };
1341
- export declare const fetchKindeOrganisationBillingAgreementsQueryKey: (options: Options<FetchKindeOrganisationBillingAgreementsData>) => [Pick<Options<FetchKindeOrganisationBillingAgreementsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
1342
- _id: string;
1343
- _infinite?: boolean;
1344
- tags?: ReadonlyArray<string>;
1345
- }];
1346
- /**
1347
- * The space billing agreements.
1348
- */
1349
- export declare const fetchKindeOrganisationBillingAgreementsOptions: (options: Options<FetchKindeOrganisationBillingAgreementsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<unknown, Error, unknown, [Pick<Options<FetchKindeOrganisationBillingAgreementsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
1350
- _id: string;
1351
- _infinite?: boolean;
1352
- tags?: ReadonlyArray<string>;
1353
- }]>, "queryFn"> & {
1354
- queryFn?: import("@tanstack/react-query").QueryFunction<unknown, [Pick<Options<FetchKindeOrganisationBillingAgreementsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
1355
- _id: string;
1356
- _infinite?: boolean;
1357
- tags?: ReadonlyArray<string>;
1358
- }], never> | undefined;
1359
- } & {
1360
- queryKey: [Pick<Options<FetchKindeOrganisationBillingAgreementsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
1361
- _id: string;
1362
- _infinite?: boolean;
1363
- tags?: ReadonlyArray<string>;
1364
- }] & {
1365
- [dataTagSymbol]: unknown;
1366
- [dataTagErrorSymbol]: Error;
1367
- };
1368
- };
1369
1341
  export declare const getSpaceInvitesQueryKey: (options: Options<GetSpaceInvitesData>) => [Pick<Options<GetSpaceInvitesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
1370
1342
  _id: string;
1371
1343
  _infinite?: boolean;
@@ -2022,180 +1994,6 @@ export declare const pingNodeOptions: (options: Options<PingNodeData>) => import
2022
1994
  * Generate a service account key file scoped to a node's own resources, for local development against them.
2023
1995
  */
2024
1996
  export declare const createNodeCredentialMutation: (options?: Partial<Options<CreateNodeCredentialData>>) => UseMutationOptions<CreateNodeCredentialResponse, CreateNodeCredentialError, Options<CreateNodeCredentialData>>;
2025
- export declare const getBillingPlanQueryKey: (options: Options<GetBillingPlanData>) => [Pick<Options<GetBillingPlanData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2026
- _id: string;
2027
- _infinite?: boolean;
2028
- tags?: ReadonlyArray<string>;
2029
- }];
2030
- /**
2031
- * Get the current billing plan for a space.
2032
- *
2033
- * @deprecated
2034
- */
2035
- export declare const getBillingPlanOptions: (options: Options<GetBillingPlanData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").BillingPlan, Error, import("../types.gen").BillingPlan, [Pick<Options<GetBillingPlanData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2036
- _id: string;
2037
- _infinite?: boolean;
2038
- tags?: ReadonlyArray<string>;
2039
- }]>, "queryFn"> & {
2040
- queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").BillingPlan, [Pick<Options<GetBillingPlanData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2041
- _id: string;
2042
- _infinite?: boolean;
2043
- tags?: ReadonlyArray<string>;
2044
- }], never> | undefined;
2045
- } & {
2046
- queryKey: [Pick<Options<GetBillingPlanData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2047
- _id: string;
2048
- _infinite?: boolean;
2049
- tags?: ReadonlyArray<string>;
2050
- }] & {
2051
- [dataTagSymbol]: import("../types.gen").BillingPlan;
2052
- [dataTagErrorSymbol]: Error;
2053
- };
2054
- };
2055
- /**
2056
- * Upgrade or downgrade the billing plan for a space.
2057
- *
2058
- * @deprecated
2059
- */
2060
- export declare const updateBillingPlanMutation: (options?: Partial<Options<UpdateBillingPlanData>>) => UseMutationOptions<unknown, UpdateBillingPlanError, Options<UpdateBillingPlanData>>;
2061
- /**
2062
- * Create a Stripe SetupIntent to collect a payment method.
2063
- *
2064
- * @deprecated
2065
- */
2066
- export declare const createSetupIntentMutation: (options?: Partial<Options<CreateSetupIntentData>>) => UseMutationOptions<CreateSetupIntentResponse, CreateSetupIntentError, Options<CreateSetupIntentData>>;
2067
- export declare const listPaymentMethodsQueryKey: (options: Options<ListPaymentMethodsData>) => [Pick<Options<ListPaymentMethodsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2068
- _id: string;
2069
- _infinite?: boolean;
2070
- tags?: ReadonlyArray<string>;
2071
- }];
2072
- /**
2073
- * List all saved payment methods for a space.
2074
- *
2075
- * @deprecated
2076
- */
2077
- export declare const listPaymentMethodsOptions: (options: Options<ListPaymentMethodsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaymentMethod[], Error, import("../types.gen").PaymentMethod[], [Pick<Options<ListPaymentMethodsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2078
- _id: string;
2079
- _infinite?: boolean;
2080
- tags?: ReadonlyArray<string>;
2081
- }]>, "queryFn"> & {
2082
- queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaymentMethod[], [Pick<Options<ListPaymentMethodsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2083
- _id: string;
2084
- _infinite?: boolean;
2085
- tags?: ReadonlyArray<string>;
2086
- }], never> | undefined;
2087
- } & {
2088
- queryKey: [Pick<Options<ListPaymentMethodsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2089
- _id: string;
2090
- _infinite?: boolean;
2091
- tags?: ReadonlyArray<string>;
2092
- }] & {
2093
- [dataTagSymbol]: import("../types.gen").PaymentMethod[];
2094
- [dataTagErrorSymbol]: Error;
2095
- };
2096
- };
2097
- /**
2098
- * Remove a saved payment method.
2099
- *
2100
- * @deprecated
2101
- */
2102
- export declare const removePaymentMethodMutation: (options?: Partial<Options<RemovePaymentMethodData>>) => UseMutationOptions<RemovePaymentMethodResponse, RemovePaymentMethodError, Options<RemovePaymentMethodData>>;
2103
- /**
2104
- * Set a payment method as the default for invoices.
2105
- *
2106
- * @deprecated
2107
- */
2108
- export declare const setDefaultPaymentMethodMutation: (options?: Partial<Options<SetDefaultPaymentMethodData>>) => UseMutationOptions<SetDefaultPaymentMethodResponse, SetDefaultPaymentMethodError, Options<SetDefaultPaymentMethodData>>;
2109
- export declare const getBillingUsageQueryKey: (options: Options<GetBillingUsageData>) => [Pick<Options<GetBillingUsageData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2110
- _id: string;
2111
- _infinite?: boolean;
2112
- tags?: ReadonlyArray<string>;
2113
- }];
2114
- /**
2115
- * Get metered cloud usage for the current billing period.
2116
- *
2117
- * @deprecated
2118
- */
2119
- export declare const getBillingUsageOptions: (options: Options<GetBillingUsageData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").BillingUsage, Error, import("../types.gen").BillingUsage, [Pick<Options<GetBillingUsageData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2120
- _id: string;
2121
- _infinite?: boolean;
2122
- tags?: ReadonlyArray<string>;
2123
- }]>, "queryFn"> & {
2124
- queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").BillingUsage, [Pick<Options<GetBillingUsageData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2125
- _id: string;
2126
- _infinite?: boolean;
2127
- tags?: ReadonlyArray<string>;
2128
- }], never> | undefined;
2129
- } & {
2130
- queryKey: [Pick<Options<GetBillingUsageData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2131
- _id: string;
2132
- _infinite?: boolean;
2133
- tags?: ReadonlyArray<string>;
2134
- }] & {
2135
- [dataTagSymbol]: import("../types.gen").BillingUsage;
2136
- [dataTagErrorSymbol]: Error;
2137
- };
2138
- };
2139
- export declare const fetchBillingPricesQueryKey: (options: Options<FetchBillingPricesData>) => [Pick<Options<FetchBillingPricesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2140
- _id: string;
2141
- _infinite?: boolean;
2142
- tags?: ReadonlyArray<string>;
2143
- }];
2144
- /**
2145
- * Fetch live unit prices for all paid plans from Stripe.
2146
- *
2147
- * @deprecated
2148
- */
2149
- export declare const fetchBillingPricesOptions: (options: Options<FetchBillingPricesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PlanPriceResponse[], Error, import("../types.gen").PlanPriceResponse[], [Pick<Options<FetchBillingPricesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2150
- _id: string;
2151
- _infinite?: boolean;
2152
- tags?: ReadonlyArray<string>;
2153
- }]>, "queryFn"> & {
2154
- queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PlanPriceResponse[], [Pick<Options<FetchBillingPricesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2155
- _id: string;
2156
- _infinite?: boolean;
2157
- tags?: ReadonlyArray<string>;
2158
- }], never> | undefined;
2159
- } & {
2160
- queryKey: [Pick<Options<FetchBillingPricesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2161
- _id: string;
2162
- _infinite?: boolean;
2163
- tags?: ReadonlyArray<string>;
2164
- }] & {
2165
- [dataTagSymbol]: import("../types.gen").PlanPriceResponse[];
2166
- [dataTagErrorSymbol]: Error;
2167
- };
2168
- };
2169
- export declare const listBillingInvoicesQueryKey: (options: Options<ListBillingInvoicesData>) => [Pick<Options<ListBillingInvoicesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2170
- _id: string;
2171
- _infinite?: boolean;
2172
- tags?: ReadonlyArray<string>;
2173
- }];
2174
- /**
2175
- * List past invoices for the space, newest first.
2176
- *
2177
- * @deprecated
2178
- */
2179
- export declare const listBillingInvoicesOptions: (options: Options<ListBillingInvoicesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").InvoicesResponse, Error, import("../types.gen").InvoicesResponse, [Pick<Options<ListBillingInvoicesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2180
- _id: string;
2181
- _infinite?: boolean;
2182
- tags?: ReadonlyArray<string>;
2183
- }]>, "queryFn"> & {
2184
- queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").InvoicesResponse, [Pick<Options<ListBillingInvoicesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2185
- _id: string;
2186
- _infinite?: boolean;
2187
- tags?: ReadonlyArray<string>;
2188
- }], never> | undefined;
2189
- } & {
2190
- queryKey: [Pick<Options<ListBillingInvoicesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
2191
- _id: string;
2192
- _infinite?: boolean;
2193
- tags?: ReadonlyArray<string>;
2194
- }] & {
2195
- [dataTagSymbol]: import("../types.gen").InvoicesResponse;
2196
- [dataTagErrorSymbol]: Error;
2197
- };
2198
- };
2199
1997
  /**
2200
1998
  * Create a bug report
2201
1999
  */
@@ -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, cloneEnvironment, createApiKey, createBlueprint, createBugReport, createEnvironment, createEnvironmentVariable, createFeatureRequest, createNeonBranch, createNeonDatabase, createNeonProject, createNeonProjectM2M, createNodeCredential, createProject, createSecret, createSecretM2M, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteBlueprint, deleteEnvironment, deleteEnvironmentM2M, deleteEnvironmentVariable, deleteNeonDatabase, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchMongoOrganizations, fetchMongoOrganizationTier, fetchMongoRegions, fetchNeonConnectionUri, fetchNeonOrganizations, fetchNeonRegions, fetchNodeM2M, getApiKeys, getBillingPlan, getBillingUsage, getBlueprint, getBlueprintM2M, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVariablesM2M, getEnvironmentVersions, getFeatureFlags, getGraphOverview, getNodeEnvironmentVariables, getProjectEnvironments, getProjectOverview, getPublicInvite, getSecretValue, getServiceHealth, getSoftDeletedEnvironmentsM2M, getSpaceInvites, getSpaceM2M, getSpaceOrgCode, getSpaceOverview, getSpaceProperties, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, getVersion, getVersionM2M, importBlueprint, joinSpace, kickSpaceMember, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listMongoClusters, listMongoProjects, listNeonBranches, listNeonDatabases, listNeonProjects, listNeonRoles, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, lookupApiKey, nukeEnvironmentM2M, pingNode, previewBlueprint, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeApiKey, revokeSpaceInvite, setDefaultPaymentMethod, setEnvironmentGcpProjectId, setSpaceProperty, updateBillingPlan, updateBlueprint, updateConnectedAppToken, updateDeploymentStatusM2M, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateUsername, updateUserProfile, viewBlueprints, viewBlueprintsM2M } from '../sdk.gen';
4
+ import { checkSubdomainUniqueness, cloneEnvironment, createApiKey, createBlueprint, createBugReport, createEnvironment, createEnvironmentVariable, createFeatureRequest, createNeonBranch, createNeonDatabase, createNeonProject, createNeonProjectM2M, createNodeCredential, createProject, createSecret, createSecretM2M, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteBlueprint, deleteEnvironment, deleteEnvironmentM2M, deleteEnvironmentVariable, deleteNeonDatabase, deployVersion, fetchGraphM2M, fetchMongoOrganizations, fetchMongoOrganizationTier, fetchMongoRegions, fetchNeonConnectionUri, fetchNeonOrganizations, fetchNeonRegions, fetchNodeM2M, getApiKeys, getBlueprint, getBlueprintM2M, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVariablesM2M, getEnvironmentVersions, getFeatureFlags, getGraphOverview, getNodeEnvironmentVariables, getProjectEnvironments, getProjectOverview, getPublicInvite, getSecretValue, getServiceHealth, getSoftDeletedEnvironmentsM2M, getSpaceInvites, getSpaceM2M, getSpaceOrgCode, getSpaceOverview, getSpaceProperties, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, getVersion, getVersionM2M, importBlueprint, joinSpace, kickSpaceMember, leaveSpace, listInstallationBranches, listInstallationRepositories, listMongoClusters, listMongoProjects, listNeonBranches, listNeonDatabases, listNeonProjects, listNeonRoles, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, lookupApiKey, nukeEnvironmentM2M, pingNode, previewBlueprint, recordOnboardingAnalytics, rejectSpaceInvite, requestAccountPasswordReset, requestSignedDownloadUrl, requestSignedUploadUrl, revokeApiKey, revokeSpaceInvite, setEnvironmentGcpProjectId, setSpaceProperty, updateBlueprint, updateConnectedAppToken, updateDeploymentStatusM2M, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateUsername, updateUserProfile, viewBlueprints, viewBlueprintsM2M } from '../sdk.gen';
5
5
  const createQueryKey = (id, options, infinite, tags) => {
6
6
  const params = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl };
7
7
  if (infinite) {
@@ -1306,24 +1306,6 @@ export const getSpaceStatsOptions = (options) => {
1306
1306
  queryKey: getSpaceStatsQueryKey(options)
1307
1307
  });
1308
1308
  };
1309
- export const fetchKindeOrganisationBillingAgreementsQueryKey = (options) => createQueryKey('fetchKindeOrganisationBillingAgreements', options);
1310
- /**
1311
- * The space billing agreements.
1312
- */
1313
- export const fetchKindeOrganisationBillingAgreementsOptions = (options) => {
1314
- return queryOptions({
1315
- queryFn: async ({ queryKey, signal }) => {
1316
- const { data } = await fetchKindeOrganisationBillingAgreements({
1317
- ...options,
1318
- ...queryKey[0],
1319
- signal,
1320
- throwOnError: true
1321
- });
1322
- return data;
1323
- },
1324
- queryKey: fetchKindeOrganisationBillingAgreementsQueryKey(options)
1325
- });
1326
- };
1327
1309
  export const getSpaceInvitesQueryKey = (options) => createQueryKey('getSpaceInvites', options);
1328
1310
  /**
1329
1311
  * View all pending invites a space has.
@@ -2099,178 +2081,6 @@ export const createNodeCredentialMutation = (options) => {
2099
2081
  };
2100
2082
  return mutationOptions;
2101
2083
  };
2102
- export const getBillingPlanQueryKey = (options) => createQueryKey('getBillingPlan', options);
2103
- /**
2104
- * Get the current billing plan for a space.
2105
- *
2106
- * @deprecated
2107
- */
2108
- export const getBillingPlanOptions = (options) => {
2109
- return queryOptions({
2110
- queryFn: async ({ queryKey, signal }) => {
2111
- const { data } = await getBillingPlan({
2112
- ...options,
2113
- ...queryKey[0],
2114
- signal,
2115
- throwOnError: true
2116
- });
2117
- return data;
2118
- },
2119
- queryKey: getBillingPlanQueryKey(options)
2120
- });
2121
- };
2122
- /**
2123
- * Upgrade or downgrade the billing plan for a space.
2124
- *
2125
- * @deprecated
2126
- */
2127
- export const updateBillingPlanMutation = (options) => {
2128
- const mutationOptions = {
2129
- mutationFn: async (fnOptions) => {
2130
- const { data } = await updateBillingPlan({
2131
- ...options,
2132
- ...fnOptions,
2133
- throwOnError: true
2134
- });
2135
- return data;
2136
- }
2137
- };
2138
- return mutationOptions;
2139
- };
2140
- /**
2141
- * Create a Stripe SetupIntent to collect a payment method.
2142
- *
2143
- * @deprecated
2144
- */
2145
- export const createSetupIntentMutation = (options) => {
2146
- const mutationOptions = {
2147
- mutationFn: async (fnOptions) => {
2148
- const { data } = await createSetupIntent({
2149
- ...options,
2150
- ...fnOptions,
2151
- throwOnError: true
2152
- });
2153
- return data;
2154
- }
2155
- };
2156
- return mutationOptions;
2157
- };
2158
- export const listPaymentMethodsQueryKey = (options) => createQueryKey('listPaymentMethods', options);
2159
- /**
2160
- * List all saved payment methods for a space.
2161
- *
2162
- * @deprecated
2163
- */
2164
- export const listPaymentMethodsOptions = (options) => {
2165
- return queryOptions({
2166
- queryFn: async ({ queryKey, signal }) => {
2167
- const { data } = await listPaymentMethods({
2168
- ...options,
2169
- ...queryKey[0],
2170
- signal,
2171
- throwOnError: true
2172
- });
2173
- return data;
2174
- },
2175
- queryKey: listPaymentMethodsQueryKey(options)
2176
- });
2177
- };
2178
- /**
2179
- * Remove a saved payment method.
2180
- *
2181
- * @deprecated
2182
- */
2183
- export const removePaymentMethodMutation = (options) => {
2184
- const mutationOptions = {
2185
- mutationFn: async (fnOptions) => {
2186
- const { data } = await removePaymentMethod({
2187
- ...options,
2188
- ...fnOptions,
2189
- throwOnError: true
2190
- });
2191
- return data;
2192
- }
2193
- };
2194
- return mutationOptions;
2195
- };
2196
- /**
2197
- * Set a payment method as the default for invoices.
2198
- *
2199
- * @deprecated
2200
- */
2201
- export const setDefaultPaymentMethodMutation = (options) => {
2202
- const mutationOptions = {
2203
- mutationFn: async (fnOptions) => {
2204
- const { data } = await setDefaultPaymentMethod({
2205
- ...options,
2206
- ...fnOptions,
2207
- throwOnError: true
2208
- });
2209
- return data;
2210
- }
2211
- };
2212
- return mutationOptions;
2213
- };
2214
- export const getBillingUsageQueryKey = (options) => createQueryKey('getBillingUsage', options);
2215
- /**
2216
- * Get metered cloud usage for the current billing period.
2217
- *
2218
- * @deprecated
2219
- */
2220
- export const getBillingUsageOptions = (options) => {
2221
- return queryOptions({
2222
- queryFn: async ({ queryKey, signal }) => {
2223
- const { data } = await getBillingUsage({
2224
- ...options,
2225
- ...queryKey[0],
2226
- signal,
2227
- throwOnError: true
2228
- });
2229
- return data;
2230
- },
2231
- queryKey: getBillingUsageQueryKey(options)
2232
- });
2233
- };
2234
- export const fetchBillingPricesQueryKey = (options) => createQueryKey('fetchBillingPrices', options);
2235
- /**
2236
- * Fetch live unit prices for all paid plans from Stripe.
2237
- *
2238
- * @deprecated
2239
- */
2240
- export const fetchBillingPricesOptions = (options) => {
2241
- return queryOptions({
2242
- queryFn: async ({ queryKey, signal }) => {
2243
- const { data } = await fetchBillingPrices({
2244
- ...options,
2245
- ...queryKey[0],
2246
- signal,
2247
- throwOnError: true
2248
- });
2249
- return data;
2250
- },
2251
- queryKey: fetchBillingPricesQueryKey(options)
2252
- });
2253
- };
2254
- export const listBillingInvoicesQueryKey = (options) => createQueryKey('listBillingInvoices', options);
2255
- /**
2256
- * List past invoices for the space, newest first.
2257
- *
2258
- * @deprecated
2259
- */
2260
- export const listBillingInvoicesOptions = (options) => {
2261
- return queryOptions({
2262
- queryFn: async ({ queryKey, signal }) => {
2263
- const { data } = await listBillingInvoices({
2264
- ...options,
2265
- ...queryKey[0],
2266
- signal,
2267
- throwOnError: true
2268
- });
2269
- return data;
2270
- },
2271
- queryKey: listBillingInvoicesQueryKey(options)
2272
- });
2273
- };
2274
2084
  /**
2275
2085
  * Create a bug report
2276
2086
  */
@@ -42,7 +42,7 @@ export declare const getUsageQueryKey: (options: Options<GetUsageData>) => [Pick
42
42
  tags?: ReadonlyArray<string>;
43
43
  }];
44
44
  /**
45
- * Returns usage information for the current billing period.
45
+ * Returns usage information for the current billing period, or for an explicit past window.
46
46
  */
47
47
  export declare const getUsageOptions: (options: Options<GetUsageData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").UsageInfoResponse, Error, import("../types.gen").UsageInfoResponse, [Pick<Options<GetUsageData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
48
48
  _id: string;
@@ -46,7 +46,7 @@ export const getCustomerOptions = (options) => {
46
46
  };
47
47
  export const getUsageQueryKey = (options) => createQueryKey('getUsage', options);
48
48
  /**
49
- * Returns usage information for the current billing period.
49
+ * Returns usage information for the current billing period, or for an explicit past window.
50
50
  */
51
51
  export const getUsageOptions = (options) => {
52
52
  return queryOptions({
@@ -18,7 +18,7 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
18
18
  */
19
19
  export declare const getCustomer: <ThrowOnError extends boolean = false>(options: Options<GetCustomerData, ThrowOnError>) => import("./client").RequestResult<GetCustomerResponses, GetCustomerErrors, ThrowOnError, "fields">;
20
20
  /**
21
- * Returns usage information for the current billing period.
21
+ * Returns usage information for the current billing period, or for an explicit past window.
22
22
  */
23
23
  export declare const getUsage: <ThrowOnError extends boolean = false>(options: Options<GetUsageData, ThrowOnError>) => import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
24
24
  /**
@@ -16,7 +16,7 @@ export const getCustomer = (options) => {
16
16
  });
17
17
  };
18
18
  /**
19
- * Returns usage information for the current billing period.
19
+ * Returns usage information for the current billing period, or for an explicit past window.
20
20
  */
21
21
  export const getUsage = (options) => {
22
22
  return (options.client ?? client).get({
@@ -154,10 +154,14 @@ export type UsageInfoResponse = {
154
154
  from: string;
155
155
  to: string;
156
156
  };
157
+ export type UsagePoint = {
158
+ date: string;
159
+ amount: unknown;
160
+ };
157
161
  export type MeterType = {
158
162
  displayName: string;
159
163
  total: unknown;
160
- values: Array<unknown>;
164
+ points: Array<UsagePoint>;
161
165
  };
162
166
  export type Meters = {
163
167
  computeVms: MeterType;
@@ -243,6 +247,14 @@ export type OrganisationId = string;
243
247
  * A valid currency.
244
248
  */
245
249
  export type Currency2 = Currency;
250
+ /**
251
+ * Start of the usage window. Defaults to the start of the current billing period. Must not be in the future.
252
+ */
253
+ export type UsageFrom = string;
254
+ /**
255
+ * End of the usage window. Defaults to now. Must not be in the future.
256
+ */
257
+ export type UsageTo = string;
246
258
  export type GetCustomerData = {
247
259
  body?: never;
248
260
  path: {
@@ -289,12 +301,20 @@ export type GetUsageData = {
289
301
  * A valid currency.
290
302
  */
291
303
  currency: Currency;
304
+ /**
305
+ * Start of the usage window. Defaults to the start of the current billing period. Must not be in the future.
306
+ */
307
+ from?: string;
308
+ /**
309
+ * End of the usage window. Defaults to now. Must not be in the future.
310
+ */
311
+ to?: string;
292
312
  };
293
313
  url: '/api/v1/usage/{org}';
294
314
  };
295
315
  export type GetUsageErrors = {
296
316
  /**
297
- * Invalid currency
317
+ * Invalid currency or usage window
298
318
  */
299
319
  400: _Error;
300
320
  /**