Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

Update API types (#50234)

Gildas Garcia737b8595f257
diff --git a/apps/docs/lib/fetch/organizations.ts b/apps/docs/lib/fetch/organizations.ts
index 9db981af8c8..8582d31838f 100644
--- a/apps/docs/lib/fetch/organizations.ts
+++ b/apps/docs/lib/fetch/organizations.ts
@@ -1,7 +1,8 @@
import { useQuery, UseQueryOptions } from '@tanstack/react-query'
-import { get } from './fetchWrappers'
-import type { components } from 'api-types'
import type { ResponseError } from '~/types/fetch'
+import type { components } from 'api-types'
+
+import { get } from './fetchWrappers'
const organizationKeys = {
list: () => ['organizations'] as const,
@@ -12,7 +13,7 @@ async function getOrganizations(signal?: AbortSignal) {
// but the actual response should be typed as OrganizationResponse.
const { data, error } = await get('/platform/organizations', { signal })
if (error) throw error
- return data as unknown as components['schemas']['OrganizationResponse'][]
+ return data as unknown as components['schemas']['OrganizationResponse_Output'][]
}
export type OrganizationsData = Awaited<ReturnType<typeof getOrganizations>>
diff --git a/apps/docs/lib/fetch/projects-infinite.ts b/apps/docs/lib/fetch/projects-infinite.ts
index 6d86bd7616e..2d512d12e6b 100644
--- a/apps/docs/lib/fetch/projects-infinite.ts
+++ b/apps/docs/lib/fetch/projects-infinite.ts
@@ -1,6 +1,7 @@
import { useInfiniteQuery, UseInfiniteQueryOptions } from '@tanstack/react-query'
-import { components } from 'api-types'
import type { ResponseError } from '~/types/fetch'
+import { components } from 'api-types'
+
import { get } from './fetchWrappers'
const DEFAULT_LIMIT = 10
@@ -20,7 +21,7 @@ interface GetProjectsInfiniteVariables {
}
export type ProjectInfoInfinite =
- components['schemas']['ListProjectsPaginatedResponse']['projects'][number]
+ components['schemas']['ListProjectsPaginatedResponse_Output']['projects'][number]
async function getProjects(
{
@@ -43,7 +44,7 @@ async function getProjects(
})
if (error) throw error
- return data as unknown as components['schemas']['ListProjectsPaginatedResponse']
+ return data as unknown as components['schemas']['ListProjectsPaginatedResponse_Output']
}
export type ProjectsInfiniteData = Awaited<ReturnType<typeof getProjects>>
diff --git a/apps/studio/components/interfaces/APIKeys/ApiKeyPill.test.tsx b/apps/studio/components/interfaces/APIKeys/ApiKeyPill.test.tsx
index bff0ed53f46..8b5ba531696 100644
--- a/apps/studio/components/interfaces/APIKeys/ApiKeyPill.test.tsx
+++ b/apps/studio/components/interfaces/APIKeys/ApiKeyPill.test.tsx
@@ -8,7 +8,7 @@ import type { APIKeysData } from '@/data/api-keys/api-keys-query'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type ApiKeyResponse = components['schemas']['ApiKeyResponse']
+type ApiKeyResponse = components['schemas']['ApiKeyResponse_Output']
// Permissions are non-network global state — mock the hook (the skill's allowed
// exception), matching the neighboring PublishableAPIKeys.test.tsx.
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.fixtures.ts b/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.fixtures.ts
index ca320cd6ab6..6946336fa94 100644
--- a/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.fixtures.ts
+++ b/apps/studio/components/interfaces/Account/AccessTokens/AccessToken.fixtures.ts
@@ -14,9 +14,9 @@ import type { Permission } from '@/types'
*/
type AccessControlPermission = components['schemas']['AccessControlPermission']
-type OrganizationResponse = components['schemas']['OrganizationResponse']
-type ProjectsResponse = components['schemas']['ListProjectsPaginatedResponse']
-type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
+type ProjectsResponse = components['schemas']['ListProjectsPaginatedResponse_Output']
+type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse_Output']
type OrganizationProject = OrganizationProjectsResponse['projects'][number]
/** Satisfies both Studio's `Permission` type and the API's `AccessControlPermission` row shape. */
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/ResourceAccessStep.test.tsx b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/ResourceAccessStep.test.tsx
index 84f80fef842..aab19060cdc 100644
--- a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/ResourceAccessStep.test.tsx
+++ b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/Form/ResourceAccessStep.test.tsx
@@ -19,7 +19,7 @@ import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
import { createMockProfileContext } from '@/tests/lib/profile-helpers'
-type OrganizationResponse = components['schemas']['OrganizationResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
// Disabling orgs for project-scoped members reads /platform/profile/permissions, which only
// fires on the platform for a logged-in user — neither is true in the default test environment.
diff --git a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.test.tsx b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.test.tsx
index e76c2f11e55..0c53b95dcc2 100644
--- a/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.test.tsx
+++ b/apps/studio/components/interfaces/Account/AccessTokens/Scoped/NewScopedTokenSheet.test.tsx
@@ -10,9 +10,9 @@ import { createMockOrganizationResponse, createMockProject } from '@/tests/helpe
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type OrganizationResponse = components['schemas']['OrganizationResponse']
-type ProjectsResponse = components['schemas']['ListProjectsPaginatedResponse']
-type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
+type ProjectsResponse = components['schemas']['ListProjectsPaginatedResponse_Output']
+type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse_Output']
type CreateTokenResponse = components['schemas']['CreateScopedAccessTokenResponse']
type CreateClassicTokenResponse = components['schemas']['CreateAccessTokenResponse']
diff --git a/apps/studio/components/interfaces/App/CommandMenu/ApiKeys.test.tsx b/apps/studio/components/interfaces/App/CommandMenu/ApiKeys.test.tsx
index be1335a8ec8..24ead7407b6 100644
--- a/apps/studio/components/interfaces/App/CommandMenu/ApiKeys.test.tsx
+++ b/apps/studio/components/interfaces/App/CommandMenu/ApiKeys.test.tsx
@@ -10,7 +10,7 @@ import { useApiKeysCommands } from './ApiKeys'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type ApiKeyResponse = components['schemas']['ApiKeyResponse']
+type ApiKeyResponse = components['schemas']['ApiKeyResponse_Output']
const { mockUseAsyncCheckPermissions, mockUseHighAvailability, mockUseSelectedProjectQuery } =
vi.hoisted(() => ({
diff --git a/apps/studio/components/interfaces/BranchManagement/SwitchToPreviewModal.test.tsx b/apps/studio/components/interfaces/BranchManagement/SwitchToPreviewModal.test.tsx
index c935c186525..5725d8eccb2 100644
--- a/apps/studio/components/interfaces/BranchManagement/SwitchToPreviewModal.test.tsx
+++ b/apps/studio/components/interfaces/BranchManagement/SwitchToPreviewModal.test.tsx
@@ -17,7 +17,7 @@ vi.mock('sonner', () => ({
toast: { success: vi.fn(), error: vi.fn() },
}))
-type BranchUpdateResponse = components['schemas']['BranchUpdateResponse']
+type BranchUpdateResponse = components['schemas']['BranchUpdateResponse_Output']
const PARENT_PROJECT_REF = 'parent-project-ref'
const BRANCH_PROJECT_REF = 'branch-project-ref'
diff --git a/apps/studio/components/interfaces/ConfigDrift/ConfigurationDriftPage.test.tsx b/apps/studio/components/interfaces/ConfigDrift/ConfigurationDriftPage.test.tsx
index 7fd9669319e..5972835f9a1 100644
--- a/apps/studio/components/interfaces/ConfigDrift/ConfigurationDriftPage.test.tsx
+++ b/apps/studio/components/interfaces/ConfigDrift/ConfigurationDriftPage.test.tsx
@@ -9,12 +9,12 @@ import { createMockOrganizationResponse } from '@/tests/helpers'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
-type ProjectDetailResponse = platformComponents['schemas']['ProjectDetailResponse']
-type OrganizationResponse = platformComponents['schemas']['OrganizationResponse']
+type ProjectDetailResponse = platformComponents['schemas']['ProjectDetailResponse_Output']
+type OrganizationResponse = platformComponents['schemas']['OrganizationResponse_Output']
type ListGitHubConnectionsResponse = platformComponents['schemas']['ListGitHubConnectionsResponse']
type GetGitHubConnectionConfigResponse =
platformComponents['schemas']['GetGitHubConnectionConfigResponse']
-type BranchResponse = apiV1Components['schemas']['BranchResponse']
+type BranchResponse = apiV1Components['schemas']['BranchResponse_Output']
type V2ProjectConfigResponse = apiV2Components['schemas']['V2ProjectConfigResponse_Output']
const PROJECT_REF = 'default'
@@ -76,6 +76,7 @@ const PROJECT: ProjectDetailResponse = {
status: 'ACTIVE_HEALTHY',
subscription_id: 'subscription-1',
updated_at: '2025-01-01T00:00:00Z',
+ connectionString: '',
}
const BRANCH: BranchResponse = {
@@ -154,8 +155,7 @@ function createProjectConfigResponse(auth: Record<string, unknown>): V2ProjectCo
suspend: false,
},
storage: {
- capabilities: { iceberg_catalog: false, list_v2: true },
- database_pool_mode: 'transaction',
+ capabilities: { iceberg_catalog: false, list_v2: true, object_versioning: false },
features: {
iceberg_catalog: { enabled: false, max_catalogs: 0, max_namespaces: 0, max_tables: 0 },
image_transformation: { enabled: true },
diff --git a/apps/studio/components/interfaces/ConnectSheet/content/server/env/content.test.tsx b/apps/studio/components/interfaces/ConnectSheet/content/server/env/content.test.tsx
index 43de2e05317..c9ebd1d78c8 100644
--- a/apps/studio/components/interfaces/ConnectSheet/content/server/env/content.test.tsx
+++ b/apps/studio/components/interfaces/ConnectSheet/content/server/env/content.test.tsx
@@ -7,8 +7,8 @@ import ServerEnvContent from './content'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type ApiKeyResponse = components['schemas']['ApiKeyResponse']
-type ProjectSettingsResponse = components['schemas']['ProjectSettingsResponse']
+type ApiKeyResponse = components['schemas']['ApiKeyResponse_Output']
+type ProjectSettingsResponse = components['schemas']['ProjectSettingsResponse_Output']
const { mockUseAsyncCheckPermissions } = vi.hoisted(() => ({
mockUseAsyncCheckPermissions: vi.fn(),
diff --git a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/index.test.tsx b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/index.test.tsx
index 953cf63bd65..5c897035f33 100644
--- a/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/index.test.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/DestinationPanel/DestinationForm/index.test.tsx
@@ -14,7 +14,7 @@ type DestinationResponse = components['schemas']['DestinationResponse_Output']
type PipelineResponse = components['schemas']['PipelineResponse_Output']
type PublicationDetailsResponse = components['schemas']['PublicationDetailsResponse_Output']
type PublicationNamesResponse = components['schemas']['ReadPublicationsResponse_Output']
-type ProjectSettingsResponse = components['schemas']['ProjectSettingsResponse']
+type ProjectSettingsResponse = components['schemas']['ProjectSettingsResponse_Output']
type SourcesResponse = components['schemas']['SourcesResponse_Output']
const mocks = vi.hoisted(() => ({
diff --git a/apps/studio/components/interfaces/Explorer/ExplorerNotebookTab.tsx b/apps/studio/components/interfaces/Explorer/ExplorerNotebookTab.tsx
index 811eabe4407..dc715017a9f 100644
--- a/apps/studio/components/interfaces/Explorer/ExplorerNotebookTab.tsx
+++ b/apps/studio/components/interfaces/Explorer/ExplorerNotebookTab.tsx
@@ -269,7 +269,7 @@ export const ExplorerNotebookTab = () => {
projectRef: ref,
id: notebookId,
name,
- description: currentNotebook?.notebook.description,
+ description: currentNotebook?.notebook.description ?? undefined,
content: writableContent,
})
}
diff --git a/apps/studio/components/interfaces/Explorer/__tests__/ExplorerNotebookTab.assistant-cache-invalidation.test.tsx b/apps/studio/components/interfaces/Explorer/__tests__/ExplorerNotebookTab.assistant-cache-invalidation.test.tsx
index b3d3b31dbe7..60a2c7b9e96 100644
--- a/apps/studio/components/interfaces/Explorer/__tests__/ExplorerNotebookTab.assistant-cache-invalidation.test.tsx
+++ b/apps/studio/components/interfaces/Explorer/__tests__/ExplorerNotebookTab.assistant-cache-invalidation.test.tsx
@@ -87,7 +87,7 @@ describe('ExplorerNotebookTab — assistant cache invalidation', () => {
method: 'get',
path: '/platform/projects/:ref/content/item/:id',
response: () =>
- HttpResponse.json<components['schemas']['GetUserContentByIdResponse']>({
+ HttpResponse.json<components['schemas']['GetUserContentByIdResponse_Output']>({
id: NOTEBOOK_ID,
type: 'notebook',
name: 'Test notebook',
@@ -147,7 +147,7 @@ describe('ExplorerNotebookTab — assistant cache invalidation', () => {
method: 'get',
path: '/platform/projects/:ref/content/item/:id',
response: () =>
- HttpResponse.json<components['schemas']['GetUserContentByIdResponse']>({
+ HttpResponse.json<components['schemas']['GetUserContentByIdResponse_Output']>({
id: NOTEBOOK_ID,
type: 'notebook',
name: 'Test notebook',
diff --git a/apps/studio/components/interfaces/Integrations/Integration/MarketplaceIntegrationSettingsTab.test.tsx b/apps/studio/components/interfaces/Integrations/Integration/MarketplaceIntegrationSettingsTab.test.tsx
index 56cab656c94..5ba0992cc63 100644
--- a/apps/studio/components/interfaces/Integrations/Integration/MarketplaceIntegrationSettingsTab.test.tsx
+++ b/apps/studio/components/interfaces/Integrations/Integration/MarketplaceIntegrationSettingsTab.test.tsx
@@ -15,7 +15,7 @@ import { addAPIMock } from '@/tests/lib/msw'
// The OAuth-apps query overrides its return type to `AuthorizedApp`, but the wire response (and so
// the MSW resolver) is the raw OpenAPI `OAuthAppResponse`. Build fixtures against the API shape.
-type OAuthAppResponse = components['schemas']['OAuthAppResponse']
+type OAuthAppResponse = components['schemas']['OAuthAppResponse_Output']
type PartnerIntegrationListResponse = components['schemas']['PartnerIntegrationListResponse']
// Same story for permissions: the frontend `Permission` type narrows nullable wire fields, so build
// the fixture against the raw `AccessControlPermission` shape the MSW resolver actually returns.
diff --git a/apps/studio/components/interfaces/Integrations/Landing/MarketplaceDetail.test.tsx b/apps/studio/components/interfaces/Integrations/Landing/MarketplaceDetail.test.tsx
index 681f22bd809..0d838d821a8 100644
--- a/apps/studio/components/interfaces/Integrations/Landing/MarketplaceDetail.test.tsx
+++ b/apps/studio/components/interfaces/Integrations/Landing/MarketplaceDetail.test.tsx
@@ -11,7 +11,7 @@ import { routerMock } from '@/tests/lib/route-mock'
// The OAuth-apps query overrides its return type to `AuthorizedApp`, but the wire response (and so
// the MSW resolver) is the raw OpenAPI `OAuthAppResponse`. Build fixtures against the API shape.
-type OAuthAppResponse = components['schemas']['OAuthAppResponse']
+type OAuthAppResponse = components['schemas']['OAuthAppResponse_Output']
type PartnerIntegrationListResponse = components['schemas']['PartnerIntegrationListResponse']
const STABLE_PARAMS = { ref: 'default', id: 'grafana', pageId: 'overview' }
diff --git a/apps/studio/components/interfaces/JwtSecrets/jwt-secret-keys-table/signing-key-row.tsx b/apps/studio/components/interfaces/JwtSecrets/jwt-secret-keys-table/signing-key-row.tsx
index 2f189271575..e61e4851c95 100644
--- a/apps/studio/components/interfaces/JwtSecrets/jwt-secret-keys-table/signing-key-row.tsx
+++ b/apps/studio/components/interfaces/JwtSecrets/jwt-secret-keys-table/signing-key-row.tsx
@@ -30,7 +30,7 @@ import { DropdownMenuItemTooltip } from '@/components/ui/DropdownMenuItemTooltip
import { JWTSigningKey } from '@/data/jwt-signing-keys/jwt-signing-keys-query'
interface SigningKeyRowProps {
- signingKey: components['schemas']['SigningKeyResponse']
+ signingKey: components['schemas']['SigningKeyResponse_Output']
setSelectedKey: (key?: JWTSigningKey) => void
setShownDialog: (dialog?: 'key-details' | 'revoke' | 'delete') => void
handlePreviouslyUsedKey: (keyId: string) => void
diff --git a/apps/studio/components/interfaces/MCP/Secrets/useSecretRequest.test.ts b/apps/studio/components/interfaces/MCP/Secrets/useSecretRequest.test.ts
index 0039402e9d1..edbbb383f6a 100644
--- a/apps/studio/components/interfaces/MCP/Secrets/useSecretRequest.test.ts
+++ b/apps/studio/components/interfaces/MCP/Secrets/useSecretRequest.test.ts
@@ -20,7 +20,7 @@ const paramsFor = (ref: string, name: string): SecretsParams => ({
const WRITE_DELAY_MS = 120
-const PROJECT: components['schemas']['ProjectDetailResponse'] = {
+const PROJECT: components['schemas']['ProjectDetailResponse_Output'] = {
cloud_provider: 'AWS',
db_host: 'db.example.supabase.co',
high_availability: false,
@@ -37,6 +37,7 @@ const PROJECT: components['schemas']['ProjectDetailResponse'] = {
status: 'ACTIVE_HEALTHY',
subscription_id: 'sub_1',
updated_at: '2026-01-01T00:00:00Z',
+ connectionString: '',
}
let writtenNames: string[] = []
diff --git a/apps/studio/components/interfaces/Organization/BillingSettings/BillingEmail.test.tsx b/apps/studio/components/interfaces/Organization/BillingSettings/BillingEmail.test.tsx
index 68329323d15..ab2dbe19443 100644
--- a/apps/studio/components/interfaces/Organization/BillingSettings/BillingEmail.test.tsx
+++ b/apps/studio/components/interfaces/Organization/BillingSettings/BillingEmail.test.tsx
@@ -12,7 +12,7 @@ import { organizationKeys } from '@/data/organizations/keys'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type CustomerResponse = components['schemas']['CustomerResponse']
+type CustomerResponse = components['schemas']['CustomerResponse_Output']
// The additional-emails control renders a Radix Popover when adding a recipient.
mockAnimationsApi()
diff --git a/apps/studio/components/interfaces/Organization/BillingSettings/helpers.ts b/apps/studio/components/interfaces/Organization/BillingSettings/helpers.ts
index 497c5a71f21..c79cba55754 100644
--- a/apps/studio/components/interfaces/Organization/BillingSettings/helpers.ts
+++ b/apps/studio/components/interfaces/Organization/BillingSettings/helpers.ts
@@ -24,7 +24,7 @@ const pricingMetricNotHrs = [
export const formatUsage = (
pricingMetric: PricingMetric,
- allocation: { usage: number; hours?: number }
+ allocation: { usage: number; hours?: number | null }
) => {
if (pricingMetricBytes.includes(pricingMetric)) {
const formattedUsage = +(allocation.usage / 1e9).toFixed(2).toLocaleString()
diff --git a/apps/studio/components/interfaces/Organization/OrgNotFound.test.tsx b/apps/studio/components/interfaces/Organization/OrgNotFound.test.tsx
index ef2759ec3eb..1d4de755115 100644
--- a/apps/studio/components/interfaces/Organization/OrgNotFound.test.tsx
+++ b/apps/studio/components/interfaces/Organization/OrgNotFound.test.tsx
@@ -9,8 +9,8 @@ import { createMockOrganizationResponse } from '@/tests/helpers'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
-type OrganizationResponse = components['schemas']['OrganizationResponse']
-type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
+type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse_Output']
const PROFILE_CONTEXT: ProfileContextType = {
profile: {
diff --git a/apps/studio/components/interfaces/Organization/PrivateApps/Apps/CreateAppSheet/CreateAppSheet.tsx b/apps/studio/components/interfaces/Organization/PrivateApps/Apps/CreateAppSheet/CreateAppSheet.tsx
index 88c520acf81..fe0509f45b1 100644
--- a/apps/studio/components/interfaces/Organization/PrivateApps/Apps/CreateAppSheet/CreateAppSheet.tsx
+++ b/apps/studio/components/interfaces/Organization/PrivateApps/Apps/CreateAppSheet/CreateAppSheet.tsx
@@ -36,9 +36,9 @@ import { usePlatformAppInstallationCreateMutation } from '@/data/platform-apps/p
import { usePlatformAppSigningKeyCreateMutation } from '@/data/platform-apps/platform-app-signing-key-create-mutation'
import { useCopyToClipboard } from '@/hooks/ui/useCopyToClipboard'
-type CreatePlatformAppResponse = components['schemas']['CreatePlatformAppResponse']
+type CreatePlatformAppResponse = components['schemas']['CreatePlatformAppResponse_Output']
type CreatePlatformAppSigningKeyResponse =
- components['schemas']['CreatePlatformAppSigningKeyResponse']
+ components['schemas']['CreatePlatformAppSigningKeyResponse_Output']
interface CreateAppSheetProps {
visible: boolean
diff --git a/apps/studio/components/interfaces/Organization/PrivateApps/PrivateApps.types.ts b/apps/studio/components/interfaces/Organization/PrivateApps/PrivateApps.types.ts
index 219148cc271..5266e6e8482 100644
--- a/apps/studio/components/interfaces/Organization/PrivateApps/PrivateApps.types.ts
+++ b/apps/studio/components/interfaces/Organization/PrivateApps/PrivateApps.types.ts
@@ -1,7 +1,7 @@
import type { components } from 'api-types'
-export type PrivateApp = components['schemas']['ListPlatformAppsResponse']['apps'][number]
-export type Installation = components['schemas']['InstallPlatformAppResponse'] & {
+export type PrivateApp = components['schemas']['ListPlatformAppsResponse_Output']['apps'][number]
+export type Installation = components['schemas']['InstallPlatformAppResponse_Output'] & {
// Project scope is not yet in the API — tracked locally for the UI
projectScope: 'all' | string[]
}
diff --git a/apps/studio/components/interfaces/Organization/PrivateApps/PrivateAppsContext.tsx b/apps/studio/components/interfaces/Organization/PrivateApps/PrivateAppsContext.tsx
index ef2c6d74cd1..620011c86bc 100644
--- a/apps/studio/components/interfaces/Organization/PrivateApps/PrivateAppsContext.tsx
+++ b/apps/studio/components/interfaces/Organization/PrivateApps/PrivateAppsContext.tsx
@@ -15,7 +15,7 @@ interface PrivateAppsContextValue {
isLoadingInstallations: boolean
installations: Installation[]
addInstallation: (
- data: components['schemas']['InstallPlatformAppResponse'],
+ data: components['schemas']['InstallPlatformAppResponse_Output'],
projectScope: 'all' | string[]
) => void
removeInstallation: (id: string) => void
@@ -41,7 +41,7 @@ export function PrivateAppsProvider({ children }: PropsWithChildren) {
const installations = useMemo<Installation[]>(() => {
if (!installationsError && installationsData?.installations) {
return installationsData.installations.map((inst) => ({
- ...(inst as components['schemas']['InstallPlatformAppResponse']),
+ ...(inst as components['schemas']['InstallPlatformAppResponse_Output']),
projectScope: 'all' as const,
}))
}
@@ -49,7 +49,7 @@ export function PrivateAppsProvider({ children }: PropsWithChildren) {
}, [installationsData, installationsError, localInstallations])
function addInstallation(
- data: components['schemas']['InstallPlatformAppResponse'],
+ data: components['schemas']['InstallPlatformAppResponse_Output'],
projectScope: 'all' | string[]
) {
setLocalInstallations((prev) => [...prev, { ...data, projectScope }])
diff --git a/apps/studio/components/interfaces/ProjectHome/CustomReportSection.tsx b/apps/studio/components/interfaces/ProjectHome/CustomReportSection.tsx
index 13af1c9a620..b2df6f9c8a5 100644
--- a/apps/studio/components/interfaces/ProjectHome/CustomReportSection.tsx
+++ b/apps/studio/components/interfaces/ProjectHome/CustomReportSection.tsx
@@ -94,7 +94,14 @@ export function CustomReportSection() {
const persistReport = useCallback(
(updated: Dashboards.Content) => {
if (!ref || !homeReport) return
- upsertContent({ projectRef: ref, payload: { ...homeReport, content: updated } })
+ upsertContent({
+ projectRef: ref,
+ payload: {
+ ...homeReport,
+ description: homeReport.description ?? undefined,
+ content: updated,
+ },
+ })
},
[homeReport, ref, upsertContent]
)
diff --git a/apps/studio/components/interfaces/ProjectHome/MakeReportSnippetPublicModal.tsx b/apps/studio/components/interfaces/ProjectHome/MakeReportSnippetPublicModal.tsx
index 30f42138c4b..5940bcee2c6 100644
--- a/apps/studio/components/interfaces/ProjectHome/MakeReportSnippetPublicModal.tsx
+++ b/apps/studio/components/interfaces/ProjectHome/MakeReportSnippetPublicModal.tsx
@@ -37,7 +37,12 @@ export const MakeReportSnippetPublicModal = ({
upsertContent(
{
projectRef,
- payload: { ...item, visibility: 'project', folder_id: null },
+ payload: {
+ ...item,
+ description: item.description ?? undefined,
+ visibility: 'project',
+ folder_id: null,
+ },
},
{
onSuccess: () => {
diff --git a/apps/studio/components/interfaces/Realtime/RealtimeSettings.test.tsx b/apps/studio/components/interfaces/Realtime/RealtimeSettings.test.tsx
index 9ecb2680e95..67512a3806f 100644
--- a/apps/studio/components/interfaces/Realtime/RealtimeSettings.test.tsx
+++ b/apps/studio/components/interfaces/Realtime/RealtimeSettings.test.tsx
@@ -121,7 +121,7 @@ describe('RealtimeSettings', () => {
method: 'get',
path: '/platform/projects/:ref/config/realtime',
response: () =>
- HttpResponse.json<components['schemas']['RealtimeConfigResponse']>(
+ HttpResponse.json<components['schemas']['RealtimeConfigResponse_Output']>(
configWithoutPool as any
),
})
diff --git a/apps/studio/components/interfaces/RedeemCredits/RedeemCredits.test.tsx b/apps/studio/components/interfaces/RedeemCredits/RedeemCredits.test.tsx
index 9eb57b4ddbe..fa39c55a00c 100644
--- a/apps/studio/components/interfaces/RedeemCredits/RedeemCredits.test.tsx
+++ b/apps/studio/components/interfaces/RedeemCredits/RedeemCredits.test.tsx
@@ -12,7 +12,7 @@ import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
import { routerMock } from '@/tests/lib/route-mock'
-type OrganizationResponse = components['schemas']['OrganizationResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
const { creditRedemptionProps } = vi.hoisted(() => ({
creditRedemptionProps: vi.fn(),
diff --git a/apps/studio/components/interfaces/Reports/Reports.tsx b/apps/studio/components/interfaces/Reports/Reports.tsx
index 6b30023a10d..c321238af69 100644
--- a/apps/studio/components/interfaces/Reports/Reports.tsx
+++ b/apps/studio/components/interfaces/Reports/Reports.tsx
@@ -258,7 +258,11 @@ const Reports = () => {
if (config === undefined) return console.error('Config is required')
upsertContent({
projectRef: ref,
- payload: { ...currentReport, content: config },
+ payload: {
+ ...currentReport,
+ description: currentReport.description ?? undefined,
+ content: config,
+ },
})
}
diff --git a/apps/studio/components/interfaces/SQLEditor/MoveQueryModal.tsx b/apps/studio/components/interfaces/SQLEditor/MoveQueryModal.tsx
index 13e8122e793..a8d71d6862b 100644
--- a/apps/studio/components/interfaces/SQLEditor/MoveQueryModal.tsx
+++ b/apps/studio/components/interfaces/SQLEditor/MoveQueryModal.tsx
@@ -150,7 +150,7 @@ export const MoveQueryModal = ({ visible, snippets = [], onClose }: MoveQueryMod
id: snippet.id,
type: 'sql',
name: snippet.name,
- description: snippet.description,
+ description: snippet.description ?? undefined,
visibility: snippet.visibility,
project_id: snippet.project_id,
owner_id: snippet.owner_id,
diff --git a/apps/studio/components/interfaces/SQLEditor/SQLEditor.utils.test.ts b/apps/studio/components/interfaces/SQLEditor/SQLEditor.utils.test.ts
index 60425bd3e32..ae75a7edb62 100644
--- a/apps/studio/components/interfaces/SQLEditor/SQLEditor.utils.test.ts
+++ b/apps/studio/components/interfaces/SQLEditor/SQLEditor.utils.test.ts
@@ -1418,6 +1418,7 @@ describe('SQLEditor.utils:hasBlockingIssues', () => {
const buildDatabase = (overrides: Partial<Database> = {}): Database => ({
cloud_provider: 'AWS',
connectionString: 'postgres://primary',
+ connection_string_read_only: 'postgres://primary',
db_host: 'db.example.com',
db_name: 'postgres',
db_port: 5432,
diff --git a/apps/studio/components/interfaces/SQLEditor/useSqlEditorExecution.test.tsx b/apps/studio/components/interfaces/SQLEditor/useSqlEditorExecution.test.tsx
index 4c4be71b112..83a2d06aaa7 100644
--- a/apps/studio/components/interfaces/SQLEditor/useSqlEditorExecution.test.tsx
+++ b/apps/studio/components/interfaces/SQLEditor/useSqlEditorExecution.test.tsx
@@ -207,6 +207,7 @@ describe('useSqlEditorExecution', () => {
{
identifier: 'replica-1',
connectionString,
+ connection_string_read_only: connectionString,
cloud_provider: 'AWS',
db_host: 'db.replica.supabase.co',
db_name: 'postgres',
diff --git a/apps/studio/components/interfaces/Settings/Addons/PITRSidePanel.tsx b/apps/studio/components/interfaces/Settings/Addons/PITRSidePanel.tsx
index 78b63f7b416..61334cdebf8 100644
--- a/apps/studio/components/interfaces/Settings/Addons/PITRSidePanel.tsx
+++ b/apps/studio/components/interfaces/Settings/Addons/PITRSidePanel.tsx
@@ -154,7 +154,7 @@ const PITRSidePanel = () => {
isSubmitting ||
!canUpdatePitr ||
(!!selectedPitr && !hasSufficientCompute) ||
- blockDowngradeDueToHipaa
+ (blockDowngradeDueToHipaa ?? undefined)
}
tooltip={
blockDowngradeDueToHipaa
diff --git a/apps/studio/components/interfaces/Settings/Database/ConnectionPooling/ConnectionPooling.tsx b/apps/studio/components/interfaces/Settings/Database/ConnectionPooling/ConnectionPooling.tsx
index 638f720e9f6..d7868f66af7 100644
--- a/apps/studio/components/interfaces/Settings/Database/ConnectionPooling/ConnectionPooling.tsx
+++ b/apps/studio/components/interfaces/Settings/Database/ConnectionPooling/ConnectionPooling.tsx
@@ -138,7 +138,7 @@ export const ConnectionPooling = () => {
toast.success(`Successfully updated pooler configuration`)
if (data) {
form.reset({
- default_pool_size: data.default_pool_size,
+ default_pool_size: data.default_pool_size ?? undefined,
})
}
},
diff --git a/apps/studio/components/interfaces/Settings/Database/SSLConfiguration.test.tsx b/apps/studio/components/interfaces/Settings/Database/SSLConfiguration.test.tsx
index 9e10370d335..c13f810e32e 100644
--- a/apps/studio/components/interfaces/Settings/Database/SSLConfiguration.test.tsx
+++ b/apps/studio/components/interfaces/Settings/Database/SSLConfiguration.test.tsx
@@ -8,8 +8,8 @@ import { SSLConfiguration } from './SSLConfiguration'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type ProjectSettingsResponse = components['schemas']['ProjectSettingsResponse']
-type SslEnforcementResponse = components['schemas']['SslEnforcementResponse']
+type ProjectSettingsResponse = components['schemas']['ProjectSettingsResponse_Output']
+type SslEnforcementResponse = components['schemas']['SslEnforcementResponse_Output']
type JitAccessConfigResponse =
paths['/v1/projects/{ref}/jit-access']['get']['responses'][200]['content']['application/json']
diff --git a/apps/studio/components/interfaces/Settings/Infrastructure/InfrastructureConfiguration/HaInstanceConfiguration.test.tsx b/apps/studio/components/interfaces/Settings/Infrastructure/InfrastructureConfiguration/HaInstanceConfiguration.test.tsx
index fefde036516..4c392e89444 100644
--- a/apps/studio/components/interfaces/Settings/Infrastructure/InfrastructureConfiguration/HaInstanceConfiguration.test.tsx
+++ b/apps/studio/components/interfaces/Settings/Infrastructure/InfrastructureConfiguration/HaInstanceConfiguration.test.tsx
@@ -9,7 +9,7 @@ import type { ProfileContextType } from '@/lib/profile'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock, mswServer, type APIErrorBody } from '@/tests/lib/msw'
-type ProjectDetailResponse = components['schemas']['ProjectDetailResponse']
+type ProjectDetailResponse = components['schemas']['ProjectDetailResponse_Output']
vi.mock('@/lib/constants', async (importOriginal) => {
const actual = await importOriginal<typeof import('@/lib/constants')>()
diff --git a/apps/studio/components/interfaces/Settings/Infrastructure/InfrastructureConfiguration/HaInstanceNode.tsx b/apps/studio/components/interfaces/Settings/Infrastructure/InfrastructureConfiguration/HaInstanceNode.tsx
index 7c439e4de59..f564131ad15 100644
--- a/apps/studio/components/interfaces/Settings/Infrastructure/InfrastructureConfiguration/HaInstanceNode.tsx
+++ b/apps/studio/components/interfaces/Settings/Infrastructure/InfrastructureConfiguration/HaInstanceNode.tsx
@@ -29,7 +29,7 @@ const PoolerCardSubtitle = ({
computeSize,
}: {
availabilityZone?: string
- computeSize?: string
+ computeSize?: string | null
}) => (
<p className="flex items-center gap-x-1 text-sm text-foreground-light">
{availabilityZone !== undefined && <span>{availabilityZone}</span>}
diff --git a/apps/studio/components/interfaces/Settings/Infrastructure/ReadReplicas/ReadReplicaDetails.tsx b/apps/studio/components/interfaces/Settings/Infrastructure/ReadReplicas/ReadReplicaDetails.tsx
index 60e27bf334d..dbfd54f7857 100644
--- a/apps/studio/components/interfaces/Settings/Infrastructure/ReadReplicas/ReadReplicaDetails.tsx
+++ b/apps/studio/components/interfaces/Settings/Infrastructure/ReadReplicas/ReadReplicaDetails.tsx
@@ -160,7 +160,7 @@ export const ReadReplicaDetails = () => {
label="Compute Size"
description="Size of replica will be identical to the primary database."
>
- <Input readOnly className="input-mono" value={size} />
+ <Input readOnly className="input-mono" value={size ?? undefined} />
</FormItemLayout>
</CardContent>
</>
diff --git a/apps/studio/components/interfaces/Settings/Infrastructure/ReadReplicas/ReadReplicas.constants.ts b/apps/studio/components/interfaces/Settings/Infrastructure/ReadReplicas/ReadReplicas.constants.ts
index 50f8d4f6e7f..216a2591482 100644
--- a/apps/studio/components/interfaces/Settings/Infrastructure/ReadReplicas/ReadReplicas.constants.ts
+++ b/apps/studio/components/interfaces/Settings/Infrastructure/ReadReplicas/ReadReplicas.constants.ts
@@ -3,7 +3,7 @@ import { components } from 'api-types'
import { PROJECT_STATUS } from '@/lib/constants'
export const REPLICA_STATUS: {
- [key: string]: components['schemas']['DatabaseStatusResponse']['status']
+ [key: string]: components['schemas']['DatabaseStatusResponse_Output']['status']
} = {
...PROJECT_STATUS,
INIT_READ_REPLICA: 'INIT_READ_REPLICA',
diff --git a/apps/studio/components/interfaces/Settings/Logs/LegacyLogsRewriteBanner.test.tsx b/apps/studio/components/interfaces/Settings/Logs/LegacyLogsRewriteBanner.test.tsx
index 0afc4614b4e..652cd1d8003 100644
--- a/apps/studio/components/interfaces/Settings/Logs/LegacyLogsRewriteBanner.test.tsx
+++ b/apps/studio/components/interfaces/Settings/Logs/LegacyLogsRewriteBanner.test.tsx
@@ -11,7 +11,7 @@ import { createMockOrganizationResponse } from '@/tests/helpers'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock, mswServer } from '@/tests/lib/msw'
-type ProjectDetailResponse = platformComponents['schemas']['ProjectDetailResponse']
+type ProjectDetailResponse = platformComponents['schemas']['ProjectDetailResponse_Output']
const PROJECT_MOCK: ProjectDetailResponse = {
id: 1,
@@ -75,7 +75,9 @@ describe('LegacyLogsRewriteBanner', () => {
method: 'post',
path: '/platform/projects/:ref/analytics/endpoints/logs.all.otel',
response: () =>
- HttpResponse.json<platformComponents['schemas']['AnalyticsResponse']>({ result: [] }),
+ HttpResponse.json<platformComponents['schemas']['AnalyticsResponse_Output']>({
+ result: [],
+ }),
})
})
diff --git a/apps/studio/components/interfaces/Settings/Logs/Logs.SavedQueriesItem.tsx b/apps/studio/components/interfaces/Settings/Logs/Logs.SavedQueriesItem.tsx
index 97831f24449..4678c0b83f9 100644
--- a/apps/studio/components/interfaces/Settings/Logs/Logs.SavedQueriesItem.tsx
+++ b/apps/studio/components/interfaces/Settings/Logs/Logs.SavedQueriesItem.tsx
@@ -18,7 +18,7 @@ interface SavedQueriesItemProps {
item: {
id: string
name: string
- description?: string
+ description?: string | null
owner_id: number
content: {
unchecked_sql: UntrustedLogSqlFragment
@@ -123,7 +123,7 @@ export const SavedQueriesItem = ({ item }: SavedQueriesItemProps) => {
<UpdateSavedQueryModal
header="Update saved query"
visible={showUpdateModal}
- initialValues={{ name: item.name, description: item.description }}
+ initialValues={{ name: item.name, description: item.description ?? undefined }}
onCancel={() => {
setShowUpdateModal(false)
}}
diff --git a/apps/studio/components/interfaces/Support/__tests__/SupportFormPage.test.tsx b/apps/studio/components/interfaces/Support/__tests__/SupportFormPage.test.tsx
index 751364b10fc..0c2f5cd265c 100644
--- a/apps/studio/components/interfaces/Support/__tests__/SupportFormPage.test.tsx
+++ b/apps/studio/components/interfaces/Support/__tests__/SupportFormPage.test.tsx
@@ -19,8 +19,8 @@ import { createMockProfileContext } from '@/tests/lib/profile-helpers'
// The project selector's infinite-scroll sentinel uses IntersectionObserver, which jsdom lacks
mockIntersectionObserver()
-type ProjectDetailResponse = components['schemas']['ProjectDetailResponse']
-type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse']
+type ProjectDetailResponse = components['schemas']['ProjectDetailResponse_Output']
+type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse_Output']
type OrganizationProjectsProject = OrganizationProjectsResponse['projects'][number]
type SendFeedbackResponse = components['schemas']['SendFeedbackResponse']
@@ -49,6 +49,7 @@ const toProjectDetailResponse = (project: {
status: 'ACTIVE_HEALTHY',
subscription_id: 'subscription-1',
updated_at: new Date().toISOString(),
+ connectionString: '',
})
const toOrganizationProject = (project: {
diff --git a/apps/studio/components/layouts/ProjectLayout/RestoringState.test.tsx b/apps/studio/components/layouts/ProjectLayout/RestoringState.test.tsx
index 7829cd41a33..95dd0f5c858 100644
--- a/apps/studio/components/layouts/ProjectLayout/RestoringState.test.tsx
+++ b/apps/studio/components/layouts/ProjectLayout/RestoringState.test.tsx
@@ -9,7 +9,7 @@ import { POLL_INTERVAL_MS, RestoringState } from './RestoringState'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type ProjectDetailResponse = components['schemas']['ProjectDetailResponse']
+type ProjectDetailResponse = components['schemas']['ProjectDetailResponse_Output']
type ProjectStatus = ProjectDetailResponse['status']
type DownloadableBackupsResponse = components['schemas']['DownloadableBackupsResponse']
diff --git a/apps/studio/components/layouts/SQLEditorLayout/SQLEditorNavV2/ShareSnippetModal.tsx b/apps/studio/components/layouts/SQLEditorLayout/SQLEditorNavV2/ShareSnippetModal.tsx
index f3cd44d3ef6..c060121ab1f 100644
--- a/apps/studio/components/layouts/SQLEditorLayout/SQLEditorNavV2/ShareSnippetModal.tsx
+++ b/apps/studio/components/layouts/SQLEditorLayout/SQLEditorNavV2/ShareSnippetModal.tsx
@@ -49,6 +49,7 @@ export const ShareSnippetModal = ({
projectRef,
payload: {
...snippet,
+ description: snippet.description ?? undefined,
visibility: 'project',
folder_id: null,
content: snippetContent,
diff --git a/apps/studio/components/layouts/SQLEditorLayout/SQLEditorNavV2/UnshareSnippetModal.tsx b/apps/studio/components/layouts/SQLEditorLayout/SQLEditorNavV2/UnshareSnippetModal.tsx
index ad35294d4c2..4aa01df1328 100644
--- a/apps/studio/components/layouts/SQLEditorLayout/SQLEditorNavV2/UnshareSnippetModal.tsx
+++ b/apps/studio/components/layouts/SQLEditorLayout/SQLEditorNavV2/UnshareSnippetModal.tsx
@@ -49,6 +49,7 @@ export const UnshareSnippetModal = ({
projectRef,
payload: {
...snippet,
+ description: snippet.description ?? undefined,
visibility: 'user',
folder_id: null,
content: snippetContent,
diff --git a/apps/studio/components/ui/AIAssistantPanel/AssistantNotebookPreview.test.tsx b/apps/studio/components/ui/AIAssistantPanel/AssistantNotebookPreview.test.tsx
index a132189be66..4b4a821ddf8 100644
--- a/apps/studio/components/ui/AIAssistantPanel/AssistantNotebookPreview.test.tsx
+++ b/apps/studio/components/ui/AIAssistantPanel/AssistantNotebookPreview.test.tsx
@@ -72,7 +72,7 @@ describe('AssistantNotebookPreview', () => {
method: 'get',
path: '/platform/projects/:ref/databases',
response: () =>
- HttpResponse.json<components['schemas']['DatabaseDetailResponse'][]>([
+ HttpResponse.json<components['schemas']['DatabaseDetailResponse_Output'][]>([
{
identifier: 'default',
region: 'us-east-1',
@@ -85,6 +85,8 @@ describe('AssistantNotebookPreview', () => {
inserted_at: '2026-01-01T00:00:00.000Z',
restUrl: 'https://default.supabase.co/rest/v1',
size: 't4g.micro',
+ connectionString: '',
+ connection_string_read_only: '',
},
{
identifier: 'default-replica-3',
@@ -98,6 +100,8 @@ describe('AssistantNotebookPreview', () => {
inserted_at: '2026-01-01T00:00:00.000Z',
restUrl: 'https://default-replica-3.supabase.co/rest/v1',
size: 't4g.micro',
+ connectionString: '',
+ connection_string_read_only: '',
},
]),
})
diff --git a/apps/studio/components/ui/AIAssistantPanel/NotebookProposalRenderer.test.tsx b/apps/studio/components/ui/AIAssistantPanel/NotebookProposalRenderer.test.tsx
index 7c0bf592dae..75ca96057e4 100644
--- a/apps/studio/components/ui/AIAssistantPanel/NotebookProposalRenderer.test.tsx
+++ b/apps/studio/components/ui/AIAssistantPanel/NotebookProposalRenderer.test.tsx
@@ -39,8 +39,8 @@ const mockContentItem = (row: ReturnType<typeof mockNotebookRow>) =>
method: 'get',
path: '/platform/projects/:ref/content/item/:id',
response: () =>
- HttpResponse.json<components['schemas']['GetUserContentByIdResponse']>(
- row as unknown as components['schemas']['GetUserContentByIdResponse']
+ HttpResponse.json<components['schemas']['GetUserContentByIdResponse_Output']>(
+ row as unknown as components['schemas']['GetUserContentByIdResponse_Output']
),
})
diff --git a/apps/studio/components/ui/AIAssistantPanel/NotebookRunRenderer.test.tsx b/apps/studio/components/ui/AIAssistantPanel/NotebookRunRenderer.test.tsx
index b6745c632b7..c42bba8f988 100644
--- a/apps/studio/components/ui/AIAssistantPanel/NotebookRunRenderer.test.tsx
+++ b/apps/studio/components/ui/AIAssistantPanel/NotebookRunRenderer.test.tsx
@@ -16,7 +16,7 @@ const mockNotebook = (updatedAt = UPDATED_AT) =>
method: 'get',
path: '/platform/projects/:ref/content/item/:id',
response: () =>
- HttpResponse.json<components['schemas']['GetUserContentByIdResponse']>({
+ HttpResponse.json<components['schemas']['GetUserContentByIdResponse_Output']>({
id: NOTEBOOK_ID,
type: 'notebook',
name: 'Signup funnel',
diff --git a/apps/studio/data/actions/action-detail-query.ts b/apps/studio/data/actions/action-detail-query.ts
index 5616bd7ba50..cdcf68113a3 100644
--- a/apps/studio/data/actions/action-detail-query.ts
+++ b/apps/studio/data/actions/action-detail-query.ts
@@ -10,7 +10,7 @@ type ActionRunVariables = {
runId?: string
}
-export type ActionRun = components['schemas']['ActionRunResponse'] & {
+export type ActionRun = components['schemas']['ActionRunResponse_Output'] & {
status?: 'SUCCESS' | 'FAILED' | 'RUNNING'
}
diff --git a/apps/studio/data/analytics/org-daily-stats-query.ts b/apps/studio/data/analytics/org-daily-stats-query.ts
index 4fc2ed8841b..4f02a01a5d9 100644
--- a/apps/studio/data/analytics/org-daily-stats-query.ts
+++ b/apps/studio/data/analytics/org-daily-stats-query.ts
@@ -124,7 +124,7 @@ export type OrgDailyStatsVariables = {
projectRef?: string
}
-export type OrgDailyUsageResponse = components['schemas']['OrgDailyUsageResponse']
+export type OrgDailyUsageResponse = components['schemas']['OrgDailyUsageResponse_Output']
export async function getOrgDailyStats(
{ orgSlug, startDate, endDate, projectRef }: OrgDailyStatsVariables,
diff --git a/apps/studio/data/aws-accounts/aws-accounts-query.ts b/apps/studio/data/aws-accounts/aws-accounts-query.ts
index ca378da61fd..29293d29793 100644
--- a/apps/studio/data/aws-accounts/aws-accounts-query.ts
+++ b/apps/studio/data/aws-accounts/aws-accounts-query.ts
@@ -13,7 +13,7 @@ type AWSAccountsVariables = {
// [Joshen] API types should be updated with these parameters, so remove once verified
export type AWSAccount =
- components['schemas']['GetPrivateLinkResponse']['private_link_associations'][number] & {
+ components['schemas']['GetPrivateLinkResponse_Output']['private_link_associations'][number] & {
database_type?: 'PRIMARY' | 'READ_REPLICA'
database_identifier?: string
resource_access_manager_resource_config_id?: string
diff --git a/apps/studio/data/branches/branches-query.ts b/apps/studio/data/branches/branches-query.ts
index 6659c11345a..40a573a31d0 100644
--- a/apps/studio/data/branches/branches-query.ts
+++ b/apps/studio/data/branches/branches-query.ts
@@ -10,7 +10,7 @@ export type BranchesVariables = {
projectRef?: string
}
-export type Branch = components['schemas']['BranchResponse']
+export type Branch = components['schemas']['BranchResponse_Output']
export async function getBranches({ projectRef }: BranchesVariables, signal?: AbortSignal) {
if (!projectRef) throw new Error('Project ref is required')
diff --git a/apps/studio/data/config/disk-attributes-query.ts b/apps/studio/data/config/disk-attributes-query.ts
index cd098620557..67d7f5503f2 100644
--- a/apps/studio/data/config/disk-attributes-query.ts
+++ b/apps/studio/data/config/disk-attributes-query.ts
@@ -12,7 +12,7 @@ export type DiskAttributesVariables = {
projectRef?: string
}
-export type DiskAttribute = components['schemas']['DiskResponse']
+export type DiskAttribute = components['schemas']['DiskResponse_Output']
export async function getDiskAttributes(
{ projectRef }: DiskAttributesVariables,
diff --git a/apps/studio/data/config/project-postgrest-config-query.ts b/apps/studio/data/config/project-postgrest-config-query.ts
index 3143826c613..e8ee4c18f02 100644
--- a/apps/studio/data/config/project-postgrest-config-query.ts
+++ b/apps/studio/data/config/project-postgrest-config-query.ts
@@ -21,7 +21,7 @@ export type ProjectPostgrestConfigVariables = {
projectRef?: string
}
-type PostgrestConfigResponse = components['schemas']['GetPostgrestConfigResponse'] & {
+type PostgrestConfigResponse = components['schemas']['GetPostgrestConfigResponse_Output'] & {
db_pool: number | null
}
diff --git a/apps/studio/data/config/project-settings-v2-query.ts b/apps/studio/data/config/project-settings-v2-query.ts
index 8c0f3c361c1..2172cad83ce 100644
--- a/apps/studio/data/config/project-settings-v2-query.ts
+++ b/apps/studio/data/config/project-settings-v2-query.ts
@@ -10,10 +10,10 @@ import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type ProjectSettingsVariables = { projectRef?: string }
// Manually add the protocol property to the response - specifically just for the local/CLI environment
-type ProjectAppConfig = components['schemas']['ProjectSettingsResponse']['app_config'] & {
+type ProjectAppConfig = components['schemas']['ProjectSettingsResponse_Output']['app_config'] & {
protocol?: string
}
-export type ProjectSettings = components['schemas']['ProjectSettingsResponse'] & {
+export type ProjectSettings = components['schemas']['ProjectSettingsResponse_Output'] & {
app_config?: ProjectAppConfig
}
diff --git a/apps/studio/data/config/project-storage-config-query.test.tsx b/apps/studio/data/config/project-storage-config-query.test.tsx
index b0bdc6469c0..cd5b72444d7 100644
--- a/apps/studio/data/config/project-storage-config-query.test.tsx
+++ b/apps/studio/data/config/project-storage-config-query.test.tsx
@@ -34,18 +34,18 @@ vi.mock('@/hooks/misc/useDeploymentMode', () => ({
const createStorageConfig = (vectorBucketsEnabled: boolean): ProjectStorageConfigData =>
({
- capabilities: { iceberg_catalog: false, list_v2: false },
- databasePoolMode: 'transaction',
+ capabilities: { iceberg_catalog: false, list_v2: false, object_versioning: false },
external: { upstreamTarget: 'main' },
features: {
icebergCatalog: { enabled: false, maxCatalogs: 0, maxNamespaces: 0, maxTables: 0 },
imageTransformation: { enabled: false },
s3Protocol: { enabled: false },
+ purgeCache: { enabled: false },
vectorBuckets: { enabled: vectorBucketsEnabled, maxBuckets: 0, maxIndexes: 0 },
},
fileSizeLimit: 0,
migrationVersion: 'v1',
- }) as ProjectStorageConfigData
+ }) as const
const deploymentMode = (overrides: Partial<DeploymentMode>): DeploymentMode => ({
isPlatform: false,
diff --git a/apps/studio/data/config/project-storage-config-query.ts b/apps/studio/data/config/project-storage-config-query.ts
index 987a0bbe364..6feab9f74ff 100644
--- a/apps/studio/data/config/project-storage-config-query.ts
+++ b/apps/studio/data/config/project-storage-config-query.ts
@@ -11,7 +11,7 @@ export type ProjectStorageConfigVariables = {
projectRef?: string
}
-export type ProjectStorageConfigResponse = components['schemas']['StorageConfigResponse']
+export type ProjectStorageConfigResponse = components['schemas']['StorageConfigResponse_Output']
export async function getProjectStorageConfig(
{ projectRef }: ProjectStorageConfigVariables,
diff --git a/apps/studio/data/config/project-upgrade-eligibility-query.ts b/apps/studio/data/config/project-upgrade-eligibility-query.ts
index 2f922756647..f827a530e5e 100644
--- a/apps/studio/data/config/project-upgrade-eligibility-query.ts
+++ b/apps/studio/data/config/project-upgrade-eligibility-query.ts
@@ -11,7 +11,7 @@ import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type ProjectUpgradeTargetVersion = { postgres_version: string; release_channel: string }
export type ProjectUpgradeEligibilityVariables = { projectRef?: string }
export type ProjectUpgradeEligibilityResponse =
- components['schemas']['ProjectUpgradeEligibilityResponse']
+ components['schemas']['ProjectUpgradeEligibilityResponse_Output']
export type ProjectUpgradeEligibilityValidationError =
ProjectUpgradeEligibilityResponse['validation_errors'][number]
export type ProjectUpgradeEligibilityWarning = ProjectUpgradeEligibilityResponse['warnings'][number]
diff --git a/apps/studio/data/content/content-id-query.ts b/apps/studio/data/content/content-id-query.ts
index 00ca2213fd4..ec748f895d9 100644
--- a/apps/studio/data/content/content-id-query.ts
+++ b/apps/studio/data/content/content-id-query.ts
@@ -9,7 +9,7 @@ import { get, handleError } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type GetUserContentByIdResponse = Omit<
- components['schemas']['GetUserContentByIdResponse'],
+ components['schemas']['GetUserContentByIdResponse_Output'],
'content'
> & {
content: Content['content']
diff --git a/apps/studio/data/content/content-query.ts b/apps/studio/data/content/content-query.ts
index 385a15073bc..7a0841df134 100644
--- a/apps/studio/data/content/content-query.ts
+++ b/apps/studio/data/content/content-query.ts
@@ -12,7 +12,7 @@ import type {
UseCustomQueryOptions,
} from '@/types'
-export type ContentBase = components['schemas']['GetUserContentResponse']['data'][number]
+export type ContentBase = components['schemas']['GetUserContentResponse_Output']['data'][number]
export type Content = Omit<ContentBase, 'content' | 'type'> &
(
diff --git a/apps/studio/data/content/notebooks/notebook-query.test.ts b/apps/studio/data/content/notebooks/notebook-query.test.ts
index 46ccd458eda..7e82b753df2 100644
--- a/apps/studio/data/content/notebooks/notebook-query.test.ts
+++ b/apps/studio/data/content/notebooks/notebook-query.test.ts
@@ -7,7 +7,7 @@ import { addAPIMock } from '@/tests/lib/msw'
const NOTEBOOK_ID = 'd3aadd77-7c3c-4de7-aa5c-5aa8ac270b44'
-const NOTEBOOK_ROW: components['schemas']['GetUserContentByIdResponse'] = {
+const NOTEBOOK_ROW: components['schemas']['GetUserContentByIdResponse_Output'] = {
id: NOTEBOOK_ID,
type: 'notebook',
name: 'Signup funnel',
@@ -31,7 +31,7 @@ describe('getNotebook', () => {
method: 'get',
path: '/platform/projects/:ref/content/item/:id',
response: () =>
- HttpResponse.json<components['schemas']['GetUserContentByIdResponse']>(NOTEBOOK_ROW),
+ HttpResponse.json<components['schemas']['GetUserContentByIdResponse_Output']>(NOTEBOOK_ROW),
})
const result = await getNotebook({ projectRef: 'default', id: NOTEBOOK_ID })
@@ -45,7 +45,7 @@ describe('getNotebook', () => {
method: 'get',
path: '/platform/projects/:ref/content/item/:id',
response: () =>
- HttpResponse.json<components['schemas']['GetUserContentByIdResponse']>({
+ HttpResponse.json<components['schemas']['GetUserContentByIdResponse_Output']>({
id: NOTEBOOK_ID,
type: 'report',
name: 'A report',
diff --git a/apps/studio/data/content/notebooks/notebooks-infinite-query.test.ts b/apps/studio/data/content/notebooks/notebooks-infinite-query.test.ts
index e256ce7e309..5291cca30fa 100644
--- a/apps/studio/data/content/notebooks/notebooks-infinite-query.test.ts
+++ b/apps/studio/data/content/notebooks/notebooks-infinite-query.test.ts
@@ -7,7 +7,7 @@ import type { components } from '@/data/api'
import { customRenderHook } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-const NOTEBOOK_ROW: components['schemas']['GetUserContentResponse']['data'][number] = {
+const NOTEBOOK_ROW: components['schemas']['GetUserContentResponse_Output']['data'][number] = {
id: 'd3aadd77-7c3c-4de7-aa5c-5aa8ac270b44',
type: 'notebook',
name: 'Signup funnel',
@@ -33,7 +33,7 @@ describe('useNotebooksInfiniteQuery', () => {
method: 'get',
path: '/platform/projects/:ref/content',
response: () =>
- HttpResponse.json<components['schemas']['GetUserContentResponse']>({
+ HttpResponse.json<components['schemas']['GetUserContentResponse_Output']>({
cursor: undefined,
data: [NOTEBOOK_ROW],
}),
diff --git a/apps/studio/data/content/sql-folders-query.ts b/apps/studio/data/content/sql-folders-query.ts
index 3027722faec..fa6f3dee01e 100644
--- a/apps/studio/data/content/sql-folders-query.ts
+++ b/apps/studio/data/content/sql-folders-query.ts
@@ -11,11 +11,12 @@ import type {
UseCustomInfiniteQueryOptions,
} from '@/types'
-export type SnippetFolderResponse = components['schemas']['GetUserContentFolderResponse']['data']
+export type SnippetFolderResponse =
+ components['schemas']['GetUserContentFolderResponse_Output']['data']
export type SnippetFolder =
- components['schemas']['GetUserContentFolderResponse']['data']['folders'][number]
+ components['schemas']['GetUserContentFolderResponse_Output']['data']['folders'][number]
export type Snippet =
- components['schemas']['GetUserContentFolderResponse']['data']['contents'][number]
+ components['schemas']['GetUserContentFolderResponse_Output']['data']['contents'][number]
// The SQL editor's loaded-snippet type. Discriminated on `type` so database SQL
// (`SqlSnippets.Content`, Postgres brand) and logs SQL (`LogSqlSnippets.Content`,
diff --git a/apps/studio/data/database-extensions/database-extensions-query.ts b/apps/studio/data/database-extensions/database-extensions-query.ts
index 4de92df2958..c0126ad0e43 100644
--- a/apps/studio/data/database-extensions/database-extensions-query.ts
+++ b/apps/studio/data/database-extensions/database-extensions-query.ts
@@ -9,7 +9,7 @@ import { PROJECT_STATUS } from '@/lib/constants'
import { EMPTY_ARR } from '@/lib/void'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
-export type DatabaseExtension = components['schemas']['PostgresExtension'] & {
+export type DatabaseExtension = components['schemas']['PostgresExtension_Output'] & {
default_version_schema: string | null
}
diff --git a/apps/studio/data/edge-functions/edge-function-query.ts b/apps/studio/data/edge-functions/edge-function-query.ts
index 0eed96ba3ad..16452c3aa8f 100644
--- a/apps/studio/data/edge-functions/edge-function-query.ts
+++ b/apps/studio/data/edge-functions/edge-function-query.ts
@@ -10,7 +10,7 @@ export type EdgeFunctionVariables = {
slug?: string
}
-export type EdgeFunction = components['schemas']['FunctionSlugResponse']
+export type EdgeFunction = components['schemas']['FunctionSlugResponse_Output']
export async function getEdgeFunction(
{ projectRef, slug }: EdgeFunctionVariables,
diff --git a/apps/studio/data/edge-functions/edge-functions-query.ts b/apps/studio/data/edge-functions/edge-functions-query.ts
index 0faa314e534..1185bb4adc2 100644
--- a/apps/studio/data/edge-functions/edge-functions-query.ts
+++ b/apps/studio/data/edge-functions/edge-functions-query.ts
@@ -7,7 +7,7 @@ import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type EdgeFunctionsVariables = { projectRef?: string }
-export type EdgeFunctionsResponse = components['schemas']['FunctionResponse']
+export type EdgeFunctionsResponse = components['schemas']['FunctionResponse_Output']
export async function getEdgeFunctions(
{ projectRef }: EdgeFunctionsVariables,
diff --git a/apps/studio/data/entitlements/entitlements-query.ts b/apps/studio/data/entitlements/entitlements-query.ts
index 697fdcdbb46..2cd48625b41 100644
--- a/apps/studio/data/entitlements/entitlements-query.ts
+++ b/apps/studio/data/entitlements/entitlements-query.ts
@@ -8,15 +8,16 @@ import { UseCustomQueryOptions } from '@/types'
import { ResponseError } from '@/types/base'
export type FeatureKey =
- components['schemas']['ListEntitlementsResponse']['entitlements'][number]['feature']['key']
+ components['schemas']['ListEntitlementsResponse_Output']['entitlements'][number]['feature']['key']
export type EntitlementsVariables = {
slug: string
}
export type EntitlementConfig =
- components['schemas']['ListEntitlementsResponse']['entitlements'][0]['config']
-export type Entitlement = components['schemas']['ListEntitlementsResponse']['entitlements'][0]
+ components['schemas']['ListEntitlementsResponse_Output']['entitlements'][0]['config']
+export type Entitlement =
+ components['schemas']['ListEntitlementsResponse_Output']['entitlements'][0]
export type EntitlementType = Entitlement['type']
export async function getEntitlements(
diff --git a/apps/studio/data/invoices/invoices-overdue-query.ts b/apps/studio/data/invoices/invoices-overdue-query.ts
index f1619de8edc..c28af3132b3 100644
--- a/apps/studio/data/invoices/invoices-overdue-query.ts
+++ b/apps/studio/data/invoices/invoices-overdue-query.ts
@@ -7,7 +7,7 @@ import { get, handleError } from '@/data/fetchers'
import { IS_PLATFORM } from '@/lib/constants'
import { UseCustomQueryOptions } from '@/types'
-export type OverdueInvoicesResponse = components['schemas']['OverdueInvoiceCount']
+export type OverdueInvoicesResponse = components['schemas']['OverdueInvoiceCount_Output']
export async function getOverdueInvoices(signal?: AbortSignal) {
const { data, error } = await get('/platform/stripe/invoices/overdue', {
diff --git a/apps/studio/data/invoices/org-invoice-upcoming-query.ts b/apps/studio/data/invoices/org-invoice-upcoming-query.ts
index 35742464ce2..fa35f6b7a9b 100644
--- a/apps/studio/data/invoices/org-invoice-upcoming-query.ts
+++ b/apps/studio/data/invoices/org-invoice-upcoming-query.ts
@@ -9,7 +9,7 @@ export type UpcomingInvoiceVariables = {
orgSlug?: string
}
-export type UpcomingInvoiceResponse = components['schemas']['UpcomingInvoice']
+export type UpcomingInvoiceResponse = components['schemas']['UpcomingInvoice_Output']
export async function getUpcomingInvoice(
{ orgSlug }: UpcomingInvoiceVariables,
diff --git a/apps/studio/data/jwt-signing-keys/jwt-signing-keys-query.ts b/apps/studio/data/jwt-signing-keys/jwt-signing-keys-query.ts
index 2663db796bb..1862297ec2c 100644
--- a/apps/studio/data/jwt-signing-keys/jwt-signing-keys-query.ts
+++ b/apps/studio/data/jwt-signing-keys/jwt-signing-keys-query.ts
@@ -5,9 +5,9 @@ import { jwtSigningKeysKeys } from './keys'
import { get, handleError } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
-export type JWTSigningKey = components['schemas']['SigningKeyResponse']
+export type JWTSigningKey = components['schemas']['SigningKeyResponse_Output']
-export type JWTAlgorithm = components['schemas']['SigningKeyResponse']['algorithm']
+export type JWTAlgorithm = components['schemas']['SigningKeyResponse_Output']['algorithm']
interface JWTSigningKeysVariables {
projectRef?: string
diff --git a/apps/studio/data/lint/lint-query.ts b/apps/studio/data/lint/lint-query.ts
index 44c7db0c0f6..4853e0c1641 100644
--- a/apps/studio/data/lint/lint-query.ts
+++ b/apps/studio/data/lint/lint-query.ts
@@ -11,7 +11,7 @@ import type { ResponseError, UseCustomQueryOptions } from '@/types'
type ProjectLintsVariables = {
projectRef?: string
}
-type ProjectLintResponse = components['schemas']['GetProjectLintsResponse']
+type ProjectLintResponse = components['schemas']['GetProjectLintsResponse_Output']
export type Lint = ProjectLintResponse[0]
export type LINT_TYPES = ProjectLintResponse[0]['name']
diff --git a/apps/studio/data/oauth-secrets/client-secrets-query.ts b/apps/studio/data/oauth-secrets/client-secrets-query.ts
index a957883840b..d5072e0fb67 100644
--- a/apps/studio/data/oauth-secrets/client-secrets-query.ts
+++ b/apps/studio/data/oauth-secrets/client-secrets-query.ts
@@ -6,11 +6,11 @@ import { get, handleError } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type Secret =
- components['schemas']['ListOAuthAppClientSecretsResponse']['client_secrets'][0] & {
- client_secret?: components['schemas']['CreateOAuthAppClientSecretResponse']['client_secret']
+ components['schemas']['ListOAuthAppClientSecretsResponse_Output']['client_secrets'][0] & {
+ client_secret?: components['schemas']['CreateOAuthAppClientSecretResponse_Output']['client_secret']
}
-export type CreatedSecret = components['schemas']['CreateOAuthAppClientSecretResponse']
+export type CreatedSecret = components['schemas']['CreateOAuthAppClientSecretResponse_Output']
export interface SecretRowProps {
secret: Secret
diff --git a/apps/studio/data/oauth-server-apps/oauth-server-apps-query.ts b/apps/studio/data/oauth-server-apps/oauth-server-apps-query.ts
index f062fb3cf7c..1a1c1f273dc 100644
--- a/apps/studio/data/oauth-server-apps/oauth-server-apps-query.ts
+++ b/apps/studio/data/oauth-server-apps/oauth-server-apps-query.ts
@@ -15,7 +15,7 @@ export type OAuthServerAppsVariables = {
const APPS_PER_PAGE = 100
-export type OAuthApp = components['schemas']['OAuthAppResponse']
+export type OAuthApp = components['schemas']['OAuthAppResponse_Output']
export async function getOAuthServerApps({
projectRef,
diff --git a/apps/studio/data/oauth/oauth-app-create-mutation.ts b/apps/studio/data/oauth/oauth-app-create-mutation.ts
index e3324b65421..cef583a7a32 100644
--- a/apps/studio/data/oauth/oauth-app-create-mutation.ts
+++ b/apps/studio/data/oauth/oauth-app-create-mutation.ts
@@ -12,11 +12,11 @@ export type OAuthAppCreateVariables = {
name: string
website: string
icon?: string
- scopes?: OAuthScope[]
+ scopes: OAuthScope[]
redirect_uris: string[]
}
-export type OAuthAppCreateResponse = components['schemas']['CreateOAuthAppResponse']
+export type OAuthAppCreateResponse = components['schemas']['CreateOAuthAppResponse_Output']
export async function createOAuthApp({
slug,
diff --git a/apps/studio/data/oauth/oauth-app-update-mutation.ts b/apps/studio/data/oauth/oauth-app-update-mutation.ts
index 9341f8482d1..bf314afaa20 100644
--- a/apps/studio/data/oauth/oauth-app-update-mutation.ts
+++ b/apps/studio/data/oauth/oauth-app-update-mutation.ts
@@ -12,7 +12,7 @@ export type OAuthAppUpdateVariables = {
name: string
website: string
icon?: string
- scopes?: OAuthScope[]
+ scopes: OAuthScope[]
redirect_uris: string[]
}
diff --git a/apps/studio/data/oauth/oauth-apps-query.ts b/apps/studio/data/oauth/oauth-apps-query.ts
index cfb491bc102..cd809c84faf 100644
--- a/apps/studio/data/oauth/oauth-apps-query.ts
+++ b/apps/studio/data/oauth/oauth-apps-query.ts
@@ -9,7 +9,7 @@ export type OAuthAppsVariables = {
slug?: string
}
-export type OAuthApp = components['schemas']['OAuthAppResponse']
+export type OAuthApp = components['schemas']['OAuthAppResponse_Output']
export async function getOAuthApps({ slug }: OAuthAppsVariables) {
if (!slug) throw new Error('Organization slug is required')
diff --git a/apps/studio/data/organization-members/organization-invitation-token-query.ts b/apps/studio/data/organization-members/organization-invitation-token-query.ts
index d61011de3cc..de938669132 100644
--- a/apps/studio/data/organization-members/organization-invitation-token-query.ts
+++ b/apps/studio/data/organization-members/organization-invitation-token-query.ts
@@ -7,7 +7,7 @@ import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type OrganizationInviteTokenVariables = { slug?: string; token?: string }
-export type OrganizationInviteByToken = components['schemas']['InvitationByTokenResponse']
+export type OrganizationInviteByToken = components['schemas']['InvitationByTokenResponse_Output']
export async function getOrganizationInviteByToken(
{ slug, token }: OrganizationInviteTokenVariables,
diff --git a/apps/studio/data/organization-members/organization-roles-query.ts b/apps/studio/data/organization-members/organization-roles-query.ts
index da13eed6d78..e05583e9f7e 100644
--- a/apps/studio/data/organization-members/organization-roles-query.ts
+++ b/apps/studio/data/organization-members/organization-roles-query.ts
@@ -7,9 +7,9 @@ import type { ResponseError, UseCustomQueryOptions } from '@/types'
export const FIXED_ROLE_ORDER = ['Owner', 'Administrator', 'Developer', 'Read-only']
export type OrganizationRolesVariables = { slug?: string }
-export type OrganizationRolesResponse = components['schemas']['OrganizationRoleResponse']
+export type OrganizationRolesResponse = components['schemas']['OrganizationRoleResponse_Output']
export type OrganizationRole =
- components['schemas']['OrganizationRoleResponse']['org_scoped_roles'][0]
+ components['schemas']['OrganizationRoleResponse_Output']['org_scoped_roles'][0]
export async function getOrganizationRoles(
{ slug }: OrganizationRolesVariables,
diff --git a/apps/studio/data/organizations/free-project-limit-check-query.ts b/apps/studio/data/organizations/free-project-limit-check-query.ts
index b1e58bc9458..1de6a50afa8 100644
--- a/apps/studio/data/organizations/free-project-limit-check-query.ts
+++ b/apps/studio/data/organizations/free-project-limit-check-query.ts
@@ -5,7 +5,7 @@ import { organizationKeys } from './keys'
import { get, handleError } from '@/data/fetchers'
import { UseCustomQueryOptions } from '@/types'
-export type MemberWithFreeProjectLimit = components['schemas']['MemberWithFreeProjectLimit']
+export type MemberWithFreeProjectLimit = components['schemas']['MemberWithFreeProjectLimit_Output']
export type FreeProjectLimitCheckVariables = {
slug?: string
diff --git a/apps/studio/data/organizations/organization-members-query.ts b/apps/studio/data/organizations/organization-members-query.ts
index f31414b0385..93a85873525 100644
--- a/apps/studio/data/organizations/organization-members-query.ts
+++ b/apps/studio/data/organizations/organization-members-query.ts
@@ -9,7 +9,7 @@ export type OrganizationMembersVariables = {
slug?: string
}
-export type Member = components['schemas']['Member']
+export type Member = components['schemas']['Member_Output']
export interface OrganizationMember extends Member {
invited_at?: string
invited_id?: number
diff --git a/apps/studio/data/organizations/organization-payment-methods-query.ts b/apps/studio/data/organizations/organization-payment-methods-query.ts
index e6a3b7b68fd..420f361f948 100644
--- a/apps/studio/data/organizations/organization-payment-methods-query.ts
+++ b/apps/studio/data/organizations/organization-payment-methods-query.ts
@@ -8,7 +8,7 @@ import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type OrganizationPaymentMethodsVariables = { slug?: string }
-export type OrganizationPaymentMethod = components['schemas']['PaymentsResponse']['data'][0]
+export type OrganizationPaymentMethod = components['schemas']['PaymentsResponse_Output']['data'][0]
export async function getOrganizationPaymentMethods(
{ slug }: OrganizationPaymentMethodsVariables,
diff --git a/apps/studio/data/organizations/organization-query.ts b/apps/studio/data/organizations/organization-query.ts
index 272a50acd6c..b649c610905 100644
--- a/apps/studio/data/organizations/organization-query.ts
+++ b/apps/studio/data/organizations/organization-query.ts
@@ -7,7 +7,7 @@ import { get, handleError } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type OrganizationVariables = { slug?: string }
-export type OrganizationDetail = components['schemas']['OrganizationSlugResponse']
+export type OrganizationDetail = components['schemas']['OrganizationSlugResponse_Output']
export type OrganizationPlanID = OrganizationDetail['plan']['id']
export function castOrganizationSlugResponseToOrganization(org: OrganizationDetail) {
diff --git a/apps/studio/data/organizations/organization-tax-id-query.ts b/apps/studio/data/organizations/organization-tax-id-query.ts
index fa8c22cab6b..21d3c9a1080 100644
--- a/apps/studio/data/organizations/organization-tax-id-query.ts
+++ b/apps/studio/data/organizations/organization-tax-id-query.ts
@@ -23,7 +23,7 @@ export async function getOrganizationTaxId(
})
if (error) throw handleError(error)
- return (data as components['schemas']['TaxIdResponse']).tax_id
+ return (data as components['schemas']['TaxIdResponse_Output']).tax_id
}
export type OrganizationTaxIdData = Awaited<ReturnType<typeof getOrganizationTaxId>>
diff --git a/apps/studio/data/organizations/organization-update-mutation.ts b/apps/studio/data/organizations/organization-update-mutation.ts
index 4812facaca7..43a3d7948ec 100644
--- a/apps/studio/data/organizations/organization-update-mutation.ts
+++ b/apps/studio/data/organizations/organization-update-mutation.ts
@@ -57,7 +57,7 @@ export const useOrganizationUpdateMutation = ({
queryKey: organizationKeys.list(),
exact: true,
},
- (prev: components['schemas']['OrganizationResponse'][] | undefined) => {
+ (prev: components['schemas']['OrganizationResponse_Output'][] | undefined) => {
if (!prev) return prev
return prev.map((org) => {
@@ -78,7 +78,7 @@ export const useOrganizationUpdateMutation = ({
queryKey: organizationKeys.customerProfile(data.slug),
exact: true,
},
- (prev: components['schemas']['CustomerResponse'] | undefined) => {
+ (prev: components['schemas']['CustomerResponse_Output'] | undefined) => {
if (!prev) return prev
return {
...prev,
@@ -92,7 +92,7 @@ export const useOrganizationUpdateMutation = ({
queryKey: organizationKeys.detail(data.slug),
exact: true,
},
- (prev: components['schemas']['OrganizationSlugResponse'] | undefined) => {
+ (prev: components['schemas']['OrganizationSlugResponse_Output'] | undefined) => {
if (!prev) return prev
return {
...prev,
diff --git a/apps/studio/data/organizations/organizations-query.ts b/apps/studio/data/organizations/organizations-query.ts
index 47fb771ae2e..7ebae53b8cb 100644
--- a/apps/studio/data/organizations/organizations-query.ts
+++ b/apps/studio/data/organizations/organizations-query.ts
@@ -7,7 +7,7 @@ import { get, handleError } from '@/data/fetchers'
import { useProfile } from '@/lib/profile'
import type { Organization, ResponseError, UseCustomQueryOptions } from '@/types'
-export type OrganizationBase = components['schemas']['OrganizationResponse']
+export type OrganizationBase = components['schemas']['OrganizationResponse_Output']
export function castOrganizationResponseToOrganization(org: OrganizationBase): Organization {
return {
diff --git a/apps/studio/data/organizations/types.ts b/apps/studio/data/organizations/types.ts
index f9e608fbf3f..159ea269183 100644
--- a/apps/studio/data/organizations/types.ts
+++ b/apps/studio/data/organizations/types.ts
@@ -1,4 +1,6 @@
import type { components } from 'api-types'
-export type CustomerAddress = NonNullable<components['schemas']['CustomerResponse']['address']>
-export type CustomerTaxId = NonNullable<components['schemas']['TaxIdResponse']['tax_id']>
+export type CustomerAddress = NonNullable<
+ components['schemas']['CustomerResponse_Output']['address']
+>
+export type CustomerTaxId = NonNullable<components['schemas']['TaxIdResponse_Output']['tax_id']>
diff --git a/apps/studio/data/partners/stripe-projects-query.ts b/apps/studio/data/partners/stripe-projects-query.ts
index ce5d6494c0a..17e8a9b2e5e 100644
--- a/apps/studio/data/partners/stripe-projects-query.ts
+++ b/apps/studio/data/partners/stripe-projects-query.ts
@@ -8,7 +8,7 @@ type GetAccountRequestVariables = {
arId?: string
}
-export type AccountRequestDetails = components['schemas']['AccountRequestDetailsDto']
+export type AccountRequestDetails = components['schemas']['AccountRequestDetailsDto_Output']
async function getAccountRequest({ arId }: GetAccountRequestVariables, signal?: AbortSignal) {
if (!arId) throw new Error('Account request ID is required')
diff --git a/apps/studio/data/platform-apps/platform-app-installations-query.ts b/apps/studio/data/platform-apps/platform-app-installations-query.ts
index 474674eb3d2..4182aa2bd6a 100644
--- a/apps/studio/data/platform-apps/platform-app-installations-query.ts
+++ b/apps/studio/data/platform-apps/platform-app-installations-query.ts
@@ -6,7 +6,7 @@ import { get, handleError } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type PlatformAppInstallation =
- components['schemas']['ListPlatformAppInstallationsResponse']['installations'][number]
+ components['schemas']['ListPlatformAppInstallationsResponse_Output']['installations'][number]
export async function getPlatformAppInstallations(
{ slug }: { slug?: string },
diff --git a/apps/studio/data/platform-apps/platform-app-query.ts b/apps/studio/data/platform-apps/platform-app-query.ts
index 7a226300070..1c612bb5b30 100644
--- a/apps/studio/data/platform-apps/platform-app-query.ts
+++ b/apps/studio/data/platform-apps/platform-app-query.ts
@@ -11,7 +11,7 @@ export type PlatformAppVariables = {
id?: string
}
-export type PlatformAppDetail = components['schemas']['GetPlatformAppResponse']
+export type PlatformAppDetail = components['schemas']['GetPlatformAppResponse_Output']
export async function getPlatformApp({ slug, id }: PlatformAppVariables, signal?: AbortSignal) {
if (!slug) throw new Error('slug is required')
diff --git a/apps/studio/data/platform-apps/platform-apps-query.ts b/apps/studio/data/platform-apps/platform-apps-query.ts
index 5beb64e8c47..07c51d97471 100644
--- a/apps/studio/data/platform-apps/platform-apps-query.ts
+++ b/apps/studio/data/platform-apps/platform-apps-query.ts
@@ -9,7 +9,7 @@ export type PlatformAppsVariables = {
slug?: string
}
-export type PlatformApp = components['schemas']['ListPlatformAppsResponse']['apps'][number]
+export type PlatformApp = components['schemas']['ListPlatformAppsResponse_Output']['apps'][number]
export async function getPlatformApps({ slug }: PlatformAppsVariables, signal?: AbortSignal) {
if (!slug) throw new Error('slug is required')
diff --git a/apps/studio/data/projects/org-projects-infinite-query.ts b/apps/studio/data/projects/org-projects-infinite-query.ts
index 0dc957f7ba3..5fbcd870f3e 100644
--- a/apps/studio/data/projects/org-projects-infinite-query.ts
+++ b/apps/studio/data/projects/org-projects-infinite-query.ts
@@ -21,7 +21,7 @@ interface GetOrgProjectsInfiniteVariables {
statuses?: string[]
}
-export type OrgProjectsResponse = components['schemas']['OrganizationProjectsResponse']
+export type OrgProjectsResponse = components['schemas']['OrganizationProjectsResponse_Output']
export type OrgProject = OrgProjectsResponse['projects'][number]
export async function getOrganizationProjects(
diff --git a/apps/studio/data/projects/project-detail-query.ts b/apps/studio/data/projects/project-detail-query.ts
index 2bb05a43e69..82d3a64de7e 100644
--- a/apps/studio/data/projects/project-detail-query.ts
+++ b/apps/studio/data/projects/project-detail-query.ts
@@ -11,7 +11,7 @@ import { get, handleError, isValidConnString, post } from '@/data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
type ProjectDetailVariables = { ref?: string; skipWake?: boolean }
-export type ProjectDetail = components['schemas']['ProjectDetailResponse']
+export type ProjectDetail = components['schemas']['ProjectDetailResponse_Output']
export interface Project extends Omit<ProjectDetail, 'status'> {
/**
* postgrestStatus is available on client side only.
diff --git a/apps/studio/data/projects/project-pause-status-override.ts b/apps/studio/data/projects/project-pause-status-override.ts
index 9e617afe208..64335f3b2f6 100644
--- a/apps/studio/data/projects/project-pause-status-override.ts
+++ b/apps/studio/data/projects/project-pause-status-override.ts
@@ -1,6 +1,6 @@
import type { components } from '@/data/api'
-type PauseStatusResponse = components['schemas']['PauseStatusResponse']
+type PauseStatusResponse = components['schemas']['PauseStatusResponse_Output']
export type PauseStateOverride = 'restorable' | 'restore-disabled'
diff --git a/apps/studio/data/projects/project-status-override.ts b/apps/studio/data/projects/project-status-override.ts
index ca5d49083ac..22b8a2a83fa 100644
--- a/apps/studio/data/projects/project-status-override.ts
+++ b/apps/studio/data/projects/project-status-override.ts
@@ -1,6 +1,6 @@
import type { components } from '@/data/api'
-type ProjectStatus = components['schemas']['ProjectDetailResponse']['status']
+type ProjectStatus = components['schemas']['ProjectDetailResponse_Output']['status']
const STORAGE_KEY = 'devToolbar:projectStatusOverrides'
diff --git a/apps/studio/data/projects/projects-infinite-query.ts b/apps/studio/data/projects/projects-infinite-query.ts
index 0e3b4dfcaf5..3e51f68fdf8 100644
--- a/apps/studio/data/projects/projects-infinite-query.ts
+++ b/apps/studio/data/projects/projects-infinite-query.ts
@@ -15,7 +15,7 @@ interface GetProjectsInfiniteVariables {
page?: number
}
-export type ProjectInfiniteResponse = components['schemas']['ListProjectsPaginatedResponse']
+export type ProjectInfiniteResponse = components['schemas']['ListProjectsPaginatedResponse_Output']
export type ProjectInfoInfinite = ProjectInfiniteResponse['projects'][number]
async function getProjects(
@@ -39,7 +39,7 @@ async function getProjects(
})
if (error) handleError(error)
- return data as unknown as components['schemas']['ListProjectsPaginatedResponse']
+ return data as unknown as components['schemas']['ListProjectsPaginatedResponse_Output']
}
export type ProjectsInfiniteData = Awaited<ReturnType<typeof getProjects>>
diff --git a/apps/studio/data/read-replicas/load-balancers-query.ts b/apps/studio/data/read-replicas/load-balancers-query.ts
index e96fcaed7f9..038643db6ef 100644
--- a/apps/studio/data/read-replicas/load-balancers-query.ts
+++ b/apps/studio/data/read-replicas/load-balancers-query.ts
@@ -10,7 +10,7 @@ export type LoadBalancersVariables = {
projectRef?: string
}
-export type LoadBalancer = components['schemas']['LoadBalancerDetailResponse']
+export type LoadBalancer = components['schemas']['LoadBalancerDetailResponse_Output']
export async function getLoadBalancers(
{ projectRef }: LoadBalancersVariables,
diff --git a/apps/studio/data/read-replicas/replicas-query.ts b/apps/studio/data/read-replicas/replicas-query.ts
index 3a9b2a1771f..f9e951f4158 100644
--- a/apps/studio/data/read-replicas/replicas-query.ts
+++ b/apps/studio/data/read-replicas/replicas-query.ts
@@ -31,7 +31,7 @@ export type ReadReplicasVariables = {
projectRef?: string
}
-export type Database = components['schemas']['DatabaseDetailResponse']
+export type Database = components['schemas']['DatabaseDetailResponse_Output']
export async function getReadReplicas(
{ projectRef }: ReadReplicasVariables,
diff --git a/apps/studio/data/read-replicas/replicas-status-query.ts b/apps/studio/data/read-replicas/replicas-status-query.ts
index 2db76aadc5f..1c88cba6d3c 100644
--- a/apps/studio/data/read-replicas/replicas-status-query.ts
+++ b/apps/studio/data/read-replicas/replicas-status-query.ts
@@ -13,7 +13,7 @@ export enum ReplicaInitializationStatus {
'Failed' = 'failed',
}
-export type DatabaseStatus = components['schemas']['DatabaseStatusResponse']
+export type DatabaseStatus = components['schemas']['DatabaseStatusResponse_Output']
export type DatabaseInitEstimations = {
baseBackupDownloadEstimateSeconds: number
walArchiveReplayEstimateSeconds: number
diff --git a/apps/studio/data/realtime/realtime-config-query.ts b/apps/studio/data/realtime/realtime-config-query.ts
index 2dcc1e7c2e0..d9f2fa52915 100644
--- a/apps/studio/data/realtime/realtime-config-query.ts
+++ b/apps/studio/data/realtime/realtime-config-query.ts
@@ -6,7 +6,7 @@ import { get, handleError } from '@/data/fetchers'
import { IS_PLATFORM } from '@/lib/constants'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
-type RealtimeConfigResponse = components['schemas']['RealtimeConfigResponse']
+type RealtimeConfigResponse = components['schemas']['RealtimeConfigResponse_Output']
export type RealtimeConfigurationVariables = {
projectRef?: string
diff --git a/apps/studio/data/replication/validate-destination-mutation.ts b/apps/studio/data/replication/validate-destination-mutation.ts
index 0d1fc23d5c9..98045ef4257 100644
--- a/apps/studio/data/replication/validate-destination-mutation.ts
+++ b/apps/studio/data/replication/validate-destination-mutation.ts
@@ -19,7 +19,7 @@ type ValidateDestinationParams = {
tableSyncCopy?: TableSyncCopyConfig
}
-type ValidateDestinationResponse = components['schemas']['ValidateDestinationResponse']
+type ValidateDestinationResponse = components['schemas']['ValidateDestinationResponse_Output']
export type ValidationFailure = ValidateDestinationResponse['validation_failures'][number]
async function validateDestination(
diff --git a/apps/studio/data/replication/validate-pipeline-mutation.ts b/apps/studio/data/replication/validate-pipeline-mutation.ts
index 92019fe2484..09260145fb3 100644
--- a/apps/studio/data/replication/validate-pipeline-mutation.ts
+++ b/apps/studio/data/replication/validate-pipeline-mutation.ts
@@ -16,7 +16,7 @@ type ValidatePipelineParams = {
invalidatedSlotBehavior?: 'error' | 'recreate'
tableSyncCopy: TableSyncCopyConfig
}
-type ValidatePipelineResponse = components['schemas']['ValidatePipelineResponse']
+type ValidatePipelineResponse = components['schemas']['ValidatePipelineResponse_Output']
async function validatePipeline(
{
diff --git a/apps/studio/data/secrets/secrets-query.ts b/apps/studio/data/secrets/secrets-query.ts
index 93cf439f094..c1f16388dd8 100644
--- a/apps/studio/data/secrets/secrets-query.ts
+++ b/apps/studio/data/secrets/secrets-query.ts
@@ -9,7 +9,7 @@ export type SecretsVariables = {
projectRef?: string
}
-export type ProjectSecret = components['schemas']['SecretResponse']
+export type ProjectSecret = components['schemas']['SecretResponse_Output']
export async function getSecrets({ projectRef }: SecretsVariables, signal?: AbortSignal) {
if (!projectRef) throw new Error('Project ref is required')
diff --git a/apps/studio/data/service-status/service-status-query.ts b/apps/studio/data/service-status/service-status-query.ts
index e49fd7931c4..f532f0ef0c2 100644
--- a/apps/studio/data/service-status/service-status-query.ts
+++ b/apps/studio/data/service-status/service-status-query.ts
@@ -11,7 +11,7 @@ export type ProjectServiceStatusVariables = {
// Omit the 'healthy' field as it's equivalent to status = 'ACTIVE_HEALTHY'
export type ServiceHealthResponse = Omit<
- components['schemas']['V1ServiceHealthResponse'],
+ components['schemas']['V1ServiceHealthResponse_Output'],
'healthy'
>
export type ProjectServiceStatus = ServiceHealthResponse['status']
diff --git a/apps/studio/data/storage/analytics-buckets-query.ts b/apps/studio/data/storage/analytics-buckets-query.ts
index e200218e8ad..b4da21e218b 100644
--- a/apps/studio/data/storage/analytics-buckets-query.ts
+++ b/apps/studio/data/storage/analytics-buckets-query.ts
@@ -9,7 +9,7 @@ import { PROJECT_STATUS } from '@/lib/constants'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type AnalyticsBucketsVariables = { projectRef?: string }
-export type AnalyticsBucket = components['schemas']['StorageAnalyticsBucketResponse']
+export type AnalyticsBucket = components['schemas']['StorageAnalyticsBucketResponse_Output']
export type AnalyticsBuckets = components['schemas'][]
export async function getAnalyticsBuckets(
diff --git a/apps/studio/data/storage/bucket-objects-list-mutation.ts b/apps/studio/data/storage/bucket-objects-list-mutation.ts
index f0ea6666224..4dab2205362 100644
--- a/apps/studio/data/storage/bucket-objects-list-mutation.ts
+++ b/apps/studio/data/storage/bucket-objects-list-mutation.ts
@@ -12,7 +12,7 @@ type ListBucketObjectsParams = {
options: components['schemas']['GetObjectsBody']['options']
}
-export type StorageObject = components['schemas']['StorageObject']
+export type StorageObject = components['schemas']['StorageObject_Output']
// [Joshen] Ideally we transform this into a query that uses a POST i think
export const listBucketObjects = async (
diff --git a/apps/studio/data/storage/buckets-query.ts b/apps/studio/data/storage/buckets-query.ts
index ab9896e98e0..86ea4f9b438 100644
--- a/apps/studio/data/storage/buckets-query.ts
+++ b/apps/studio/data/storage/buckets-query.ts
@@ -22,7 +22,7 @@ import {
export type BucketsVariables = { projectRef?: string }
-export type Bucket = components['schemas']['StorageBucketResponse']
+export type Bucket = components['schemas']['StorageBucketResponse_Output']
export type BucketType = Bucket['type']
diff --git a/apps/studio/data/storage/s3-access-key-query.ts b/apps/studio/data/storage/s3-access-key-query.ts
index deb2ebdb976..744a5a54301 100644
--- a/apps/studio/data/storage/s3-access-key-query.ts
+++ b/apps/studio/data/storage/s3-access-key-query.ts
@@ -8,9 +8,10 @@ import type { ResponseError, UseCustomQueryOptions } from '@/types'
type StorageCredentialsVariables = { projectRef?: string }
-export type S3AccessKey = components['schemas']['GetStorageCredentialsResponse']['data'][number] & {
- access_key: string
-}
+export type S3AccessKey =
+ components['schemas']['GetStorageCredentialsResponse_Output']['data'][number] & {
+ access_key: string
+ }
async function fetchStorageCredentials(
{ projectRef }: StorageCredentialsVariables,
diff --git a/apps/studio/data/storage/vector-bucket-query.ts b/apps/studio/data/storage/vector-bucket-query.ts
index 0edb2671bae..ad62f430212 100644
--- a/apps/studio/data/storage/vector-bucket-query.ts
+++ b/apps/studio/data/storage/vector-bucket-query.ts
@@ -8,7 +8,7 @@ import { PROJECT_STATUS } from '@/lib/constants'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
// [Joshen] JFYI typed incorrectly in API, to fix by adding creationTime to APi
-export type VectorBucket = components['schemas']['StorageVectorBucketResponse'] & {
+export type VectorBucket = components['schemas']['StorageVectorBucketResponse_Output'] & {
creationTime: string
}
diff --git a/apps/studio/data/storage/vector-buckets-indexes-query.ts b/apps/studio/data/storage/vector-buckets-indexes-query.ts
index 158164680dc..f0eda059265 100644
--- a/apps/studio/data/storage/vector-buckets-indexes-query.ts
+++ b/apps/studio/data/storage/vector-buckets-indexes-query.ts
@@ -8,7 +8,7 @@ import { PROJECT_STATUS } from '@/lib/constants'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type VectorBucketIndex =
- components['schemas']['StorageVectorBucketListIndexesResponse']['indexes'][number]
+ components['schemas']['StorageVectorBucketListIndexesResponse_Output']['indexes'][number]
export type GetVectorBucketsIndexesVariables = { projectRef?: string; vectorBucketName?: string }
export async function getVectorBucketsIndexes(
diff --git a/apps/studio/data/subscriptions/org-subscription-confirm-pending-create.ts b/apps/studio/data/subscriptions/org-subscription-confirm-pending-create.ts
index 2fd072d26c3..8892318ba3d 100644
--- a/apps/studio/data/subscriptions/org-subscription-confirm-pending-create.ts
+++ b/apps/studio/data/subscriptions/org-subscription-confirm-pending-create.ts
@@ -80,7 +80,7 @@ export const useConfirmPendingSubscriptionCreateMutation = ({
return [
...prev,
castOrganizationResponseToOrganization(
- data as components['schemas']['OrganizationResponse']
+ data as components['schemas']['OrganizationResponse_Output']
),
]
}
diff --git a/apps/studio/data/subscriptions/types.ts b/apps/studio/data/subscriptions/types.ts
index bd896d67696..edb15b58956 100644
--- a/apps/studio/data/subscriptions/types.ts
+++ b/apps/studio/data/subscriptions/types.ts
@@ -1,12 +1,6 @@
import type { components } from '@/data/api'
-export type SubscriptionTier =
- | 'tier_free'
- | 'tier_pro'
- | 'tier_payg'
- | 'tier_team'
- | 'tier_enterprise'
- | 'tier_platform'
+export type SubscriptionTier = 'tier_free' | 'tier_pro' | 'tier_payg' | 'tier_team'
export type AddonVariantId = components['schemas']['UpdateAddonBody']['addon_variant']
@@ -14,9 +8,9 @@ export type OrgSubscription = components['schemas']['GetSubscriptionResponse']
export type ProjectAddon = components['schemas']['GetSubscriptionResponse']['project_addons'][0]
-export type PlanId = components['schemas']['PlansResponse']['plans'][number]['id']
+export type PlanId = components['schemas']['PlansResponse_Output']['plans'][number]['id']
-export type OrgPlan = components['schemas']['PlansResponse']['plans'][0]
+export type OrgPlan = components['schemas']['PlansResponse_Output']['plans'][0]
export type ProjectAddonType = components['schemas']['UpdateAddonBody']['addon_type']
@@ -33,6 +27,6 @@ export interface ProjectAddonVariantMeta {
}
export type ProjectSelectedAddon =
- components['schemas']['ProjectAddonsResponse']['selected_addons'][0]
+ components['schemas']['ProjectAddonsResponse_Output']['selected_addons'][0]
export type ProjectAvailableAddon =
- components['schemas']['ProjectAddonsResponse']['available_addons'][0]
+ components['schemas']['ProjectAddonsResponse_Output']['available_addons'][0]
diff --git a/apps/studio/data/third-party-auth/integrations-query.ts b/apps/studio/data/third-party-auth/integrations-query.ts
index feb8e9b9f50..ab657362e0a 100644
--- a/apps/studio/data/third-party-auth/integrations-query.ts
+++ b/apps/studio/data/third-party-auth/integrations-query.ts
@@ -11,7 +11,7 @@ export type ThirdPartyAuthIntegrationsVariables = {
export type ThirdPartyAuthIntegrationsError = ResponseError
-export type ThirdPartyAuthIntegration = components['schemas']['ThirdPartyAuth']
+export type ThirdPartyAuthIntegration = components['schemas']['ThirdPartyAuth_Output']
async function getThirdPartyAuthIntegrations(
{ projectRef }: ThirdPartyAuthIntegrationsVariables,
diff --git a/apps/studio/data/usage/org-usage-query.ts b/apps/studio/data/usage/org-usage-query.ts
index 6b2a0130b5a..bf5759b5b8f 100644
--- a/apps/studio/data/usage/org-usage-query.ts
+++ b/apps/studio/data/usage/org-usage-query.ts
@@ -13,8 +13,8 @@ export type OrgUsageVariables = {
end?: Date
}
-export type OrgUsageResponse = components['schemas']['OrgUsageResponse']
-export type OrgMetricsUsage = components['schemas']['OrgUsageResponse']['usages'][0]
+export type OrgUsageResponse = components['schemas']['OrgUsageResponse_Output']
+export type OrgMetricsUsage = components['schemas']['OrgUsageResponse_Output']['usages'][0]
export async function getOrgUsage(
{ orgSlug, projectRef, start, end }: OrgUsageVariables,
diff --git a/apps/studio/data/usage/resource-warnings-query.ts b/apps/studio/data/usage/resource-warnings-query.ts
index 93655be488f..2e2271c8ede 100644
--- a/apps/studio/data/usage/resource-warnings-query.ts
+++ b/apps/studio/data/usage/resource-warnings-query.ts
@@ -30,7 +30,7 @@ export async function getResourceWarnings(
return Array.isArray(data) ? data : EMPTY_ARR
}
-export type ResourceWarning = components['schemas']['ProjectResourceWarningsResponse']
+export type ResourceWarning = components['schemas']['ProjectResourceWarningsResponse_Output']
export type ResourceWarningsData = Awaited<ReturnType<typeof getResourceWarnings>>
export type ResourceWarningsError = ResponseError
diff --git a/apps/studio/lib/ai/tools/notebook-tools.test.ts b/apps/studio/lib/ai/tools/notebook-tools.test.ts
index a473d170140..0eecb01d99f 100644
--- a/apps/studio/lib/ai/tools/notebook-tools.test.ts
+++ b/apps/studio/lib/ai/tools/notebook-tools.test.ts
@@ -12,7 +12,7 @@ import {
import type { AgentNotebook } from '@/data/content/notebooks/notebook-schema'
import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
-type DatabaseDetailResponse = components['schemas']['DatabaseDetailResponse']
+type DatabaseDetailResponse = components['schemas']['DatabaseDetailResponse_Output']
function mockDatabases(identifiers: string[]) {
addAPIMock({
@@ -32,6 +32,8 @@ function mockDatabases(identifiers: string[]) {
inserted_at: '2026-01-01T00:00:00.000Z',
restUrl: `https://${identifier}.supabase.co/rest/v1`,
size: 't4g.micro',
+ connectionString: '',
+ connection_string_read_only: '',
}))
),
})
@@ -62,8 +64,8 @@ const VALID_AGENT_CONTENT: AgentNotebook = {
],
}
-type GetUserContentByIdResponse = components['schemas']['GetUserContentByIdResponse']
-type GetUserContentResponse = components['schemas']['GetUserContentResponse']
+type GetUserContentByIdResponse = components['schemas']['GetUserContentByIdResponse_Output']
+type GetUserContentResponse = components['schemas']['GetUserContentResponse_Output']
const NOTEBOOK_CONTENT = {
schema_version: 1,
@@ -147,7 +149,7 @@ describe('ai/tools/notebook-tools', () => {
method: 'get',
path: '/platform/projects/:ref/databases',
response: () =>
- HttpResponse.json<components['schemas']['DatabaseDetailResponse'][]>([
+ HttpResponse.json<components['schemas']['DatabaseDetailResponse_Output'][]>([
{
identifier: 'test-project',
region: 'us-east-1',
@@ -160,6 +162,8 @@ describe('ai/tools/notebook-tools', () => {
inserted_at: '2026-01-01T00:00:00.000Z',
restUrl: 'https://test-project.supabase.co/rest/v1',
size: 't4g.micro',
+ connectionString: '',
+ connection_string_read_only: '',
},
{
identifier: 'test-project-replica-1',
@@ -173,6 +177,8 @@ describe('ai/tools/notebook-tools', () => {
inserted_at: '2026-01-01T00:00:00.000Z',
restUrl: 'https://test-project-replica-1.supabase.co/rest/v1',
size: 't4g.micro',
+ connectionString: '',
+ connection_string_read_only: '',
},
]),
})
diff --git a/apps/studio/lib/ai/tools/notebook-tools.ts b/apps/studio/lib/ai/tools/notebook-tools.ts
index 5272f155f5d..798d61fa721 100644
--- a/apps/studio/lib/ai/tools/notebook-tools.ts
+++ b/apps/studio/lib/ai/tools/notebook-tools.ts
@@ -464,7 +464,7 @@ export const getNotebookTools = (ctx: NotebookToolsContext = {}) => {
projectRef: projectRef ?? '',
id,
name: notebook.name,
- description: notebook.description,
+ description: notebook.description ?? undefined,
content: { schema_version: result.notebook.schema_version, cells },
},
undefined,
diff --git a/apps/studio/lib/ai/tools/report-tools.test.ts b/apps/studio/lib/ai/tools/report-tools.test.ts
index 8dd6dea1524..ae421dc538a 100644
--- a/apps/studio/lib/ai/tools/report-tools.test.ts
+++ b/apps/studio/lib/ai/tools/report-tools.test.ts
@@ -5,7 +5,7 @@ import { describe, expect, it } from 'vitest'
import { getReportTools } from './report-tools'
import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
-type GetUserContentByIdResponse = components['schemas']['GetUserContentByIdResponse']
+type GetUserContentByIdResponse = components['schemas']['GetUserContentByIdResponse_Output']
describe('ai/tools/report-tools', () => {
describe('getReportTools', () => {
diff --git a/apps/studio/lib/api/self-hosted/settings.ts b/apps/studio/lib/api/self-hosted/settings.ts
index bed53b34b3c..8a6ca68adf2 100644
--- a/apps/studio/lib/api/self-hosted/settings.ts
+++ b/apps/studio/lib/api/self-hosted/settings.ts
@@ -4,11 +4,11 @@ import { AUTH_JWT_SECRET, POSTGRES_PORT } from './constants'
import { assertSelfHosted } from './util'
import { PROJECT_DB_HOST, PROJECT_ENDPOINT, PROJECT_ENDPOINT_PROTOCOL } from '@/lib/constants/api'
-type ProjectAppConfig = components['schemas']['ProjectSettingsResponse']['app_config'] & {
+type ProjectAppConfig = components['schemas']['ProjectSettingsResponse_Output']['app_config'] & {
protocol?: string
}
-export type ProjectSettings = components['schemas']['ProjectSettingsResponse'] & {
+export type ProjectSettings = components['schemas']['ProjectSettingsResponse_Output'] & {
app_config?: ProjectAppConfig
}
diff --git a/apps/studio/lib/api/self-hosted/signing-keys.ts b/apps/studio/lib/api/self-hosted/signing-keys.ts
index 3541f2e8e71..ba9a22b6ed7 100644
--- a/apps/studio/lib/api/self-hosted/signing-keys.ts
+++ b/apps/studio/lib/api/self-hosted/signing-keys.ts
@@ -2,7 +2,7 @@ import { components } from 'api-types'
import { assertSelfHosted } from './util'
-type SigningKeyResponse = components['schemas']['SigningKeyResponse']
+type SigningKeyResponse = components['schemas']['SigningKeyResponse_Output']
const LEGACY_KEY_ID = '00000000-0000-0000-0000-000000000000'
const LEGACY_KEY_CREATED_AT = '1970-01-01T00:00:00.000Z'
diff --git a/apps/studio/lib/constants/infrastructure.ts b/apps/studio/lib/constants/infrastructure.ts
index d25d74cf125..0cccaa7b513 100644
--- a/apps/studio/lib/constants/infrastructure.ts
+++ b/apps/studio/lib/constants/infrastructure.ts
@@ -70,7 +70,7 @@ export const PROVIDERS = {
} as const
export const PROJECT_STATUS: {
- [key: string]: components['schemas']['ProjectDetailResponse']['status']
+ [key: string]: components['schemas']['ProjectDetailResponse_Output']['status']
} = {
INACTIVE: 'INACTIVE',
ACTIVE_HEALTHY: 'ACTIVE_HEALTHY',
diff --git a/apps/studio/pages/api/platform/organizations/[slug]/billing/subscription.ts b/apps/studio/pages/api/platform/organizations/[slug]/billing/subscription.ts
index d7cee03359e..3d2fd5818d7 100644
--- a/apps/studio/pages/api/platform/organizations/[slug]/billing/subscription.ts
+++ b/apps/studio/pages/api/platform/organizations/[slug]/billing/subscription.ts
@@ -22,7 +22,6 @@ type ResponseData =
const handleGet = async (_req: NextApiRequest, res: NextApiResponse<ResponseData>) => {
const response: ResponseData = {
- billing_cycle_anchor: 0,
current_period_end: 0,
current_period_start: 0,
next_invoice_at: 0,
@@ -36,7 +35,6 @@ const handleGet = async (_req: NextApiRequest, res: NextApiResponse<ResponseData
payment_method_type: '',
billing_via_partner: false,
billing_partner: 'aws_marketplace',
- scheduled_plan_change: null,
customer_balance: 0,
}
diff --git a/apps/studio/pages/api/platform/projects/[ref]/api-keys/temporary.ts b/apps/studio/pages/api/platform/projects/[ref]/api-keys/temporary.ts
index 11b5d7c3f64..88c0b7279c0 100644
--- a/apps/studio/pages/api/platform/projects/[ref]/api-keys/temporary.ts
+++ b/apps/studio/pages/api/platform/projects/[ref]/api-keys/temporary.ts
@@ -3,10 +3,10 @@ import { NextApiRequest, NextApiResponse } from 'next'
import { apiWrapper } from '@/lib/api/apiWrapper'
-type ProjectAppConfig = components['schemas']['ProjectSettingsResponse']['app_config'] & {
+type ProjectAppConfig = components['schemas']['ProjectSettingsResponse_Output']['app_config'] & {
protocol?: string
}
-export type ProjectSettings = components['schemas']['ProjectSettingsResponse'] & {
+export type ProjectSettings = components['schemas']['ProjectSettingsResponse_Output'] & {
app_config?: ProjectAppConfig
}
diff --git a/apps/studio/pages/api/platform/projects/[ref]/config/postgrest.ts b/apps/studio/pages/api/platform/projects/[ref]/config/postgrest.ts
index 8c95bc36e35..e1bbda06489 100644
--- a/apps/studio/pages/api/platform/projects/[ref]/config/postgrest.ts
+++ b/apps/studio/pages/api/platform/projects/[ref]/config/postgrest.ts
@@ -19,7 +19,7 @@ async function handler(req: NextApiRequest, res: NextApiResponse) {
}
const handleGet = async (_req: NextApiRequest, res: NextApiResponse) => {
- const responseObj: components['schemas']['GetPostgrestConfigResponse'] = {
+ const responseObj: components['schemas']['GetPostgrestConfigResponse_Output'] = {
db_anon_role: 'anon',
db_extra_search_path: process.env.PGRST_DB_EXTRA_SEARCH_PATH ?? 'public',
db_schema: DEFAULT_EXPOSED_SCHEMAS,
diff --git a/apps/studio/pages/api/platform/projects/[ref]/settings.ts b/apps/studio/pages/api/platform/projects/[ref]/settings.ts
index d57678dd1a3..de47292821d 100644
--- a/apps/studio/pages/api/platform/projects/[ref]/settings.ts
+++ b/apps/studio/pages/api/platform/projects/[ref]/settings.ts
@@ -4,10 +4,10 @@ import { NextApiRequest, NextApiResponse } from 'next'
import { apiWrapper } from '@/lib/api/apiWrapper'
import { getProjectSettings } from '@/lib/api/self-hosted/settings'
-type ProjectAppConfig = components['schemas']['ProjectSettingsResponse']['app_config'] & {
+type ProjectAppConfig = components['schemas']['ProjectSettingsResponse_Output']['app_config'] & {
protocol?: string
}
-export type ProjectSettings = components['schemas']['ProjectSettingsResponse'] & {
+export type ProjectSettings = components['schemas']['ProjectSettingsResponse_Output'] & {
app_config?: ProjectAppConfig
}
diff --git a/apps/studio/pages/api/v1/projects/[ref]/functions/[slug]/index.ts b/apps/studio/pages/api/v1/projects/[ref]/functions/[slug]/index.ts
index bda25f00d92..1c3df3b30b1 100644
--- a/apps/studio/pages/api/v1/projects/[ref]/functions/[slug]/index.ts
+++ b/apps/studio/pages/api/v1/projects/[ref]/functions/[slug]/index.ts
@@ -21,7 +21,7 @@ async function handler(req: NextApiRequest, res: NextApiResponse) {
}
}
-type EdgeFunctionsResponse = components['schemas']['FunctionResponse']
+type EdgeFunctionsResponse = components['schemas']['FunctionResponse_Output']
const handleGet = async (req: NextApiRequest, res: NextApiResponse) => {
const slugParam = req.query.slug
diff --git a/apps/studio/pages/api/v1/projects/[ref]/functions/index.ts b/apps/studio/pages/api/v1/projects/[ref]/functions/index.ts
index f2c1757ad78..16870a2fc3b 100644
--- a/apps/studio/pages/api/v1/projects/[ref]/functions/index.ts
+++ b/apps/studio/pages/api/v1/projects/[ref]/functions/index.ts
@@ -21,7 +21,7 @@ async function handler(req: NextApiRequest, res: NextApiResponse) {
}
}
-type EdgeFunctionsResponse = components['schemas']['FunctionResponse']
+type EdgeFunctionsResponse = components['schemas']['FunctionResponse_Output']
const handleGetAll = async (_req: NextApiRequest, res: NextApiResponse) => {
const store = getFunctionsArtifactStore()
diff --git a/apps/studio/pages/project/[ref]/logs/explorer/index.tsx b/apps/studio/pages/project/[ref]/logs/explorer/index.tsx
index 2e002bcca9e..03f5e54e6cd 100644
--- a/apps/studio/pages/project/[ref]/logs/explorer/index.tsx
+++ b/apps/studio/pages/project/[ref]/logs/explorer/index.tsx
@@ -373,6 +373,7 @@ export const LogsExplorerPage: NextPageWithLayout = () => {
projectRef: projectRef!,
payload: {
...query,
+ description: query.description ?? undefined,
content: {
...(query.content as LogSqlSnippets.Content),
unchecked_sql: untrustedLogSql(currentSql),
diff --git a/apps/studio/state/notebooks/types.ts b/apps/studio/state/notebooks/types.ts
index cd989982a73..24970b5d331 100644
--- a/apps/studio/state/notebooks/types.ts
+++ b/apps/studio/state/notebooks/types.ts
@@ -5,13 +5,13 @@ export interface Notebook {
id: string
type: 'notebook'
name: string
- description?: string
+ description?: string | null | undefined
visibility: 'project'
favorite: boolean
owner_id: number
project_id: number
content?: Notebooks.Content // Undefined until loaded
- updated_at?: string // Absent for a notebook that's never been saved
+ updated_at?: string | null | undefined // Absent for a notebook that's never been saved
}
export interface StateNotebook {
diff --git a/apps/studio/tests/components/ApiAuthorization.test.tsx b/apps/studio/tests/components/ApiAuthorization.test.tsx
index 7e31ee0eb80..31b7a044ba8 100644
--- a/apps/studio/tests/components/ApiAuthorization.test.tsx
+++ b/apps/studio/tests/components/ApiAuthorization.test.tsx
@@ -17,10 +17,10 @@ import { createMockOrganizationResponse } from '@/tests/helpers'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
-type OrganizationResponse = components['schemas']['OrganizationResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
type GetOAuthAuthorizationResponse = components['schemas']['GetOAuthAuthorizationResponse']
-type ApproveAuthorizationResponse = components['schemas']['ApproveAuthorizationResponse']
-type DeclineAuthorizationResponse = components['schemas']['DeclineAuthorizationResponse']
+type ApproveAuthorizationResponse = components['schemas']['ApproveAuthorizationResponse_Output']
+type DeclineAuthorizationResponse = components['schemas']['DeclineAuthorizationResponse_Output']
// --- Fixtures ---
diff --git a/apps/studio/tests/components/Organization/TeamSettings/InviteMemberButton.network.test.tsx b/apps/studio/tests/components/Organization/TeamSettings/InviteMemberButton.network.test.tsx
index e835d9fc5b1..21d69f98f43 100644
--- a/apps/studio/tests/components/Organization/TeamSettings/InviteMemberButton.network.test.tsx
+++ b/apps/studio/tests/components/Organization/TeamSettings/InviteMemberButton.network.test.tsx
@@ -10,11 +10,11 @@ import { createMockOrganizationResponse } from '@/tests/helpers'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock, type APIErrorBody } from '@/tests/lib/msw'
-type OrganizationResponse = components['schemas']['OrganizationResponse']
-type Member = components['schemas']['Member']
-type InvitationResponse = components['schemas']['InvitationResponse']
-type OrganizationRoleResponse = components['schemas']['OrganizationRoleResponse']
-type ListEntitlementsResponse = components['schemas']['ListEntitlementsResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
+type Member = components['schemas']['Member_Output']
+type InvitationResponse = components['schemas']['InvitationResponse_Output']
+type OrganizationRoleResponse = components['schemas']['OrganizationRoleResponse_Output']
+type ListEntitlementsResponse = components['schemas']['ListEntitlementsResponse_Output']
type CreateInvitationResponse =
operations['InvitationsController_createInvitation']['responses']['201']['content']['application/json']
type AccessControlPermission = components['schemas']['AccessControlPermission']
diff --git a/apps/studio/tests/components/Organization/TeamSettings/UpdateRolesPanel.network.test.tsx b/apps/studio/tests/components/Organization/TeamSettings/UpdateRolesPanel.network.test.tsx
index 3a2b575228b..9ead9852447 100644
--- a/apps/studio/tests/components/Organization/TeamSettings/UpdateRolesPanel.network.test.tsx
+++ b/apps/studio/tests/components/Organization/TeamSettings/UpdateRolesPanel.network.test.tsx
@@ -12,10 +12,10 @@ import { createMockOrganizationResponse } from '@/tests/helpers'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type OrganizationResponse = components['schemas']['OrganizationResponse']
-type OrganizationRoleResponse = components['schemas']['OrganizationRoleResponse']
-type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse']
-type ListEntitlementsResponse = components['schemas']['ListEntitlementsResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
+type OrganizationRoleResponse = components['schemas']['OrganizationRoleResponse_Output']
+type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse_Output']
+type ListEntitlementsResponse = components['schemas']['ListEntitlementsResponse_Output']
type AccessControlPermission = components['schemas']['AccessControlPermission']
const ORG_SLUG = 'test-org'
diff --git a/apps/studio/tests/components/Settings/Infrastructure/ReadReplicasSection.test.tsx b/apps/studio/tests/components/Settings/Infrastructure/ReadReplicasSection.test.tsx
index f8b1928b812..0f8fd8ac5b6 100644
--- a/apps/studio/tests/components/Settings/Infrastructure/ReadReplicasSection.test.tsx
+++ b/apps/studio/tests/components/Settings/Infrastructure/ReadReplicasSection.test.tsx
@@ -7,9 +7,9 @@ import type { components } from '@/data/api'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type DatabaseDetailResponse = components['schemas']['DatabaseDetailResponse']
-type DatabaseStatusResponse = components['schemas']['DatabaseStatusResponse']
-type LoadBalancerDetailResponse = components['schemas']['LoadBalancerDetailResponse']
+type DatabaseDetailResponse = components['schemas']['DatabaseDetailResponse_Output']
+type DatabaseStatusResponse = components['schemas']['DatabaseStatusResponse_Output']
+type LoadBalancerDetailResponse = components['schemas']['LoadBalancerDetailResponse_Output']
const { mockUseIsFeatureEnabled } = vi.hoisted(() => ({
mockUseIsFeatureEnabled: vi.fn(() => ({ infrastructureReadReplicas: true })),
@@ -32,6 +32,8 @@ const addReplicaListMocks = () => {
{
cloud_provider: 'AWS',
connectionString: 'postgresql://postgres:[email protected]:5432/postgres',
+ connection_string_read_only:
+ 'postgresql://postgres:[email protected]:5432/postgres',
db_host: 'db.default.supabase.co',
db_name: 'postgres',
db_port: 5432,
diff --git a/apps/studio/tests/helpers.tsx b/apps/studio/tests/helpers.tsx
index 3a8a0dcae4c..df10594c7ba 100644
--- a/apps/studio/tests/helpers.tsx
+++ b/apps/studio/tests/helpers.tsx
@@ -9,7 +9,7 @@ import { CommandProvider } from 'ui-patterns/CommandMenu'
import { ProjectInfoInfinite } from '@/data/projects/projects-infinite-query'
import type { Organization } from '@/types'
-type OrganizationResponse = components['schemas']['OrganizationResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
interface SelectorOptions {
container?: HTMLElement
diff --git a/apps/studio/tests/lib/sql-editor-test-utils.tsx b/apps/studio/tests/lib/sql-editor-test-utils.tsx
index e332c1977d7..1664a04177d 100644
--- a/apps/studio/tests/lib/sql-editor-test-utils.tsx
+++ b/apps/studio/tests/lib/sql-editor-test-utils.tsx
@@ -243,7 +243,6 @@ export function setupSqlEditorMocks({
path: '/platform/organizations/:slug/billing/subscription',
response: {
addons: [],
- billing_cycle_anchor: 1700000000,
billing_via_partner: false,
current_period_end: 1700000000,
current_period_start: 1700000000,
@@ -251,7 +250,6 @@ export function setupSqlEditorMocks({
payment_method_type: 'card',
plan: { id: 'free', name: 'Free' },
project_addons: [],
- scheduled_plan_change: null,
usage_billing_enabled: false,
},
})
@@ -283,6 +281,7 @@ export function setupSqlEditorMocks({
{
identifier: ref,
connectionString,
+ connection_string_read_only: connectionString,
cloud_provider: 'AWS',
db_host: `db.${ref}.supabase.co`,
db_name: 'postgres',
diff --git a/apps/studio/tests/pages/aws-marketplace-onboarding.test.tsx b/apps/studio/tests/pages/aws-marketplace-onboarding.test.tsx
index 2765dd36958..4bb65bb3209 100644
--- a/apps/studio/tests/pages/aws-marketplace-onboarding.test.tsx
+++ b/apps/studio/tests/pages/aws-marketplace-onboarding.test.tsx
@@ -22,7 +22,7 @@ vi.mock('sonner', () => ({
toast: { error: vi.fn() },
}))
-type OrganizationResponse = components['schemas']['OrganizationResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
const DEFAULT_PROFILE_CONTEXT: ProfileContextType = {
profile: {
diff --git a/apps/studio/tests/pages/new/[slug].test.tsx b/apps/studio/tests/pages/new/[slug].test.tsx
index 07d3f8dcf23..7db99dfd03b 100644
--- a/apps/studio/tests/pages/new/[slug].test.tsx
+++ b/apps/studio/tests/pages/new/[slug].test.tsx
@@ -16,14 +16,14 @@ import { createMockProfileContext } from '@/tests/lib/profile-helpers'
import { routerMock } from '@/tests/lib/route-mock'
import type { Permission } from '@/types'
-type OrganizationResponse = components['schemas']['OrganizationResponse']
+type OrganizationResponse = components['schemas']['OrganizationResponse_Output']
type CreateProjectBody = components['schemas']['CreateProjectBody']
-type CreateProjectResponse = components['schemas']['CreateProjectResponse']
-type RegionsInfo = components['schemas']['RegionsInfo']
-type MemberWithFreeProjectLimit = components['schemas']['MemberWithFreeProjectLimit']
-type OverdueInvoiceCount = components['schemas']['OverdueInvoiceCount']
-type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse']
-type Entitlement = components['schemas']['ListEntitlementsResponse']['entitlements'][number]
+type CreateProjectResponse = components['schemas']['CreateProjectResponse_Output']
+type RegionsInfo = components['schemas']['RegionsInfo_Output']
+type MemberWithFreeProjectLimit = components['schemas']['MemberWithFreeProjectLimit_Output']
+type OverdueInvoiceCount = components['schemas']['OverdueInvoiceCount_Output']
+type OrganizationProjectsResponse = components['schemas']['OrganizationProjectsResponse_Output']
+type Entitlement = components['schemas']['ListEntitlementsResponse_Output']['entitlements'][number]
type AvailableVersion = {
postgres_engine: '15' | '17' | '17-oriole'
release_channel: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
diff --git a/apps/studio/tests/pages/project/[ref]/settings/infrastructure.test.tsx b/apps/studio/tests/pages/project/[ref]/settings/infrastructure.test.tsx
index 38abd0b4045..0a818736a0a 100644
--- a/apps/studio/tests/pages/project/[ref]/settings/infrastructure.test.tsx
+++ b/apps/studio/tests/pages/project/[ref]/settings/infrastructure.test.tsx
@@ -12,8 +12,8 @@ import { createMockOrganizationResponse } from '@/tests/helpers'
import { customRender } from '@/tests/lib/custom-render'
import { addAPIMock } from '@/tests/lib/msw'
-type ProjectDetailResponse = components['schemas']['ProjectDetailResponse']
-type ProjectAddonsResponse = components['schemas']['ProjectAddonsResponse']
+type ProjectDetailResponse = components['schemas']['ProjectDetailResponse_Output']
+type ProjectAddonsResponse = components['schemas']['ProjectAddonsResponse_Output']
type PermissionResponse = components['schemas']['AccessControlPermission']
const PROJECT_REF = 'project-ref'
diff --git a/apps/studio/tests/pages/project/[ref]/storage/vectors/index.test.tsx b/apps/studio/tests/pages/project/[ref]/storage/vectors/index.test.tsx
index 49005e81ee2..a515633730d 100644
--- a/apps/studio/tests/pages/project/[ref]/storage/vectors/index.test.tsx
+++ b/apps/studio/tests/pages/project/[ref]/storage/vectors/index.test.tsx
@@ -53,18 +53,18 @@ const mockStorageConfig = (vectorBucketsEnabled: boolean) => {
path: '/platform/projects/:ref/config/storage',
response: () =>
HttpResponse.json<ProjectStorageConfigData>({
- capabilities: { iceberg_catalog: false, list_v2: false },
- databasePoolMode: 'transaction',
+ capabilities: { iceberg_catalog: false, list_v2: false, object_versioning: false },
external: { upstreamTarget: 'main' },
features: {
icebergCatalog: { enabled: false, maxCatalogs: 0, maxNamespaces: 0, maxTables: 0 },
imageTransformation: { enabled: false },
s3Protocol: { enabled: false },
+ purgeCache: { enabled: false },
vectorBuckets: { enabled: vectorBucketsEnabled, maxBuckets: 0, maxIndexes: 0 },
},
fileSizeLimit: 0,
migrationVersion: 'v1',
- } as ProjectStorageConfigData),
+ } as const),
})
}
diff --git a/apps/ui-library/lib/fetch/projects.ts b/apps/ui-library/lib/fetch/projects.ts
index ff2c035284f..91a6324da95 100644
--- a/apps/ui-library/lib/fetch/projects.ts
+++ b/apps/ui-library/lib/fetch/projects.ts
@@ -1,5 +1,6 @@
import { infiniteQueryOptions } from '@tanstack/react-query'
import { components } from 'api-types'
+
import { get } from './fetchWrappers'
const DEFAULT_LIMIT = 10
@@ -19,7 +20,7 @@ interface GetProjectsInfiniteVariables {
}
export type ProjectInfoInfinite =
- components['schemas']['ListProjectsPaginatedResponse']['projects'][number]
+ components['schemas']['ListProjectsPaginatedResponse_Output']['projects'][number]
async function getProjects(
{
@@ -42,7 +43,7 @@ async function getProjects(
})
if (error) throw error
- return data as unknown as components['schemas']['ListProjectsPaginatedResponse']
+ return data as unknown as components['schemas']['ListProjectsPaginatedResponse_Output']
}
export type ProjectsInfiniteData = Awaited<ReturnType<typeof getProjects>>
diff --git a/apps/www/data/organizations.ts b/apps/www/data/organizations.ts
index 26b7dc21192..ec902f4236b 100644
--- a/apps/www/data/organizations.ts
+++ b/apps/www/data/organizations.ts
@@ -1,10 +1,9 @@
-import { components } from 'api-types'
-import { useEffect, useState } from 'react'
-
import { API_URL } from '~/lib/constants'
import { get } from '~/lib/fetchWrapper'
+import { components } from 'api-types'
+import { useEffect, useState } from 'react'
-export type Organization = components['schemas']['OrganizationResponse']
+export type Organization = components['schemas']['OrganizationResponse_Output']
export function useOrganizations() {
const [organizations, setOrganizations] = useState<Organization[]>([])
diff --git a/packages/api-types/scripts/verify-production-types.mjs b/packages/api-types/scripts/verify-production-types.mjs
index 308de036e7c..80fa563beb0 100644
--- a/packages/api-types/scripts/verify-production-types.mjs
+++ b/packages/api-types/scripts/verify-production-types.mjs
@@ -92,11 +92,22 @@ export async function verifyProductionTypes() {
{ cwd: packageDirectory }
)
+ // Prettier resolves its config from the formatted file's location. The generated files live
+ // in a temporary directory outside the repository, so pass the repository config explicitly
+ // or they are formatted with Prettier's defaults and never match the committed files.
+ const { stdout: prettierConfigPath } = await run(
+ 'pnpm',
+ ['exec', 'prettier', '--find-config-path', join(packageDirectory, 'package.json')],
+ { cwd: packageDirectory }
+ )
+
await run(
'pnpm',
[
'exec',
'prettier',
+ '--config',
+ prettierConfigPath.trim(),
'--write',
...specifications.map(({ name }) => join(generatedTypesDirectory, `${name}.d.ts`)),
],
diff --git a/packages/api-types/types/api-v1.d.ts b/packages/api-types/types/api-v1.d.ts
index 8c91525db81..09a5785a5c0 100644
--- a/packages/api-types/types/api-v1.d.ts
+++ b/packages/api-types/types/api-v1.d.ts
@@ -2215,7 +2215,7 @@ export interface components {
email: string
token: string
}
- ActionRunResponse: {
+ ActionRunResponse_Output: {
branch_id: string
check_run_id: number | null
created_at: string
@@ -2232,10 +2232,10 @@ export interface components {
updated_at: string
workdir: string | null
}
- ActivateVanitySubdomainResponse: {
+ ActivateVanitySubdomainResponse_Output: {
custom_domain: string
}
- AnalyticsResponse: {
+ AnalyticsResponse_Output: {
error?:
| string
| {
@@ -2252,7 +2252,7 @@ export interface components {
}
result?: unknown[]
}
- ApiKeyResponse: {
+ ApiKeyResponse_Output: {
api_key?: string | null
description?: string | null
hash?: string | null
@@ -2309,7 +2309,7 @@ export interface components {
| ('pitr_7' | 'pitr_14' | 'pitr_28')
| 'ipv4_default'
}
- AuthConfigResponse: {
+ AuthConfigResponse_Output: {
api_max_request_duration: number | null
custom_oauth_enabled: boolean
custom_oauth_max_providers: number
@@ -2516,6 +2516,7 @@ export interface components {
security_manual_linking_enabled: boolean | null
security_refresh_token_reuse_interval: number | null
security_sb_forwarded_for_enabled: boolean | null
+ security_update_password_require_current_password: boolean | null
security_update_password_require_reauthentication: boolean | null
sessions_inactivity_timeout: number | null
sessions_single_per_user: boolean | null
@@ -2573,11 +2574,11 @@ export interface components {
BranchActionBody: {
migration_version?: string
}
- BranchDeleteResponse: {
+ BranchDeleteResponse_Output: {
/** @enum {string} */
message: 'ok'
}
- BranchDetailResponse: {
+ BranchDetailResponse_Output: {
db_host: string
db_pass?: string
db_port: number
@@ -2605,7 +2606,7 @@ export interface components {
| 'PAUSE_FAILED'
| 'RESIZING'
}
- BranchResponse: {
+ BranchResponse_Output: {
/** Format: date-time */
created_at: string
/** Format: date-time */
@@ -2662,11 +2663,11 @@ export interface components {
updated_at: string
with_data: boolean
}
- BranchRestoreResponse: {
+ BranchRestoreResponse_Output: {
/** @enum {string} */
message: 'Branch restoration initiated'
}
- BranchUpdateResponse: {
+ BranchUpdateResponse_Output: {
/** @enum {string} */
message: 'ok'
workflow_run_id: string
@@ -2697,7 +2698,7 @@ export interface components {
verify_jwt?: boolean
version: number
}[]
- BulkUpdateFunctionResponse: {
+ BulkUpdateFunctionResponse_Output: {
functions: {
/** Format: int64 */
created_at: number
@@ -2791,7 +2792,7 @@ export interface components {
CreateOrganizationV1: {
name: string
}
- CreateProjectClaimTokenResponse: {
+ CreateProjectClaimTokenResponse_Output: {
created_at: string
/** Format: uuid */
created_by: string
@@ -2845,7 +2846,7 @@ export interface components {
*/
type: 'saml'
}
- CreateProviderResponse: {
+ CreateProviderResponse_Output: {
created_at?: string
domains?: {
created_at?: string
@@ -2882,7 +2883,7 @@ export interface components {
CreateRoleBody: {
read_only: boolean
}
- CreateRoleResponse: {
+ CreateRoleResponse_Output: {
password: string
role: string
/** Format: int64 */
@@ -2994,7 +2995,7 @@ export interface components {
jwks_url?: string
oidc_issuer_url?: string
}
- DatabaseUpgradeStatusResponse: {
+ DatabaseUpgradeStatusResponse_Output: {
databaseUpgradeStatus: {
/** @enum {string} */
error?:
@@ -3023,10 +3024,10 @@ export interface components {
| '9_completed_upgrade'
| '10_completed_post_physical_backup'
status: number
- target_version: number
+ target_version: string
} | null
}
- DeleteProviderResponse: {
+ DeleteProviderResponse_Output: {
created_at?: string
domains?: {
created_at?: string
@@ -3057,7 +3058,7 @@ export interface components {
}
updated_at?: string
}
- DeleteRolesResponse: {
+ DeleteRolesResponse_Output: {
/** @enum {string} */
message: 'ok'
}
@@ -3065,7 +3066,7 @@ export interface components {
* "OPENAI_API_KEY"
* ] */
DeleteSecretsBody: string[]
- DeployFunctionResponse: {
+ DeployFunctionResponse_Output: {
/** Format: int64 */
created_at?: number
entrypoint_path?: string
@@ -3082,7 +3083,7 @@ export interface components {
verify_jwt?: boolean
version: number
}
- DiskAutoscaleConfig: {
+ DiskAutoscaleConfig_Output: {
/** @description Growth percentage for disk autoscaling */
growth_percent: number | null
/** @description Maximum limit the disk size will grow to in GB */
@@ -3114,7 +3115,7 @@ export interface components {
type: 'io2'
}
}
- DiskResponse: {
+ DiskResponse_Output: {
attributes:
| {
iops: number
@@ -3131,7 +3132,7 @@ export interface components {
}
last_modified_at?: string
}
- DiskUtilMetricsResponse: {
+ DiskUtilMetricsResponse_Output: {
metrics: {
fs_avail_bytes: number
fs_size_bytes: number
@@ -3159,7 +3160,7 @@ export interface components {
verify_jwt?: boolean
}
}
- FunctionResponse: {
+ FunctionResponse_Output: {
/** Format: int64 */
created_at: number
entrypoint_path?: string
@@ -3176,7 +3177,7 @@ export interface components {
verify_jwt?: boolean
version: number
}
- FunctionSlugResponse: {
+ FunctionSlugResponse_Output: {
/** Format: int64 */
created_at: number
entrypoint_path?: string
@@ -3193,7 +3194,7 @@ export interface components {
verify_jwt?: boolean
version: number
}
- GetProjectAvailableRestoreVersionsResponse: {
+ GetProjectAvailableRestoreVersionsResponse_Output: {
available_versions: {
/** @enum {string} */
postgres_engine: '13' | '14' | '15' | '17' | '17-oriole'
@@ -3202,19 +3203,15 @@ export interface components {
version: string
}[]
}
- GetProjectDbMetadataResponse: {
- databases: ({
+ GetProjectDbMetadataResponse_Output: {
+ databases: {
name: string
- schemas: ({
+ schemas: {
name: string
- } & {
- [key: string]: unknown
- })[]
- } & {
- [key: string]: unknown
- })[]
+ }[]
+ }[]
}
- GetProviderResponse: {
+ GetProviderResponse_Output: {
created_at?: string
domains?: {
created_at?: string
@@ -3281,7 +3278,7 @@ export interface components {
role: string
}[]
}
- InviteExternalUserJitResponse: {
+ InviteExternalUserJitResponse_Output: {
/** Format: email */
email: string
/** Format: uuid */
@@ -3309,7 +3306,7 @@ export interface components {
/** @enum {string} */
state: 'enabled' | 'disabled'
}
- JitAccessResponse: {
+ JitAccessResponse_Output: {
/** Format: uuid */
user_id?: string
user_roles: {
@@ -3328,7 +3325,7 @@ export interface components {
role: string
}[]
}
- JitAuthorizeAccessResponse: {
+ JitAuthorizeAccessResponse_Output: {
/** Format: uuid */
user_id: string
user_role: {
@@ -3347,7 +3344,7 @@ export interface components {
role: string
}
}
- JitListAccessResponse: {
+ JitListAccessResponse_Output: {
items: (
| {
expires_at: null
@@ -3395,10 +3392,17 @@ export interface components {
}
)[]
}
- LegacyApiKeysResponse: {
+ /** @description Any JSON-serializable value */
+ JsonValue_Output:
+ | ((string | number | boolean) | null)
+ | components['schemas']['JsonValue_Output'][]
+ | {
+ [key: string]: components['schemas']['JsonValue_Output']
+ }
+ LegacyApiKeysResponse_Output: {
enabled: boolean
}
- ListActionRunResponse: {
+ ListActionRunResponse_Output: {
branch_id: string
check_run_id: number | null
created_at: string
@@ -3415,7 +3419,7 @@ export interface components {
updated_at: string
workdir: string | null
}[]
- ListProjectAddonsResponse: {
+ ListProjectAddonsResponse_Output: {
available_addons: {
name: string
/** @enum {string} */
@@ -3457,7 +3461,7 @@ export interface components {
| 'auth_mfa_web_authn_default'
| 'log_drain_default'
| 'etl_pipeline_default'
- meta?: components['schemas']['ListProjectAddonsResponseJsonValue']
+ meta?: components['schemas']['JsonValue_Output']
name: string
price: {
amount: number
@@ -3509,7 +3513,7 @@ export interface components {
| 'auth_mfa_web_authn_default'
| 'log_drain_default'
| 'etl_pipeline_default'
- meta?: components['schemas']['ListProjectAddonsResponseJsonValue']
+ meta?: components['schemas']['JsonValue_Output']
name: string
price: {
amount: number
@@ -3522,14 +3526,7 @@ export interface components {
}
}[]
}
- /** @description Any JSON-serializable value */
- ListProjectAddonsResponseJsonValue:
- | ((string | number | boolean) | null)
- | components['schemas']['ListProjectAddonsResponseJsonValue'][]
- | {
- [key: string]: components['schemas']['ListProjectAddonsResponseJsonValue']
- }
- ListProvidersResponse: {
+ ListProvidersResponse_Output: {
items: {
created_at?: string
domains?: {
@@ -3562,10 +3559,10 @@ export interface components {
updated_at?: string
}[]
}
- NetworkBanResponse: {
+ NetworkBanResponse_Output: {
banned_ipv4_addresses: string[]
}
- NetworkBanResponseEnriched: {
+ NetworkBanResponseEnriched_Output: {
banned_ipv4_addresses: {
banned_address: string
identifier: string
@@ -3606,7 +3603,7 @@ export interface components {
dbAllowedCidrs?: string[]
dbAllowedCidrsV6?: string[]
}
- NetworkRestrictionsResponse: {
+ NetworkRestrictionsResponse_Output: {
/** Format: date-time */
applied_at?: string
/**
@@ -3646,7 +3643,7 @@ export interface components {
/** Format: date-time */
updated_at?: string
}
- NetworkRestrictionsV2Response: {
+ NetworkRestrictionsV2Response_Output: {
/** Format: date-time */
applied_at?: string
/** @description At any given point in time, this is the config that the user has requested be applied to their project. The `status` field indicates if it has been applied to the project, or is pending. When an updated config is received, the applied config is moved to `old_config`. */
@@ -3714,7 +3711,7 @@ export interface components {
resource?: string
scope?: string
}
- OAuthTokenResponse: {
+ OAuthTokenResponse_Output: {
access_token: string
expires_in: number
/** @description The `urn:ietf:params:oauth:grant-type:jwt-bearer` grant type issues access tokens only, no refresh token is returned and the token cannot be revoked via `/v1/oauth/revoke`. */
@@ -3722,7 +3719,7 @@ export interface components {
/** @enum {string} */
token_type: 'Bearer'
}
- OrganizationProjectClaimResponse: {
+ OrganizationProjectClaimResponse_Output: {
created_at: string
/** Format: uuid */
created_by: string
@@ -3755,7 +3752,7 @@ export interface components {
ref: string
}
}
- OrganizationProjectsResponse: {
+ OrganizationProjectsResponse_Output: {
pagination: {
/** @description Total number of projects. Use this to calculate the total number of pages. */
count: number
@@ -3838,7 +3835,7 @@ export interface components {
| 'RESIZING'
}[]
}
- OrganizationResponseV1: {
+ OrganizationResponseV1_Output: {
/**
* @deprecated
* @description Deprecated: Use `slug` instead.
@@ -3854,7 +3851,7 @@ export interface components {
/** @example {
* "root_key": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
* } */
- PgsodiumConfigResponse: {
+ PgsodiumConfigResponse_Output: {
/** @description The pgsodium root key: 32 bytes, hex-encoded (64 characters). */
root_key: string
}
@@ -3874,7 +3871,7 @@ export interface components {
/** @description Human-readable explanation of the plan gate */
message: string
}
- PostgresConfigResponse: {
+ PostgresConfigResponse_Output: {
/** @description Default unit: s */
checkpoint_timeout?: string
'cron.log_statement'?: boolean
@@ -3920,7 +3917,7 @@ export interface components {
wal_sender_timeout?: string
work_mem?: string
}
- PostgrestConfigWithJWTSecretResponse: {
+ PostgrestConfigWithJWTSecretResponse_Output: {
db_extra_search_path: string
/** @description If `null`, the value is automatically configured based on compute size. */
db_pool: number | null
@@ -3930,14 +3927,14 @@ export interface components {
jwt_secret?: string
max_rows: number
}
- ProjectClaimTokenResponse: {
+ ProjectClaimTokenResponse_Output: {
created_at: string
/** Format: uuid */
created_by: string
expires_at: string
token_alias: string
}
- ProjectUpgradeEligibilityResponse: {
+ ProjectUpgradeEligibilityResponse_Output: {
current_app_version: string
/** @enum {string} */
current_app_version_release_channel:
@@ -4051,15 +4048,15 @@ export interface components {
}
)[]
}
- ProjectUpgradeInitiateResponse: {
+ ProjectUpgradeInitiateResponse_Output: {
tracking_id: string
}
- ReadOnlyStatusResponse: {
+ ReadOnlyStatusResponse_Output: {
enabled: boolean
override_active_until: string
override_enabled: boolean
}
- RealtimeConfigResponse: {
+ RealtimeConfigResponse_Output: {
/** @description Sets connection pool size for Realtime Authorization */
connection_pool: number | null
/** @description Sets maximum number of bytes per second rate per channel limit */
@@ -4085,7 +4082,7 @@ export interface components {
/** @description Disables the Realtime service for this project when true. Set to false to re-enable it. */
suspend: boolean | null
}
- RegionsInfo: {
+ RegionsInfo_Output: {
all: {
smartGroup: {
/** @enum {string} */
@@ -4185,7 +4182,7 @@ export interface components {
RemoveReadReplicaBody: {
database_identifier: string
}
- SecretResponse: {
+ SecretResponse_Output: {
name: string
updated_at?: string
value: string
@@ -4218,7 +4215,7 @@ export interface components {
| 'ap-south-1'
| 'sa-east-1'
}
- SigningKeyResponse: {
+ SigningKeyResponse_Output: {
/** @enum {string} */
algorithm: 'EdDSA' | 'ES256' | 'RS256' | 'HS256'
/** Format: date-time */
@@ -4231,7 +4228,7 @@ export interface components {
/** Format: date-time */
updated_at: string
}
- SigningKeysResponse: {
+ SigningKeysResponse_Output: {
keys: {
/** @enum {string} */
algorithm: 'EdDSA' | 'ES256' | 'RS256' | 'HS256'
@@ -4246,7 +4243,7 @@ export interface components {
updated_at: string
}[]
}
- SnippetList: {
+ SnippetList_Output: {
cursor?: string
data: {
description: string | null
@@ -4273,7 +4270,7 @@ export interface components {
visibility: 'user' | 'project' | 'org' | 'public'
}[]
}
- SnippetResponse: {
+ SnippetResponse_Output: {
content: {
/**
* @deprecated
@@ -4316,18 +4313,18 @@ export interface components {
database: boolean
}
}
- SslEnforcementResponse: {
+ SslEnforcementResponse_Output: {
appliedSuccessfully: boolean
currentConfig: {
database: boolean
}
}
- StorageConfigResponse: {
+ StorageConfigResponse_Output: {
capabilities: {
iceberg_catalog: boolean
list_v2: boolean
+ object_versioning: boolean
}
- databasePoolMode: string
external: {
/** @enum {string} */
upstreamTarget: 'main' | 'canary'
@@ -4356,13 +4353,13 @@ export interface components {
}
/** Format: int64 */
fileSizeLimit: number
- migrationVersion: string
+ migrationVersion: string | null
}
StreamableFile: Record<string, never>
- SubdomainAvailabilityResponse: {
+ SubdomainAvailabilityResponse_Output: {
available: boolean
}
- SupavisorConfigResponse: {
+ SupavisorConfigResponse_Output: {
connection_string: string
/** @description Use connection_string instead */
connectionString: string
@@ -4379,7 +4376,7 @@ export interface components {
/** @enum {string} */
pool_mode: 'transaction' | 'session'
}
- ThirdPartyAuth: {
+ ThirdPartyAuth_Output: {
custom_jwks?: unknown
/** Format: uuid */
id: string
@@ -4391,7 +4388,7 @@ export interface components {
type: string
updated_at: string
}
- TypescriptResponse: {
+ TypescriptResponse_Output: {
types: string
}
/** @example {
@@ -4612,12 +4609,17 @@ export interface components {
security_captcha_provider?: 'turnstile' | 'hcaptcha' | null
security_captcha_secret?: string | null
security_manual_linking_enabled?: boolean | null
+ /** @description Refresh token reuse interval in seconds. Maximum 300 seconds (5 minutes). */
security_refresh_token_reuse_interval?: number | null
security_sb_forwarded_for_enabled?: boolean | null
+ /** @description Require the user's current password when updating their password. */
+ security_update_password_require_current_password?: boolean | null
security_update_password_require_reauthentication?: boolean | null
+ /** @description Session inactivity timeout in hours. Maximum 8760 hours (1 year). */
sessions_inactivity_timeout?: number | null
sessions_single_per_user?: boolean | null
sessions_tags?: string | null
+ /** @description Session timebox in hours. Maximum 8760 hours (1 year). */
sessions_timebox?: number | null
site_url?: string | null
sms_autoconfirm?: boolean | null
@@ -4694,31 +4696,31 @@ export interface components {
UpdateCustomHostnameBody: {
custom_hostname: string
}
- UpdateCustomHostnameResponse: {
- custom_hostname: string
+ UpdateCustomHostnameResponse_Output: {
+ custom_hostname?: string
data: {
- errors: components['schemas']['UpdateCustomHostnameResponseJsonValue'][]
- messages: components['schemas']['UpdateCustomHostnameResponseJsonValue'][]
+ errors: components['schemas']['JsonValue_Output'][]
+ messages: components['schemas']['JsonValue_Output'][]
result: {
- custom_origin_server: string
+ custom_origin_server?: string
hostname: string
id: string
- ownership_verification: {
- name: string
- type: string
- value: string
+ ownership_verification?: {
+ name?: string
+ type?: string
+ value?: string
}
- ssl: {
- status: string
+ ssl?: {
+ status?: string
validation_errors?: {
message: string
}[]
- validation_records: {
- txt_name: string
- txt_value: string
+ validation_records?: {
+ txt_name?: string
+ txt_value?: string
}[]
}
- status: string
+ status?: string
verification_errors?: string[]
}
success: boolean
@@ -4731,13 +4733,6 @@ export interface components {
| '4_origin_setup_completed'
| '5_services_reconfigured'
}
- /** @description Any JSON-serializable value */
- UpdateCustomHostnameResponseJsonValue:
- | ((string | number | boolean) | null)
- | components['schemas']['UpdateCustomHostnameResponseJsonValue'][]
- | {
- [key: string]: components['schemas']['UpdateCustomHostnameResponseJsonValue']
- }
/** @example {
* "user_id": "55555555-5555-4555-8555-555555555555",
* "roles": [
@@ -4862,7 +4857,7 @@ export interface components {
| 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'
| 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'
}
- UpdateProviderResponse: {
+ UpdateProviderResponse_Output: {
created_at?: string
domains?: {
created_at?: string
@@ -4946,7 +4941,7 @@ export interface components {
/** @enum {string} */
seed?: 'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'
}
- UpdateRunStatusResponse: {
+ UpdateRunStatusResponse_Output: {
/** @enum {string} */
message: 'ok'
}
@@ -5007,7 +5002,7 @@ export interface components {
*/
pool_mode?: 'transaction' | 'session'
}
- UpdateSupavisorConfigResponse: {
+ UpdateSupavisorConfigResponse_Output: {
default_pool_size: number | null
pool_mode: string
}
@@ -5020,7 +5015,7 @@ export interface components {
release_channel?: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
target_version: string
}
- V1BackupScheduleResponse: {
+ V1BackupScheduleResponse_Output: {
/**
* @description Time of day to schedule daily backups, in UTC. Format: HH:MM:SS.
* @example 04:00:00
@@ -5033,7 +5028,7 @@ export interface components {
*/
updated_at: string
}
- V1BackupsResponse: {
+ V1BackupsResponse_Output: {
backups: {
id: number
inserted_at: string
@@ -5201,7 +5196,7 @@ export interface components {
*/
template_url?: string
}
- V1GetMigrationResponse: {
+ V1GetMigrationResponse_Output: {
created_by?: string
idempotency_key?: string
name?: string
@@ -5209,7 +5204,7 @@ export interface components {
statements?: string[]
version: string
}
- V1GetUsageApiCountResponse: {
+ V1GetUsageApiCountResponse_Output: {
error?:
| string
| {
@@ -5233,7 +5228,7 @@ export interface components {
total_storage_requests: number
}[]
}
- V1GetUsageApiRequestsCountResponse: {
+ V1GetUsageApiRequestsCountResponse_Output: {
error?:
| string
| {
@@ -5252,7 +5247,7 @@ export interface components {
count: number
}[]
}
- V1ListEntitlementsResponse: {
+ V1ListEntitlementsResponse_Output: {
entitlements: {
config:
| {
@@ -5343,19 +5338,19 @@ export interface components {
type: 'boolean' | 'numeric' | 'set'
}[]
}
- V1ListMigrationsResponse: {
+ V1ListMigrationsResponse_Output: {
name?: string
version: string
}[]
- V1OrganizationMemberResponse: {
+ V1OrganizationMemberResponse_Output: {
avatar_url: string | null
email?: string
mfa_enabled: boolean
- role_name: string
+ role_name?: string
user_id: string
user_name: string
}
- V1OrganizationSlugResponse: {
+ V1OrganizationSlugResponse_Output: {
allowed_release_channels: ('internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview')[]
id: string
name: string
@@ -5375,7 +5370,7 @@ export interface components {
name?: string
rollback?: string
}
- V1PgbouncerConfigResponse: {
+ V1PgbouncerConfigResponse_Output: {
connection_string?: string
default_pool_size?: number
ignore_startup_parameters?: string
@@ -5387,7 +5382,7 @@ export interface components {
server_idle_timeout?: number
server_lifetime?: number
}
- V1PostgrestConfigResponse: {
+ V1PostgrestConfigResponse_Output: {
db_extra_search_path: string
/** @description If `null`, the value is automatically configured based on compute size. */
db_pool: number | null
@@ -5396,13 +5391,13 @@ export interface components {
db_schema: string
max_rows: number
}
- V1ProfileResponse: {
+ V1ProfileResponse_Output: {
gotrue_id: string
primary_email: string
username: string
}
- V1ProjectAdvisorsResponse: {
- lints: ({
+ V1ProjectAdvisorsResponse_Output: {
+ lints: {
cache_key: string
categories: ('PERFORMANCE' | 'SECURITY' | 'HEALTH')[]
description: string
@@ -5428,8 +5423,6 @@ export interface components {
| 'extension'
| 'compliance'
| 'health'
- } & {
- [key: string]: unknown
}
/** @enum {string} */
name:
@@ -5479,16 +5472,14 @@ export interface components {
observed_at?: string
remediation: string
title: string
- } & {
- [key: string]: unknown
- })[]
+ }[]
}
- V1ProjectRefResponse: {
+ V1ProjectRefResponse_Output: {
id: number
name: string
ref: string
}
- V1ProjectResponse: {
+ V1ProjectResponse_Output: {
/** @description Creation timestamp */
created_at: string
/**
@@ -5533,7 +5524,7 @@ export interface components {
| 'PAUSE_FAILED'
| 'RESIZING'
}
- V1ProjectWithDatabaseResponse: {
+ V1ProjectWithDatabaseResponse_Output: {
/** @description Creation timestamp */
created_at: string
database: {
@@ -5630,7 +5621,7 @@ export interface components {
query: string
read_only?: boolean
}
- V1ServiceHealthResponse: {
+ V1ServiceHealthResponse_Output: {
error?: string
/**
* @deprecated
@@ -5670,7 +5661,7 @@ export interface components {
/** @enum {string} */
status: 'COMING_UP' | 'ACTIVE_HEALTHY' | 'UNHEALTHY'
}
- V1StorageBucketResponse: {
+ V1StorageBucketResponse_Output: {
created_at: string
id: string
name: string
@@ -5710,7 +5701,7 @@ export interface components {
V1UpdatePasswordBody: {
password: string
}
- V1UpdatePasswordResponse: {
+ V1UpdatePasswordResponse_Output: {
message: string
}
/** @example {
@@ -5747,7 +5738,7 @@ export interface components {
VanitySubdomainBody: {
vanity_subdomain: string
}
- VanitySubdomainConfigResponse: {
+ VanitySubdomainConfigResponse_Output: {
custom_domain?: string
/** @enum {string} */
status: 'not-used' | 'custom-domain-used' | 'active'
@@ -5778,9 +5769,30 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchDetailResponse']
+ 'application/json': components['schemas']['BranchDetailResponse_Output']
}
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Failed to retrieve database branch */
500: {
headers: {
@@ -5810,9 +5822,30 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchDeleteResponse']
+ 'application/json': components['schemas']['BranchDeleteResponse_Output']
}
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Failed to delete database branch */
500: {
headers: {
@@ -5843,8 +5876,29 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchResponse']
+ 'application/json': components['schemas']['BranchResponse_Output']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
}
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
}
/** @description Failed to update database branch */
500: {
@@ -5884,6 +5938,27 @@ export interface operations {
'text/plain': string
}
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Failed to diff database branch */
500: {
headers: {
@@ -5914,8 +5989,29 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchUpdateResponse']
+ 'application/json': components['schemas']['BranchUpdateResponse_Output']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
}
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
}
/** @description Failed to merge database branch */
500: {
@@ -5947,8 +6043,29 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchUpdateResponse']
+ 'application/json': components['schemas']['BranchUpdateResponse_Output']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
}
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
}
/** @description Failed to push database branch */
500: {
@@ -5980,8 +6097,29 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchUpdateResponse']
+ 'application/json': components['schemas']['BranchUpdateResponse_Output']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
}
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
}
/** @description Failed to reset database branch */
500: {
@@ -6004,14 +6142,35 @@ export interface operations {
}
requestBody?: never
responses: {
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchRestoreResponse']
+ 'application/json': components['schemas']['BranchRestoreResponse_Output']
}
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Failed to restore database branch */
500: {
headers: {
@@ -6050,6 +6209,27 @@ export interface operations {
}
content?: never
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
}
}
'v1-oauth-authorize-project-claim': {
@@ -6119,6 +6299,27 @@ export interface operations {
}
content?: never
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
}
}
'v1-exchange-oauth-token': {
@@ -6139,9 +6340,30 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OAuthTokenResponse']
+ 'application/json': components['schemas']['OAuthTokenResponse_Output']
}
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
}
}
'v1-list-all-organizations': {
@@ -6158,7 +6380,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationResponseV1'][]
+ 'application/json': components['schemas']['OrganizationResponseV1_Output'][]
}
}
/** @description Unauthorized */
@@ -6209,7 +6431,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationResponseV1']
+ 'application/json': components['schemas']['OrganizationResponseV1_Output']
}
}
/** @description Unauthorized */
@@ -6259,7 +6481,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1OrganizationSlugResponse']
+ 'application/json': components['schemas']['V1OrganizationSlugResponse_Output']
}
}
/** @description Unauthorized */
@@ -6302,7 +6524,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ListEntitlementsResponse']
+ 'application/json': components['schemas']['V1ListEntitlementsResponse_Output']
}
}
/** @description Unauthorized */
@@ -6345,9 +6567,30 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1OrganizationMemberResponse'][]
+ 'application/json': components['schemas']['V1OrganizationMemberResponse_Output'][]
}
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
}
}
'v1-get-organization-project-claim': {
@@ -6368,7 +6611,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationProjectClaimResponse']
+ 'application/json': components['schemas']['OrganizationProjectClaimResponse_Output']
}
}
/** @description Unauthorized */
@@ -6466,7 +6709,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationProjectsResponse']
+ 'application/json': components['schemas']['OrganizationProjectsResponse_Output']
}
}
/** @description Unauthorized */
@@ -6513,7 +6756,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ProfileResponse']
+ 'application/json': components['schemas']['V1ProfileResponse_Output']
}
}
}
@@ -6532,7 +6775,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ProjectWithDatabaseResponse'][]
+ 'application/json': components['schemas']['V1ProjectWithDatabaseResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -6576,7 +6819,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ProjectResponse']
+ 'application/json': components['schemas']['V1ProjectResponse_Output']
}
}
/** @description Unauthorized */
@@ -6619,7 +6862,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ProjectWithDatabaseResponse']
+ 'application/json': components['schemas']['V1ProjectWithDatabaseResponse_Output']
}
}
/** @description Unauthorized */
@@ -6669,7 +6912,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ProjectRefResponse']
+ 'application/json': components['schemas']['V1ProjectRefResponse_Output']
}
}
/** @description Unauthorized */
@@ -6716,7 +6959,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ProjectRefResponse']
+ 'application/json': components['schemas']['V1ProjectRefResponse_Output']
}
}
/** @description Unauthorized */
@@ -6769,7 +7012,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ListActionRunResponse']
+ 'application/json': components['schemas']['ListActionRunResponse_Output']
}
}
/** @description Unauthorized */
@@ -6871,7 +7114,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ActionRunResponse']
+ 'application/json': components['schemas']['ActionRunResponse_Output']
}
}
/** @description Unauthorized */
@@ -6979,7 +7222,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateRunStatusResponse']
+ 'application/json': components['schemas']['UpdateRunStatusResponse_Output']
}
}
/** @description Unauthorized */
@@ -7029,7 +7272,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ProjectAdvisorsResponse']
+ 'application/json': components['schemas']['V1ProjectAdvisorsResponse_Output']
}
}
/** @description Unauthorized */
@@ -7074,7 +7317,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ProjectAdvisorsResponse']
+ 'application/json': components['schemas']['V1ProjectAdvisorsResponse_Output']
}
}
/** @description Unauthorized */
@@ -7120,7 +7363,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -7175,7 +7418,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -7230,7 +7473,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -7341,7 +7584,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1GetUsageApiCountResponse']
+ 'application/json': components['schemas']['V1GetUsageApiCountResponse_Output']
}
}
/** @description Unauthorized */
@@ -7391,7 +7634,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1GetUsageApiRequestsCountResponse']
+ 'application/json': components['schemas']['V1GetUsageApiRequestsCountResponse_Output']
}
}
/** @description Unauthorized */
@@ -7448,7 +7691,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ApiKeyResponse'][]
+ 'application/json': components['schemas']['ApiKeyResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -7502,7 +7745,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ApiKeyResponse']
+ 'application/json': components['schemas']['ApiKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -7553,7 +7796,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ApiKeyResponse']
+ 'application/json': components['schemas']['ApiKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -7603,7 +7846,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ApiKeyResponse']
+ 'application/json': components['schemas']['ApiKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -7658,7 +7901,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ApiKeyResponse']
+ 'application/json': components['schemas']['ApiKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -7701,7 +7944,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LegacyApiKeysResponse']
+ 'application/json': components['schemas']['LegacyApiKeysResponse_Output']
}
}
/** @description Unauthorized */
@@ -7751,7 +7994,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LegacyApiKeysResponse']
+ 'application/json': components['schemas']['LegacyApiKeysResponse_Output']
}
}
/** @description Unauthorized */
@@ -7794,7 +8037,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ListProjectAddonsResponse']
+ 'application/json': components['schemas']['ListProjectAddonsResponse_Output']
}
}
/** @description Unauthorized */
@@ -7968,9 +8211,30 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchResponse'][]
+ 'application/json': components['schemas']['BranchResponse_Output'][]
}
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Failed to retrieve database branches */
500: {
headers: {
@@ -8001,9 +8265,30 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchResponse']
+ 'application/json': components['schemas']['BranchResponse_Output']
}
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Failed to create database branch */
500: {
headers: {
@@ -8079,9 +8364,30 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BranchResponse']
+ 'application/json': components['schemas']['BranchResponse_Output']
}
}
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Failed to fetch database branch */
500: {
headers: {
@@ -8108,7 +8414,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectClaimTokenResponse']
+ 'application/json': components['schemas']['ProjectClaimTokenResponse_Output']
}
}
/** @description Unauthorized */
@@ -8151,7 +8457,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateProjectClaimTokenResponse']
+ 'application/json': components['schemas']['CreateProjectClaimTokenResponse_Output']
}
}
/** @description Unauthorized */
@@ -8239,7 +8545,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateRoleResponse']
+ 'application/json': components['schemas']['CreateRoleResponse_Output']
}
}
/** @description Unauthorized */
@@ -8289,7 +8595,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DeleteRolesResponse']
+ 'application/json': components['schemas']['DeleteRolesResponse_Output']
}
}
/** @description Unauthorized */
@@ -8339,7 +8645,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AuthConfigResponse']
+ 'application/json': components['schemas']['AuthConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -8393,7 +8699,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AuthConfigResponse']
+ 'application/json': components['schemas']['AuthConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -8443,7 +8749,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SigningKeysResponse']
+ 'application/json': components['schemas']['SigningKeysResponse_Output']
}
}
/** @description Unauthorized */
@@ -8490,7 +8796,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SigningKeyResponse']
+ 'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -8534,7 +8840,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SigningKeyResponse']
+ 'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -8578,7 +8884,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SigningKeyResponse']
+ 'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -8626,7 +8932,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SigningKeyResponse']
+ 'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -8669,7 +8975,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SigningKeyResponse']
+ 'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -8712,7 +9018,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SigningKeyResponse']
+ 'application/json': components['schemas']['SigningKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -8755,7 +9061,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ListProvidersResponse']
+ 'application/json': components['schemas']['ListProvidersResponse_Output']
}
}
/** @description Unauthorized */
@@ -8809,7 +9115,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateProviderResponse']
+ 'application/json': components['schemas']['CreateProviderResponse_Output']
}
}
/** @description Unauthorized */
@@ -8860,7 +9166,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetProviderResponse']
+ 'application/json': components['schemas']['GetProviderResponse_Output']
}
}
/** @description Unauthorized */
@@ -8915,7 +9221,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateProviderResponse']
+ 'application/json': components['schemas']['UpdateProviderResponse_Output']
}
}
/** @description Unauthorized */
@@ -8966,7 +9272,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DeleteProviderResponse']
+ 'application/json': components['schemas']['DeleteProviderResponse_Output']
}
}
/** @description Unauthorized */
@@ -9016,7 +9322,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ThirdPartyAuth'][]
+ 'application/json': components['schemas']['ThirdPartyAuth_Output'][]
}
}
/** @description Unauthorized */
@@ -9063,7 +9369,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ThirdPartyAuth']
+ 'application/json': components['schemas']['ThirdPartyAuth_Output']
}
}
/** @description Unauthorized */
@@ -9107,7 +9413,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ThirdPartyAuth']
+ 'application/json': components['schemas']['ThirdPartyAuth_Output']
}
}
/** @description Unauthorized */
@@ -9151,7 +9457,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ThirdPartyAuth']
+ 'application/json': components['schemas']['ThirdPartyAuth_Output']
}
}
/** @description Unauthorized */
@@ -9194,7 +9500,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1PgbouncerConfigResponse']
+ 'application/json': components['schemas']['V1PgbouncerConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -9244,7 +9550,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SupavisorConfigResponse'][]
+ 'application/json': components['schemas']['SupavisorConfigResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -9298,7 +9604,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateSupavisorConfigResponse']
+ 'application/json': components['schemas']['UpdateSupavisorConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -9348,7 +9654,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PostgresConfigResponse']
+ 'application/json': components['schemas']['PostgresConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -9402,7 +9708,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PostgresConfigResponse']
+ 'application/json': components['schemas']['PostgresConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -9452,7 +9758,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DiskResponse']
+ 'application/json': components['schemas']['DiskResponse_Output']
}
}
/** @description Unauthorized */
@@ -9554,7 +9860,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DiskAutoscaleConfig']
+ 'application/json': components['schemas']['DiskAutoscaleConfig_Output']
}
}
/** @description Unauthorized */
@@ -9604,7 +9910,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DiskUtilMetricsResponse']
+ 'application/json': components['schemas']['DiskUtilMetricsResponse_Output']
}
}
/** @description Unauthorized */
@@ -9655,7 +9961,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['RealtimeConfigResponse']
+ 'application/json': components['schemas']['RealtimeConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -9792,7 +10098,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageConfigResponse']
+ 'application/json': components['schemas']['StorageConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -9894,7 +10200,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateCustomHostnameResponse']
+ 'application/json': components['schemas']['UpdateCustomHostnameResponse_Output']
}
}
/** @description Unauthorized */
@@ -9995,7 +10301,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateCustomHostnameResponse']
+ 'application/json': components['schemas']['UpdateCustomHostnameResponse_Output']
}
}
/** @description Unauthorized */
@@ -10049,7 +10355,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateCustomHostnameResponse']
+ 'application/json': components['schemas']['UpdateCustomHostnameResponse_Output']
}
}
/** @description Unauthorized */
@@ -10099,7 +10405,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateCustomHostnameResponse']
+ 'application/json': components['schemas']['UpdateCustomHostnameResponse_Output']
}
}
/** @description Unauthorized */
@@ -10149,7 +10455,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1BackupsResponse']
+ 'application/json': components['schemas']['V1BackupsResponse_Output']
}
}
/** @description Unauthorized */
@@ -10388,7 +10694,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1BackupScheduleResponse']
+ 'application/json': components['schemas']['V1BackupScheduleResponse_Output']
}
}
/** @description Unauthorized */
@@ -10458,7 +10764,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1BackupScheduleResponse']
+ 'application/json': components['schemas']['V1BackupScheduleResponse_Output']
}
}
/** @description Invalid schedule_for format */
@@ -10576,7 +10882,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetProjectDbMetadataResponse']
+ 'application/json': components['schemas']['GetProjectDbMetadataResponse_Output']
}
}
/** @description Unauthorized */
@@ -10619,7 +10925,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['JitAccessResponse']
+ 'application/json': components['schemas']['JitAccessResponse_Output']
}
}
/** @description Unauthorized */
@@ -10673,7 +10979,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['JitAccessResponse']
+ 'application/json': components['schemas']['JitAccessResponse_Output']
}
}
/** @description Unauthorized */
@@ -10727,7 +11033,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['JitAuthorizeAccessResponse']
+ 'application/json': components['schemas']['JitAuthorizeAccessResponse_Output']
}
}
/** @description Unauthorized */
@@ -10830,7 +11136,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['InviteExternalUserJitResponse']
+ 'application/json': components['schemas']['InviteExternalUserJitResponse_Output']
}
}
/** @description Unauthorized */
@@ -10933,7 +11239,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['JitAccessResponse']
+ 'application/json': components['schemas']['JitAccessResponse_Output']
}
}
/** @description Failed to accept invitation */
@@ -10962,7 +11268,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['JitListAccessResponse']
+ 'application/json': components['schemas']['JitListAccessResponse_Output']
}
}
/** @description Unauthorized */
@@ -11012,7 +11318,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ListMigrationsResponse']
+ 'application/json': components['schemas']['V1ListMigrationsResponse_Output']
}
}
/** @description Unauthorized */
@@ -11224,7 +11530,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1GetMigrationResponse']
+ 'application/json': components['schemas']['V1GetMigrationResponse_Output']
}
}
/** @description Unauthorized */
@@ -11384,7 +11690,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1UpdatePasswordResponse']
+ 'application/json': components['schemas']['V1UpdatePasswordResponse_Output']
}
}
/** @description Unauthorized */
@@ -11586,7 +11892,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['FunctionResponse'][]
+ 'application/json': components['schemas']['FunctionResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -11640,7 +11946,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BulkUpdateFunctionResponse']
+ 'application/json': components['schemas']['BulkUpdateFunctionResponse_Output']
}
}
/** @description Unauthorized */
@@ -11710,7 +12016,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['FunctionResponse']
+ 'application/json': components['schemas']['FunctionResponse_Output']
}
}
/** @description Unauthorized */
@@ -11769,7 +12075,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['FunctionSlugResponse']
+ 'application/json': components['schemas']['FunctionSlugResponse_Output']
}
}
/** @description Unauthorized */
@@ -11884,7 +12190,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['FunctionResponse']
+ 'application/json': components['schemas']['FunctionSlugResponse_Output']
}
}
/** @description Unauthorized */
@@ -11993,7 +12299,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DeployFunctionResponse']
+ 'application/json': components['schemas']['DeployFunctionResponse_Output']
}
}
/** @description Unauthorized */
@@ -12065,7 +12371,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1ServiceHealthResponse'][]
+ 'application/json': components['schemas']['V1ServiceHealthResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -12126,6 +12432,7 @@ export interface operations {
state: 'unavailable'
/** @enum {string} */
unavailableReason:
+ | 'platform_unsupported'
| 'postgres_upgrade_required'
| 'ssl_enforcement_required'
| 'temporarily_unavailable'
@@ -12194,6 +12501,7 @@ export interface operations {
state: 'unavailable'
/** @enum {string} */
unavailableReason:
+ | 'platform_unsupported'
| 'postgres_upgrade_required'
| 'ssl_enforcement_required'
| 'temporarily_unavailable'
@@ -12299,7 +12607,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['NetworkBanResponse']
+ 'application/json': components['schemas']['NetworkBanResponse_Output']
}
}
/** @description Unauthorized */
@@ -12349,7 +12657,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['NetworkBanResponseEnriched']
+ 'application/json': components['schemas']['NetworkBanResponseEnriched_Output']
}
}
/** @description Unauthorized */
@@ -12399,7 +12707,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['NetworkRestrictionsResponse']
+ 'application/json': components['schemas']['NetworkRestrictionsResponse_Output']
}
}
/** @description Unauthorized */
@@ -12453,7 +12761,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['NetworkRestrictionsV2Response']
+ 'application/json': components['schemas']['NetworkRestrictionsV2Response_Output']
}
}
/** @description Unauthorized */
@@ -12507,7 +12815,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['NetworkRestrictionsResponse']
+ 'application/json': components['schemas']['NetworkRestrictionsResponse_Output']
}
}
/** @description Unauthorized */
@@ -12598,7 +12906,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PgsodiumConfigResponse']
+ 'application/json': components['schemas']['PgsodiumConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -12652,7 +12960,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PgsodiumConfigResponse']
+ 'application/json': components['schemas']['PgsodiumConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -12702,7 +13010,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PostgrestConfigWithJWTSecretResponse']
+ 'application/json': components['schemas']['PostgrestConfigWithJWTSecretResponse_Output']
}
}
/** @description Unauthorized */
@@ -12756,7 +13064,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1PostgrestConfigResponse']
+ 'application/json': components['schemas']['V1PostgrestConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -12919,7 +13227,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReadOnlyStatusResponse']
+ 'application/json': components['schemas']['ReadOnlyStatusResponse_Output']
}
}
/** @description Unauthorized */
@@ -13058,7 +13366,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetProjectAvailableRestoreVersionsResponse']
+ 'application/json': components['schemas']['GetProjectAvailableRestoreVersionsResponse_Output']
}
}
/** @description Unauthorized */
@@ -13183,7 +13491,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SecretResponse'][]
+ 'application/json': components['schemas']['SecretResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -13337,7 +13645,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SslEnforcementResponse']
+ 'application/json': components['schemas']['SslEnforcementResponse_Output']
}
}
/** @description Unauthorized */
@@ -13391,7 +13699,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SslEnforcementResponse']
+ 'application/json': components['schemas']['SslEnforcementResponse_Output']
}
}
/** @description Unauthorized */
@@ -13441,7 +13749,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['V1StorageBucketResponse'][]
+ 'application/json': components['schemas']['V1StorageBucketResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -13493,7 +13801,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['TypescriptResponse']
+ 'application/json': components['schemas']['TypescriptResponse_Output']
}
}
/** @description Unauthorized */
@@ -13547,7 +13855,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectUpgradeInitiateResponse']
+ 'application/json': components['schemas']['ProjectUpgradeInitiateResponse_Output']
}
}
/** @description Unauthorized */
@@ -13597,7 +13905,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectUpgradeEligibilityResponse']
+ 'application/json': components['schemas']['ProjectUpgradeEligibilityResponse_Output']
}
}
/** @description Unauthorized */
@@ -13649,7 +13957,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DatabaseUpgradeStatusResponse']
+ 'application/json': components['schemas']['DatabaseUpgradeStatusResponse_Output']
}
}
/** @description Unauthorized */
@@ -13699,7 +14007,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['VanitySubdomainConfigResponse']
+ 'application/json': components['schemas']['VanitySubdomainConfigResponse_Output']
}
}
/** @description This feature requires the Pro, Team, or Enterprise organization plan. */
@@ -13810,7 +14118,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ActivateVanitySubdomainResponse']
+ 'application/json': components['schemas']['ActivateVanitySubdomainResponse_Output']
}
}
/** @description This feature requires the Pro, Team, or Enterprise organization plan. */
@@ -13873,7 +14181,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SubdomainAvailabilityResponse']
+ 'application/json': components['schemas']['SubdomainAvailabilityResponse_Output']
}
}
/** @description This feature requires the Pro, Team, or Enterprise organization plan. */
@@ -13955,7 +14263,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['RegionsInfo']
+ 'application/json': components['schemas']['RegionsInfo_Output']
}
}
}
@@ -13981,7 +14289,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SnippetList']
+ 'application/json': components['schemas']['SnippetList_Output']
}
}
/** @description Unauthorized */
@@ -14030,7 +14338,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SnippetResponse']
+ 'application/json': components['schemas']['SnippetResponse_Output']
}
}
/** @description Unauthorized */
diff --git a/packages/api-types/types/api-v2.d.ts b/packages/api-types/types/api-v2.d.ts
index 93193ccfcf1..ae6ec047539 100644
--- a/packages/api-types/types/api-v2.d.ts
+++ b/packages/api-types/types/api-v2.d.ts
@@ -4,33 +4,6 @@
*/
export interface paths {
- '/v1/webhooks/events': {
- parameters: {
- query?: never
- header?: never
- path?: never
- cookie?: never
- }
- get?: never
- put?: never
- /**
- * Publish event
- * @description Ingests and schedules a new webhook event to be published out to all subscribed endpoints.
- *
- * In case of non-successful response status codes, early termination, networking issues,
- * requests to this endpoint should be retried until it succeeds, otherwise there is a risk of
- * loosing events.
- *
- * `meta.idempotency_key` is used to ensure idempotency when retrying the requests and so it
- * must always be provided.
- */
- post: operations['v1-webhooks-events-post']
- delete?: never
- options?: never
- head?: never
- patch?: never
- trace?: never
- }
'/v2/organizations/{slug}/integrations/github/connections': {
parameters: {
query?: never
@@ -369,6 +342,26 @@ export interface paths {
patch?: never
trace?: never
}
+ '/v2/projects/{ref}/branches': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * Create a database branch
+ * @description Creates a database branch from the specified project. Compute and disk size can be set here so the branch is provisioned at the requested size, instead of being resized after creation.
+ */
+ post: operations['v2-create-a-branch']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
'/v2/projects/{ref}/config': {
parameters: {
query?: never
@@ -1193,6 +1186,110 @@ export interface components {
type: 'organization_member_role'
}
}
+ V2BranchResponse_Output: {
+ data: {
+ attributes: {
+ /**
+ * Format: date-time
+ * @description Creation timestamp.
+ */
+ created_at: string
+ /** @description Git branch being tracked. */
+ git_branch?: string
+ /** @description Whether this is the default branch of the project. */
+ is_default: boolean
+ /** @description Name of the branch. */
+ name: string
+ /**
+ * Format: uri
+ * @description HTTP endpoint receiving branch status updates.
+ */
+ notify_url?: string
+ /** @description Ref of the project it branches from. */
+ parent_project_ref: string
+ /** @description Whether the branch is kept when its git branch is deleted or its PR is merged. */
+ persistent: boolean
+ /** @description Ref of the project backing this branch. */
+ project_ref: string
+ /**
+ * Format: date-time
+ * @description Last update timestamp.
+ */
+ updated_at: string
+ /** @description Whether the branch is seeded from the project's data. */
+ with_data: boolean
+ }
+ /**
+ * Format: uuid
+ * @description ID of the branch.
+ */
+ id: string
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'branch'
+ }
+ }
+ V2CreateBranchRequest: {
+ data: {
+ attributes: {
+ /** @description Desired disk size in GB. Omit this field to default to the smallest disk size available on the plan. */
+ desired_disk_size_gb?: number
+ /**
+ * @description Desired instance size. Omit this field to always default to the smallest possible size.
+ * @enum {string}
+ */
+ desired_instance_size?:
+ | 'nano'
+ | 'micro'
+ | 'small'
+ | 'medium'
+ | 'large'
+ | 'xlarge'
+ | '2xlarge'
+ | '4xlarge'
+ | '8xlarge'
+ | '12xlarge'
+ | '16xlarge'
+ | '24xlarge'
+ | '24xlarge_optimized_memory'
+ | '24xlarge_optimized_cpu'
+ | '24xlarge_high_memory'
+ | '48xlarge'
+ | '48xlarge_optimized_memory'
+ | '48xlarge_optimized_cpu'
+ | '48xlarge_high_memory'
+ /**
+ * @description Git branch to track. Must exist on the connected GitHub repository when the project has one.
+ * @example feature/login-page
+ */
+ git_branch?: string
+ /**
+ * @description Name of the branch.
+ * @example preview-login-page
+ */
+ name: string
+ /**
+ * Format: uri
+ * @description HTTP endpoint to receive branch status updates.
+ * @example https://example.com/webhooks/branches
+ */
+ notify_url?: string
+ /** @description Whether the branch is kept when its git branch is deleted or its PR is merged. */
+ persistent?: boolean
+ /** @description Region to create the branch in. Omit to inherit the region of the project it branches from. */
+ region?: string
+ /** @description Whether to seed the branch from the project's latest physical backup. */
+ with_data?: boolean
+ }
+ /**
+ * @description Resource type.
+ * @enum {string}
+ */
+ type: 'branch'
+ }
+ }
V2CreateInvitationsRequest: {
data: {
attributes: {
@@ -2003,8 +2100,8 @@ export interface components {
capabilities: {
iceberg_catalog: boolean
list_v2: boolean
+ object_versioning: boolean
}
- database_pool_mode: string
features: {
iceberg_catalog: {
enabled: boolean
@@ -2029,7 +2126,7 @@ export interface components {
}
/** Format: int64 */
file_size_limit: number
- migration_version: string
+ migration_version: string | null
/** @enum {string} */
upstream_target: 'main' | 'canary'
}
@@ -2182,325 +2279,6 @@ export interface components {
}
export type $defs = Record<string, never>
export interface operations {
- 'v1-webhooks-events-post': {
- parameters: {
- query?: never
- header?: never
- path?: never
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': {
- data: {
- attributes: {
- /**
- * @description Organization slug
- * @example tsrqponmlkjihgfedcba
- */
- organization_slug: string
- /** @description Extra data to pass to consumers. `organization_slug` and `project_ref` (if applicable) are always provided by default. */
- payload?: {
- [key: string]: unknown
- }
- /** @description Project's ref. If left unspecified or `null`, the event will published as organization-wide, only to organization-wide endpoints. */
- project_ref?: string | null
- /**
- * Format: date-time
- * @description Optional timestamp of event publication.
- */
- timestamp?: string
- /**
- * @description Webhook event type.
- * @enum {string}
- */
- type:
- | 'v1.project.paused'
- | 'v1.project.created'
- | 'v1.project.restored'
- | 'v1.project.transferred'
- | 'v1.project.removed'
- | 'v1.project.restarted'
- | 'v1.project.status.changed'
- | 'v1.project.backup.started'
- | 'v1.project.branch.created'
- | 'v1.project.branch.updated'
- | 'v1.project.branch.removed'
- | 'v1.organization.member.invitation.created'
- | 'v1.organization.member.invitation.canceled'
- | 'v1.organization.member.added'
- | 'v1.organization.member.removed'
- | 'v1.organization.member.role.assigned'
- | 'v1.organization.member.role.removed'
- | 'v1.organization.member.role.updated'
- | 'v1.organization.billing.plan.upgraded'
- | 'v1.organization.billing.plan.downgraded'
- | 'project.v1.paused'
- | 'project.v1.created'
- | 'project.v1.restored'
- | 'project.v1.transferred'
- | 'project.v1.removed'
- | 'project.v1.restarted'
- | 'project.v1.status.changed'
- | 'project.v1.backup.started'
- | 'project.v1.branch.created'
- | 'project.v1.branch.updated'
- | 'project.v1.branch.removed'
- | 'organization.v1.member.invitation.created'
- | 'organization.v1.member.invitation.canceled'
- | 'organization.v1.member.added'
- | 'organization.v1.member.removed'
- | 'organization.v1.member.role.assigned'
- | 'organization.v1.member.role.removed'
- | 'organization.v1.member.role.updated'
- | 'organization.v1.billing.plan.upgraded'
- | 'organization.v1.billing.plan.downgraded'
- | 'project.v1.branch.deleted'
- }
- /**
- * @description Resource type.
- * @constant
- */
- type: 'event'
- }
- meta: {
- /** @description Idempotency key. */
- idempotency_key: string
- }
- }
- }
- }
- responses: {
- /** @description Events published */
- 201: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': {
- data: {
- id: string
- /**
- * @description Resource type.
- * @constant
- */
- type: 'ingress'
- }
- }
- }
- }
- /** @description PermissionDenied */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': {
- error: {
- /** @constant */
- code: 'forbidden.permission_denied'
- description?: string
- id?: string
- issues?: components['schemas']['APIErrorObject'][]
- links?: {
- [key: string]: {
- describedby?: string
- href: string
- meta?: {
- [key: string]: unknown
- }
- rel?: string
- title?: string
- type?: string
- }
- }
- /** @constant */
- message: 'Forbidden: Permission denied'
- meta?: {
- [key: string]: unknown
- }
- }
- $defs: {
- APIErrorObject: components['schemas']['APIErrorObject']
- }
- }
- }
- }
- /** @description GenericRequestTimeout */
- 408: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': {
- error: {
- /** @constant */
- code: 'request_timeout'
- description?: string
- id?: string
- issues?: components['schemas']['APIErrorObject'][]
- links?: {
- [key: string]: {
- describedby?: string
- href: string
- meta?: {
- [key: string]: unknown
- }
- rel?: string
- title?: string
- type?: string
- }
- }
- /** @constant */
- message: 'Request Timeout'
- meta?: {
- [key: string]: unknown
- }
- }
- $defs: {
- APIErrorObject: components['schemas']['APIErrorObject']
- }
- }
- }
- }
- /** @description GenericTooManyRequests */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': {
- error: {
- /** @constant */
- code: 'too_many_requests'
- description?: string
- id?: string
- issues?: components['schemas']['APIErrorObject'][]
- links?: {
- [key: string]: {
- describedby?: string
- href: string
- meta?: {
- [key: string]: unknown
- }
- rel?: string
- title?: string
- type?: string
- }
- }
- /** @constant */
- message: 'Too Many Requests'
- meta?: {
- [key: string]: unknown
- }
- }
- $defs: {
- APIErrorObject: components['schemas']['APIErrorObject']
- }
- }
- }
- }
- /** @description Multiple error responses */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': {
- error:
- | {
- /** @constant */
- code: 'internal_server_error'
- description?: string
- id?: string
- issues?: components['schemas']['APIErrorObject'][]
- links?: {
- [key: string]: {
- describedby?: string
- href: string
- meta?: {
- [key: string]: unknown
- }
- rel?: string
- title?: string
- type?: string
- }
- }
- /** @constant */
- message: 'Internal Server Error'
- meta?: {
- [key: string]: unknown
- }
- }
- | {
- /** @constant */
- code: 'internal_server_error.event.ingress_failed'
- description?: string
- id?: string
- issues?: components['schemas']['APIErrorObject'][]
- links?: {
- [key: string]: {
- describedby?: string
- href: string
- meta?: {
- [key: string]: unknown
- }
- rel?: string
- title?: string
- type?: string
- }
- }
- /** @constant */
- message: 'Internal Server Error: Failed to ingress the event'
- meta?: {
- [key: string]: unknown
- }
- }
- $defs: {
- APIErrorObject: components['schemas']['APIErrorObject']
- }
- }
- }
- }
- /** @description TemporarilyDisabled */
- 503: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': {
- error: {
- /** @constant */
- code: 'service_unavailable.temporarily_disabled'
- description?: string
- id?: string
- issues?: components['schemas']['APIErrorObject'][]
- links?: {
- [key: string]: {
- describedby?: string
- href: string
- meta?: {
- [key: string]: unknown
- }
- rel?: string
- title?: string
- type?: string
- }
- }
- /** @constant */
- message: 'Service Unavailable: Temporarily disabled'
- meta?: {
- [key: string]: unknown
- }
- }
- $defs: {
- APIErrorObject: components['schemas']['APIErrorObject']
- }
- }
- }
- }
- }
- }
'v2-list-organization-github-connections': {
parameters: {
query?: {
@@ -7463,6 +7241,86 @@ export interface operations {
}
}
}
+ 'v2-create-a-branch': {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['V2CreateBranchRequest']
+ }
+ }
+ responses: {
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['V2BranchResponse_Output']
+ }
+ }
+ /** @description Invalid branch configuration for this project */
+ 400: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Organization plan does not cover the requested branch */
+ 402: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ /** @description Failed to create database branch */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['ErrorResponseBody']
+ }
+ }
+ }
+ }
'v2-get-project-config': {
parameters: {
query?: never
diff --git a/packages/api-types/types/platform.d.ts b/packages/api-types/types/platform.d.ts
index 4f0f82e4971..00e73debf18 100644
--- a/packages/api-types/types/platform.d.ts
+++ b/packages/api-types/types/platform.d.ts
@@ -849,6 +849,23 @@ export interface paths {
patch: operations['VercelConnectionsController_updateVercelConnection']
trace?: never
}
+ '/platform/integrations/vercel/connections/{connection_id}/enable-jit-access': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /** Enables JIT database access for a supabase project with given connection id */
+ post: operations['VercelConnectionsController_enableVercelConnectionJitAccess']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
'/platform/integrations/vercel/connections/{connection_id}/sync-envs': {
parameters: {
query?: never
@@ -4212,13 +4229,13 @@ export interface paths {
get: operations['V2SourcesController_getPublication']
/**
* Create or replace a publication (V2)
- * @description Creates the named publication, or replaces the table configuration of an existing explicit-table publication. Table references use stable Postgres table ids (OIDs), and support optional per-table row filters and column lists. Requires bearer auth and an active, healthy project.
+ * @description Creates the named publication, or replaces the table configuration of an existing explicit-table publication. Table references use stable Postgres table ids (OIDs), and support optional per-table row filters and column lists. Existing open-ended publications cannot be updated, and publish_via_partition_root cannot be changed after creation. Requires bearer auth and an active, healthy project.
*/
put: operations['V2SourcesController_putPublication']
post?: never
/**
* Delete a publication (V2)
- * @description Delete a publication for a source. Requires bearer auth and an active, healthy project.
+ * @description Delete a publication for a source when it exists. Requires bearer auth and an active, healthy project.
*/
delete: operations['V2SourcesController_deletePublication']
options?: never
@@ -4235,7 +4252,7 @@ export interface paths {
}
/**
* List replication-eligible source tables (V2)
- * @description List tables available for a source, including their partition hierarchy. Requires bearer auth and an active, healthy project.
+ * @description List tables available for a source, including their partition hierarchy, optionally restricted to one schema. Requires bearer auth and an active, healthy project.
*/
get: operations['V2SourcesController_getTables']
put?: never
@@ -5240,7 +5257,7 @@ export interface components {
scope?: 'V0'
token_alias: string
}
- AccountRequestDetailsDto: {
+ AccountRequestDetailsDto_Output: {
email: string
email_matches: boolean
expires_at: string
@@ -5259,7 +5276,7 @@ export interface components {
/** @description Identifier of the read replica this PrivateLink share should target. Omit to target the primary database. */
database_identifier?: string
}
- AnalyticsResponse: {
+ AnalyticsResponse_Output: {
error?:
| string
| {
@@ -5276,68 +5293,68 @@ export interface components {
}
result?: unknown[]
}
- ApproveAuthorizationResponse: {
+ ApproveAuthorizationResponse_Output: {
url: string
}
AssignMemberRoleBodyV2: {
role_id: number
role_scoped_projects?: string[]
}
- AuditLogsResponse: {
+ AuditLogsResponse_Output: {
result: {
action: {
metadata?: {
[key: string]: unknown
- }
+ } | null
method: string
name: string
params?: {
[key: string]: unknown
- }
+ } | null
route: string
status: number
}
actor: {
- app_id?: string
- app_name?: string
- email?: string
+ app_id?: string | null
+ app_name?: string | null
+ email?: string | null
/** @description Only present when token_type=app */
- installation_id?: string
- ip?: string
+ installation_id?: string | null
+ ip?: string | null
/** @description JWT issuer. Only present for branching service JWTs */
- jwt_issuer?: string
+ jwt_issuer?: string | null
/** @description JWT subject. Only present for branching service JWTs */
- jwt_subject?: string
- oauth_app_id?: string
- oauth_app_name?: string
+ jwt_subject?: string | null
+ oauth_app_id?: string | null
+ oauth_app_name?: string | null
/** @description Organization whose grant was used. Only present when token_type=oauth */
- organization_id?: string
+ organization_id?: string | null
/** @description Marketplace partner that authenticated the request. Only present when token_type=partner */
- partner?: string
+ partner?: string | null
/** @description The partner's own integration-installation id. Only present when token_type=partner and the integration is already installed. Distinct from installation_id, which is a Supabase platform-app installation */
- partner_installation_id?: string
+ partner_installation_id?: string | null
/** @description Email of the partner user who triggered the action. Only present when token_type=partner and the partner acted on behalf of one of its users */
- partner_user_email?: string
+ partner_user_email?: string | null
/** @description Opaque user identifier in the partner's namespace. Only present when token_type=partner and the partner acted on behalf of one of its users */
- partner_user_id?: string
+ partner_user_id?: string | null
/** @description GoTrue login session. Only present when token_type=jwt */
- session_id?: string
+ session_id?: string | null
/** @description Access token alias, as shown in the dashboard. Only present when token_type=v0, token_type=v1 or token_type=scoped_pat */
- token_alias?: string
- token_hash?: string
+ token_alias?: string | null
+ token_hash?: string | null
/** @description Only present when token_type=scoped_pat */
- token_scope?: string
+ token_scope?: string | null
token_type: string
- user_id?: string
+ user_id?: string | null
}
- organization_slug?: string
- project_ref?: string
+ organization_slug?: string | null
+ project_ref?: string | null
request_id: string
timestamp: number
}[]
retention_period: number
}
- BackendConnectionTest: {
+ BackendConnectionTest_Output: {
'connected?': boolean
reason: string
}
@@ -5383,7 +5400,7 @@ export interface components {
}
}
Buffer: Record<string, never>
- BulkDeleteUserContentResponse: {
+ BulkDeleteUserContentResponse_Output: {
id: string
}
ChangeMFAEnforcementStateRequest: {
@@ -5452,7 +5469,7 @@ export interface components {
payment_intent_id: string
size?: string
}
- ConfirmResponseDto: {
+ ConfirmResponseDto_Output: {
organization_slug: string
success: boolean
}
@@ -5461,12 +5478,14 @@ export interface components {
}
CopyObjectBody: {
from: string
+ /** Format: uuid */
+ sourceVersionId?: string
to: string
}
- CopyObjectResponse: {
+ CopyObjectResponse_Output: {
path: string
}
- CostEstimateResponse: {
+ CostEstimateResponse_Output: {
/**
* @description Currency of all amounts
* @example usd
@@ -5668,7 +5687,460 @@ export interface components {
/** Format: uuid */
parent_id?: string
}
- CreateDestinationPipelineResponse: {
+ CreateDestinationBody: {
+ /** @description Destination configuration */
+ config:
+ | {
+ big_query: {
+ /**
+ * @description Number of concurrent BigQuery Storage Write API connections.
+ * @example 8
+ */
+ connection_pool_size?: number | null
+ /**
+ * @description BigQuery dataset id
+ * @example analytics
+ */
+ dataset_id: string
+ /**
+ * @description Maximum data staleness in minutes
+ * @example 5
+ */
+ max_staleness_mins?: number | null
+ /**
+ * @description BigQuery project id
+ * @example my-gcp-project
+ */
+ project_id: string
+ /** @description BigQuery service account key */
+ service_account_key: string
+ /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
+ table_options?: {
+ tables?: {
+ cluster_by?: string[]
+ partition_by?:
+ | (
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
+ * @enum {string}
+ */
+ kind: 'time_column'
+ }
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Exclusive end of the last partition range
+ * @example 100
+ */
+ end: number
+ /**
+ * @description Width of each partition range
+ * @example 10
+ */
+ interval: number
+ /**
+ * @description Partition by ranges of a replicated integer column
+ * @enum {string}
+ */
+ kind: 'integer_range'
+ /**
+ * @description Inclusive start of the first partition range
+ * @example 0
+ */
+ start: number
+ }
+ | {
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by the time at which BigQuery ingests each row
+ * @enum {string}
+ */
+ kind: 'ingestion_time'
+ }
+ )
+ | null
+ /**
+ * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
+ * @example 16384
+ */
+ table_id: number
+ }[]
+ }
+ }
+ }
+ | {
+ clickhouse: {
+ /**
+ * @description ClickHouse target database
+ * @example analytics
+ */
+ database: string
+ /**
+ * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
+ * @example replacing_merge_tree
+ * @enum {string}
+ */
+ engine?: 'merge_tree' | 'replacing_merge_tree'
+ /** @description ClickHouse password. Omit for passwordless access. */
+ password?: string | null
+ /**
+ * @description ClickHouse HTTPS endpoint URL
+ * @example https://clickhouse.example.com:8443
+ */
+ url: string
+ /**
+ * @description ClickHouse user name
+ * @example default
+ */
+ user: string
+ }
+ }
+ | {
+ iceberg: {
+ supabase: {
+ /**
+ * @description Catalog token
+ * @example A jwt secret
+ */
+ catalog_token: string
+ /**
+ * @description Namespace
+ * @example my-namespace
+ */
+ namespace?: string | null
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ project_ref: string
+ /**
+ * @description S3 access key ID
+ * @example 53383b1d0cdb16a3afa63152656aa3cc
+ */
+ s3_access_key_id: string
+ /**
+ * @description S3 region
+ * @example ap-southeast-1
+ */
+ s3_region: string
+ /**
+ * @description S3 secret access key
+ * @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
+ */
+ s3_secret_access_key: string
+ /**
+ * @description Warehouse name
+ * @example my-warehouse
+ */
+ warehouse_name: string
+ }
+ }
+ }
+ | {
+ ducklake:
+ | {
+ /**
+ * @description DuckLake catalog URL
+ * @example postgres://user:pass@localhost:5432/ducklake_catalog
+ */
+ catalog_url: string
+ /**
+ * @description DuckLake data path
+ * @example s3://<bucket-name>/
+ */
+ data_path: string
+ /**
+ * @description Schema used for DuckLake metadata tables stored in PostgreSQL
+ * @default ducklake
+ * @example ducklake
+ */
+ metadata_schema?: string
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /**
+ * @description S3-compatible storage access key ID
+ * @example my-access-key
+ */
+ s3_access_key_id?: string | null
+ /**
+ * @description S3-compatible storage endpoint
+ * @example 127.0.0.1:5000/s3
+ */
+ s3_endpoint?: string | null
+ /**
+ * @description S3-compatible storage region
+ * @example us-east-1
+ */
+ s3_region?: string | null
+ /**
+ * @description S3-compatible storage secret access key
+ * @example my-secret-key
+ */
+ s3_secret_access_key?: string | null
+ /**
+ * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
+ * @example path
+ * @enum {string|null}
+ */
+ s3_url_style?: 'path' | 'vhost' | null
+ /**
+ * @description Whether to use SSL for S3-compatible storage
+ * @default true
+ * @example false
+ */
+ s3_use_ssl?: boolean
+ table_sorting?: {
+ tables?: {
+ schema: string
+ sort_by:
+ | {
+ columns: {
+ /**
+ * @description DuckLake sort direction
+ * @example asc
+ * @enum {string}
+ */
+ direction?: 'asc' | 'desc'
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ name: string
+ /**
+ * @description Optional placement of null values in the DuckLake sort order
+ * @example last
+ * @enum {string|null}
+ */
+ nulls?: 'first' | 'last' | null
+ }[]
+ /** @enum {string} */
+ kind: 'columns'
+ }
+ | {
+ /** @enum {string} */
+ kind: 'primary_key'
+ }
+ table: string
+ }[]
+ }
+ }
+ | {
+ catalog:
+ | {
+ /**
+ * @description DuckLake catalog URL
+ * @example postgres://user:pass@localhost:5432/ducklake_catalog
+ */
+ catalog_url: string
+ /**
+ * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
+ * @example ducklake
+ */
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /** @enum {string} */
+ type: 'postgres_url'
+ }
+ | {
+ /**
+ * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
+ * @example ducklake
+ */
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /**
+ * @description Supabase project ref used as the DuckLake PostgreSQL catalog
+ * @example abcjuqabhgwjjutfvtpa
+ */
+ project_ref: string
+ /** @enum {string} */
+ type: 'supabase_project'
+ }
+ /**
+ * @description Schema used for DuckLake metadata tables stored in PostgreSQL
+ * @default ducklake
+ * @example ducklake
+ */
+ metadata_schema?: string
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ storage:
+ | {
+ /**
+ * @description DuckLake data path
+ * @example s3://<bucket-name>/
+ */
+ data_path: string
+ /**
+ * @description S3-compatible storage access key ID
+ * @example my-access-key
+ */
+ s3_access_key_id: string
+ /**
+ * @description S3-compatible storage endpoint
+ * @example 127.0.0.1:5000/s3
+ */
+ s3_endpoint: string
+ /**
+ * @description S3-compatible storage region
+ * @example us-east-1
+ */
+ s3_region: string
+ /**
+ * @description S3-compatible storage secret access key
+ * @example my-secret-key
+ */
+ s3_secret_access_key: string
+ /**
+ * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
+ * @example path
+ * @enum {string|null}
+ */
+ s3_url_style?: 'path' | 'vhost' | null
+ /**
+ * @description Whether to use SSL for S3-compatible storage
+ * @default true
+ * @example false
+ */
+ s3_use_ssl?: boolean
+ /** @enum {string} */
+ type: 's3'
+ }
+ | {
+ /**
+ * @description Storage bucket id used for DuckLake data files
+ * @example ducklake
+ */
+ bucket: string
+ /**
+ * @description Optional description for the generated Supabase Storage S3 credential
+ * @example DuckLake replication destination
+ */
+ credential_description?: string
+ /**
+ * @description Optional path prefix inside the bucket for DuckLake data files
+ * @example replication
+ */
+ path?: string
+ /**
+ * @description Supabase project ref whose Object Storage S3 API stores DuckLake data files
+ * @example abcjuqabhgwjjutfvtpa
+ */
+ project_ref: string
+ /** @enum {string} */
+ type: 'supabase_storage'
+ }
+ table_sorting?: {
+ tables?: {
+ schema: string
+ sort_by:
+ | {
+ columns: {
+ /**
+ * @description DuckLake sort direction
+ * @example asc
+ * @enum {string}
+ */
+ direction?: 'asc' | 'desc'
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ name: string
+ /**
+ * @description Optional placement of null values in the DuckLake sort order
+ * @example last
+ * @enum {string|null}
+ */
+ nulls?: 'first' | 'last' | null
+ }[]
+ /** @enum {string} */
+ kind: 'columns'
+ }
+ | {
+ /** @enum {string} */
+ kind: 'primary_key'
+ }
+ table: string
+ }[]
+ }
+ }
+ }
+ | {
+ snowflake: {
+ /**
+ * @description Snowflake account identifier
+ * @example MYORG-MYACCOUNT
+ */
+ account_id: string
+ /**
+ * @description Snowflake target database
+ * @example ANALYTICS
+ */
+ database: string
+ /** @description Snowflake RSA private key PEM contents */
+ private_key: string
+ /** @description Optional passphrase for encrypted private keys */
+ private_key_passphrase?: string | null
+ /**
+ * @description Optional Snowflake role
+ * @example PIPELINES_ROLE
+ */
+ role?: string | null
+ /**
+ * @description Snowflake target schema
+ * @example PUBLIC
+ */
+ schema: string
+ /**
+ * @description Snowflake user configured for key-pair authentication
+ * @example PIPELINES_USER
+ */
+ user: string
+ }
+ }
+ /**
+ * @description Destination name
+ * @example bq-analytics
+ */
+ name: string
+ }
+ CreateDestinationPipelineResponse_Output: {
/**
* @description Destination id
* @example 2001
@@ -5680,7 +6152,7 @@ export interface components {
*/
pipeline_id: number
}
- CreateDestinationResponse: {
+ CreateDestinationResponse_Output: {
/**
* @description Destination id
* @example 2001
@@ -5809,7 +6281,7 @@ export interface components {
}[]
}
CreateNotificationExceptionsResponse_Output: {
- exceptions: ({
+ exceptions: {
/** Format: uuid */
assigned_to: string | null
/** Format: uuid */
@@ -5826,15 +6298,13 @@ export interface components {
lint_name: string | null
note: string | null
project_ref: string
- } & {
- [key: string]: unknown
- })[]
+ }[]
}
CreateOAuthAppBody: {
icon?: string
name: string
redirect_uris: string[]
- scopes?: (
+ scopes: (
| 'analytics:read'
| 'analytics:write'
| 'analytics_config:read'
@@ -5862,7 +6332,7 @@ export interface components {
)[]
website: string
}
- CreateOAuthAppClientSecretResponse: {
+ CreateOAuthAppClientSecretResponse_Output: {
client_secret: string
client_secret_alias: string
/** Format: date-time */
@@ -5883,6 +6353,13 @@ export interface components {
id: string
redirect_uris: string[]
}
+ CreateOAuthAppResponse_Output: {
+ client_id: string
+ client_secret: string
+ client_secret_expires_at: number
+ id: string
+ redirect_uris: string[]
+ }
CreateOrganizationBody: {
address?: {
city?: string | null
@@ -5911,7 +6388,129 @@ export interface components {
| 'tier_enterprise'
| 'tier_platform'
}
- CreatePipelineResponse: {
+ CreatePipelineBody: {
+ /** @description Pipeline configuration */
+ config: {
+ /** @description Batch configuration. Omit or use `null` for server defaults. */
+ batch?: {
+ /**
+ * @description Maximum preferred byte size for one source batch
+ * @example 8388608
+ */
+ max_bytes?: number
+ /**
+ * @description Maximum fill time in milliseconds
+ * @example 200
+ */
+ max_fill_ms?: number
+ /**
+ * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
+ * @example 0.2
+ */
+ memory_budget_ratio?: number
+ } | null
+ /**
+ * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
+ * @example error
+ * @enum {string|null}
+ */
+ invalidated_slot_behavior?: 'error' | 'recreate' | null
+ /**
+ * @description Replicator log level
+ * @example info
+ * @enum {string|null}
+ */
+ log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
+ /** @description Maximum number of copy connections per table */
+ max_copy_connections_per_table?: number | null
+ /** @description Maximum number of table sync workers */
+ max_table_sync_workers?: number | null
+ /** @description Memory-based backpressure configuration. Omission enables server defaults; `null` disables it. */
+ memory_backpressure?: {
+ /**
+ * @description Memory usage ratio above which backpressure is activated
+ * @example 0.85
+ */
+ activate_threshold: number
+ /**
+ * @description Memory usage ratio below which backpressure is released
+ * @example 0.75
+ */
+ resume_threshold: number
+ } | null
+ /**
+ * @description Milliseconds between one memory usage refresh and another
+ * @example 100
+ */
+ memory_refresh_interval_ms?: number | null
+ /**
+ * @description Publication name
+ * @example pub_orders
+ */
+ publication_name: string
+ /**
+ * @description Milliseconds between one replication lag refresh and another
+ * @example 10000
+ */
+ replication_lag_refresh_interval_ms?: number | null
+ /**
+ * @description Milliseconds between one retry and another for timed worker retries
+ * @example 10000
+ */
+ table_error_retry_delay_ms?: number | null
+ /**
+ * @description Maximum number of automatic timed retry attempts
+ * @example 5
+ */
+ table_error_retry_max_attempts?: number | null
+ /** @description Selection rules for tables participating in initial table copy. Omit or use `null` to copy all tables. */
+ table_sync_copy?:
+ | (
+ | {
+ /** @enum {string} */
+ type: 'include_all_tables'
+ }
+ | {
+ /** @enum {string} */
+ type: 'skip_all_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be performed
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'include_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be skipped
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'skip_tables'
+ }
+ )
+ | null
+ }
+ /**
+ * @description Destination id
+ * @example 2001
+ */
+ destination_id: number
+ /**
+ * @description Source id
+ * @example 3001
+ */
+ source_id: number
+ }
+ CreatePipelineResponse_Output: {
/**
* @description Pipeline id
* @example 1012
@@ -5944,6 +6543,7 @@ export interface components {
| 'analytics_logs_read'
| 'analytics_usage_read'
| 'api_gateway_keys_read'
+ | 'api_gateway_keys_secret_read'
| 'api_gateway_keys_write'
| 'auth_config_read'
| 'auth_config_write'
@@ -5962,6 +6562,7 @@ export interface components {
| 'custom_domain_read'
| 'custom_domain_write'
| 'data_api_config_read'
+ | 'data_api_config_secret_read'
| 'data_api_config_write'
| 'database_read'
| 'database_write'
@@ -6009,7 +6610,7 @@ export interface components {
| 'workers_write'
)[]
}
- CreatePlatformAppResponse: {
+ CreatePlatformAppResponse_Output: {
/** Format: date-time */
created_at: string
/** Format: uuid */
@@ -6022,7 +6623,7 @@ export interface components {
/** Format: date-time */
updated_at: string
}
- CreatePlatformAppSigningKeyResponse: {
+ CreatePlatformAppSigningKeyResponse_Output: {
/** Format: date-time */
created_at: string
/** Format: uuid */
@@ -6236,7 +6837,7 @@ export interface components {
*/
release_channel?: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
}
- CreateProjectResponse: {
+ CreateProjectResponse_Output: {
anon_key: string
cloud_provider: string
disk_volume_size_gb?: number
@@ -6277,9 +6878,29 @@ export interface components {
status: string
subscription_id: string | null
}
- CreateReplicationDestinationBody: {
+ CreatePublicationBody: {
+ /**
+ * @description Publication name
+ * @example pub_orders
+ */
+ name: string
+ /** @description Publication tables */
+ tables: {
+ /**
+ * @description Table name
+ * @example orders
+ */
+ name: string
+ /**
+ * @description Table schema
+ * @example public
+ */
+ schema: string
+ }[]
+ }
+ CreateReplicationDestinationPipelineBody: {
/** @description Destination configuration */
- config:
+ destination_config:
| {
big_query: {
/**
@@ -6503,425 +7124,40 @@ export interface components {
* @example false
*/
s3_use_ssl?: boolean
- }
- | {
- catalog:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url: string
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /** @enum {string} */
- type: 'postgres_url'
- }
- | {
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description Supabase project ref used as the DuckLake PostgreSQL catalog
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_project'
- }
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @default ducklake
- * @example ducklake
- */
- metadata_schema?: string
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- storage:
- | {
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id: string
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint: string
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region: string
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key: string
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @default true
- * @example false
- */
- s3_use_ssl?: boolean
- /** @enum {string} */
- type: 's3'
- }
- | {
- /**
- * @description Storage bucket id used for DuckLake data files
- * @example ducklake
- */
- bucket: string
- /**
- * @description Optional description for the generated Supabase Storage S3 credential
- * @example DuckLake replication destination
- */
- credential_description?: string
- /**
- * @description Optional path prefix inside the bucket for DuckLake data files
- * @example replication
- */
- path?: string
- /**
- * @description Supabase project ref whose Object Storage S3 API stores DuckLake data files
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_storage'
- }
- }
- }
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id: string
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database: string
- /** @description Snowflake RSA private key PEM contents */
- private_key: string
- /** @description Optional passphrase for encrypted private keys */
- private_key_passphrase?: string | null
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string | null
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema: string
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user: string
- }
- }
- /**
- * @description Destination name
- * @example bq-analytics
- */
- name: string
- }
- CreateReplicationDestinationPipelineBody: {
- /** @description Destination configuration */
- destination_config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size?: number | null
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id: string
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number | null
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id: string
- /** @description BigQuery service account key */
- service_account_key: string
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- }
- }
- }
- | {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database: string
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string}
- */
- engine?: 'merge_tree' | 'replacing_merge_tree'
- /** @description ClickHouse password. Omit for passwordless access. */
- password?: string | null
- /**
- * @description ClickHouse HTTPS endpoint URL
- * @example https://clickhouse.example.com:8443
- */
- url: string
- /**
- * @description ClickHouse user name
- * @example default
- */
- user: string
- }
- }
- | {
- iceberg: {
- supabase: {
- /**
- * @description Catalog token
- * @example A jwt secret
- */
- catalog_token: string
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref: string
- /**
- * @description S3 access key ID
- * @example 53383b1d0cdb16a3afa63152656aa3cc
- */
- s3_access_key_id: string
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region: string
- /**
- * @description S3 secret access key
- * @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
- */
- s3_secret_access_key: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
- }
- }
- }
- | {
- ducklake:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url: string
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @default ducklake
- * @example ducklake
- */
- metadata_schema?: string
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id?: string | null
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string | null
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string | null
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key?: string | null
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @default true
- * @example false
- */
- s3_use_ssl?: boolean
- table_sorting?: {
- tables?: {
- schema: string
- sort_by:
- | {
- columns: {
- /**
- * @description DuckLake sort direction
- * @example asc
- * @enum {string}
- */
- direction?: 'asc' | 'desc'
- /**
- * @description Source column name
- * @example created_at
- */
- name: string
- /**
- * @description Optional placement of null values in the DuckLake sort order
- * @example last
- * @enum {string|null}
- */
- nulls?: 'first' | 'last' | null
- }[]
- /** @enum {string} */
- kind: 'columns'
- }
- | {
- /** @enum {string} */
- kind: 'primary_key'
- }
- table: string
- }[]
- }
+ table_sorting?: {
+ tables?: {
+ schema: string
+ sort_by:
+ | {
+ columns: {
+ /**
+ * @description DuckLake sort direction
+ * @example asc
+ * @enum {string}
+ */
+ direction?: 'asc' | 'desc'
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ name: string
+ /**
+ * @description Optional placement of null values in the DuckLake sort order
+ * @example last
+ * @enum {string|null}
+ */
+ nulls?: 'first' | 'last' | null
+ }[]
+ /** @enum {string} */
+ kind: 'columns'
+ }
+ | {
+ /** @enum {string} */
+ kind: 'primary_key'
+ }
+ table: string
+ }[]
+ }
}
| {
catalog:
@@ -7230,146 +7466,6 @@ export interface components {
*/
source_id: number
}
- CreateReplicationPipelineBody: {
- /** @description Pipeline configuration */
- config: {
- /** @description Batch configuration. Omit or use `null` for server defaults. */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Memory-based backpressure configuration. Omission enables server defaults; `null` disables it. */
- memory_backpressure?: {
- /**
- * @description Memory usage ratio above which backpressure is activated
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Memory usage ratio below which backpressure is released
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name
- * @example pub_orders
- */
- publication_name: string
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Selection rules for tables participating in initial table copy. Omit or use `null` to copy all tables. */
- table_sync_copy?:
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- | never
- }
- /**
- * @description Destination id
- * @example 2001
- */
- destination_id: number
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- }
- CreateReplicationPublicationBody: {
- /**
- * @description Publication name
- * @example pub_orders
- */
- name: string
- /** @description Publication tables */
- tables: {
- /**
- * @description Table name
- * @example orders
- */
- name: string
- /**
- * @description Table schema
- * @example public
- */
- schema: string
- }[]
- }
CreateScopedAccessTokenBody: {
/** Format: date-time */
expires_at?: string
@@ -7398,6 +7494,7 @@ export interface components {
| 'analytics_logs_read'
| 'analytics_usage_read'
| 'api_gateway_keys_read'
+ | 'api_gateway_keys_secret_read'
| 'api_gateway_keys_write'
| 'auth_config_read'
| 'auth_config_write'
@@ -7416,6 +7513,7 @@ export interface components {
| 'custom_domain_read'
| 'custom_domain_write'
| 'data_api_config_read'
+ | 'data_api_config_secret_read'
| 'data_api_config_write'
| 'database_read'
| 'database_write'
@@ -7476,7 +7574,7 @@ export interface components {
token: string
token_alias: string
}
- CreateSourceResponse: {
+ CreateSourceResponse_Output: {
/** @description Source ID */
id: number
}
@@ -7491,11 +7589,13 @@ export interface components {
public: boolean
/** @enum {string} */
type?: 'STANDARD' | 'ANALYTICS'
+ /** @enum {string} */
+ versioning_status?: 'DISABLED' | 'ENABLED'
}
CreateStorageCredentialBody: {
description: string
}
- CreateStorageCredentialResponse: {
+ CreateStorageCredentialResponse_Output: {
access_key: string
description: string
id: string
@@ -7504,7 +7604,7 @@ export interface components {
CreateStorageVectorBucketBody: {
bucketName: string
}
- CreateTenantSourceResponse: {
+ CreateTenantSourceResponse_Output: {
/**
* @description Source id
* @example 3001
@@ -7521,7 +7621,7 @@ export interface components {
email_confirm: boolean
password: string
}
- CreateUserContentFolderResponse: {
+ CreateUserContentFolderResponse_Output: {
id: string
name: string
owner_id: number
@@ -7597,14 +7697,14 @@ export interface components {
source: string
teamId?: string
}
- CreditBalanceResponse: {
+ CreditBalanceResponse_Output: {
billing_via_partner: boolean
total_balance_cents: number
}
CreditRedemptionRequest: {
code: string
}
- CreditRedemptionResponse: {
+ CreditRedemptionResponse_Output: {
amount_cents: number
credits_expire_at: string | null
}
@@ -7627,7 +7727,7 @@ export interface components {
value: string
}
}
- CreditsTopUpResponse: {
+ CreditsTopUpResponse_Output: {
payment_intent_secret?: string
/** @enum {string} */
status:
@@ -7639,7 +7739,7 @@ export interface components {
| 'requires_payment_method'
| 'succeeded'
}
- CustomerResponse: {
+ CustomerResponse_Output: {
additional_emails: string[] | null
address?: {
city?: string | null
@@ -7648,7 +7748,7 @@ export interface components {
line2?: string | null
postal_code?: string | null
state?: string | null
- }
+ } | null
balance: number
billing_name?: string
billing_via_partner: boolean
@@ -7660,13 +7760,13 @@ export interface components {
value: string
} | null
}
- DatabaseDetailResponse: {
+ DatabaseDetailResponse_Output: {
/** @enum {string} */
cloud_provider: 'AWS' | 'AWS_K8S' | 'AWS_NIMBUS'
/** @default null */
- connection_string_read_only?: string | null
+ connection_string_read_only: string | null
/** @default null */
- connectionString?: string | null
+ connectionString: string | null
db_host: string
db_name: string
db_port: number
@@ -7675,7 +7775,7 @@ export interface components {
inserted_at: string
region: string
restUrl: string
- size: string
+ size: string | null
/** @enum {string} */
status:
| 'ACTIVE_HEALTHY'
@@ -7691,7 +7791,7 @@ export interface components {
| 'RESTARTING'
| 'RESIZING'
}
- DatabaseStatusResponse: {
+ DatabaseStatusResponse_Output: {
identifier: string
replicaInitializationStatus?:
| {
@@ -7699,7 +7799,15 @@ export interface components {
baseBackupDownloadEstimateSeconds: number
walArchiveReplayEstimateSeconds: number
}
- progress?: unknown
+ /** @enum {string} */
+ progress?:
+ | '0_requested'
+ | '1_started'
+ | '2_launched_read_replica_instance'
+ | '3_initiated_read_replica_setup'
+ | '4_downloaded_base_backup'
+ | '5_replayed_wal_archives'
+ | '6_completed_read_replica_setup'
/** @enum {string} */
status: 'in_progress'
}
@@ -7708,7 +7816,13 @@ export interface components {
status: 'completed'
}
| {
- error?: unknown
+ /** @enum {string} */
+ error?:
+ | '1_read_replica_instance_launch_failed'
+ | '2_initiate_read_replica_setup_failed'
+ | '3_download_base_backup_failed'
+ | '4_replay_wal_archives_failed'
+ | '5_complete_read_replica_setup_failed'
/** @enum {string} */
status: 'failed'
}
@@ -7727,10 +7841,10 @@ export interface components {
| 'RESTARTING'
| 'RESIZING'
}
- DeclineAuthorizationResponse: {
+ DeclineAuthorizationResponse_Output: {
id: string
}
- DeleteDestinationPipelineResponse: {
+ DeleteDestinationPipelineResponse_Output: {
/**
* @description Whether the destination was deleted. True when no other pipelines remain attached to it.
* @example true
@@ -7747,7 +7861,7 @@ export interface components {
*/
pipeline_id: number
}
- DeleteOAuthAppResponse: {
+ DeleteOAuthAppResponse_Output: {
client_id: string
created_at: string
icon?: string
@@ -7757,73 +7871,671 @@ export interface components {
website: string
}
DeleteObjectsBody: {
- paths: string[]
+ paths: (
+ | string
+ | {
+ path: string
+ /** Format: uuid */
+ versionId: string
+ }
+ )[]
}
DeleteVercelConnectionResponse: {
id: string
}
- DetachPaymentMethodBody: {
- card_id: string
- }
- DiskAutoscaleConfig: {
- /** @description Growth percentage for disk autoscaling */
- growth_percent: number | null
- /** @description Maximum limit the disk size will grow to in GB */
- max_size_gb: number | null
- /** @description Minimum increment size for disk autoscaling in GB */
- min_increment_gb: number | null
- }
- DiskRequestBody: {
- attributes:
- | {
- iops: number
- size_gb: number
- /**
- * @deprecated
- * @description Use throughput_mibps instead. This field incorrectly uses `mbps` but the value is actually MiB/s.
- */
- throughput_mbps?: number
- throughput_mibps?: number
- /** @enum {string} */
- type: 'gp3'
- }
+ DestinationResponse_Output: {
+ /** @description Destination configuration */
+ config:
| {
- iops: number
- size_gb: number
- /** @enum {string} */
- type: 'io2'
+ big_query: {
+ /**
+ * @description Number of concurrent BigQuery Storage Write API connections.
+ * @example 8
+ */
+ connection_pool_size?: number | null
+ /**
+ * @description BigQuery dataset id
+ * @example analytics
+ */
+ dataset_id: string
+ /**
+ * @description Maximum data staleness in minutes
+ * @example 5
+ */
+ max_staleness_mins?: number | null
+ /**
+ * @description BigQuery project id
+ * @example my-gcp-project
+ */
+ project_id: string
+ /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
+ table_options?: {
+ tables?: {
+ cluster_by?: string[]
+ partition_by?:
+ | (
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
+ * @enum {string}
+ */
+ kind: 'time_column'
+ }
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Exclusive end of the last partition range
+ * @example 100
+ */
+ end: number
+ /**
+ * @description Width of each partition range
+ * @example 10
+ */
+ interval: number
+ /**
+ * @description Partition by ranges of a replicated integer column
+ * @enum {string}
+ */
+ kind: 'integer_range'
+ /**
+ * @description Inclusive start of the first partition range
+ * @example 0
+ */
+ start: number
+ }
+ | {
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by the time at which BigQuery ingests each row
+ * @enum {string}
+ */
+ kind: 'ingestion_time'
+ }
+ )
+ | null
+ /**
+ * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
+ * @example 16384
+ */
+ table_id: number
+ }[]
+ }
+ }
}
- }
- DiskResponse: {
- attributes:
| {
- iops: number
- size_gb: number
- /**
- * @deprecated
- * @description Use throughput_mibps instead. This field incorrectly uses `mbps` but the value is actually MiB/s.
- */
- throughput_mbps: number
- throughput_mibps: number
- /** @enum {string} */
- type: 'gp3'
+ clickhouse: {
+ /**
+ * @description ClickHouse target database
+ * @example analytics
+ */
+ database: string
+ /**
+ * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
+ * @example replacing_merge_tree
+ * @enum {string}
+ */
+ engine: 'merge_tree' | 'replacing_merge_tree'
+ /**
+ * @description Persisted ClickHouse HTTP(S) endpoint URL
+ * @example http://clickhouse.example.com:8123
+ */
+ url: string
+ /**
+ * @description ClickHouse user name
+ * @example default
+ */
+ user: string
+ }
}
| {
- iops: number
- size_gb: number
- /** @enum {string} */
- type: 'io2'
+ iceberg:
+ | {
+ supabase: {
+ /**
+ * @description Namespace
+ * @example my-namespace
+ */
+ namespace?: string | null
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ project_ref: string
+ /**
+ * @description S3 region
+ * @example ap-southeast-1
+ */
+ s3_region: string
+ /**
+ * @description Warehouse name
+ * @example my-warehouse
+ */
+ warehouse_name: string
+ }
+ }
+ | {
+ rest: {
+ /**
+ * @description Iceberg REST catalog URI
+ * @example https://catalog.example.com
+ */
+ catalog_uri: string
+ /**
+ * @description Namespace
+ * @example my-namespace
+ */
+ namespace?: string | null
+ /**
+ * @description S3-compatible storage endpoint
+ * @example https://s3.example.com
+ */
+ s3_endpoint: string
+ /**
+ * @description Warehouse name
+ * @example my-warehouse
+ */
+ warehouse_name: string
+ }
+ }
}
- last_modified_at?: string
- requested_modification?:
| {
- iops: number
- size_gb: number
- /**
- * @deprecated
- * @description Use throughput_mibps instead. This field incorrectly uses `mbps` but the value is actually MiB/s.
- */
- throughput_mbps: number
+ ducklake: {
+ /**
+ * @description Persisted DuckLake data path
+ * @example s3://<bucket-name>/
+ */
+ data_path: string
+ /**
+ * @description Persisted DuckLake metadata schema
+ * @example ducklake
+ */
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /**
+ * @description Persisted S3-compatible storage endpoint
+ * @example 127.0.0.1:5000/s3
+ */
+ s3_endpoint?: string | null
+ /**
+ * @description S3-compatible storage region
+ * @example us-east-1
+ */
+ s3_region?: string | null
+ /**
+ * @description Persisted S3 URL style
+ * @example path
+ */
+ s3_url_style?: string | null
+ /**
+ * @description Whether to use SSL for S3-compatible storage
+ * @example false
+ */
+ s3_use_ssl?: boolean | null
+ table_sorting?: {
+ tables: {
+ schema: string
+ sort_by:
+ | {
+ columns: {
+ /**
+ * @description DuckLake sort direction
+ * @example asc
+ * @enum {string}
+ */
+ direction: 'asc' | 'desc'
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ name: string
+ /**
+ * @description Optional placement of null values in the DuckLake sort order
+ * @example last
+ * @enum {string|null}
+ */
+ nulls?: 'first' | 'last' | null
+ }[]
+ /** @enum {string} */
+ kind: 'columns'
+ }
+ | {
+ /** @enum {string} */
+ kind: 'primary_key'
+ }
+ table: string
+ }[]
+ }
+ }
+ }
+ | {
+ snowflake: {
+ /**
+ * @description Snowflake account identifier
+ * @example MYORG-MYACCOUNT
+ */
+ account_id: string
+ /**
+ * @description Snowflake target database
+ * @example ANALYTICS
+ */
+ database: string
+ /**
+ * @description Optional Snowflake role
+ * @example PIPELINES_ROLE
+ */
+ role?: string | null
+ /**
+ * @description Snowflake target schema
+ * @example PUBLIC
+ */
+ schema: string
+ /**
+ * @description Snowflake user configured for key-pair authentication
+ * @example PIPELINES_USER
+ */
+ user: string
+ }
+ }
+ /**
+ * @description Destination id
+ * @example 2001
+ */
+ id: number
+ /**
+ * @description Destination name
+ * @example bq-analytics
+ */
+ name: string
+ /**
+ * @description Tenant id
+ * @example tenant_9f3a2c
+ */
+ tenant_id: string
+ }
+ DestinationsResponse_Output: {
+ /** @description List of destinations */
+ destinations: {
+ /** @description Destination configuration */
+ config:
+ | {
+ big_query: {
+ /**
+ * @description Number of concurrent BigQuery Storage Write API connections.
+ * @example 8
+ */
+ connection_pool_size?: number | null
+ /**
+ * @description BigQuery dataset id
+ * @example analytics
+ */
+ dataset_id: string
+ /**
+ * @description Maximum data staleness in minutes
+ * @example 5
+ */
+ max_staleness_mins?: number | null
+ /**
+ * @description BigQuery project id
+ * @example my-gcp-project
+ */
+ project_id: string
+ /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
+ table_options?: {
+ tables?: {
+ cluster_by?: string[]
+ partition_by?:
+ | (
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
+ * @enum {string}
+ */
+ kind: 'time_column'
+ }
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Exclusive end of the last partition range
+ * @example 100
+ */
+ end: number
+ /**
+ * @description Width of each partition range
+ * @example 10
+ */
+ interval: number
+ /**
+ * @description Partition by ranges of a replicated integer column
+ * @enum {string}
+ */
+ kind: 'integer_range'
+ /**
+ * @description Inclusive start of the first partition range
+ * @example 0
+ */
+ start: number
+ }
+ | {
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by the time at which BigQuery ingests each row
+ * @enum {string}
+ */
+ kind: 'ingestion_time'
+ }
+ )
+ | null
+ /**
+ * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
+ * @example 16384
+ */
+ table_id: number
+ }[]
+ }
+ }
+ }
+ | {
+ clickhouse: {
+ /**
+ * @description ClickHouse target database
+ * @example analytics
+ */
+ database: string
+ /**
+ * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
+ * @example replacing_merge_tree
+ * @enum {string}
+ */
+ engine: 'merge_tree' | 'replacing_merge_tree'
+ /**
+ * @description Persisted ClickHouse HTTP(S) endpoint URL
+ * @example http://clickhouse.example.com:8123
+ */
+ url: string
+ /**
+ * @description ClickHouse user name
+ * @example default
+ */
+ user: string
+ }
+ }
+ | {
+ iceberg:
+ | {
+ supabase: {
+ /**
+ * @description Namespace
+ * @example my-namespace
+ */
+ namespace?: string | null
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ project_ref: string
+ /**
+ * @description S3 region
+ * @example ap-southeast-1
+ */
+ s3_region: string
+ /**
+ * @description Warehouse name
+ * @example my-warehouse
+ */
+ warehouse_name: string
+ }
+ }
+ | {
+ rest: {
+ /**
+ * @description Iceberg REST catalog URI
+ * @example https://catalog.example.com
+ */
+ catalog_uri: string
+ /**
+ * @description Namespace
+ * @example my-namespace
+ */
+ namespace?: string | null
+ /**
+ * @description S3-compatible storage endpoint
+ * @example https://s3.example.com
+ */
+ s3_endpoint: string
+ /**
+ * @description Warehouse name
+ * @example my-warehouse
+ */
+ warehouse_name: string
+ }
+ }
+ }
+ | {
+ ducklake: {
+ /**
+ * @description Persisted DuckLake data path
+ * @example s3://<bucket-name>/
+ */
+ data_path: string
+ /**
+ * @description Persisted DuckLake metadata schema
+ * @example ducklake
+ */
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /**
+ * @description Persisted S3-compatible storage endpoint
+ * @example 127.0.0.1:5000/s3
+ */
+ s3_endpoint?: string | null
+ /**
+ * @description S3-compatible storage region
+ * @example us-east-1
+ */
+ s3_region?: string | null
+ /**
+ * @description Persisted S3 URL style
+ * @example path
+ */
+ s3_url_style?: string | null
+ /**
+ * @description Whether to use SSL for S3-compatible storage
+ * @example false
+ */
+ s3_use_ssl?: boolean | null
+ table_sorting?: {
+ tables: {
+ schema: string
+ sort_by:
+ | {
+ columns: {
+ /**
+ * @description DuckLake sort direction
+ * @example asc
+ * @enum {string}
+ */
+ direction: 'asc' | 'desc'
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ name: string
+ /**
+ * @description Optional placement of null values in the DuckLake sort order
+ * @example last
+ * @enum {string|null}
+ */
+ nulls?: 'first' | 'last' | null
+ }[]
+ /** @enum {string} */
+ kind: 'columns'
+ }
+ | {
+ /** @enum {string} */
+ kind: 'primary_key'
+ }
+ table: string
+ }[]
+ }
+ }
+ }
+ | {
+ snowflake: {
+ /**
+ * @description Snowflake account identifier
+ * @example MYORG-MYACCOUNT
+ */
+ account_id: string
+ /**
+ * @description Snowflake target database
+ * @example ANALYTICS
+ */
+ database: string
+ /**
+ * @description Optional Snowflake role
+ * @example PIPELINES_ROLE
+ */
+ role?: string | null
+ /**
+ * @description Snowflake target schema
+ * @example PUBLIC
+ */
+ schema: string
+ /**
+ * @description Snowflake user configured for key-pair authentication
+ * @example PIPELINES_USER
+ */
+ user: string
+ }
+ }
+ /**
+ * @description Destination id
+ * @example 2001
+ */
+ id: number
+ /**
+ * @description Destination name
+ * @example bq-analytics
+ */
+ name: string
+ /**
+ * @description Tenant id
+ * @example tenant_9f3a2c
+ */
+ tenant_id: string
+ }[]
+ }
+ DetachPaymentMethodBody: {
+ card_id: string
+ }
+ DiskAutoscaleConfig_Output: {
+ /** @description Growth percentage for disk autoscaling */
+ growth_percent: number | null
+ /** @description Maximum limit the disk size will grow to in GB */
+ max_size_gb: number | null
+ /** @description Minimum increment size for disk autoscaling in GB */
+ min_increment_gb: number | null
+ }
+ DiskRequestBody: {
+ attributes:
+ | {
+ iops: number
+ size_gb: number
+ /**
+ * @deprecated
+ * @description Use throughput_mibps instead. This field incorrectly uses `mbps` but the value is actually MiB/s.
+ */
+ throughput_mbps?: number
+ throughput_mibps?: number
+ /** @enum {string} */
+ type: 'gp3'
+ }
+ | {
+ iops: number
+ size_gb: number
+ /** @enum {string} */
+ type: 'io2'
+ }
+ }
+ DiskResponse_Output: {
+ attributes:
+ | {
+ iops: number
+ size_gb: number
+ /**
+ * @deprecated
+ * @description Use throughput_mibps instead. This field incorrectly uses `mbps` but the value is actually MiB/s.
+ */
+ throughput_mbps: number
+ throughput_mibps: number
+ /** @enum {string} */
+ type: 'gp3'
+ }
+ | {
+ iops: number
+ size_gb: number
+ /** @enum {string} */
+ type: 'io2'
+ }
+ last_modified_at?: string
+ requested_modification?:
+ | {
+ iops: number
+ size_gb: number
+ /**
+ * @deprecated
+ * @description Use throughput_mibps instead. This field incorrectly uses `mbps` but the value is actually MiB/s.
+ */
+ throughput_mbps: number
throughput_mibps: number
/** @enum {string} */
type: 'gp3'
@@ -7835,7 +8547,7 @@ export interface components {
type: 'io2'
}
}
- DiskUtilMetricsResponse: {
+ DiskUtilMetricsResponse_Output: {
metrics: {
fs_avail_bytes: number
fs_size_bytes: number
@@ -7877,15 +8589,15 @@ export interface components {
chatId: string
conversationId: string
}
- GetArchiveResponse: {
+ GetArchiveResponse_Output: {
archive_empty: boolean
file_url: string
fileUrl: string
}
- GetCloudMarketplaceRedirectUrlResponse: {
+ GetCloudMarketplaceRedirectUrlResponse_Output: {
url: string
}
- GetContentCountV2Response: {
+ GetContentCountV2Response_Output: {
favorites: number
private: number
shared: number
@@ -7902,7 +8614,7 @@ export interface components {
/** @description Blob SHA of the config file, to detect changes between requests. */
sha: string
}
- GetJwtSecretUpdateStatus: {
+ GetJwtSecretUpdateStatus_Output: {
update_status: {
change_tracking_id: string
error?: 0 | 1 | 2 | 3 | 4 | 5
@@ -7950,7 +8662,12 @@ export interface components {
}
GetObjectsBody: {
options?: {
+ /** @enum {string} */
+ deleteMarkers?: 'exclude' | 'include' | 'only'
+ exactMatch?: boolean
limit?: number
+ /** @enum {string} */
+ noncurrentVersions?: 'exclude' | 'include' | 'only'
offset?: number
search?: string
sortBy?: {
@@ -7962,8 +8679,13 @@ export interface components {
}
GetObjectsV2Body: {
cursor?: string
+ /** @enum {string} */
+ deleteMarkers?: 'exclude' | 'include' | 'only'
+ exactMatch?: boolean
/** @default 1000 */
limit?: number
+ /** @enum {string} */
+ noncurrentVersions?: 'exclude' | 'include' | 'only'
prefix?: string
sortBy?: {
/** @enum {string} */
@@ -8007,7 +8729,7 @@ export interface components {
| {
[key: string]: components['schemas']['GetOrganizationIntegrationResponseJsonValue']
}
- GetPlatformAppInstallationResponse: {
+ GetPlatformAppInstallationResponse_Output: {
/** Format: uuid */
app_id: string
/** Format: date-time */
@@ -8021,7 +8743,7 @@ export interface components {
/** Format: date-time */
updated_at: string
}
- GetPlatformAppResponse: {
+ GetPlatformAppResponse_Output: {
/** Format: date-time */
created_at: string
/** Format: uuid */
@@ -8034,7 +8756,7 @@ export interface components {
/** Format: date-time */
updated_at: string
}
- GetPostgrestConfigResponse: {
+ GetPostgrestConfigResponse_Output: {
db_anon_role: string
db_extra_search_path: string
db_schema: string
@@ -8042,7 +8764,7 @@ export interface components {
max_rows: number
role_claim_key: string
}
- GetPrivateLinkResponse: {
+ GetPrivateLinkResponse_Output: {
private_link_associations: {
account_name?: string
aws_account_id: string
@@ -8084,7 +8806,7 @@ export interface components {
| 'DELETING'
}[]
}
- GetProjectLintsResponse: ({
+ GetProjectLintsResponse_Output: {
cache_key: string
categories: ('PERFORMANCE' | 'SECURITY' | 'HEALTH')[]
description: string
@@ -8110,8 +8832,6 @@ export interface components {
| 'extension'
| 'compliance'
| 'health'
- } & {
- [key: string]: unknown
}
/** @enum {string} */
name:
@@ -8161,9 +8881,7 @@ export interface components {
observed_at?: string
remediation: string
title: string
- } & {
- [key: string]: unknown
- })[]
+ }[]
GetProjectLogsBody: {
iso_timestamp_end?: string
iso_timestamp_start?: string
@@ -8245,6 +8963,8 @@ export interface components {
resize?: 'cover' | 'contain' | 'fill'
width?: number
}
+ /** Format: uuid */
+ versionId?: string
}
path: string
}
@@ -8285,6 +9005,8 @@ export interface components {
resize?: 'cover' | 'contain' | 'fill'
width?: number
}
+ /** Format: uuid */
+ versionId?: string
}
path: string
}
@@ -8296,7 +9018,7 @@ export interface components {
}
path: string[]
}
- GetStorageCredentialsResponse: {
+ GetStorageCredentialsResponse_Output: {
data: {
created_at: string
description: string
@@ -8309,7 +9031,6 @@ export interface components {
price: number
supabase_prod_id: string
}[]
- billing_cycle_anchor: number
/** @enum {string} */
billing_partner?: 'aws_marketplace' | 'vercel_marketplace'
billing_via_partner: boolean
@@ -8379,12 +9100,6 @@ export interface components {
name: string
ref: string
}[]
- scheduled_plan_change: {
- at: string
- /** @enum {string} */
- target_plan: 'free' | 'pro' | 'team' | 'enterprise' | 'platform'
- usage_billing_enabled: boolean
- } | null
usage_billing_enabled: boolean
}
/** @description Any JSON-serializable value */
@@ -8394,16 +9109,16 @@ export interface components {
| {
[key: string]: components['schemas']['GetSubscriptionResponseJsonValue']
}
- GetUserContentByIdResponse: {
- content: {
+ GetUserContentByIdResponse_Output: {
+ content?: {
[key: string]: unknown
- }
- description?: string
+ } | null
+ description?: string | null
favorite: boolean
folder_id?: string | null
id: string
inserted_at: string
- last_updated_by?: number
+ last_updated_by?: number | null
name: string
owner_id: number
project_id: number
@@ -8413,16 +9128,16 @@ export interface components {
/** @enum {string} */
visibility: 'user' | 'project' | 'org' | 'public'
}
- GetUserContentFolderResponse: {
+ GetUserContentFolderResponse_Output: {
cursor?: string
data: {
contents: {
- description?: string
+ description?: string | null
favorite: boolean
folder_id?: string | null
id: string
inserted_at: string
- last_updated_by?: number
+ last_updated_by?: number | null
name: string
owner_id: number
project_id: number
@@ -8441,18 +9156,18 @@ export interface components {
}[]
}
}
- GetUserContentResponse: {
+ GetUserContentResponse_Output: {
cursor?: string
data: {
- content: {
+ content?: {
[key: string]: unknown
- }
- description?: string
+ } | null
+ description?: string | null
favorite: boolean
folder_id?: string | null
id: string
inserted_at: string
- last_updated_by?: number
+ last_updated_by?: number | null
name: string
owner: {
id: number
@@ -8466,7 +9181,7 @@ export interface components {
updated_by: {
id: number
username: string
- }
+ } | null
/** @enum {string} */
visibility: 'user' | 'project' | 'org' | 'public'
}[]
@@ -8799,7 +9514,7 @@ export interface components {
/** Format: uuid */
app_id: string
}
- InstallPlatformAppResponse: {
+ InstallPlatformAppResponse_Output: {
/** Format: uuid */
app_id: string
/** Format: date-time */
@@ -8812,7 +9527,7 @@ export interface components {
/** Format: date-time */
updated_at: string
}
- InvitationByTokenResponse: {
+ InvitationByTokenResponse_Output: {
authorized_user: boolean
email_match: boolean
expired_token: boolean
@@ -8821,7 +9536,7 @@ export interface components {
sso_mismatch: boolean
token_does_not_exist: boolean
}
- InvitationResponse: {
+ InvitationResponse_Output: {
invitations: {
id: number
invited_at: string
@@ -8829,10 +9544,10 @@ export interface components {
role_id: number
}[]
}
- Invoice: {
+ Invoice_Output: {
amount_due: number
id: string
- invoice_pdf: string
+ invoice_pdf: string | null
number: string
payment_attempted: boolean
payment_is_processing: boolean
@@ -8841,14 +9556,21 @@ export interface components {
subscription: string | null
subtotal: number
}
- InvoicePaymentLinkResponse: {
+ InvoicePaymentLinkResponse_Output: {
redirectUrl: string
}
- InvoiceReceiptResponse: {
+ InvoiceReceiptResponse_Output: {
/** Format: uri */
receipt_pdf: string
}
- LFBackend: {
+ /** @description Any JSON-serializable value */
+ JsonValue_Output:
+ | ((string | number | boolean) | null)
+ | components['schemas']['JsonValue_Output'][]
+ | {
+ [key: string]: components['schemas']['JsonValue_Output']
+ }
+ LFBackend_Output: {
config:
| {
gzip?: boolean
@@ -8941,7 +9663,7 @@ export interface components {
LinkClazarBuyerBody: {
buyer_id: string
}
- ListEntitlementsResponse: {
+ ListEntitlementsResponse_Output: {
entitlements: {
config:
| {
@@ -9069,7 +9791,7 @@ export interface components {
}[]
}
ListNotificationExceptionsResponse_Output: {
- exceptions: ({
+ exceptions: {
/** Format: uuid */
assigned_to: string | null
/** Format: uuid */
@@ -9086,11 +9808,9 @@ export interface components {
lint_name: string | null
note: string | null
project_ref: string
- } & {
- [key: string]: unknown
- })[]
+ }[]
}
- ListOAuthAppClientSecretsResponse: {
+ ListOAuthAppClientSecretsResponse_Output: {
client_secrets: {
client_secret_alias: string
/** Format: date-time */
@@ -9105,7 +9825,7 @@ export interface components {
oauth_app_id: string
}[]
}
- ListPlatformAppInstallationsResponse: {
+ ListPlatformAppInstallationsResponse_Output: {
installations: {
/** Format: uuid */
app_id: string
@@ -9120,7 +9840,7 @@ export interface components {
updated_at: string
}[]
}
- ListPlatformAppSigningKeysResponse: {
+ ListPlatformAppSigningKeysResponse_Output: {
keys: {
/** Format: uuid */
app_id: string
@@ -9135,7 +9855,7 @@ export interface components {
last_used_at: string | null
}[]
}
- ListPlatformAppsResponse: {
+ ListPlatformAppsResponse_Output: {
apps: {
/** Format: date-time */
created_at: string
@@ -9149,7 +9869,7 @@ export interface components {
updated_at: string
}[]
}
- ListProjectsPaginatedResponse: {
+ ListProjectsPaginatedResponse_Output: {
pagination: {
/** @description Total number of projects. Use this to calculate the total number of pages. */
count: number
@@ -9202,7 +9922,7 @@ export interface components {
name: string
}[]
}
- LoadBalancerDetailResponse: {
+ LoadBalancerDetailResponse_Output: {
databases: {
identifier: string
status: string
@@ -9217,7 +9937,7 @@ export interface components {
MarkSensitiveBody: {
is_sensitive: boolean
}
- Member: {
+ Member_Output: {
avatar_url: string | null
gotrue_id: string
is_sso_user: boolean | null
@@ -9229,24 +9949,26 @@ export interface components {
role_ids: number[]
username: string
}
- MemberWithFreeProjectLimit: {
+ MemberWithFreeProjectLimit_Output: {
free_project_limit: number
primary_email: string
username: string
}
- MfaStatusResponse: {
+ MfaStatusResponse_Output: {
enforced: boolean
}
MoveObjectBody: {
from: string
+ /** Format: uuid */
+ sourceVersionId?: string
to: string
}
- NamespacesResponse: {
+ NamespacesResponse_Output: {
data: {
namespace: string[]
}[]
}
- NamespaceTableResponse: {
+ NamespaceTableResponse_Output: {
'current-schema-id': number
'current-snapshot-id'?: number
'default-sort-order-id'?: number
@@ -9299,7 +10021,7 @@ export interface components {
has_warning: boolean
unread_count: number
}
- OAuthAppResponse: {
+ OAuthAppResponse_Output: {
app_id?: string
authorized_at?: string
client_id?: string
@@ -9346,7 +10068,7 @@ export interface components {
size?: string
slug: string
}
- OrganizationProjectsResponse: {
+ OrganizationProjectsResponse_Output: {
pagination: {
/** @description Total number of projects. Use this to calculate the total number of pages. */
count: number
@@ -9430,7 +10152,7 @@ export interface components {
| 'RESIZING'
}[]
}
- OrganizationResponse: {
+ OrganizationResponse_Output: {
billing_email: string | null
/** @enum {string|null} */
billing_partner: 'aws_marketplace' | 'vercel_marketplace' | null
@@ -9449,7 +10171,49 @@ export interface components {
}
requires_indirect_tax_declaration: boolean
restriction_data: {
- [key: string]: string
+ /** Format: date-time */
+ billing_period_end?: string
+ /** Format: date-time */
+ grace_period_end?: string
+ grace_period_manually_extended?: boolean
+ /** Format: date-time */
+ lifted_at?: string
+ reason?: string
+ /** Format: date */
+ report_date?: string
+ restrictions?: 'drop_requests_402'[]
+ usage_stats?: {
+ /** Format: date */
+ report_date: string
+ total_auth_billing_period_mau_billing_period?: number
+ total_cached_egress_gb_billing_period?: number
+ total_db_size_gb_billing_period?: number
+ total_func_invocations_billing_period?: number
+ total_log_query_gb_billing_period?: number
+ total_realtime_message_count_billing_period?: number
+ total_realtime_peak_connection_billing_period?: number
+ total_regular_egress_gb_billing_period?: number
+ total_storage_size_gb_billing_period?: number
+ }
+ violation_data?: {
+ [key: string]: {
+ current: number
+ limit: number
+ }
+ }
+ violations?: (
+ | 'exceed_db_size_quota'
+ | 'exceed_egress_quota'
+ | 'exceed_cached_egress_quota'
+ | 'exceed_edge_functions_count_quota'
+ | 'exceed_edge_functions_invocations_quota'
+ | 'exceed_monthly_active_users_quota'
+ | 'exceed_realtime_connection_count_quota'
+ | 'exceed_realtime_message_count_quota'
+ | 'exceed_storage_size_quota'
+ | 'exceed_log_query_quota'
+ | 'overdue_payment'
+ )[]
} | null
/** @enum {string|null} */
restriction_status: 'grace_period' | 'grace_period_over' | 'restricted' | null
@@ -9458,7 +10222,7 @@ export interface components {
subscription_id: string | null
usage_billing_enabled: boolean
}
- OrganizationRoleResponse: {
+ OrganizationRoleResponse_Output: {
org_scoped_roles: {
base_role_id: number
description: string | null
@@ -9493,7 +10257,7 @@ export interface components {
provider: 'AWS' | 'AWS_K8S' | 'AWS_NIMBUS'
region: string
}
- OrganizationSlugAvailableVersionsResponse: {
+ OrganizationSlugAvailableVersionsResponse_Output: {
available_versions: {
/** @enum {string} */
postgres_engine: '15' | '17' | '17-oriole'
@@ -9502,7 +10266,7 @@ export interface components {
version: string
}[]
}
- OrganizationSlugResponse: {
+ OrganizationSlugResponse_Output: {
billing_email: string | null
/** @enum {string|null} */
billing_partner: 'aws_marketplace' | 'vercel_marketplace' | null
@@ -9517,14 +10281,56 @@ export interface components {
name: string
}
restriction_data: {
- [key: string]: unknown
+ /** Format: date-time */
+ billing_period_end?: string
+ /** Format: date-time */
+ grace_period_end?: string
+ grace_period_manually_extended?: boolean
+ /** Format: date-time */
+ lifted_at?: string
+ reason?: string
+ /** Format: date */
+ report_date?: string
+ restrictions?: 'drop_requests_402'[]
+ usage_stats?: {
+ /** Format: date */
+ report_date: string
+ total_auth_billing_period_mau_billing_period?: number
+ total_cached_egress_gb_billing_period?: number
+ total_db_size_gb_billing_period?: number
+ total_func_invocations_billing_period?: number
+ total_log_query_gb_billing_period?: number
+ total_realtime_message_count_billing_period?: number
+ total_realtime_peak_connection_billing_period?: number
+ total_regular_egress_gb_billing_period?: number
+ total_storage_size_gb_billing_period?: number
+ }
+ violation_data?: {
+ [key: string]: {
+ current: number
+ limit: number
+ }
+ }
+ violations?: (
+ | 'exceed_db_size_quota'
+ | 'exceed_egress_quota'
+ | 'exceed_cached_egress_quota'
+ | 'exceed_edge_functions_count_quota'
+ | 'exceed_edge_functions_invocations_quota'
+ | 'exceed_monthly_active_users_quota'
+ | 'exceed_realtime_connection_count_quota'
+ | 'exceed_realtime_message_count_quota'
+ | 'exceed_storage_size_quota'
+ | 'exceed_log_query_quota'
+ | 'overdue_payment'
+ )[]
} | null
/** @enum {string|null} */
restriction_status: 'grace_period' | 'grace_period_over' | 'restricted' | null
slug: string
usage_billing_enabled: boolean
}
- OrgDailyUsageResponse: {
+ OrgDailyUsageResponse_Output: {
usages: {
breakdown: {
egress_function: number
@@ -9595,10 +10401,10 @@ export interface components {
usage_original: number
}[]
}
- OrgDocumentUrlResponse: {
+ OrgDocumentUrlResponse_Output: {
fileUrl: string
}
- OrgUsageResponse: {
+ OrgUsageResponse_Output: {
usage_billing_enabled: boolean
usages: {
available_in_plan: boolean
@@ -9665,7 +10471,7 @@ export interface components {
/** @enum {string} */
pricing_strategy: 'UNIT' | 'PACKAGE' | 'TIERED' | 'NONE'
project_allocations: {
- hours?: number
+ hours?: number | null
name: string
ref: string
usage: number
@@ -9676,7 +10482,7 @@ export interface components {
usage_original: number
}[]
}
- OverdueInvoiceCount: {
+ OverdueInvoiceCount_Output: {
organization_id: number
overdue_invoice_count: number
}
@@ -9717,14 +10523,14 @@ export interface components {
}
installed: boolean
}
- PauseStatusResponse: {
+ PauseStatusResponse_Output: {
can_restore: boolean
last_paused_on: string | null
latest_downloadable_backup_id: number | null
max_days_till_restore_disabled: number
remaining_days_till_restore_disabled: number | null
}
- PaymentsResponse: {
+ PaymentsResponse_Output: {
data: {
card?: {
brand: string
@@ -9748,7 +10554,7 @@ export interface components {
PendingConfirmationResponse: {
message: string
}
- PgbouncerConfigResponse: {
+ PgbouncerConfigResponse_Output: {
connection_string: string
db_dns_name: string
db_host: string
@@ -9768,202 +10574,715 @@ export interface components {
server_lifetime?: number
ssl_enforced: boolean
}
- PgbouncerStatusResponse: {
+ PgbouncerStatusResponse_Output: {
active: boolean
}
- PlanFeaturesResponse: {
- [key: string]: {
- [key: string]: {
- config:
- | {
- enabled: boolean
- }
- | {
- enabled: boolean
- unit: string
- unlimited: boolean
- value: number
- }
- | {
- enabled: boolean
- set: string[]
- }
- /** @enum {string} */
- type: 'boolean' | 'numeric' | 'set'
- }
- }
- }
- PlanGateErrorBody: {
- /** @description Present on entitlement denials. Other errors with this status code (validation, billing state) carry only message. */
- error?: {
+ PipelineReplicationStatusResponse_Output: {
+ /** @description Stats about apply worker lag */
+ apply_lag?: {
/**
- * @description Machine-readable marker for plan-gated denials
- * @enum {string}
+ * @description Whether the slot currently has an active replication connection.
+ * @example true
+ */
+ active: boolean
+ /**
+ * @description Bytes between the current WAL location and the confirmed flush LSN.
+ * @example 2048
+ */
+ confirmed_flush_lsn_bytes: number
+ /**
+ * @description Flush lag expressed in milliseconds.
+ * @example 1200
+ */
+ flush_lag?: number | null
+ /**
+ * @description Milliseconds elapsed since the walsender last received client feedback. This can be present even when write and flush lag are unavailable.
+ * @example 5000
+ */
+ reply_time_lag?: number | null
+ /**
+ * @description Bytes between the current WAL location and the slot restart LSN.
+ * @example 1024
+ */
+ restart_lsn_bytes: number
+ /**
+ * @description How many bytes of WAL are still safe to build up before the limit of the slot is reached. `null` means Postgres reports unlimited slot WAL retention.
+ * @example 8192
+ */
+ safe_wal_size_bytes?: number | null
+ /**
+ * @description WAL availability status reported by Postgres for the slot.
+ * @example reserved
+ * @enum {string|null}
+ */
+ wal_status?: 'reserved' | 'extended' | 'unreserved' | 'lost' | 'unknown' | null
+ /**
+ * @description Write lag expressed in milliseconds.
+ * @example 1500
+ */
+ write_lag?: number | null
+ } | null
+ /**
+ * @description Pipeline id
+ * @example 1012
+ */
+ pipeline_id: number
+ /** @description Table statuses */
+ table_statuses: {
+ /**
+ * @description Table id (Postgres OID)
+ * @example 16408
+ */
+ id: number
+ /**
+ * @description Table name
+ * @example orders
*/
- code: 'entitlement_required'
- /** @description Entitlement feature key that failed the check */
- feature: string
- /** @description Billing page URL for the organization, present when the org is resolvable */
- upgrade_url?: string
- }
- /** @description Human-readable explanation of the plan gate */
- message: string
- }
- PlansResponse: {
- plans: {
- /** @enum {string} */
- change_type: 'upgrade' | 'downgrade' | 'none'
- /** @enum {string} */
- effective_at?: 'now' | 'end_of_billing_period' | 'none'
- /** @enum {string} */
- id: 'free' | 'pro' | 'team' | 'enterprise' | 'platform'
- is_current: boolean
- name: string
- price: number
- }[]
- }
- PointInTimeRestoreBody: {
- recovery_time_target_unix: number
- }
- PostgresColumnPrivileges: {
- column_id: string
- column_name: string
- privileges: {
- grantee: string
- grantor: string
- is_grantable: boolean
- /** @enum {string} */
- privilege_type: 'ALL' | 'SELECT' | 'INSERT' | 'UPDATE' | 'REFERENCES'
- }[]
- relation_name: string
- relation_schema: string
- }
- PostgresExtension: {
- comment: string | null
- default_version: string
- installed_version: string | null
- name: string
- schema: string | null
- }
- PostgresForeignTable: {
- columns?: {
- check: string | null
- comment: string | null
- data_type: string
- default_value: (string | number) | null
- enums: string[]
- format: string
- id: string
- /** @enum {string|null} */
- identity_generation: 'BY DEFAULT' | 'ALWAYS' | null
- is_generated: boolean
- is_identity: boolean
- is_nullable: boolean
- is_unique: boolean
- is_updatable: boolean
- name: string
- ordinal_position: number
- schema: string
- table: string
- table_id: number
- }[]
- comment: string | null
- id: number
- name: string
- schema: string
- }
- PostgresMaterializedView: {
- columns?: {
- check: string | null
- comment: string | null
- data_type: string
- default_value: (string | number) | null
- enums: string[]
- format: string
- id: string
- /** @enum {string|null} */
- identity_generation: 'BY DEFAULT' | 'ALWAYS' | null
- is_generated: boolean
- is_identity: boolean
- is_nullable: boolean
- is_unique: boolean
- is_updatable: boolean
name: string
- ordinal_position: number
+ /**
+ * @description Table schema
+ * @example public
+ */
schema: string
- table: string
+ /** @description Table replication state */
+ state:
+ | {
+ /** @enum {string} */
+ name: 'queued'
+ }
+ | {
+ /** @enum {string} */
+ name: 'copying_table'
+ }
+ | {
+ /** @enum {string} */
+ name: 'copied_table'
+ }
+ | {
+ /** @enum {string} */
+ name: 'following_wal'
+ }
+ | {
+ /** @enum {string} */
+ name: 'error'
+ reason: string
+ retry_policy:
+ | {
+ /** @enum {string} */
+ policy: 'no_retry'
+ }
+ | {
+ /** @enum {string} */
+ policy: 'manual_retry'
+ }
+ | {
+ /**
+ * @description Next retry time (RFC 3339 timestamp)
+ * @example 2025-01-02T03:04:05Z
+ */
+ next_retry: string
+ /** @enum {string} */
+ policy: 'timed_retry'
+ }
+ solution?: string | null
+ }
+ /**
+ * @deprecated
+ * @description Deprecated compatibility alias for `id`.
+ * @example 16408
+ */
table_id: number
+ /**
+ * @deprecated
+ * @description Deprecated unquoted `schema.name` compatibility representation.
+ * @example public.orders
+ */
+ table_name: string
+ /** @description Stats about table sync worker lag */
+ table_sync_lag?: {
+ /**
+ * @description Whether the slot currently has an active replication connection.
+ * @example true
+ */
+ active: boolean
+ /**
+ * @description Bytes between the current WAL location and the confirmed flush LSN.
+ * @example 2048
+ */
+ confirmed_flush_lsn_bytes: number
+ /**
+ * @description Flush lag expressed in milliseconds.
+ * @example 1200
+ */
+ flush_lag?: number | null
+ /**
+ * @description Milliseconds elapsed since the walsender last received client feedback. This can be present even when write and flush lag are unavailable.
+ * @example 5000
+ */
+ reply_time_lag?: number | null
+ /**
+ * @description Bytes between the current WAL location and the slot restart LSN.
+ * @example 1024
+ */
+ restart_lsn_bytes: number
+ /**
+ * @description How many bytes of WAL are still safe to build up before the limit of the slot is reached. `null` means Postgres reports unlimited slot WAL retention.
+ * @example 8192
+ */
+ safe_wal_size_bytes?: number | null
+ /**
+ * @description WAL availability status reported by Postgres for the slot.
+ * @example reserved
+ * @enum {string|null}
+ */
+ wal_status?: 'reserved' | 'extended' | 'unreserved' | 'lost' | 'unknown' | null
+ /**
+ * @description Write lag expressed in milliseconds.
+ * @example 1500
+ */
+ write_lag?: number | null
+ } | null
}[]
- comment: string | null
- id: number
- is_populated: boolean
- name: string
- schema: string
}
- PostgresPolicy: {
- /** @enum {string} */
- action: 'PERMISSIVE' | 'RESTRICTIVE'
- check: string | null
- /** @enum {string} */
- command: 'SELECT' | 'INSERT' | 'UPDATE' | 'DELETE' | 'ALL'
- definition: string | null
- id: number
- name: string
- roles: string[]
- schema: string
- table: string
- table_id: number
- }
- PostgresPublication: {
+ /** @description Pipeline */
+ PipelineResponse_Output: {
+ /** @description Pipeline configuration */
+ config: {
+ /** @description Batch configuration */
+ batch?: {
+ /**
+ * @description Maximum preferred byte size for one source batch
+ * @example 8388608
+ */
+ max_bytes?: number
+ /**
+ * @description Maximum fill time in milliseconds
+ * @example 200
+ */
+ max_fill_ms?: number
+ /**
+ * @description Persisted ratio of process memory reserved for incoming stream batch bytes
+ * @example 0.2
+ */
+ memory_budget_ratio?: number
+ } | null
+ /**
+ * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
+ * @example error
+ * @enum {string|null}
+ */
+ invalidated_slot_behavior?: 'error' | 'recreate' | null
+ /**
+ * @description Replicator log level
+ * @example info
+ * @enum {string|null}
+ */
+ log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
+ /** @description Maximum number of copy connections per table */
+ max_copy_connections_per_table?: number | null
+ /** @description Maximum number of table sync workers */
+ max_table_sync_workers?: number | null
+ /** @description Memory-based backpressure configuration */
+ memory_backpressure?: {
+ /**
+ * @description Persisted memory usage ratio that activates backpressure
+ * @example 0.85
+ */
+ activate_threshold: number
+ /**
+ * @description Persisted memory usage ratio that releases backpressure
+ * @example 0.75
+ */
+ resume_threshold: number
+ } | null
+ /**
+ * @description Milliseconds between one memory usage refresh and another
+ * @example 100
+ */
+ memory_refresh_interval_ms?: number | null
+ /**
+ * @description Publication name
+ * @example pub_orders
+ */
+ publication_name: string
+ /**
+ * @description Milliseconds between one replication lag refresh and another
+ * @example 10000
+ */
+ replication_lag_refresh_interval_ms?: number | null
+ /**
+ * @description Milliseconds between one retry and another for timed worker retries
+ * @example 10000
+ */
+ table_error_retry_delay_ms?: number | null
+ /**
+ * @description Maximum number of automatic timed retry attempts
+ * @example 5
+ */
+ table_error_retry_max_attempts?: number | null
+ /** @description Selection rules for tables participating in initial table copy */
+ table_sync_copy?:
+ | (
+ | {
+ /** @enum {string} */
+ type: 'include_all_tables'
+ }
+ | {
+ /** @enum {string} */
+ type: 'skip_all_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be performed
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'include_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be skipped
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'skip_tables'
+ }
+ )
+ | null
+ }
+ /**
+ * @description Destination id
+ * @example 2001
+ */
+ destination_id: number
+ /**
+ * @description Destination name
+ * @example bq-analytics
+ */
+ destination_name: string
+ /**
+ * @description Pipeline id
+ * @example 1012
+ */
id: number
- name: string
- owner: string
- publish_delete: boolean
- publish_insert: boolean
- publish_truncate: boolean
- publish_update: boolean
- tables:
- | {
- id: number
- name: string
- schema: string
- }[]
- | null
+ /**
+ * @description Replicator id
+ * @example 9001
+ */
+ replicator_id: number
+ /**
+ * @description Source id
+ * @example 3001
+ */
+ source_id: number
+ /**
+ * @description Source name
+ * @example main-db
+ */
+ source_name: string
+ /**
+ * @description Tenant id
+ * @example tenant_9f3a2c
+ */
+ tenant_id: string
}
- PostgresTable: {
- bytes: number
- columns?: {
- check: string | null
- comment: string | null
- data_type: string
- default_value: (string | number) | null
- enums: string[]
- format: string
- id: string
- /** @enum {string|null} */
- identity_generation: 'BY DEFAULT' | 'ALWAYS' | null
- is_generated: boolean
- is_identity: boolean
- is_nullable: boolean
- is_unique: boolean
- is_updatable: boolean
- name: string
- ordinal_position: number
- schema: string
- table: string
- table_id: number
- }[]
- comment: string | null
- dead_rows_estimate: number
- id: number
- live_rows_estimate: number
- name: string
- primary_keys: {
- name: string
- schema: string
- table_id: number
- table_name: string
- }[]
+ PipelinesResponse_Output: {
+ /** @description List of pipelines */
+ pipelines: {
+ /** @description Pipeline configuration */
+ config: {
+ /** @description Batch configuration */
+ batch?: {
+ /**
+ * @description Maximum preferred byte size for one source batch
+ * @example 8388608
+ */
+ max_bytes?: number
+ /**
+ * @description Maximum fill time in milliseconds
+ * @example 200
+ */
+ max_fill_ms?: number
+ /**
+ * @description Persisted ratio of process memory reserved for incoming stream batch bytes
+ * @example 0.2
+ */
+ memory_budget_ratio?: number
+ } | null
+ /**
+ * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
+ * @example error
+ * @enum {string|null}
+ */
+ invalidated_slot_behavior?: 'error' | 'recreate' | null
+ /**
+ * @description Replicator log level
+ * @example info
+ * @enum {string|null}
+ */
+ log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
+ /** @description Maximum number of copy connections per table */
+ max_copy_connections_per_table?: number | null
+ /** @description Maximum number of table sync workers */
+ max_table_sync_workers?: number | null
+ /** @description Memory-based backpressure configuration */
+ memory_backpressure?: {
+ /**
+ * @description Persisted memory usage ratio that activates backpressure
+ * @example 0.85
+ */
+ activate_threshold: number
+ /**
+ * @description Persisted memory usage ratio that releases backpressure
+ * @example 0.75
+ */
+ resume_threshold: number
+ } | null
+ /**
+ * @description Milliseconds between one memory usage refresh and another
+ * @example 100
+ */
+ memory_refresh_interval_ms?: number | null
+ /**
+ * @description Publication name
+ * @example pub_orders
+ */
+ publication_name: string
+ /**
+ * @description Milliseconds between one replication lag refresh and another
+ * @example 10000
+ */
+ replication_lag_refresh_interval_ms?: number | null
+ /**
+ * @description Milliseconds between one retry and another for timed worker retries
+ * @example 10000
+ */
+ table_error_retry_delay_ms?: number | null
+ /**
+ * @description Maximum number of automatic timed retry attempts
+ * @example 5
+ */
+ table_error_retry_max_attempts?: number | null
+ /** @description Selection rules for tables participating in initial table copy */
+ table_sync_copy?:
+ | (
+ | {
+ /** @enum {string} */
+ type: 'include_all_tables'
+ }
+ | {
+ /** @enum {string} */
+ type: 'skip_all_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be performed
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'include_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be skipped
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'skip_tables'
+ }
+ )
+ | null
+ }
+ /**
+ * @description Destination id
+ * @example 2001
+ */
+ destination_id: number
+ /**
+ * @description Destination name
+ * @example bq-analytics
+ */
+ destination_name: string
+ /**
+ * @description Pipeline id
+ * @example 1012
+ */
+ id: number
+ /**
+ * @description Replicator id
+ * @example 9001
+ */
+ replicator_id: number
+ /**
+ * @description Source id
+ * @example 3001
+ */
+ source_id: number
+ /**
+ * @description Source name
+ * @example main-db
+ */
+ source_name: string
+ /**
+ * @description Tenant id
+ * @example tenant_9f3a2c
+ */
+ tenant_id: string
+ }[]
+ }
+ PipelineStatusResponse_Output: {
+ /**
+ * @description Pipeline id
+ * @example 1012
+ */
+ pipeline_id: number
+ /** @description Pipeline status */
+ status: {
+ /**
+ * @example started
+ * @enum {string}
+ */
+ name: 'stopped' | 'starting' | 'started' | 'stopping' | 'unknown' | 'failed'
+ }
+ }
+ PipelineVersionResponse_Output: {
+ /** @description New pipeline version */
+ new_version?: {
+ /**
+ * @description Version id
+ * @example 3
+ */
+ id: number
+ /**
+ * @description Version name
+ * @example v0.3.0
+ */
+ name: string
+ } | null
+ /**
+ * @description Pipeline id
+ * @example 1012
+ */
+ pipeline_id: number
+ /** @description Current pipeline version */
+ version: {
+ /**
+ * @description Version id
+ * @example 3
+ */
+ id: number
+ /**
+ * @description Version name
+ * @example v0.3.0
+ */
+ name: string
+ }
+ }
+ PlanFeaturesResponse: {
+ [key: string]: {
+ [key: string]: {
+ config:
+ | {
+ enabled: boolean
+ }
+ | {
+ enabled: boolean
+ unit: string
+ unlimited: boolean
+ value: number
+ }
+ | {
+ enabled: boolean
+ set: string[]
+ }
+ /** @enum {string} */
+ type: 'boolean' | 'numeric' | 'set'
+ }
+ }
+ }
+ PlanGateErrorBody: {
+ /** @description Present on entitlement denials. Other errors with this status code (validation, billing state) carry only message. */
+ error?: {
+ /**
+ * @description Machine-readable marker for plan-gated denials
+ * @enum {string}
+ */
+ code: 'entitlement_required'
+ /** @description Entitlement feature key that failed the check */
+ feature: string
+ /** @description Billing page URL for the organization, present when the org is resolvable */
+ upgrade_url?: string
+ }
+ /** @description Human-readable explanation of the plan gate */
+ message: string
+ }
+ PlansResponse_Output: {
+ plans: {
+ /** @enum {string} */
+ change_type: 'upgrade' | 'downgrade' | 'none'
+ /** @enum {string} */
+ effective_at?: 'now' | 'end_of_billing_period' | 'none'
+ /** @enum {string} */
+ id: 'free' | 'pro' | 'team' | 'enterprise' | 'platform'
+ is_current: boolean
+ name: string
+ price: number
+ }[]
+ }
+ PointInTimeRestoreBody: {
+ recovery_time_target_unix: number
+ }
+ PostgresColumnPrivileges: {
+ column_id: string
+ column_name: string
+ privileges: {
+ grantee: string
+ grantor: string
+ is_grantable: boolean
+ /** @enum {string} */
+ privilege_type: 'ALL' | 'SELECT' | 'INSERT' | 'UPDATE' | 'REFERENCES'
+ }[]
+ relation_name: string
+ relation_schema: string
+ }
+ PostgresExtension_Output: {
+ comment: string | null
+ default_version: string
+ installed_version: string | null
+ name: string
+ schema: string | null
+ }
+ PostgresForeignTable: {
+ columns?: {
+ check: string | null
+ comment: string | null
+ data_type: string
+ default_value: (string | number) | null
+ enums: string[]
+ format: string
+ id: string
+ /** @enum {string|null} */
+ identity_generation: 'BY DEFAULT' | 'ALWAYS' | null
+ is_generated: boolean
+ is_identity: boolean
+ is_nullable: boolean
+ is_unique: boolean
+ is_updatable: boolean
+ name: string
+ ordinal_position: number
+ schema: string
+ table: string
+ table_id: number
+ }[]
+ comment: string | null
+ id: number
+ name: string
+ schema: string
+ }
+ PostgresMaterializedView: {
+ columns?: {
+ check: string | null
+ comment: string | null
+ data_type: string
+ default_value: (string | number) | null
+ enums: string[]
+ format: string
+ id: string
+ /** @enum {string|null} */
+ identity_generation: 'BY DEFAULT' | 'ALWAYS' | null
+ is_generated: boolean
+ is_identity: boolean
+ is_nullable: boolean
+ is_unique: boolean
+ is_updatable: boolean
+ name: string
+ ordinal_position: number
+ schema: string
+ table: string
+ table_id: number
+ }[]
+ comment: string | null
+ id: number
+ is_populated: boolean
+ name: string
+ schema: string
+ }
+ PostgresPolicy: {
+ /** @enum {string} */
+ action: 'PERMISSIVE' | 'RESTRICTIVE'
+ check: string | null
+ /** @enum {string} */
+ command: 'SELECT' | 'INSERT' | 'UPDATE' | 'DELETE' | 'ALL'
+ definition: string | null
+ id: number
+ name: string
+ roles: string[]
+ schema: string
+ table: string
+ table_id: number
+ }
+ PostgresPublication: {
+ id: number
+ name: string
+ owner: string
+ publish_delete: boolean
+ publish_insert: boolean
+ publish_truncate: boolean
+ publish_update: boolean
+ tables:
+ | {
+ id: number
+ name: string
+ schema: string
+ }[]
+ | null
+ }
+ PostgresTable: {
+ bytes: number
+ columns?: {
+ check: string | null
+ comment: string | null
+ data_type: string
+ default_value: (string | number) | null
+ enums: string[]
+ format: string
+ id: string
+ /** @enum {string|null} */
+ identity_generation: 'BY DEFAULT' | 'ALWAYS' | null
+ is_generated: boolean
+ is_identity: boolean
+ is_nullable: boolean
+ is_unique: boolean
+ is_updatable: boolean
+ name: string
+ ordinal_position: number
+ schema: string
+ table: string
+ table_id: number
+ }[]
+ comment: string | null
+ dead_rows_estimate: number
+ id: number
+ live_rows_estimate: number
+ name: string
+ primary_keys: {
+ name: string
+ schema: string
+ table_id: number
+ table_name: string
+ }[]
relationships: {
constraint_name: string
id: number
@@ -10051,7 +11370,7 @@ export interface components {
value: string
}
}
- PreviewCreditTopUpResponse: {
+ PreviewCreditTopUpResponse_Output: {
amount: number
currency: string
tax: {
@@ -10082,7 +11401,7 @@ export interface components {
/** @enum {string} */
tier: 'tier_free' | 'tier_pro' | 'tier_payg' | 'tier_team'
}
- PreviewOrganizationCreationResponse: {
+ PreviewOrganizationCreationResponse_Output: {
currency: string
plan_price: number
tax: {
@@ -10096,7 +11415,7 @@ export interface components {
tax_status: 'calculated' | 'not_applicable' | 'failed'
total: number
}
- PreviewProjectTransferResponse: {
+ PreviewProjectTransferResponse_Output: {
errors: {
key: string
message: string
@@ -10121,10 +11440,10 @@ export interface components {
message: string
}[]
}
- PreviewSubscriptionChangeResponse: {
+ PreviewSubscriptionChangeResponse_Output: {
active_projects: {
/** @enum {string} */
- instance_size:
+ instance_size?:
| 'pico'
| 'nano'
| 'micro'
@@ -10262,7 +11581,7 @@ export interface components {
primary_email: string
username: string
}
- ProjectAddonsResponse: {
+ ProjectAddonsResponse_Output: {
available_addons: {
name: string
/** @enum {string} */
@@ -10305,7 +11624,7 @@ export interface components {
| 'auth_mfa_web_authn_default'
| 'log_drain_default'
| 'etl_pipeline_default'
- meta?: components['schemas']['ProjectAddonsResponseJsonValue']
+ meta?: components['schemas']['JsonValue_Output']
name: string
price: number
price_description: string
@@ -10357,7 +11676,7 @@ export interface components {
| 'auth_mfa_web_authn_default'
| 'log_drain_default'
| 'etl_pipeline_default'
- meta?: components['schemas']['ProjectAddonsResponseJsonValue']
+ meta?: components['schemas']['JsonValue_Output']
name: string
price: number
price_description: string
@@ -10368,13 +11687,6 @@ export interface components {
}
}[]
}
- /** @description Any JSON-serializable value */
- ProjectAddonsResponseJsonValue:
- | ((string | number | boolean) | null)
- | components['schemas']['ProjectAddonsResponseJsonValue'][]
- | {
- [key: string]: components['schemas']['ProjectAddonsResponseJsonValue']
- }
ProjectClonedResponse: {
source_project_ref: string
target_disk_size_gb: number
@@ -10404,10 +11716,10 @@ export interface components {
id: number
ref: string
}
- ProjectDetailResponse: {
+ ProjectDetailResponse_Output: {
cloud_provider: string
/** @default null */
- connectionString?: string | null
+ connectionString: string | null
db_host: string
dbVersion?: string
high_availability: boolean
@@ -10439,8 +11751,8 @@ export interface components {
is_branch_enabled: boolean
is_hibernating?: boolean
is_physical_backups_enabled: boolean
- lastDatabaseResizeAt?: string
- maxDatabasePreprovisionGb?: number
+ lastDatabaseResizeAt?: string | null
+ maxDatabasePreprovisionGb?: number | null
name: string
organization_id: number
parent_project_ref?: string
@@ -10466,21 +11778,21 @@ export interface components {
| 'RESIZING'
subscription_id: string
updated_at: string
- volumeSizeGb?: number
+ volumeSizeGb?: number | null
}
- ProjectMembersResponse: {
+ ProjectMembersResponse_Output: {
members: {
primary_email: string
user_id: string
username: string
}[]
}
- ProjectRefResponse: {
+ ProjectRefResponse_Output: {
id: number
name: string
ref: string
}
- ProjectResourceWarningsResponse: {
+ ProjectResourceWarningsResponse_Output: {
/** @enum {string|null} */
auth_email_offender: 'critical' | 'warning' | null
/** @enum {string|null} */
@@ -10500,22 +11812,10 @@ export interface components {
need_pitr: 'critical' | 'warning' | null
project: string
}
- ProjectSensitivityResponse: {
+ ProjectSensitivityResponse_Output: {
is_sensitive: boolean
}
- ProjectServiceHealthResponse: {
- /** @enum {string} */
- granularity?: 'day' | 'hour' | 'minute'
- /** @example 2025-03-01T23:59:59Z */
- iso_timestamp_end: string
- /** @example 2025-03-01T00:00:00Z */
- iso_timestamp_start: string
- /** @example s:edge_logs */
- lql?: string
- /** @example select timestamp, edge_logs from service_health */
- sql?: string
- }
- ProjectSettingsResponse: {
+ ProjectSettingsResponse_Output: {
app_config?: {
db_schema: string
endpoint: string
@@ -10524,12 +11824,12 @@ export interface components {
cloud_provider: string
db_dns_name: string
db_host: string
- db_ip_addr_config: string
+ db_ip_addr_config?: string | null
db_name: string
db_port: number
db_user: string
inserted_at: string
- is_sensitive?: boolean
+ is_sensitive?: boolean | null
jwt_secret?: string
name: string
ref: string
@@ -10542,1747 +11842,1395 @@ export interface components {
ssl_enforced: boolean
status: string
}
- ProjectWakeResponse: {
+ ProjectWakeResponse_Output: {
connection_string: string | null
connection_string_read_only: string | null
}
- PublicUrlResponse: {
- publicUrl: string
- }
- PurgeBucketCacheBody: {
- /** @description Storage bucket id */
- bucket_id: string
- }
- PurgeObjectCacheBody: {
- /** @description Storage bucket id */
- bucket_id: string
- path: string
- }
- PutOAuthAppResponse: {
- client_id: string
- created_at: string
- icon?: string
- id: string
+ PublicationDetailsResponse_Output: {
+ config:
+ | {
+ /** @description Data-change operations to publish */
+ operations: ('insert' | 'update' | 'delete' | 'truncate')[]
+ /**
+ * @description PostgreSQL 18+ generated-column publication behavior
+ * @enum {string}
+ */
+ publish_generated_columns?: 'none' | 'stored'
+ /** @description Whether partition changes use the partition root identity */
+ publish_via_partition_root: boolean
+ /** @enum {string} */
+ type: 'all_tables'
+ }
+ | {
+ /** @description Data-change operations to publish */
+ operations: ('insert' | 'update' | 'delete' | 'truncate')[]
+ /**
+ * @description PostgreSQL 18+ generated-column publication behavior
+ * @enum {string}
+ */
+ publish_generated_columns?: 'none' | 'stored'
+ /** @description Whether partition changes use the partition root identity */
+ publish_via_partition_root: boolean
+ /** @description Schemas whose tables are published */
+ schemas: string[]
+ /** @enum {string} */
+ type: 'tables_in_schema'
+ }
+ | {
+ /** @description Data-change operations to publish */
+ operations: ('insert' | 'update' | 'delete' | 'truncate')[]
+ /**
+ * @description PostgreSQL 18+ generated-column publication behavior
+ * @enum {string}
+ */
+ publish_generated_columns?: 'none' | 'stored'
+ /** @description Whether partition changes use the partition root identity */
+ publish_via_partition_root: boolean
+ tables: {
+ /** @description Columns to publish, or null for Postgres' default column set */
+ columns: string[] | null
+ /**
+ * @description Table id (Postgres OID)
+ * @example 16408
+ */
+ id: number
+ /**
+ * @description Table name
+ * @example orders
+ */
+ name: string
+ /** @description A self-contained PostgreSQL row-filter expression, or null for none */
+ row_filter: string | null
+ /**
+ * @description Table schema
+ * @example public
+ */
+ schema: string
+ }[]
+ /** @enum {string} */
+ type: 'tables'
+ }
+ /**
+ * @description Publication name
+ * @example pub_orders
+ */
name: string
- redirect_uris: string[]
- website: string
+ /** @description Tables currently exposed by the publication */
+ tables: {
+ /**
+ * @description Table id (Postgres OID)
+ * @example 16408
+ */
+ id: number
+ /**
+ * @description Whether the table can own partitions
+ * @enum {string}
+ */
+ kind: 'table' | 'partitioned_table'
+ /**
+ * @description Table name
+ * @example orders
+ */
+ name: string
+ /** @description The direct partition parent's table id, if any */
+ partition_parent_id: number | null
+ /**
+ * @description Table schema
+ * @example public
+ */
+ schema: string
+ }[]
}
- DestinationsResponse_Output: {
- /** @description List of destinations */
- destinations: {
- /** @description Destination configuration */
- config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size?: number | null
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id: string
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number | null
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id: string
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- }
- }
- }
- | {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database: string
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string}
- */
- engine: 'merge_tree' | 'replacing_merge_tree'
- /**
- * @description Persisted ClickHouse HTTP(S) endpoint URL
- * @example http://clickhouse.example.com:8123
- */
- url: string
- /**
- * @description ClickHouse user name
- * @example default
- */
- user: string
- }
- }
- | {
- iceberg:
- | {
- supabase: {
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref: string
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
- }
- }
- | {
- rest: {
- /**
- * @description Iceberg REST catalog URI
- * @example https://catalog.example.com
- */
- catalog_uri: string
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description S3-compatible storage endpoint
- * @example https://s3.example.com
- */
- s3_endpoint: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
- }
- }
- }
- | {
- ducklake: {
- /**
- * @description Persisted DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description Persisted DuckLake metadata schema
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description Persisted S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string | null
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string | null
- /**
- * @description Persisted S3 URL style
- * @example path
- */
- s3_url_style?: string | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean | null
- table_sorting?: {
- tables: ({
- schema: string
- sort_by:
- | ({
- columns: ({
- /**
- * @description DuckLake sort direction
- * @example asc
- * @enum {string}
- */
- direction: 'asc' | 'desc'
- /**
- * @description Source column name
- * @example created_at
- */
- name: string
- /**
- * @description Optional placement of null values in the DuckLake sort order
- * @example last
- * @enum {string|null}
- */
- nulls?: 'first' | 'last' | null
- } & {
- [key: string]: unknown
- })[]
- /** @enum {string} */
- kind: 'columns'
- } & {
- [key: string]: unknown
- })
- | ({
- /** @enum {string} */
- kind: 'primary_key'
- } & {
- [key: string]: unknown
- })
- table: string
- } & {
- [key: string]: unknown
- })[]
- } & {
- [key: string]: unknown
- }
- }
- }
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id: string
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database: string
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string | null
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema: string
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user: string
- }
- }
+ PublicationsResponse_Output: {
+ /** @description List of publications */
+ publications: {
/**
- * @description Destination id
- * @example 2001
+ * @description Publication name
+ * @example pub_orders
+ */
+ name: string
+ /** @description Publication tables */
+ tables: {
+ /**
+ * @description Table id (Postgres OID)
+ * @example 16408
+ */
+ id: number
+ /**
+ * @description Table name
+ * @example orders
+ */
+ name: string
+ /**
+ * @description Table schema
+ * @example public
+ */
+ schema: string
+ }[]
+ }[]
+ }
+ PublicUrlResponse_Output: {
+ publicUrl: string
+ }
+ PurgeBucketCacheBody: {
+ /** @description Storage bucket id */
+ bucket_id: string
+ }
+ PurgeObjectCacheBody: {
+ /** @description Storage bucket id */
+ bucket_id: string
+ path: string
+ }
+ PutOAuthAppResponse_Output: {
+ client_id: string
+ created_at: string
+ icon?: string
+ id: string
+ name: string
+ redirect_uris: string[]
+ website: string
+ }
+ PutPublicationBody:
+ | {
+ /** @description Data-change operations to publish */
+ operations: ('insert' | 'update' | 'delete' | 'truncate')[]
+ /**
+ * @description PostgreSQL 18+ generated-column publication behavior
+ * @enum {string|null}
+ */
+ publish_generated_columns?: 'none' | 'stored' | null
+ /** @description Whether partition changes use the partition root identity */
+ publish_via_partition_root?: boolean
+ /** @enum {string} */
+ type: 'all_tables'
+ }
+ | {
+ /** @description Data-change operations to publish */
+ operations: ('insert' | 'update' | 'delete' | 'truncate')[]
+ /**
+ * @description PostgreSQL 18+ generated-column publication behavior
+ * @enum {string|null}
+ */
+ publish_generated_columns?: 'none' | 'stored' | null
+ /** @description Whether partition changes use the partition root identity */
+ publish_via_partition_root?: boolean
+ /** @description Schemas whose tables are published */
+ schemas: string[]
+ /** @enum {string} */
+ type: 'tables_in_schema'
+ }
+ | {
+ /** @description Data-change operations to publish */
+ operations: ('insert' | 'update' | 'delete' | 'truncate')[]
+ /**
+ * @description PostgreSQL 18+ generated-column publication behavior
+ * @enum {string|null}
+ */
+ publish_generated_columns?: 'none' | 'stored' | null
+ /** @description Whether partition changes use the partition root identity */
+ publish_via_partition_root?: boolean
+ tables: {
+ /** @description Columns to publish, or null for Postgres' default column set */
+ columns?: string[] | null
+ /**
+ * @description Table id (Postgres OID)
+ * @example 16408
+ */
+ id: number
+ /** @description A self-contained PostgreSQL row-filter expression, or null for none */
+ row_filter?: string | null
+ }[]
+ /** @enum {string} */
+ type: 'tables'
+ }
+ ReadColumnsResponse_Output: {
+ /** @description Table columns in ordinal position order */
+ columns: {
+ /**
+ * @description Column name
+ * @example created_at
+ */
+ name: string
+ /** @description Whether the column accepts null values */
+ nullable: boolean
+ /** @description Whether the column belongs to the table's primary key */
+ primary_key: boolean
+ /**
+ * @description Postgres-formatted column type
+ * @example timestamptz
+ */
+ type: string
+ }[]
+ }
+ ReadPublicationsResponse_Output: {
+ /** @description List of publications */
+ publications: {
+ /**
+ * @description Publication name
+ * @example pub_orders
+ */
+ name: string
+ }[]
+ }
+ ReadTablesResponse_Output: {
+ /** @description List of tables */
+ tables: {
+ /**
+ * @description Table id (Postgres OID)
+ * @example 16408
*/
id: number
/**
- * @description Destination name
- * @example bq-analytics
+ * @description Whether the table can own partitions
+ * @enum {string}
+ */
+ kind: 'table' | 'partitioned_table'
+ /**
+ * @description Table name
+ * @example orders
*/
name: string
+ /** @description The direct partition parent's table id, if any */
+ partition_parent_id: number | null
/**
- * @description Tenant id
- * @example tenant_9f3a2c
+ * @description Table schema
+ * @example public
*/
- tenant_id: string
+ schema: string
}[]
}
- CreateDestinationBody: {
- /** @description Destination configuration */
- config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size?: number | null
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id: string
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number | null
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id: string
- /** @description BigQuery service account key */
- service_account_key: string
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- }
- }
- }
+ RealtimeConfigResponse_Output: {
+ /** @description Sets connection pool size for Realtime Authorization */
+ connection_pool?: number | null
+ /** @description Sets maximum number of bytes per second rate per channel limit */
+ max_bytes_per_second?: number | null
+ /** @description Sets maximum number of channels per client rate limit */
+ max_channels_per_client?: number | null
+ /** @description Sets maximum number of concurrent users rate limit */
+ max_concurrent_users?: number | null
+ /** @description Sets maximum number of events per second rate per channel limit */
+ max_events_per_second?: number | null
+ /** @description Sets maximum number of joins per second rate limit */
+ max_joins_per_second?: number | null
+ /** @description Sets maximum number of payload size in KB rate limit */
+ max_payload_size_in_kb?: number | null
+ /** @description Sets maximum number of presence events per second rate limit */
+ max_presence_events_per_second?: number | null
+ /** @description Sets connection pool size used to create Postgres Changes subscriptions */
+ postgres_changes_pool?: number | null
+ /** @description Whether to enable presence */
+ presence_enabled?: boolean | null
+ /** @description Whether to only allow private channels */
+ private_only?: boolean | null
+ /** @description Disables the Realtime service for this project when true. Set to false to re-enable it. */
+ suspend?: boolean | null
+ }
+ RegionsInfo_Output: {
+ all: {
+ smartGroup: {
+ /** @enum {string} */
+ code: 'americas' | 'emea' | 'apac'
+ name: string
+ /** @enum {string} */
+ type: 'smartGroup'
+ }[]
+ specific: {
+ /** @enum {string} */
+ code:
+ | 'us-east-1'
+ | 'us-east-2'
+ | 'us-west-1'
+ | 'us-west-2'
+ | 'ap-southeast-1'
+ | 'ap-northeast-1'
+ | 'ap-northeast-2'
+ | 'ap-east-1'
+ | 'ap-southeast-2'
+ | 'eu-west-1'
+ | 'eu-west-2'
+ | 'eu-west-3'
+ | 'eu-north-1'
+ | 'eu-central-1'
+ | 'eu-central-2'
+ | 'ca-central-1'
+ | 'ap-south-1'
+ | 'sa-east-1'
+ name: string
+ /** @enum {string} */
+ provider: 'AWS' | 'AWS_K8S' | 'AWS_NIMBUS'
+ /** @enum {string} */
+ status?: 'capacity' | 'other'
+ /** @enum {string} */
+ type: 'specific'
+ }[]
+ }
+ recommendations: {
+ smartGroup: {
+ /** @enum {string} */
+ code: 'americas' | 'emea' | 'apac'
+ name: string
+ /** @enum {string} */
+ type: 'smartGroup'
+ }
+ specific: {
+ /** @enum {string} */
+ code:
+ | 'us-east-1'
+ | 'us-east-2'
+ | 'us-west-1'
+ | 'us-west-2'
+ | 'ap-southeast-1'
+ | 'ap-northeast-1'
+ | 'ap-northeast-2'
+ | 'ap-east-1'
+ | 'ap-southeast-2'
+ | 'eu-west-1'
+ | 'eu-west-2'
+ | 'eu-west-3'
+ | 'eu-north-1'
+ | 'eu-central-1'
+ | 'eu-central-2'
+ | 'ca-central-1'
+ | 'ap-south-1'
+ | 'sa-east-1'
+ name: string
+ /** @enum {string} */
+ provider: 'AWS' | 'AWS_K8S' | 'AWS_NIMBUS'
+ /** @enum {string} */
+ status?: 'capacity' | 'other'
+ /** @enum {string} */
+ type: 'specific'
+ }[]
+ }
+ }
+ RemoveProjectResponse_Output: {
+ id: number
+ name: string
+ ref: string
+ vercel?: {
+ resourceUninstallFailure: boolean
+ }
+ }
+ RequestUpgradeBody: {
+ note?: string
+ /** @enum {string} */
+ requested_plan: 'Pro' | 'Team' | 'Enterprise'
+ }
+ RequestUpgradeResponse_Output: {
+ message: string
+ }
+ ResetPasswordBody: {
+ /** Format: email */
+ email: string
+ /** Format: uri */
+ redirectTo?: string
+ }
+ ResizeBody: {
+ volume_size_gb: number
+ }
+ ResolveConversationBody: {
+ /** @enum {string} */
+ aiSupportStatus: 'user_resolved' | 'bot_resolved'
+ chatId: string
+ conversationId: string
+ }
+ RestartProjectBody: {
+ database_identifier?: string
+ }
+ RestartServicesBody: {
+ restartRequest: {
+ database_identifier?: string
+ region: string
+ services: (
+ | 'adminapi'
+ | 'api-gateway'
+ | 'envoy'
+ | 'functions'
+ | 'gotrue'
+ | 'kong'
+ | 'pgbouncer'
+ | 'pgsodium'
+ | 'postgresql'
+ | 'postgrest'
+ | 'realtime'
+ | 'storage'
+ | 'walg'
+ | 'autoshutdown'
+ )[]
+ source_notification_id?: string
+ }
+ }
+ RestoreLogicalBackupBody: {
+ id: number
+ }
+ RestorePhysicalBackupBody: {
+ id: number
+ recovery_time_target?: string
+ }
+ RevokeAuthorizedOAuthAppResponse_Output: {
+ authorized_at?: string
+ icon?: string
+ id: string
+ name: string
+ website: string
+ }
+ RollbackTablesBody: {
+ /**
+ * @description Rollback type
+ * @example individual
+ * @enum {string}
+ */
+ rollback_type: 'individual' | 'full'
+ /** @description Rollback target */
+ target:
| {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database: string
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string}
- */
- engine?: 'merge_tree' | 'replacing_merge_tree'
- /** @description ClickHouse password. Omit for passwordless access. */
- password?: string | null
- /**
- * @description ClickHouse HTTPS endpoint URL
- * @example https://clickhouse.example.com:8443
- */
- url: string
- /**
- * @description ClickHouse user name
- * @example default
- */
- user: string
- }
+ /**
+ * @description Table id (Postgres OID)
+ * @example 16408
+ */
+ table_id: number
+ /** @enum {string} */
+ type: 'single_table'
}
| {
- iceberg: {
- supabase: {
- /**
- * @description Catalog token
- * @example A jwt secret
- */
- catalog_token: string
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref: string
- /**
- * @description S3 access key ID
- * @example 53383b1d0cdb16a3afa63152656aa3cc
- */
- s3_access_key_id: string
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region: string
- /**
- * @description S3 secret access key
- * @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
- */
- s3_secret_access_key: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
- }
- }
+ /** @enum {string} */
+ type: 'all_errored_tables'
}
| {
- ducklake:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url: string
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @default ducklake
- * @example ducklake
- */
- metadata_schema?: string
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id?: string | null
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string | null
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string | null
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key?: string | null
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @default true
- * @example false
- */
- s3_use_ssl?: boolean
- table_sorting?: {
- tables?: {
- schema: string
- sort_by:
- | {
- columns: {
- /**
- * @description DuckLake sort direction
- * @example asc
- * @enum {string}
- */
- direction?: 'asc' | 'desc'
- /**
- * @description Source column name
- * @example created_at
- */
- name: string
- /**
- * @description Optional placement of null values in the DuckLake sort order
- * @example last
- * @enum {string|null}
- */
- nulls?: 'first' | 'last' | null
- }[]
- /** @enum {string} */
- kind: 'columns'
- }
- | {
- /** @enum {string} */
- kind: 'primary_key'
- }
- table: string
- }[]
- }
- }
- | {
- catalog:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url: string
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /** @enum {string} */
- type: 'postgres_url'
- }
- | {
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description Supabase project ref used as the DuckLake PostgreSQL catalog
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_project'
- }
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @default ducklake
- * @example ducklake
- */
- metadata_schema?: string
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- storage:
- | {
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id: string
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint: string
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region: string
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key: string
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @default true
- * @example false
- */
- s3_use_ssl?: boolean
- /** @enum {string} */
- type: 's3'
- }
- | {
- /**
- * @description Storage bucket id used for DuckLake data files
- * @example ducklake
- */
- bucket: string
- /**
- * @description Optional description for the generated Supabase Storage S3 credential
- * @example DuckLake replication destination
- */
- credential_description?: string
- /**
- * @description Optional path prefix inside the bucket for DuckLake data files
- * @example replication
- */
- path?: string
- /**
- * @description Supabase project ref whose Object Storage S3 API stores DuckLake data files
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_storage'
- }
- table_sorting?: {
- tables?: {
- schema: string
- sort_by:
- | {
- columns: {
- /**
- * @description DuckLake sort direction
- * @example asc
- * @enum {string}
- */
- direction?: 'asc' | 'desc'
- /**
- * @description Source column name
- * @example created_at
- */
- name: string
- /**
- * @description Optional placement of null values in the DuckLake sort order
- * @example last
- * @enum {string|null}
- */
- nulls?: 'first' | 'last' | null
- }[]
- /** @enum {string} */
- kind: 'columns'
- }
- | {
- /** @enum {string} */
- kind: 'primary_key'
- }
- table: string
- }[]
- }
- }
+ /** @enum {string} */
+ type: 'all_tables'
}
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id: string
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database: string
- /** @description Snowflake RSA private key PEM contents */
- private_key: string
- /** @description Optional passphrase for encrypted private keys */
- private_key_passphrase?: string | null
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string | null
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema: string
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user: string
- }
- }
- /**
- * @description Destination name
- * @example bq-analytics
- */
- name: string
- }
- CreateDestinationResponse_Output: {
- /**
- * @description Destination id
- * @example 2001
- */
- id: number
- }
- CreateDestinationPipelineResponse_Output: {
- /**
- * @description Destination id
- * @example 2001
- */
- destination_id: number
- /**
- * @description Pipeline id
- * @example 1012
- */
- pipeline_id: number
}
- DeleteDestinationPipelineResponse_Output: {
- /**
- * @description Whether the destination was deleted. True when no other pipelines remain attached to it.
- * @example true
- */
- destination_deleted: boolean
- /**
- * @description Destination id
- * @example 2001
- */
- destination_id: number
+ RollbackTablesResponse_Output: {
/**
* @description Pipeline id
* @example 1012
*/
pipeline_id: number
- }
- DestinationResponse_Output: {
- /** @description Destination configuration */
- config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size?: number | null
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id: string
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number | null
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id: string
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- }
+ /** @description Rolled back tables */
+ tables: {
+ /** @description Table replication state */
+ new_state:
+ | {
+ /** @enum {string} */
+ name: 'queued'
}
- }
- | {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database: string
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string}
- */
- engine: 'merge_tree' | 'replacing_merge_tree'
- /**
- * @description Persisted ClickHouse HTTP(S) endpoint URL
- * @example http://clickhouse.example.com:8123
- */
- url: string
- /**
- * @description ClickHouse user name
- * @example default
- */
- user: string
+ | {
+ /** @enum {string} */
+ name: 'copying_table'
}
- }
- | {
- iceberg:
- | {
- supabase: {
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref: string
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
+ | {
+ /** @enum {string} */
+ name: 'copied_table'
+ }
+ | {
+ /** @enum {string} */
+ name: 'following_wal'
+ }
+ | {
+ /** @enum {string} */
+ name: 'error'
+ reason: string
+ retry_policy:
+ | {
+ /** @enum {string} */
+ policy: 'no_retry'
}
- }
- | {
- rest: {
- /**
- * @description Iceberg REST catalog URI
- * @example https://catalog.example.com
- */
- catalog_uri: string
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description S3-compatible storage endpoint
- * @example https://s3.example.com
- */
- s3_endpoint: string
+ | {
+ /** @enum {string} */
+ policy: 'manual_retry'
+ }
+ | {
/**
- * @description Warehouse name
- * @example my-warehouse
+ * @description Next retry time (RFC 3339 timestamp)
+ * @example 2025-01-02T03:04:05Z
*/
- warehouse_name: string
+ next_retry: string
+ /** @enum {string} */
+ policy: 'timed_retry'
}
- }
- }
- | {
- ducklake: {
- /**
- * @description Persisted DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description Persisted DuckLake metadata schema
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description Persisted S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string | null
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string | null
- /**
- * @description Persisted S3 URL style
- * @example path
- */
- s3_url_style?: string | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean | null
- table_sorting?: {
- tables: ({
- schema: string
- sort_by:
- | ({
- columns: ({
- /**
- * @description DuckLake sort direction
- * @example asc
- * @enum {string}
- */
- direction: 'asc' | 'desc'
- /**
- * @description Source column name
- * @example created_at
- */
- name: string
- /**
- * @description Optional placement of null values in the DuckLake sort order
- * @example last
- * @enum {string|null}
- */
- nulls?: 'first' | 'last' | null
- } & {
- [key: string]: unknown
- })[]
- /** @enum {string} */
- kind: 'columns'
- } & {
- [key: string]: unknown
- })
- | ({
- /** @enum {string} */
- kind: 'primary_key'
- } & {
- [key: string]: unknown
- })
- table: string
- } & {
- [key: string]: unknown
- })[]
- } & {
- [key: string]: unknown
- }
- }
- }
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id: string
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database: string
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string | null
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema: string
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user: string
+ solution?: string | null
}
- }
- /**
- * @description Destination id
- * @example 2001
- */
- id: number
- /**
- * @description Destination name
- * @example bq-analytics
- */
+ /**
+ * @description Table id (Postgres OID)
+ * @example 16408
+ */
+ table_id: number
+ }[]
+ }
+ RunQueryBody: {
+ /** @default false */
+ disable_statement_timeout?: boolean
+ parameters?: unknown[]
+ query: string
+ }
+ SendExitSurveyBody: {
+ additionalFeedback?: string
+ exitAction?: string
+ orgSlug?: string
+ projectRef?: string
+ reasons: string
+ }
+ SendFeedbackBody: {
+ additionalRedirectUrls?: string
+ affectedServices?: string
+ allowSupportAccess?: boolean
+ browserInformation?: string
+ category: string
+ dashboardLogs?: string
+ dashboardSentryIssueId?: string
+ dashboardStudioVersion?: string
+ library?: string
+ message: string
+ organizationSlug?: string
+ pathname?: string
+ projectRef?: string
+ severity?: string
+ siteUrl?: string
+ subject?: string
+ tags: string[]
+ threadRef?: string
+ urlToAirTable?: string
+ verified?: boolean
+ }
+ SendFeedbackResponse: {
+ conversationId?: string
+ result: string
+ }
+ SendUpgradeSurveyBody: {
+ additionalFeedback?: string
+ currentPlan?: string
+ orgSlug?: string
+ prevPlan?: string
+ reasons: string[]
+ }
+ ServiceVersions_Output: {
+ gotrue?: string
+ postgrest?: string
+ 'supabase-postgres': string
+ }
+ SetupIntentRequest: {
+ hcaptchaToken?: string
+ }
+ SetupIntentResponse: {
+ client_secret: string
+ pending_subscription_flow_enabled_for_creation: boolean
+ }
+ SetupIntentResponse_Output: {
+ client_secret: string
+ pending_subscription_flow_enabled_for_creation: boolean
+ }
+ SignedUrlResponse_Output: {
+ signedUrl: string
+ }
+ SignedUrlsResponse_Output: {
+ error: string | null
+ path: string | null
+ signedUrl: string | null
+ }
+ SignUpBody: {
+ /** Format: email */
+ email: string
+ password: string
+ /** Format: uri */
+ redirectTo?: string
+ }
+ SourcesResponse_Output: {
+ /** @description List of sources */
+ sources: {
+ /** @description Source configuration */
+ config: {
+ /**
+ * @description Source host
+ * @example db.internal
+ */
+ host: string
+ /**
+ * @description Source name
+ * @example main-db
+ */
+ name: string
+ /**
+ * @description Source port
+ * @example 5432
+ */
+ port: number
+ /**
+ * @description Source username
+ * @example etl_user
+ */
+ username: string
+ }
+ /**
+ * @description Source id
+ * @example 3001
+ */
+ id: number
+ /**
+ * @description Source name
+ * @example main-db
+ */
+ name: string
+ /**
+ * @description Tenant id
+ * @example tenant_9f3a2c
+ */
+ tenant_id: string
+ }[]
+ }
+ StorageAnalyticsBucketDeleteResponse_Output: {
+ message: string
+ }
+ StorageAnalyticsBucketNamespaceTablesResponse_Output: {
+ data: {
+ name: string
+ namespace: string[]
+ }[]
+ }
+ StorageAnalyticsBucketResponse_Output: {
+ created_at: string
name: string
- /**
- * @description Tenant id
- * @example tenant_9f3a2c
- */
- tenant_id: string
+ updated_at: string
}
- UpdateDestinationBody: {
- /** @description Destination configuration */
- config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size?: number | null
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id?: string | null
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number | null
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id?: string | null
- /** @description BigQuery service account key */
- service_account_key?: string | null
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- } | null
- }
- }
- | {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database?: string | null
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string|null}
- */
- engine?: 'merge_tree' | 'replacing_merge_tree' | null
- /** @description ClickHouse password. Omit for passwordless access. */
- password?: string | null
- /**
- * @description ClickHouse HTTPS endpoint URL
- * @example https://clickhouse.example.com:8443
- */
- url?: string | null
- /**
- * @description ClickHouse user name
- * @example default
- */
- user?: string | null
- }
- }
- | {
- iceberg: {
- supabase: {
- /**
- * @description Catalog token
- * @example A jwt secret
- */
- catalog_token?: string | null
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref?: string | null
- /**
- * @description S3 access key ID
- * @example 53383b1d0cdb16a3afa63152656aa3cc
- */
- s3_access_key_id?: string | null
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region?: string | null
- /**
- * @description S3 secret access key
- * @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
- */
- s3_secret_access_key?: string | null
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name?: string | null
- }
- }
- }
- | {
- ducklake:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url?: string | null
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path?: string | null
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id?: string | null
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string | null
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string | null
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key?: string | null
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean | null
- table_sorting?: {
- tables?: {
- schema: string
- sort_by:
- | {
- columns: {
- /**
- * @description DuckLake sort direction
- * @example asc
- * @enum {string}
- */
- direction?: 'asc' | 'desc'
- /**
- * @description Source column name
- * @example created_at
- */
- name: string
- /**
- * @description Optional placement of null values in the DuckLake sort order
- * @example last
- * @enum {string|null}
- */
- nulls?: 'first' | 'last' | null
- }[]
- /** @enum {string} */
- kind: 'columns'
- }
- | {
- /** @enum {string} */
- kind: 'primary_key'
- }
- table: string
- }[]
- } | null
- }
- | {
- catalog:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url: string
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /** @enum {string} */
- type: 'postgres_url'
- }
- | {
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description Supabase project ref used as the DuckLake PostgreSQL catalog
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_project'
- }
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- storage:
- | {
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id: string
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint: string
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region: string
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key: string
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean | null
- /** @enum {string} */
- type: 's3'
- }
- | {
- /**
- * @description Storage bucket id used for DuckLake data files
- * @example ducklake
- */
- bucket: string
- /**
- * @description Optional description for the generated Supabase Storage S3 credential
- * @example DuckLake replication destination
- */
- credential_description?: string
- /**
- * @description Optional path prefix inside the bucket for DuckLake data files
- * @example replication
- */
- path?: string
- /**
- * @description Supabase project ref whose Object Storage S3 API stores DuckLake data files
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_storage'
- }
- table_sorting?: {
- tables?: {
- schema: string
- sort_by:
- | {
- columns: {
- /**
- * @description DuckLake sort direction
- * @example asc
- * @enum {string}
- */
- direction?: 'asc' | 'desc'
- /**
- * @description Source column name
- * @example created_at
- */
- name: string
- /**
- * @description Optional placement of null values in the DuckLake sort order
- * @example last
- * @enum {string|null}
- */
- nulls?: 'first' | 'last' | null
- }[]
- /** @enum {string} */
- kind: 'columns'
- }
- | {
- /** @enum {string} */
- kind: 'primary_key'
- }
- table: string
- }[]
- } | null
- }
- }
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id?: string | null
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database?: string | null
- /** @description Snowflake RSA private key PEM contents */
- private_key?: string | null
- /** @description Optional passphrase for encrypted private keys */
- private_key_passphrase?: string | null
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string | null
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema?: string | null
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user?: string | null
- }
- }
- /**
- * @description Destination name
- * @example bq-analytics
- */
+ StorageAnalyticsBucketsResponse_Output: {
+ data: {
+ created_at: string
+ name: string
+ updated_at: string
+ }[]
+ }
+ StorageBucketResponse_Output: {
+ allowed_mime_types?: string[] | null
+ created_at: string
+ file_size_limit?: number | null
+ id: string
name: string
+ owner: string
+ public: boolean
+ type?: ('STANDARD' | 'ANALYTICS') | string
+ updated_at: string
+ /** @enum {string} */
+ versioning_status?: 'DISABLED' | 'ENABLED' | 'SUSPENDED'
}
- ValidateDestinationBody: {
- /** @description Destination configuration */
- config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size?: number | null
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id: string
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number | null
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id: string
- /** @description BigQuery service account key */
- service_account_key: string
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- }
+ StorageConfigResponse_Output: {
+ capabilities: {
+ iceberg_catalog: boolean
+ list_v2: boolean
+ object_versioning: boolean
+ }
+ external: {
+ /** @enum {string} */
+ upstreamTarget: 'main' | 'canary'
+ }
+ features: {
+ icebergCatalog: {
+ enabled: boolean
+ maxCatalogs: number
+ maxNamespaces: number
+ maxTables: number
+ }
+ imageTransformation: {
+ enabled: boolean
+ }
+ purgeCache: {
+ enabled: boolean
+ }
+ s3Protocol: {
+ enabled: boolean
+ }
+ vectorBuckets: {
+ enabled: boolean
+ maxBuckets: number
+ maxIndexes: number
+ }
+ }
+ /** Format: int64 */
+ fileSizeLimit: number
+ migrationVersion: string | null
+ }
+ StorageListResponseV2_Output: {
+ folders: {
+ key?: string
+ name: string
+ }[]
+ hasNext: boolean
+ nextCursor?: string
+ objects: {
+ archived_at?: string | null
+ created_at: string
+ id: string
+ is_delete_marker?: boolean
+ is_versioned?: boolean
+ key?: string
+ last_accessed_at: string
+ metadata: {
+ cacheControl?: string | null
+ contentLength?: number | null
+ eTag?: string | null
+ httpStatusCode?: number | null
+ lastModified?: string | null
+ mimetype?: string | null
+ size?: number | null
+ } | null
+ name: string
+ updated_at: string
+ /** Format: uuid */
+ version?: string
+ }[]
+ }
+ StorageObject_Output: {
+ archived_at?: string | null
+ bucket_id?: string
+ buckets?: {
+ allowed_mime_types?: string[] | null
+ created_at: string
+ file_size_limit?: number | null
+ id: string
+ name: string
+ owner: string
+ public: boolean
+ type?: ('STANDARD' | 'ANALYTICS') | string
+ updated_at: string
+ /** @enum {string} */
+ versioning_status?: 'DISABLED' | 'ENABLED' | 'SUSPENDED'
+ }
+ created_at: string | null
+ id: string | null
+ is_delete_marker?: boolean | null
+ is_versioned?: boolean | null
+ last_accessed_at: string | null
+ metadata: {
+ [key: string]: unknown
+ } | null
+ name: string
+ owner?: string
+ updated_at: string | null
+ /** Format: uuid */
+ version?: string | null
+ }
+ StorageVectorBucketListIndexesResponse_Output: {
+ indexes: {
+ creationTime?: number
+ dataType: 'float32' | string
+ dimension: number
+ distanceMetric: ('cosine' | 'euclidean' | 'dotproduct') | string
+ indexName: string
+ metadataConfiguration?: {
+ nonFilterableMetadataKeys?: string[]
+ }
+ vectorBucketName: string
+ }[]
+ nextToken?: string
+ }
+ StorageVectorBucketResponse_Output: {
+ vectorBucketName: string
+ }
+ StorageVectorBucketsResponse_Output: {
+ nextToken?: string
+ vectorBuckets: {
+ vectorBucketName: string
+ }[]
+ }
+ SupavisorConfigResponse_Output: {
+ connection_string: string
+ /** @description Use connection_string instead */
+ connectionString: string
+ /** @enum {string} */
+ database_type: 'PRIMARY' | 'READ_REPLICA'
+ db_host: string
+ db_name: string
+ db_port: number
+ db_user: string
+ default_pool_size: number | null
+ identifier: string
+ is_using_scram_auth: boolean
+ max_client_conn: number | null
+ /** @enum {string} */
+ pool_mode: 'transaction' | 'session'
+ }
+ SyncConversationMessagesBody: {
+ affectedServices?: string
+ allowSupportAccess?: boolean
+ browserInformation?: string
+ category?: string
+ chatId: string
+ conversationId?: string
+ /** @default false */
+ isInitial?: boolean
+ library?: string
+ messages: {
+ content: string
+ id: string
+ /** @enum {string} */
+ role: 'user' | 'assistant'
+ }[]
+ organizationSlug?: string
+ projectRef?: string
+ severity?: string
+ subject: string
+ }
+ SyncConversationMessagesResponse: {
+ conversationId?: string
+ /** @enum {string} */
+ result: 'success'
+ }
+ TablesResponse_Output: {
+ /** @description List of tables */
+ tables: {
+ /**
+ * @description Table id (Postgres OID)
+ * @example 16408
+ */
+ id: number
+ /**
+ * @description Table name
+ * @example orders
+ */
+ name: string
+ /**
+ * @description Table schema
+ * @example public
+ */
+ schema: string
+ }[]
+ }
+ TaxIdResponse_Output: {
+ tax_id: {
+ country: string
+ type: string
+ value: string
+ } | null
+ }
+ TelemetryCallFeatureFlagsResponse: {
+ [key: string]: unknown
+ }
+ TelemetryEventBodyV2: {
+ action: string
+ custom_properties: {
+ [key: string]: unknown
+ }
+ groups?: {
+ organization?: string
+ project?: string
+ }
+ page_title: string
+ page_url: string
+ pathname: string
+ ph: {
+ language: string
+ referrer: string
+ search: string
+ user_agent: string
+ viewport_height: number
+ viewport_width: number
+ }
+ }
+ TelemetryFeatureFlagBody: {
+ feature_flag_name: string
+ feature_flag_value: unknown
+ }
+ TelemetryGroupsIdentityBody: {
+ organization_slug?: string
+ project_ref?: string
+ }
+ TelemetryGroupsResetBody: {
+ reset_organization?: boolean
+ reset_project?: boolean
+ }
+ TelemetryIdentifyBodyV2: {
+ anonymous_id?: string
+ organization_slug?: string
+ project_ref?: string
+ user_id: string
+ }
+ TemporaryApiKeyResponse_Output: {
+ api_key: string
+ }
+ TransferProjectBody: {
+ target_organization_slug: string
+ }
+ UnpauseProjectAvailableVersionsResponse_Output: {
+ available_versions: {
+ /** @enum {string} */
+ postgres_engine: '13' | '14' | '15' | '17' | '17-oriole'
+ /** @enum {string} */
+ release_channel: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
+ version: string
+ }[]
+ }
+ UnpauseProjectBody: {
+ /**
+ * @description Postgres engine version. If not provided, the latest version from the given release channel will be used.
+ * @enum {string}
+ */
+ postgres_engine?: '15' | '17' | '17-oriole'
+ /**
+ * @description Release channel version. If not provided, GeneralAvailability will be used.
+ * @enum {string}
+ */
+ release_channel?: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
+ }
+ UnpauseProjectResponse_Output: {
+ back_ups: {
+ id: number
+ }[]
+ cloud_provider: string
+ id: number
+ organization_id: number
+ region: string
+ status: string
+ }
+ UpcomingInvoice_Output: {
+ amount_projected?: number
+ amount_total: number
+ billing_cycle_end: string
+ billing_cycle_start: string
+ currency: string
+ customer_balance: number
+ /** @enum {string} */
+ fixed_fees_billing_mode: 'in_advance' | 'in_arrears'
+ lines: {
+ amount: number
+ amount_before_discount: number
+ breakdown?: {
+ amount?: number
+ /** @enum {string} */
+ project_db_instance_size?:
+ | 'pico'
+ | 'nano'
+ | 'micro'
+ | 'small'
+ | 'medium'
+ | 'large'
+ | 'xlarge'
+ | '2xlarge'
+ | '4xlarge'
+ | '8xlarge'
+ | '12xlarge'
+ | '16xlarge'
+ | '24xlarge'
+ | '24xlarge_optimized_memory'
+ | '24xlarge_optimized_cpu'
+ | '24xlarge_high_memory'
+ | '48xlarge'
+ | '48xlarge_optimized_memory'
+ | '48xlarge_optimized_cpu'
+ | '48xlarge_high_memory'
+ project_name: string
+ project_ref: string
+ /** @enum {string} */
+ project_status?:
+ | 'INACTIVE'
+ | 'ACTIVE_HEALTHY'
+ | 'ACTIVE_UNHEALTHY'
+ | 'COMING_UP'
+ | 'UNKNOWN'
+ | 'GOING_DOWN'
+ | 'INIT_FAILED'
+ | 'REMOVED'
+ | 'RESTORING'
+ | 'UPGRADING'
+ | 'PAUSING'
+ | 'RESTORE_FAILED'
+ | 'RESTARTING'
+ | 'PAUSE_FAILED'
+ | 'RESIZING'
+ usage: number
+ }[]
+ description: string
+ item_name: string
+ metadata?: {
+ is_branch?: boolean
+ is_read_replica?: boolean
+ }
+ period?: {
+ end: string
+ start: string
+ }
+ proration: boolean
+ quantity: number | null
+ unit_price: number | null
+ unit_price_desc: string | null
+ usage_based: boolean
+ /** @enum {string} */
+ usage_metric?:
+ | 'EGRESS'
+ | 'CACHED_EGRESS'
+ | 'DATABASE_SIZE'
+ | 'STORAGE_SIZE'
+ | 'MONTHLY_ACTIVE_USERS'
+ | 'MONTHLY_ACTIVE_SSO_USERS'
+ | 'FUNCTION_INVOCATIONS'
+ | 'FUNCTION_CPU_MILLISECONDS'
+ | 'STORAGE_IMAGES_TRANSFORMED'
+ | 'REALTIME_MESSAGE_COUNT'
+ | 'REALTIME_PEAK_CONNECTIONS'
+ | 'DISK_SIZE_GB_HOURS_GP3'
+ | 'DISK_SIZE_GB_HOURS_IO2'
+ | 'AUTH_MFA_PHONE'
+ | 'AUTH_MFA_WEB_AUTHN'
+ | 'LOG_DRAIN_EVENTS'
+ | 'MONTHLY_ACTIVE_THIRD_PARTY_USERS'
+ | 'DISK_THROUGHPUT_GP3'
+ | 'DISK_IOPS_GP3'
+ | 'DISK_IOPS_IO2'
+ | 'COMPUTE_HOURS_BRANCH'
+ | 'COMPUTE_HOURS_XS'
+ | 'COMPUTE_HOURS_SM'
+ | 'COMPUTE_HOURS_MD'
+ | 'COMPUTE_HOURS_L'
+ | 'COMPUTE_HOURS_XL'
+ | 'COMPUTE_HOURS_2XL'
+ | 'COMPUTE_HOURS_4XL'
+ | 'COMPUTE_HOURS_8XL'
+ | 'COMPUTE_HOURS_12XL'
+ | 'COMPUTE_HOURS_16XL'
+ | 'COMPUTE_HOURS_24XL'
+ | 'COMPUTE_HOURS_24XL_OPTIMIZED_CPU'
+ | 'COMPUTE_HOURS_24XL_OPTIMIZED_MEMORY'
+ | 'COMPUTE_HOURS_24XL_HIGH_MEMORY'
+ | 'COMPUTE_HOURS_48XL'
+ | 'COMPUTE_HOURS_48XL_OPTIMIZED_CPU'
+ | 'COMPUTE_HOURS_48XL_OPTIMIZED_MEMORY'
+ | 'COMPUTE_HOURS_48XL_HIGH_MEMORY'
+ | 'CUSTOM_DOMAIN'
+ | 'PITR_7'
+ | 'PITR_14'
+ | 'PITR_28'
+ | 'IPV4'
+ | 'LOG_DRAIN'
+ | 'ETL_PIPELINE'
+ | 'ETL_REPLICATED_DATA'
+ | 'ETL_COPY_BACKFILL_DATA'
+ | 'LOG_INGESTION'
+ | 'LOG_QUERYING'
+ | 'LOG_STORAGE'
+ | 'ACTIVE_COMPUTE_HOURS'
+ usage_original?: number
+ }[]
+ subscription_id: string
+ tax: {
+ currency: string
+ tax_amount: number
+ tax_rate_percentage: number
+ total_amount_excluding_tax: number
+ total_amount_including_tax: number
+ } | null
+ /** @enum {string} */
+ tax_status: 'calculated' | 'not_applicable' | 'failed'
+ }
+ UpdateAddonBody: {
+ /** @enum {string} */
+ addon_type:
+ | 'custom_domain'
+ | 'compute_instance'
+ | 'pitr'
+ | 'ipv4'
+ | 'auth_mfa_phone'
+ | 'auth_mfa_web_authn'
+ | 'log_drain'
+ | 'etl_pipeline'
+ /** @enum {string} */
+ addon_variant:
+ | 'ci_micro'
+ | 'ci_small'
+ | 'ci_medium'
+ | 'ci_large'
+ | 'ci_xlarge'
+ | 'ci_2xlarge'
+ | 'ci_4xlarge'
+ | 'ci_8xlarge'
+ | 'ci_12xlarge'
+ | 'ci_16xlarge'
+ | 'ci_24xlarge'
+ | 'ci_24xlarge_optimized_cpu'
+ | 'ci_24xlarge_optimized_memory'
+ | 'ci_24xlarge_high_memory'
+ | 'ci_48xlarge'
+ | 'ci_48xlarge_optimized_cpu'
+ | 'ci_48xlarge_optimized_memory'
+ | 'ci_48xlarge_high_memory'
+ | 'cd_default'
+ | 'pitr_7'
+ | 'pitr_14'
+ | 'pitr_28'
+ | 'ipv4_default'
+ | 'auth_mfa_phone_default'
+ | 'auth_mfa_web_authn_default'
+ | 'log_drain_default'
+ | 'etl_pipeline_default'
+ }
+ UpdateBackendParamsOpenapi: {
+ config?:
+ | {
+ gzip?: boolean
+ headers?: {
+ [key: string]: string
}
+ /** @enum {string} */
+ http?: 'http1' | 'http2'
+ url?: string
}
| {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database: string
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string}
- */
- engine?: 'merge_tree' | 'replacing_merge_tree'
- /** @description ClickHouse password. Omit for passwordless access. */
- password?: string | null
- /**
- * @description ClickHouse HTTPS endpoint URL
- * @example https://clickhouse.example.com:8443
- */
- url: string
- /**
- * @description ClickHouse user name
- * @example default
- */
- user: string
+ api_key?: string
+ region?: string
+ }
+ | {
+ headers?: {
+ [key: string]: string
}
+ password?: string | null
+ url?: string
+ username?: string | null
}
| {
- iceberg: {
- supabase: {
- /**
- * @description Catalog token
- * @example A jwt secret
- */
- catalog_token: string
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref: string
+ dsn?: string
+ }
+ | {
+ api_token?: string
+ dataset_name?: string
+ domain?: string
+ }
+ | {
+ ca_cert?: string
+ cipher_key?: string
+ client_cert?: string
+ client_key?: string
+ host?: string
+ port?: number
+ structured_data?: string
+ /** @default false */
+ tls?: boolean
+ }
+ | {
+ access_key_id?: string
+ batch_timeout?: number
+ s3_bucket?: string
+ secret_access_key?: string
+ storage_region?: string
+ }
+ | {
+ password?: string
+ region?: string
+ username?: string
+ }
+ | {
+ endpoint?: string
+ /** @default true */
+ gzip?: boolean
+ /** @default {} */
+ headers?: {
+ [key: string]: string
+ }
+ /** @default http/protobuf */
+ protocol?: string
+ }
+ description?: string
+ name?: string
+ /** @enum {string} */
+ type?:
+ | 'postgres'
+ | 'bigquery'
+ | 'clickhouse'
+ | 'webhook'
+ | 'datadog'
+ | 'loki'
+ | 'sentry'
+ | 's3'
+ | 'axiom'
+ | 'last9'
+ | 'otlp'
+ | 'syslog'
+ }
+ UpdateContentFolderBody: {
+ name: string
+ }
+ UpdateConversationCustomFieldsBody: {
+ /** @default false */
+ allow_support_access?: boolean
+ /** @default Problem */
+ category?: string
+ org_id: number
+ project_ref?: string
+ }
+ UpdateConversationCustomFieldsResponse: {
+ /** @enum {string} */
+ result: 'success'
+ }
+ UpdateConversationLifecycleResponse: {
+ /** @enum {string} */
+ aiSupportStatus: 'bot_active' | 'escalated' | 'user_resolved' | 'bot_resolved'
+ conversationId: string
+ /** @enum {string} */
+ result: 'success'
+ }
+ UpdateDestinationBody: {
+ /** @description Destination configuration */
+ config:
+ | {
+ big_query: {
+ /**
+ * @description Number of concurrent BigQuery Storage Write API connections.
+ * @example 8
+ */
+ connection_pool_size?: number | null
+ /**
+ * @description BigQuery dataset id
+ * @example analytics
+ */
+ dataset_id?: string | null
+ /**
+ * @description Maximum data staleness in minutes
+ * @example 5
+ */
+ max_staleness_mins?: number | null
+ /**
+ * @description BigQuery project id
+ * @example my-gcp-project
+ */
+ project_id?: string | null
+ /** @description BigQuery service account key */
+ service_account_key?: string | null
+ /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
+ table_options?: {
+ tables?: {
+ cluster_by?: string[]
+ partition_by?:
+ | (
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
+ * @enum {string}
+ */
+ kind: 'time_column'
+ }
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Exclusive end of the last partition range
+ * @example 100
+ */
+ end: number
+ /**
+ * @description Width of each partition range
+ * @example 10
+ */
+ interval: number
+ /**
+ * @description Partition by ranges of a replicated integer column
+ * @enum {string}
+ */
+ kind: 'integer_range'
+ /**
+ * @description Inclusive start of the first partition range
+ * @example 0
+ */
+ start: number
+ }
+ | {
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by the time at which BigQuery ingests each row
+ * @enum {string}
+ */
+ kind: 'ingestion_time'
+ }
+ )
+ | null
+ /**
+ * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
+ * @example 16384
+ */
+ table_id: number
+ }[]
+ } | null
+ }
+ }
+ | {
+ clickhouse: {
+ /**
+ * @description ClickHouse target database
+ * @example analytics
+ */
+ database?: string | null
+ /**
+ * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
+ * @example replacing_merge_tree
+ * @enum {string|null}
+ */
+ engine?: 'merge_tree' | 'replacing_merge_tree' | null
+ /** @description ClickHouse password. Omit for passwordless access. */
+ password?: string | null
+ /**
+ * @description ClickHouse HTTPS endpoint URL
+ * @example https://clickhouse.example.com:8443
+ */
+ url?: string | null
+ /**
+ * @description ClickHouse user name
+ * @example default
+ */
+ user?: string | null
+ }
+ }
+ | {
+ iceberg: {
+ supabase: {
+ /**
+ * @description Catalog token
+ * @example A jwt secret
+ */
+ catalog_token?: string | null
+ /**
+ * @description Namespace
+ * @example my-namespace
+ */
+ namespace?: string | null
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ project_ref?: string | null
/**
* @description S3 access key ID
* @example 53383b1d0cdb16a3afa63152656aa3cc
*/
- s3_access_key_id: string
+ s3_access_key_id?: string | null
/**
* @description S3 region
* @example ap-southeast-1
*/
- s3_region: string
+ s3_region?: string | null
/**
* @description S3 secret access key
* @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
*/
- s3_secret_access_key: string
+ s3_secret_access_key?: string | null
/**
* @description Warehouse name
* @example my-warehouse
*/
- warehouse_name: string
+ warehouse_name?: string | null
}
}
}
@@ -12293,18 +13241,17 @@ export interface components {
* @description DuckLake catalog URL
* @example postgres://user:pass@localhost:5432/ducklake_catalog
*/
- catalog_url: string
+ catalog_url?: string | null
/**
* @description DuckLake data path
* @example s3://<bucket-name>/
*/
- data_path: string
+ data_path?: string | null
/**
* @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @default ducklake
* @example ducklake
*/
- metadata_schema?: string
+ metadata_schema?: string | null
/**
* @description Number of concurrent DuckDB connections.
* @example 4
@@ -12338,10 +13285,9 @@ export interface components {
s3_url_style?: 'path' | 'vhost' | null
/**
* @description Whether to use SSL for S3-compatible storage
- * @default true
* @example false
*/
- s3_use_ssl?: boolean
+ s3_use_ssl?: boolean | null
table_sorting?: {
tables?: {
schema: string
@@ -12375,7 +13321,7 @@ export interface components {
}
table: string
}[]
- }
+ } | null
}
| {
catalog:
@@ -12419,10 +13365,9 @@ export interface components {
}
/**
* @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @default ducklake
* @example ducklake
*/
- metadata_schema?: string
+ metadata_schema?: string | null
/**
* @description Number of concurrent DuckDB connections.
* @example 4
@@ -12463,10 +13408,9 @@ export interface components {
s3_url_style?: 'path' | 'vhost' | null
/**
* @description Whether to use SSL for S3-compatible storage
- * @default true
* @example false
*/
- s3_use_ssl?: boolean
+ s3_use_ssl?: boolean | null
/** @enum {string} */
type: 's3'
}
@@ -12527,7 +13471,7 @@ export interface components {
}
table: string
}[]
- }
+ } | null
}
}
| {
@@ -12536,14 +13480,14 @@ export interface components {
* @description Snowflake account identifier
* @example MYORG-MYACCOUNT
*/
- account_id: string
+ account_id?: string | null
/**
* @description Snowflake target database
* @example ANALYTICS
*/
- database: string
+ database?: string | null
/** @description Snowflake RSA private key PEM contents */
- private_key: string
+ private_key?: string | null
/** @description Optional passphrase for encrypted private keys */
private_key_passphrase?: string | null
/**
@@ -12555,305 +13499,401 @@ export interface components {
* @description Snowflake target schema
* @example PUBLIC
*/
- schema: string
+ schema?: string | null
/**
* @description Snowflake user configured for key-pair authentication
* @example PIPELINES_USER
*/
- user: string
+ user?: string | null
}
}
- /** @description Pipeline configuration */
- pipeline_config?: {
- /** @description Batch configuration. Omit or use `null` for server defaults. */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Memory-based backpressure configuration. Omission enables server defaults; `null` disables it. */
- memory_backpressure?: {
- /**
- * @description Memory usage ratio above which backpressure is activated
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Memory usage ratio below which backpressure is released
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name
- * @example pub_orders
- */
- publication_name: string
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Selection rules for tables participating in initial table copy. Omit or use `null` to copy all tables. */
- table_sync_copy?:
- | (
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- )
- | null
- } | null
/**
- * @description Source id
- * @example 1
+ * @description Destination name
+ * @example bq-analytics
*/
- source_id?: number | null
+ name: string
}
- ValidateDestinationResponse_Output: {
- /** @description List of validation failures */
- validation_failures: {
- /**
- * @description Failure type
- * @example critical
- * @enum {string}
- */
- failure_type: 'critical' | 'warning'
- /**
- * @description Validation failure name
- * @example Validation Failed
- */
- name: string
- /**
- * @description Validation failure reason
- * @example The configuration is invalid
- */
- reason: string
- }[]
+ UpdateDiskAutoscaleConfig: {
+ /**
+ * @description Growth percentage for disk autoscaling
+ * @default 50
+ */
+ growth_percent?: number
+ /**
+ * @description Maximum limit the disk size will grow to in GB
+ * @default 61440
+ */
+ max_size_gb?: number
+ /**
+ * @description Minimum increment size for disk autoscaling in GB
+ * @default 4
+ */
+ min_increment_gb?: number
}
- PipelinesResponse_Output: {
- /** @description List of pipelines */
- pipelines: {
- /** @description Pipeline configuration */
- config: {
- /** @description Batch configuration */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Persisted ratio of process memory reserved for incoming stream batch bytes
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Memory-based backpressure configuration */
- memory_backpressure?: {
- /**
- * @description Persisted memory usage ratio that activates backpressure
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Persisted memory usage ratio that releases backpressure
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name
- * @example pub_orders
- */
- publication_name: string
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Selection rules for tables participating in initial table copy */
- table_sync_copy?:
- | (
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- )
- | null
- }
- /**
- * @description Destination id
- * @example 2001
- */
- destination_id: number
- /**
- * @description Destination name
- * @example bq-analytics
- */
- destination_name: string
- /**
- * @description Pipeline id
- * @example 1012
- */
- id: number
- /**
- * @description Replicator id
- * @example 9001
- */
- replicator_id: number
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- /**
- * @description Source name
- * @example main-db
- */
- source_name: string
- /**
- * @description Tenant id
- * @example tenant_9f3a2c
- */
- tenant_id: string
- }[]
+ UpdateEmailBody: {
+ newEmail: string
}
- CreatePipelineBody: {
- /** @description Pipeline configuration */
+ UpdateGitHubConnectionBody: {
+ branch_limit?: number
+ new_branch_per_pr?: boolean
+ supabase_changes_only?: boolean
+ workdir?: string
+ }
+ UpdateGoTrueConfigBody: {
+ API_MAX_REQUEST_DURATION?: number | null
+ AUDIT_LOG_DISABLE_POSTGRES?: boolean | null
+ CUSTOM_OAUTH_ENABLED?: boolean
+ DB_MAX_POOL_SIZE?: number | null
+ /** @enum {string|null} */
+ DB_MAX_POOL_SIZE_UNIT?: 'connections' | 'percent' | null
+ DISABLE_SIGNUP?: boolean | null
+ EXTERNAL_ANONYMOUS_USERS_ENABLED?: boolean | null
+ EXTERNAL_APPLE_ADDITIONAL_CLIENT_IDS?: string | null
+ EXTERNAL_APPLE_CLIENT_ID?: string | null
+ EXTERNAL_APPLE_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_APPLE_ENABLED?: boolean | null
+ EXTERNAL_APPLE_SECRET?: string | null
+ EXTERNAL_AZURE_CLIENT_ID?: string | null
+ EXTERNAL_AZURE_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_AZURE_ENABLED?: boolean | null
+ EXTERNAL_AZURE_SECRET?: string | null
+ EXTERNAL_AZURE_URL?: string | null
+ EXTERNAL_BITBUCKET_CLIENT_ID?: string | null
+ EXTERNAL_BITBUCKET_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_BITBUCKET_ENABLED?: boolean | null
+ EXTERNAL_BITBUCKET_SECRET?: string | null
+ EXTERNAL_DISCORD_CLIENT_ID?: string | null
+ EXTERNAL_DISCORD_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_DISCORD_ENABLED?: boolean | null
+ EXTERNAL_DISCORD_SECRET?: string | null
+ EXTERNAL_EMAIL_ENABLED?: boolean | null
+ EXTERNAL_FACEBOOK_CLIENT_ID?: string | null
+ EXTERNAL_FACEBOOK_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_FACEBOOK_ENABLED?: boolean | null
+ EXTERNAL_FACEBOOK_SECRET?: string | null
+ EXTERNAL_FIGMA_CLIENT_ID?: string | null
+ EXTERNAL_FIGMA_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_FIGMA_ENABLED?: boolean | null
+ EXTERNAL_FIGMA_SECRET?: string | null
+ EXTERNAL_GITHUB_CLIENT_ID?: string | null
+ EXTERNAL_GITHUB_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_GITHUB_ENABLED?: boolean | null
+ EXTERNAL_GITHUB_SECRET?: string | null
+ EXTERNAL_GITLAB_CLIENT_ID?: string | null
+ EXTERNAL_GITLAB_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_GITLAB_ENABLED?: boolean | null
+ EXTERNAL_GITLAB_SECRET?: string | null
+ EXTERNAL_GITLAB_URL?: string | null
+ EXTERNAL_GOOGLE_ADDITIONAL_CLIENT_IDS?: string | null
+ EXTERNAL_GOOGLE_CLIENT_ID?: string | null
+ EXTERNAL_GOOGLE_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_GOOGLE_ENABLED?: boolean | null
+ EXTERNAL_GOOGLE_SECRET?: string | null
+ EXTERNAL_GOOGLE_SKIP_NONCE_CHECK?: boolean | null
+ EXTERNAL_KAKAO_CLIENT_ID?: string | null
+ EXTERNAL_KAKAO_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_KAKAO_ENABLED?: boolean | null
+ EXTERNAL_KAKAO_SECRET?: string | null
+ EXTERNAL_KEYCLOAK_CLIENT_ID?: string | null
+ EXTERNAL_KEYCLOAK_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_KEYCLOAK_ENABLED?: boolean | null
+ EXTERNAL_KEYCLOAK_SECRET?: string | null
+ EXTERNAL_KEYCLOAK_URL?: string | null
+ EXTERNAL_LINKEDIN_OIDC_CLIENT_ID?: string | null
+ EXTERNAL_LINKEDIN_OIDC_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_LINKEDIN_OIDC_ENABLED?: boolean | null
+ EXTERNAL_LINKEDIN_OIDC_SECRET?: string | null
+ EXTERNAL_NOTION_CLIENT_ID?: string | null
+ EXTERNAL_NOTION_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_NOTION_ENABLED?: boolean | null
+ EXTERNAL_NOTION_SECRET?: string | null
+ EXTERNAL_PHONE_ENABLED?: boolean | null
+ EXTERNAL_SLACK_CLIENT_ID?: string | null
+ EXTERNAL_SLACK_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_SLACK_ENABLED?: boolean | null
+ EXTERNAL_SLACK_OIDC_CLIENT_ID?: string | null
+ EXTERNAL_SLACK_OIDC_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_SLACK_OIDC_ENABLED?: boolean | null
+ EXTERNAL_SLACK_OIDC_SECRET?: string | null
+ EXTERNAL_SLACK_SECRET?: string | null
+ EXTERNAL_SPOTIFY_CLIENT_ID?: string | null
+ EXTERNAL_SPOTIFY_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_SPOTIFY_ENABLED?: boolean | null
+ EXTERNAL_SPOTIFY_SECRET?: string | null
+ EXTERNAL_TWITCH_CLIENT_ID?: string | null
+ EXTERNAL_TWITCH_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_TWITCH_ENABLED?: boolean | null
+ EXTERNAL_TWITCH_SECRET?: string | null
+ EXTERNAL_TWITTER_CLIENT_ID?: string | null
+ EXTERNAL_TWITTER_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_TWITTER_ENABLED?: boolean | null
+ EXTERNAL_TWITTER_SECRET?: string | null
+ EXTERNAL_WEB3_ETHEREUM_ENABLED?: boolean | null
+ EXTERNAL_WEB3_SOLANA_ENABLED?: boolean | null
+ EXTERNAL_WORKOS_CLIENT_ID?: string | null
+ EXTERNAL_WORKOS_ENABLED?: boolean | null
+ EXTERNAL_WORKOS_SECRET?: string | null
+ EXTERNAL_WORKOS_URL?: string | null
+ EXTERNAL_X_CLIENT_ID?: string | null
+ EXTERNAL_X_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_X_ENABLED?: boolean | null
+ EXTERNAL_X_SECRET?: string | null
+ EXTERNAL_ZOOM_CLIENT_ID?: string | null
+ EXTERNAL_ZOOM_EMAIL_OPTIONAL?: boolean | null
+ EXTERNAL_ZOOM_ENABLED?: boolean | null
+ EXTERNAL_ZOOM_SECRET?: string | null
+ HOOK_AFTER_USER_CREATED_ENABLED?: boolean | null
+ HOOK_AFTER_USER_CREATED_SECRETS?: string | null
+ HOOK_AFTER_USER_CREATED_URI?: string | null
+ HOOK_BEFORE_USER_CREATED_ENABLED?: boolean | null
+ HOOK_BEFORE_USER_CREATED_SECRETS?: string | null
+ HOOK_BEFORE_USER_CREATED_URI?: string | null
+ HOOK_CUSTOM_ACCESS_TOKEN_ENABLED?: boolean | null
+ HOOK_CUSTOM_ACCESS_TOKEN_SECRETS?: string | null
+ HOOK_CUSTOM_ACCESS_TOKEN_URI?: string | null
+ HOOK_MFA_VERIFICATION_ATTEMPT_ENABLED?: boolean | null
+ HOOK_MFA_VERIFICATION_ATTEMPT_SECRETS?: string | null
+ HOOK_MFA_VERIFICATION_ATTEMPT_URI?: string | null
+ HOOK_PASSWORD_VERIFICATION_ATTEMPT_ENABLED?: boolean | null
+ HOOK_PASSWORD_VERIFICATION_ATTEMPT_SECRETS?: string | null
+ HOOK_PASSWORD_VERIFICATION_ATTEMPT_URI?: string | null
+ HOOK_SEND_EMAIL_ENABLED?: boolean | null
+ HOOK_SEND_EMAIL_SECRETS?: string | null
+ HOOK_SEND_EMAIL_URI?: string | null
+ HOOK_SEND_SMS_ENABLED?: boolean | null
+ HOOK_SEND_SMS_SECRETS?: string | null
+ HOOK_SEND_SMS_URI?: string | null
+ INDEX_WORKER_ENSURE_USER_SEARCH_INDEXES_EXIST?: boolean | null
+ JWT_EXP?: number | null
+ MAILER_ALLOW_UNVERIFIED_EMAIL_SIGN_INS?: boolean | null
+ MAILER_AUTOCONFIRM?: boolean | null
+ MAILER_NOTIFICATIONS_EMAIL_CHANGED_ENABLED?: boolean | null
+ MAILER_NOTIFICATIONS_IDENTITY_LINKED_ENABLED?: boolean | null
+ MAILER_NOTIFICATIONS_IDENTITY_UNLINKED_ENABLED?: boolean | null
+ MAILER_NOTIFICATIONS_MFA_FACTOR_ENROLLED_ENABLED?: boolean | null
+ MAILER_NOTIFICATIONS_MFA_FACTOR_UNENROLLED_ENABLED?: boolean | null
+ MAILER_NOTIFICATIONS_PASSWORD_CHANGED_ENABLED?: boolean | null
+ MAILER_NOTIFICATIONS_PHONE_CHANGED_ENABLED?: boolean | null
+ MAILER_OTP_EXP?: number
+ MAILER_OTP_LENGTH?: number | null
+ MAILER_SECURE_EMAIL_CHANGE_ENABLED?: boolean | null
+ MAILER_SUBJECTS_CONFIRMATION?: string | null
+ MAILER_SUBJECTS_EMAIL_CHANGE?: string | null
+ MAILER_SUBJECTS_EMAIL_CHANGED_NOTIFICATION?: string | null
+ MAILER_SUBJECTS_IDENTITY_LINKED_NOTIFICATION?: string | null
+ MAILER_SUBJECTS_IDENTITY_UNLINKED_NOTIFICATION?: string | null
+ MAILER_SUBJECTS_INVITE?: string | null
+ MAILER_SUBJECTS_MAGIC_LINK?: string | null
+ MAILER_SUBJECTS_MFA_FACTOR_ENROLLED_NOTIFICATION?: string | null
+ MAILER_SUBJECTS_MFA_FACTOR_UNENROLLED_NOTIFICATION?: string | null
+ MAILER_SUBJECTS_PASSWORD_CHANGED_NOTIFICATION?: string | null
+ MAILER_SUBJECTS_PHONE_CHANGED_NOTIFICATION?: string | null
+ MAILER_SUBJECTS_REAUTHENTICATION?: string | null
+ MAILER_SUBJECTS_RECOVERY?: string | null
+ MAILER_TEMPLATES_CONFIRMATION_CONTENT?: string | null
+ MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT?: string | null
+ MAILER_TEMPLATES_EMAIL_CHANGED_NOTIFICATION_CONTENT?: string | null
+ MAILER_TEMPLATES_IDENTITY_LINKED_NOTIFICATION_CONTENT?: string | null
+ MAILER_TEMPLATES_IDENTITY_UNLINKED_NOTIFICATION_CONTENT?: string | null
+ MAILER_TEMPLATES_INVITE_CONTENT?: string | null
+ MAILER_TEMPLATES_MAGIC_LINK_CONTENT?: string | null
+ MAILER_TEMPLATES_MFA_FACTOR_ENROLLED_NOTIFICATION_CONTENT?: string | null
+ MAILER_TEMPLATES_MFA_FACTOR_UNENROLLED_NOTIFICATION_CONTENT?: string | null
+ MAILER_TEMPLATES_PASSWORD_CHANGED_NOTIFICATION_CONTENT?: string | null
+ MAILER_TEMPLATES_PHONE_CHANGED_NOTIFICATION_CONTENT?: string | null
+ MAILER_TEMPLATES_REAUTHENTICATION_CONTENT?: string | null
+ MAILER_TEMPLATES_RECOVERY_CONTENT?: string | null
+ MFA_ALLOW_LOW_AAL?: boolean | null
+ MFA_MAX_ENROLLED_FACTORS?: number | null
+ MFA_PHONE_ENROLL_ENABLED?: boolean | null
+ MFA_PHONE_MAX_FREQUENCY?: number | null
+ MFA_PHONE_OTP_LENGTH?: number | null
+ MFA_PHONE_TEMPLATE?: string | null
+ MFA_PHONE_VERIFY_ENABLED?: boolean | null
+ MFA_TOTP_ENROLL_ENABLED?: boolean | null
+ MFA_TOTP_VERIFY_ENABLED?: boolean | null
+ MFA_WEB_AUTHN_ENROLL_ENABLED?: boolean | null
+ MFA_WEB_AUTHN_VERIFY_ENABLED?: boolean | null
+ NIMBUS_OAUTH_CLIENT_ID?: string | null
+ NIMBUS_OAUTH_CLIENT_SECRET?: string | null
+ OAUTH_SERVER_ALLOW_DYNAMIC_REGISTRATION?: boolean | null
+ OAUTH_SERVER_AUTHORIZATION_PATH?: string | null
+ OAUTH_SERVER_ENABLED?: boolean | null
+ PASSKEY_ENABLED?: boolean
+ PASSWORD_HIBP_ENABLED?: boolean | null
+ PASSWORD_MIN_LENGTH?: number | null
+ /** @enum {string|null} */
+ PASSWORD_REQUIRED_CHARACTERS?:
+ | 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789'
+ | 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789'
+ | 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789:!@#$%^&*()_+-=[]{};\'\\\\:"|<>?,./`~'
+ | ''
+ | null
+ RATE_LIMIT_ANONYMOUS_USERS?: number | null
+ RATE_LIMIT_EMAIL_SENT?: number | null
+ RATE_LIMIT_OTP?: number | null
+ RATE_LIMIT_SMS_SENT?: number | null
+ RATE_LIMIT_TOKEN_REFRESH?: number | null
+ RATE_LIMIT_VERIFY?: number | null
+ RATE_LIMIT_WEB3?: number | null
+ REFRESH_TOKEN_ROTATION_ENABLED?: boolean | null
+ SAML_ALLOW_ENCRYPTED_ASSERTIONS?: boolean | null
+ SAML_ENABLED?: boolean | null
+ SAML_EXTERNAL_URL?: string | null
+ SECURITY_CAPTCHA_ENABLED?: boolean | null
+ /** @enum {string|null} */
+ SECURITY_CAPTCHA_PROVIDER?: 'turnstile' | 'hcaptcha' | null
+ SECURITY_CAPTCHA_SECRET?: string | null
+ SECURITY_MANUAL_LINKING_ENABLED?: boolean | null
+ /** @description Refresh token reuse interval in seconds. Maximum 300 seconds (5 minutes). */
+ SECURITY_REFRESH_TOKEN_REUSE_INTERVAL?: number | null
+ SECURITY_SB_FORWARDED_FOR_ENABLED?: boolean | null
+ SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD?: boolean | null
+ SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION?: boolean | null
+ /** @description Session inactivity timeout in hours. Maximum 8760 hours (1 year). */
+ SESSIONS_INACTIVITY_TIMEOUT?: number | null
+ SESSIONS_SINGLE_PER_USER?: boolean | null
+ SESSIONS_TAGS?: string | null
+ /** @description Session timebox in hours. Maximum 8760 hours (1 year). */
+ SESSIONS_TIMEBOX?: number | null
+ SITE_URL?: string | null
+ SMS_AUTOCONFIRM?: boolean | null
+ SMS_MAX_FREQUENCY?: number | null
+ SMS_MESSAGEBIRD_ACCESS_KEY?: string | null
+ SMS_MESSAGEBIRD_ORIGINATOR?: string | null
+ SMS_OTP_EXP?: number | null
+ SMS_OTP_LENGTH?: number
+ /** @enum {string|null} */
+ SMS_PROVIDER?: 'messagebird' | 'textlocal' | 'twilio' | 'twilio_verify' | 'vonage' | null
+ SMS_TEMPLATE?: string | null
+ SMS_TEST_OTP?: string | null
+ /** Format: date-time */
+ SMS_TEST_OTP_VALID_UNTIL?: string | null
+ SMS_TEXTLOCAL_API_KEY?: string | null
+ SMS_TEXTLOCAL_SENDER?: string | null
+ SMS_TWILIO_ACCOUNT_SID?: string | null
+ SMS_TWILIO_AUTH_TOKEN?: string | null
+ SMS_TWILIO_CONTENT_SID?: string | null
+ SMS_TWILIO_MESSAGE_SERVICE_SID?: string | null
+ SMS_TWILIO_VERIFY_ACCOUNT_SID?: string | null
+ SMS_TWILIO_VERIFY_AUTH_TOKEN?: string | null
+ SMS_TWILIO_VERIFY_MESSAGE_SERVICE_SID?: string | null
+ SMS_VONAGE_API_KEY?: string | null
+ SMS_VONAGE_API_SECRET?: string | null
+ SMS_VONAGE_FROM?: string | null
+ /** Format: email */
+ SMTP_ADMIN_EMAIL?: string | null
+ SMTP_HOST?: string | null
+ SMTP_MAX_FREQUENCY?: number | null
+ SMTP_PASS?: string | null
+ SMTP_PORT?: string | null
+ SMTP_SENDER_NAME?: string | null
+ SMTP_USER?: string | null
+ URI_ALLOW_LIST?: string | null
+ WEBAUTHN_RP_DISPLAY_NAME?: string | null
+ WEBAUTHN_RP_ID?: string | null
+ WEBAUTHN_RP_ORIGINS?: string | null
+ }
+ UpdateGoTrueConfigHooksBody: {
+ HOOK_AFTER_USER_CREATED_ENABLED?: boolean | null
+ HOOK_AFTER_USER_CREATED_SECRETS?: string | null
+ HOOK_AFTER_USER_CREATED_URI?: string | null
+ HOOK_BEFORE_USER_CREATED_ENABLED?: boolean | null
+ HOOK_BEFORE_USER_CREATED_SECRETS?: string | null
+ HOOK_BEFORE_USER_CREATED_URI?: string | null
+ HOOK_CUSTOM_ACCESS_TOKEN_ENABLED?: boolean | null
+ HOOK_CUSTOM_ACCESS_TOKEN_SECRETS?: string | null
+ HOOK_CUSTOM_ACCESS_TOKEN_URI?: string | null
+ HOOK_MFA_VERIFICATION_ATTEMPT_ENABLED?: boolean | null
+ HOOK_MFA_VERIFICATION_ATTEMPT_SECRETS?: string | null
+ HOOK_MFA_VERIFICATION_ATTEMPT_URI?: string | null
+ HOOK_PASSWORD_VERIFICATION_ATTEMPT_ENABLED?: boolean | null
+ HOOK_PASSWORD_VERIFICATION_ATTEMPT_SECRETS?: string | null
+ HOOK_PASSWORD_VERIFICATION_ATTEMPT_URI?: string | null
+ HOOK_SEND_EMAIL_ENABLED?: boolean | null
+ HOOK_SEND_EMAIL_SECRETS?: string | null
+ HOOK_SEND_EMAIL_URI?: string | null
+ HOOK_SEND_SMS_ENABLED?: boolean | null
+ HOOK_SEND_SMS_SECRETS?: string | null
+ HOOK_SEND_SMS_URI?: string | null
+ }
+ UpdateMemberBody: {
+ role_id: number
+ }
+ UpdateMemberRoleBody: {
+ description?: string
+ name: string
+ role_scoped_projects: string[]
+ }
+ UpdateNotificationBody: {
+ /** Format: uuid */
+ id: string
+ /** @enum {string} */
+ status: 'new' | 'seen' | 'archived'
+ }[]
+ UpdateNotificationExceptionBody: {
+ /** Format: uuid */
+ assigned_to?: string
+ is_disabled?: boolean
+ lint_category?: string
+ lint_metadata?: {
+ [key: string]: unknown
+ }
+ lint_name?: string
+ note?: string
+ }
+ UpdateOrganizationBody: {
+ additional_billing_emails?: string[]
+ /** Format: email */
+ billing_email?: string
+ name?: string
+ opt_in_tags?: (
+ | 'AI_SQL_GENERATOR_OPT_IN'
+ | 'AI_DATA_GENERATOR_OPT_IN'
+ | 'AI_LOG_GENERATOR_OPT_IN'
+ )[]
+ }
+ UpdateOrganizationResponse_Output: {
+ billing_email?: string
+ id: number
+ name: string
+ opt_in_tags: string[]
+ slug: string
+ stripe_customer_id: string
+ }
+ /** @example {
+ * "password": "correct-horse-battery-staple"
+ * } */
+ UpdatePasswordBody: {
+ password: string
+ }
+ UpdatePasswordResponse_Output: {
+ message: string
+ }
+ UpdatePgbouncerConfigBody: {
+ default_pool_size?: number
+ /**
+ * @deprecated
+ * @default options,extra_float_digits
+ */
+ ignore_startup_parameters?: string
+ max_client_conn?: number
+ /** @deprecated */
+ pgbouncer_enabled?: boolean
+ /**
+ * @deprecated
+ * @enum {string}
+ */
+ pool_mode?: 'transaction' | 'session' | 'statement'
+ query_wait_timeout?: number
+ reserve_pool_size?: number
+ server_idle_timeout?: number
+ server_lifetime?: number
+ }
+ UpdatePipelineBody: {
+ /** @description Pipeline configuration patch */
config: {
- /** @description Batch configuration. Omit or use `null` for server defaults. */
+ /** @description Complete batch configuration replacement. Omission preserves it; `null` resets server defaults. */
batch?: {
/**
* @description Maximum preferred byte size for one source batch
@@ -12887,7 +13927,7 @@ export interface components {
max_copy_connections_per_table?: number | null
/** @description Maximum number of table sync workers */
max_table_sync_workers?: number | null
- /** @description Memory-based backpressure configuration. Omission enables server defaults; `null` disables it. */
+ /** @description Complete memory backpressure replacement. Omission preserves it; `null` resets server defaults. */
memory_backpressure?: {
/**
* @description Memory usage ratio above which backpressure is activated
@@ -12906,10 +13946,10 @@ export interface components {
*/
memory_refresh_interval_ms?: number | null
/**
- * @description Publication name
+ * @description Publication name. Omission preserves the stored value; Pipelines rejects clearing it with `null`.
* @example pub_orders
*/
- publication_name: string
+ publication_name?: string | null
/**
* @description Milliseconds between one replication lag refresh and another
* @example 10000
@@ -12925,7 +13965,7 @@ export interface components {
* @example 5
*/
table_error_retry_max_attempts?: number | null
- /** @description Selection rules for tables participating in initial table copy. Omit or use `null` to copy all tables. */
+ /** @description Initial-copy selection. Omission preserves it; `null` resets to copying all tables. */
table_sync_copy?:
| (
| {
@@ -12972,339 +14012,170 @@ export interface components {
*/
source_id: number
}
- CreatePipelineResponse_Output: {
+ UpdatePipelineVersionBody: {
/**
- * @description Pipeline id
- * @example 1012
+ * @description Pipeline version id
+ * @example 4
*/
- id: number
+ version_id: number
}
- PipelineResponse_Output: {
- /** @description Pipeline configuration */
- config: {
- /** @description Batch configuration */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Persisted ratio of process memory reserved for incoming stream batch bytes
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Memory-based backpressure configuration */
- memory_backpressure?: {
- /**
- * @description Persisted memory usage ratio that activates backpressure
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Persisted memory usage ratio that releases backpressure
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name
- * @example pub_orders
- */
- publication_name: string
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Selection rules for tables participating in initial table copy */
- table_sync_copy?:
- | (
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- )
- | null
- }
- /**
- * @description Destination id
- * @example 2001
- */
- destination_id: number
- /**
- * @description Destination name
- * @example bq-analytics
- */
- destination_name: string
- /**
- * @description Pipeline id
- * @example 1012
- */
- id: number
- /**
- * @description Replicator id
- * @example 9001
- */
- replicator_id: number
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- /**
- * @description Source name
- * @example main-db
- */
- source_name: string
+ UpdatePlatformAppBody: {
+ description?: string
+ name: string
+ permissions: (
+ | 'organizations_read'
+ | 'organizations_create'
+ | 'projects_read'
+ | 'snippets_read'
+ | 'organization_admin_read'
+ | 'organization_admin_write'
+ | 'members_read'
+ | 'members_write'
+ | 'organization_projects_read'
+ | 'organization_projects_create'
+ | 'platform_webhooks_organization_read'
+ | 'platform_webhooks_organization_write'
+ | 'project_admin_read'
+ | 'project_admin_write'
+ | 'action_runs_read'
+ | 'action_runs_write'
+ | 'advisors_read'
+ | 'analytics_config_read'
+ | 'analytics_config_write'
+ | 'analytics_logs_read'
+ | 'analytics_usage_read'
+ | 'api_gateway_keys_read'
+ | 'api_gateway_keys_secret_read'
+ | 'api_gateway_keys_write'
+ | 'auth_config_read'
+ | 'auth_config_write'
+ | 'auth_signing_keys_read'
+ | 'auth_signing_keys_write'
+ | 'backups_read'
+ | 'backups_write'
+ | 'branching_development_create'
+ | 'branching_development_delete'
+ | 'branching_development_read'
+ | 'branching_development_write'
+ | 'branching_production_create'
+ | 'branching_production_delete'
+ | 'branching_production_read'
+ | 'branching_production_write'
+ | 'custom_domain_read'
+ | 'custom_domain_write'
+ | 'data_api_config_read'
+ | 'data_api_config_secret_read'
+ | 'data_api_config_write'
+ | 'database_read'
+ | 'database_write'
+ | 'database_config_read'
+ | 'database_config_write'
+ | 'database_jit_read'
+ | 'database_jit_write'
+ | 'database_network_bans_read'
+ | 'database_network_bans_write'
+ | 'database_network_restrictions_read'
+ | 'database_network_restrictions_write'
+ | 'database_migrations_read'
+ | 'database_migrations_write'
+ | 'database_pooling_config_read'
+ | 'database_pooling_config_write'
+ | 'database_readonly_config_read'
+ | 'database_readonly_config_write'
+ | 'database_ssl_config_read'
+ | 'database_ssl_config_write'
+ | 'database_webhooks_config_read'
+ | 'database_webhooks_config_write'
+ | 'edge_functions_read'
+ | 'edge_functions_write'
+ | 'edge_functions_secrets_read'
+ | 'edge_functions_secrets_write'
+ | 'infra_add_ons_read'
+ | 'infra_add_ons_write'
+ | 'infra_disk_config_read'
+ | 'infra_disk_config_write'
+ | 'infra_read_replicas_read'
+ | 'infra_read_replicas_write'
+ | 'project_snippets_read'
+ | 'project_snippets_write'
+ | 'realtime_config_read'
+ | 'realtime_config_write'
+ | 'storage_read'
+ | 'storage_write'
+ | 'storage_config_read'
+ | 'storage_config_write'
+ | 'vanity_subdomain_read'
+ | 'vanity_subdomain_write'
+ | 'platform_webhooks_projects_read'
+ | 'platform_webhooks_projects_write'
+ | 'workers_read'
+ | 'workers_write'
+ )[]
+ }
+ UpdatePlatformAppInstallationResponse_Output: {
+ /** Format: uuid */
+ app_id: string
+ /** Format: date-time */
+ created_at: string
+ /** Format: uuid */
+ id: string
+ /** Format: uuid */
+ installed_by: string
+ organization_slug: string
+ permissions: string[]
+ /** Format: date-time */
+ updated_at: string
+ }
+ UpdatePoolingConfigResponse_Output: {
+ default_pool_size?: number | null
+ ignore_startup_parameters?: string | null
+ max_client_conn?: number | null
+ pgbouncer_enabled: boolean
+ /** @enum {string} */
+ pgbouncer_status: 'COMING_UP' | 'COMING_DOWN' | 'RELOADING' | 'ENABLED' | 'DISABLED'
/**
- * @description Tenant id
- * @example tenant_9f3a2c
+ * @deprecated
+ * @description Cannot be changed, this is ignored
+ * @enum {string|null}
*/
- tenant_id: string
+ pool_mode?: 'transaction' | 'session' | 'statement' | null
+ server_idle_timeout?: number | null
+ server_lifetime?: number | null
}
- UpdatePipelineBody: {
- /** @description Pipeline configuration patch */
- config: {
- /** @description Complete batch configuration replacement. Omission preserves it; `null` resets server defaults. */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Complete memory backpressure replacement. Omission preserves it; `null` resets server defaults. */
- memory_backpressure?: {
- /**
- * @description Memory usage ratio above which backpressure is activated
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Memory usage ratio below which backpressure is released
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name. Omission preserves the stored value; Pipelines rejects clearing it with `null`.
- * @example pub_orders
- */
- publication_name?: string | null
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Initial-copy selection. Omission preserves it; `null` resets to copying all tables. */
- table_sync_copy?:
- | (
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- )
- | null
+ UpdatePostgrestConfigBody: {
+ db_extra_search_path?: string
+ db_pool?: number
+ db_pool_acquisition_timeout?: number
+ db_schema?: string
+ max_rows?: number
+ }
+ UpdatePostgrestConfigResponse_Output: {
+ db_extra_search_path: string
+ /** @description If `null`, the value is automatically configured based on compute size. */
+ db_pool: number | null
+ /** @description If `null`, the value is automatically configured to 10. */
+ db_pool_acquisition_timeout: number | null
+ db_schema: string
+ max_rows: number
+ }
+ UpdatePrivateLinkBody: {
+ requestedConfig: {
+ enabled: boolean
}
- /**
- * @description Destination id
- * @example 2001
- */
- destination_id: number
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
}
- PipelineReplicationStatusResponse_Output: {
- /** @description Stats about apply worker lag */
- apply_lag?: {
- /**
- * @description Whether the slot currently has an active replication connection.
- * @example true
- */
- active: boolean
- /**
- * @description Bytes between the current WAL location and the confirmed flush LSN.
- * @example 2048
- */
- confirmed_flush_lsn_bytes: number
- /**
- * @description Flush lag expressed in milliseconds.
- * @example 1200
- */
- flush_lag?: number | null
- /**
- * @description Milliseconds elapsed since the walsender last received client feedback. This can be present even when write and flush lag are unavailable.
- * @example 5000
- */
- reply_time_lag?: number | null
- /**
- * @description Bytes between the current WAL location and the slot restart LSN.
- * @example 1024
- */
- restart_lsn_bytes: number
- /**
- * @description How many bytes of WAL are still safe to build up before the limit of the slot is reached. `null` means Postgres reports unlimited slot WAL retention.
- * @example 8192
- */
- safe_wal_size_bytes?: number | null
- /**
- * @description WAL availability status reported by Postgres for the slot.
- * @example reserved
- * @enum {string|null}
- */
- wal_status?: 'reserved' | 'extended' | 'unreserved' | 'lost' | 'unknown' | null
- /**
- * @description Write lag expressed in milliseconds.
- * @example 1500
- */
- write_lag?: number | null
- } | null
- /**
- * @description Pipeline id
- * @example 1012
- */
- pipeline_id: number
- /** @description Table statuses */
- table_statuses: {
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- id: number
+ UpdateProfileBody: {
+ first_name?: string
+ last_name?: string
+ /** Format: email */
+ primary_email?: string
+ username?: string
+ }
+ UpdateProjectBody: {
+ name: string
+ }
+ UpdatePublicationBody: {
+ /** @description Publication tables */
+ tables: {
/**
* @description Table name
* @example orders
@@ -13315,8119 +14186,1974 @@ export interface components {
* @example public
*/
schema: string
- /** @description Table replication state */
- state:
- | {
- /** @enum {string} */
- name: 'queued'
- }
- | {
- /** @enum {string} */
- name: 'copying_table'
- }
- | {
- /** @enum {string} */
- name: 'copied_table'
- }
- | {
- /** @enum {string} */
- name: 'following_wal'
- }
- | {
- /** @enum {string} */
- name: 'error'
- reason: string
- retry_policy:
- | {
- /** @enum {string} */
- policy: 'no_retry'
- }
- | {
- /** @enum {string} */
- policy: 'manual_retry'
- }
- | {
- /**
- * @description Next retry time (RFC 3339 timestamp)
- * @example 2025-01-02T03:04:05Z
- */
- next_retry: string
- /** @enum {string} */
- policy: 'timed_retry'
- }
- solution?: string | null
- }
- /**
- * @deprecated
- * @description Deprecated compatibility alias for `id`.
- * @example 16408
- */
- table_id: number
- /**
- * @deprecated
- * @description Deprecated unquoted `schema.name` compatibility representation.
- * @example public.orders
- */
- table_name: string
- /** @description Stats about table sync worker lag */
- table_sync_lag?: {
- /**
- * @description Whether the slot currently has an active replication connection.
- * @example true
- */
- active: boolean
- /**
- * @description Bytes between the current WAL location and the confirmed flush LSN.
- * @example 2048
- */
- confirmed_flush_lsn_bytes: number
- /**
- * @description Flush lag expressed in milliseconds.
- * @example 1200
- */
- flush_lag?: number | null
- /**
- * @description Milliseconds elapsed since the walsender last received client feedback. This can be present even when write and flush lag are unavailable.
- * @example 5000
- */
- reply_time_lag?: number | null
- /**
- * @description Bytes between the current WAL location and the slot restart LSN.
- * @example 1024
- */
- restart_lsn_bytes: number
- /**
- * @description How many bytes of WAL are still safe to build up before the limit of the slot is reached. `null` means Postgres reports unlimited slot WAL retention.
- * @example 8192
- */
- safe_wal_size_bytes?: number | null
- /**
- * @description WAL availability status reported by Postgres for the slot.
- * @example reserved
- * @enum {string|null}
- */
- wal_status?: 'reserved' | 'extended' | 'unreserved' | 'lost' | 'unknown' | null
- /**
- * @description Write lag expressed in milliseconds.
- * @example 1500
- */
- write_lag?: number | null
- } | null
}[]
}
- /** @description Pipeline */
- RollbackTablesResponse_Output: {
- /**
- * @description Pipeline id
- * @example 1012
- */
- pipeline_id: number
- /** @description Rolled back tables */
- tables: {
- /** @description Table replication state */
- new_state:
- | {
- /** @enum {string} */
- name: 'queued'
- }
- | {
- /** @enum {string} */
- name: 'copying_table'
- }
- | {
- /** @enum {string} */
- name: 'copied_table'
- }
- | {
- /** @enum {string} */
- name: 'following_wal'
- }
- | {
- /** @enum {string} */
- name: 'error'
- reason: string
- retry_policy:
- | {
- /** @enum {string} */
- policy: 'no_retry'
- }
- | {
- /** @enum {string} */
- policy: 'manual_retry'
- }
- | {
- /**
- * @description Next retry time (RFC 3339 timestamp)
- * @example 2025-01-02T03:04:05Z
- */
- next_retry: string
- /** @enum {string} */
- policy: 'timed_retry'
- }
- solution?: string | null
- }
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- table_id: number
- }[]
- }
- PipelineStatusResponse_Output: {
- /**
- * @description Pipeline id
- * @example 1012
- */
- pipeline_id: number
- /** @description Pipeline status */
- status: {
- /**
- * @example started
- * @enum {string}
- */
- name: 'stopped' | 'starting' | 'started' | 'stopping' | 'unknown' | 'failed'
- }
- }
- PipelineVersionResponse_Output: {
- /** @description New pipeline version */
- new_version?: {
- /**
- * @description Version id
- * @example 3
- */
- id: number
- /**
- * @description Version name
- * @example v0.3.0
- */
- name: string
- } | null
- /**
- * @description Pipeline id
- * @example 1012
- */
- pipeline_id: number
- /** @description Current pipeline version */
- version: {
- /**
- * @description Version id
- * @example 3
- */
- id: number
- /**
- * @description Version name
- * @example v0.3.0
- */
- name: string
- }
- }
- UpdatePipelineVersionBody: {
- /**
- * @description Pipeline version id
- * @example 4
- */
- version_id: number
+ UpdateRealtimeConfigBody: {
+ /** @description Sets connection pool size for Realtime Authorization */
+ connection_pool?: number
+ /** @description Sets maximum number of bytes per second rate per channel limit */
+ max_bytes_per_second?: number
+ /** @description Sets maximum number of channels per client rate limit */
+ max_channels_per_client?: number
+ /** @description Sets maximum number of concurrent users rate limit */
+ max_concurrent_users?: number
+ /** @description Sets maximum number of events per second rate per channel limit */
+ max_events_per_second?: number
+ /** @description Sets maximum number of joins per second rate limit */
+ max_joins_per_second?: number
+ /** @description Sets maximum number of payload size in KB rate limit */
+ max_payload_size_in_kb?: number
+ /** @description Sets maximum number of presence events per second rate limit */
+ max_presence_events_per_second?: number
+ /** @description Sets connection pool size used to create Postgres Changes subscriptions */
+ postgres_changes_pool?: number
+ /** @description Whether to enable presence */
+ presence_enabled?: boolean
+ /** @description Whether to only allow private channels */
+ private_only?: boolean
+ /** @description Disables the Realtime service for this project when true. Set to false to re-enable it. */
+ suspend?: boolean
}
- ValidatePipelineBody: {
- /** @description Pipeline configuration */
- config: {
- /** @description Batch configuration. Omit or use `null` for server defaults. */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Memory-based backpressure configuration. Omission enables server defaults; `null` disables it. */
- memory_backpressure?: {
- /**
- * @description Memory usage ratio above which backpressure is activated
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Memory usage ratio below which backpressure is released
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name
- * @example pub_orders
- */
- publication_name: string
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Selection rules for tables participating in initial table copy. Omit or use `null` to copy all tables. */
- table_sync_copy?:
- | (
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
+ UpdateReplicationDestinationPipelineBody: {
+ /** @description Destination configuration */
+ destination_config:
+ | {
+ big_query: {
+ /**
+ * @description Number of concurrent BigQuery Storage Write API connections.
+ * @example 8
+ */
+ connection_pool_size?: number | null
+ /**
+ * @description BigQuery dataset id
+ * @example analytics
+ */
+ dataset_id?: string | null
+ /**
+ * @description Maximum data staleness in minutes
+ * @example 5
+ */
+ max_staleness_mins?: number | null
+ /**
+ * @description BigQuery project id
+ * @example my-gcp-project
+ */
+ project_id?: string | null
+ /** @description BigQuery service account key */
+ service_account_key?: string | null
+ /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
+ table_options?: {
+ tables?: {
+ cluster_by?: string[]
+ partition_by?:
+ | (
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
+ * @enum {string}
+ */
+ kind: 'time_column'
+ }
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Exclusive end of the last partition range
+ * @example 100
+ */
+ end: number
+ /**
+ * @description Width of each partition range
+ * @example 10
+ */
+ interval: number
+ /**
+ * @description Partition by ranges of a replicated integer column
+ * @enum {string}
+ */
+ kind: 'integer_range'
+ /**
+ * @description Inclusive start of the first partition range
+ * @example 0
+ */
+ start: number
+ }
+ | {
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by the time at which BigQuery ingests each row
+ * @enum {string}
+ */
+ kind: 'ingestion_time'
+ }
+ )
+ | null
+ /**
+ * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
+ * @example 16384
+ */
+ table_id: number
+ }[]
+ } | null
+ }
+ }
+ | {
+ clickhouse: {
+ /**
+ * @description ClickHouse target database
+ * @example analytics
+ */
+ database?: string | null
+ /**
+ * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
+ * @example replacing_merge_tree
+ * @enum {string|null}
+ */
+ engine?: 'merge_tree' | 'replacing_merge_tree' | null
+ /** @description ClickHouse password. Omit for passwordless access. */
+ password?: string | null
+ /**
+ * @description ClickHouse HTTPS endpoint URL
+ * @example https://clickhouse.example.com:8443
+ */
+ url?: string | null
+ /**
+ * @description ClickHouse user name
+ * @example default
+ */
+ user?: string | null
+ }
+ }
+ | {
+ iceberg: {
+ supabase: {
+ /**
+ * @description Catalog token
+ * @example A jwt secret
+ */
+ catalog_token?: string | null
+ /**
+ * @description Namespace
+ * @example my-namespace
+ */
+ namespace?: string | null
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ project_ref?: string | null
+ /**
+ * @description S3 access key ID
+ * @example 53383b1d0cdb16a3afa63152656aa3cc
+ */
+ s3_access_key_id?: string | null
+ /**
+ * @description S3 region
+ * @example ap-southeast-1
+ */
+ s3_region?: string | null
+ /**
+ * @description S3 secret access key
+ * @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
+ */
+ s3_secret_access_key?: string | null
+ /**
+ * @description Warehouse name
+ * @example my-warehouse
+ */
+ warehouse_name?: string | null
+ }
+ }
+ }
+ | {
+ ducklake:
| {
/**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
+ * @description DuckLake catalog URL
+ * @example postgres://user:pass@localhost:5432/ducklake_catalog
*/
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
+ catalog_url?: string | null
+ /**
+ * @description DuckLake data path
+ * @example s3://<bucket-name>/
+ */
+ data_path?: string | null
+ /**
+ * @description Schema used for DuckLake metadata tables stored in PostgreSQL
+ * @example ducklake
+ */
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /**
+ * @description S3-compatible storage access key ID
+ * @example my-access-key
+ */
+ s3_access_key_id?: string | null
+ /**
+ * @description S3-compatible storage endpoint
+ * @example 127.0.0.1:5000/s3
+ */
+ s3_endpoint?: string | null
+ /**
+ * @description S3-compatible storage region
+ * @example us-east-1
+ */
+ s3_region?: string | null
+ /**
+ * @description S3-compatible storage secret access key
+ * @example my-secret-key
+ */
+ s3_secret_access_key?: string | null
+ /**
+ * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
+ * @example path
+ * @enum {string|null}
+ */
+ s3_url_style?: 'path' | 'vhost' | null
+ /**
+ * @description Whether to use SSL for S3-compatible storage
+ * @example false
+ */
+ s3_use_ssl?: boolean | null
+ table_sorting?: {
+ tables?: {
+ schema: string
+ sort_by:
+ | {
+ columns: {
+ /**
+ * @description DuckLake sort direction
+ * @example asc
+ * @enum {string}
+ */
+ direction?: 'asc' | 'desc'
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ name: string
+ /**
+ * @description Optional placement of null values in the DuckLake sort order
+ * @example last
+ * @enum {string|null}
+ */
+ nulls?: 'first' | 'last' | null
+ }[]
+ /** @enum {string} */
+ kind: 'columns'
+ }
+ | {
+ /** @enum {string} */
+ kind: 'primary_key'
+ }
+ table: string
+ }[]
+ } | null
}
| {
+ catalog:
+ | {
+ /**
+ * @description DuckLake catalog URL
+ * @example postgres://user:pass@localhost:5432/ducklake_catalog
+ */
+ catalog_url: string
+ /**
+ * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
+ * @example ducklake
+ */
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /** @enum {string} */
+ type: 'postgres_url'
+ }
+ | {
+ /**
+ * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
+ * @example ducklake
+ */
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /**
+ * @description Supabase project ref used as the DuckLake PostgreSQL catalog
+ * @example abcjuqabhgwjjutfvtpa
+ */
+ project_ref: string
+ /** @enum {string} */
+ type: 'supabase_project'
+ }
/**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
+ * @description Schema used for DuckLake metadata tables stored in PostgreSQL
+ * @example ducklake
*/
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- )
- | null
- }
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- }
- ValidatePipelineResponse_Output: {
- /** @description List of validation failures */
- validation_failures: {
- /**
- * @description Failure type
- * @example critical
- * @enum {string}
- */
- failure_type: 'critical' | 'warning'
- /**
- * @description Validation failure name
- * @example Validation Failed
- */
- name: string
- /**
- * @description Validation failure reason
- * @example The configuration is invalid
- */
- reason: string
- }[]
- }
- SourcesResponse_Output: {
- /** @description List of sources */
- sources: {
- /** @description Source configuration */
- config: {
- /**
- * @description Source host
- * @example db.internal
- */
- host: string
- /**
- * @description Source name
- * @example main-db
- */
- name: string
- /**
- * @description Source port
- * @example 5432
- */
- port: number
- /**
- * @description Source username
- * @example etl_user
- */
- username: string
- }
- /**
- * @description Source id
- * @example 3001
- */
- id: number
- /**
- * @description Source name
- * @example main-db
- */
- name: string
- /**
- * @description Tenant id
- * @example tenant_9f3a2c
- */
- tenant_id: string
- }[]
- }
- CreateSourceResponse_Output: {
- /** @description Source ID */
- id: number
- }
- PublicationsResponse_Output: {
- /** @description List of publications */
- publications: {
- /**
- * @description Publication name
- * @example pub_orders
- */
- name: string
- /** @description Publication tables */
- tables: {
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ storage:
+ | {
+ /**
+ * @description DuckLake data path
+ * @example s3://<bucket-name>/
+ */
+ data_path: string
+ /**
+ * @description S3-compatible storage access key ID
+ * @example my-access-key
+ */
+ s3_access_key_id: string
+ /**
+ * @description S3-compatible storage endpoint
+ * @example 127.0.0.1:5000/s3
+ */
+ s3_endpoint: string
+ /**
+ * @description S3-compatible storage region
+ * @example us-east-1
+ */
+ s3_region: string
+ /**
+ * @description S3-compatible storage secret access key
+ * @example my-secret-key
+ */
+ s3_secret_access_key: string
+ /**
+ * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
+ * @example path
+ * @enum {string|null}
+ */
+ s3_url_style?: 'path' | 'vhost' | null
+ /**
+ * @description Whether to use SSL for S3-compatible storage
+ * @example false
+ */
+ s3_use_ssl?: boolean | null
+ /** @enum {string} */
+ type: 's3'
+ }
+ | {
+ /**
+ * @description Storage bucket id used for DuckLake data files
+ * @example ducklake
+ */
+ bucket: string
+ /**
+ * @description Optional description for the generated Supabase Storage S3 credential
+ * @example DuckLake replication destination
+ */
+ credential_description?: string
+ /**
+ * @description Optional path prefix inside the bucket for DuckLake data files
+ * @example replication
+ */
+ path?: string
+ /**
+ * @description Supabase project ref whose Object Storage S3 API stores DuckLake data files
+ * @example abcjuqabhgwjjutfvtpa
+ */
+ project_ref: string
+ /** @enum {string} */
+ type: 'supabase_storage'
+ }
+ table_sorting?: {
+ tables?: {
+ schema: string
+ sort_by:
+ | {
+ columns: {
+ /**
+ * @description DuckLake sort direction
+ * @example asc
+ * @enum {string}
+ */
+ direction?: 'asc' | 'desc'
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ name: string
+ /**
+ * @description Optional placement of null values in the DuckLake sort order
+ * @example last
+ * @enum {string|null}
+ */
+ nulls?: 'first' | 'last' | null
+ }[]
+ /** @enum {string} */
+ kind: 'columns'
+ }
+ | {
+ /** @enum {string} */
+ kind: 'primary_key'
+ }
+ table: string
+ }[]
+ } | null
+ }
+ }
+ | {
+ snowflake: {
+ /**
+ * @description Snowflake account identifier
+ * @example MYORG-MYACCOUNT
+ */
+ account_id?: string | null
+ /**
+ * @description Snowflake target database
+ * @example ANALYTICS
+ */
+ database?: string | null
+ /** @description Snowflake RSA private key PEM contents */
+ private_key?: string | null
+ /** @description Optional passphrase for encrypted private keys */
+ private_key_passphrase?: string | null
+ /**
+ * @description Optional Snowflake role
+ * @example PIPELINES_ROLE
+ */
+ role?: string | null
+ /**
+ * @description Snowflake target schema
+ * @example PUBLIC
+ */
+ schema?: string | null
+ /**
+ * @description Snowflake user configured for key-pair authentication
+ * @example PIPELINES_USER
+ */
+ user?: string | null
+ }
+ }
+ /**
+ * @description Destination name
+ * @example bq-analytics
+ */
+ destination_name: string
+ /** @description Pipeline configuration patch */
+ pipeline_config: {
+ /** @description Complete batch configuration replacement. Omission preserves it; `null` resets server defaults. */
+ batch?: {
/**
- * @description Table id (Postgres OID)
- * @example 16408
+ * @description Maximum preferred byte size for one source batch
+ * @example 8388608
*/
- id: number
+ max_bytes?: number
/**
- * @description Table name
- * @example orders
+ * @description Maximum fill time in milliseconds
+ * @example 200
*/
- name: string
+ max_fill_ms?: number
/**
- * @description Table schema
- * @example public
+ * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
+ * @example 0.2
*/
- schema: string
- }[]
- }[]
- }
- CreatePublicationBody: {
- /**
- * @description Publication name
- * @example pub_orders
- */
- name: string
- /** @description Publication tables */
- tables: {
- /**
- * @description Table name
- * @example orders
- */
- name: string
- /**
- * @description Table schema
- * @example public
- */
- schema: string
- }[]
- }
- UpdatePublicationBody: {
- /** @description Publication tables */
- tables: {
- /**
- * @description Table name
- * @example orders
- */
- name: string
- /**
- * @description Table schema
- * @example public
- */
- schema: string
- }[]
- }
- CostEstimateResponse_Output: {
- /**
- * @description Currency of all amounts
- * @example usd
- * @enum {string}
- */
- currency: 'usd'
- /** @description Recurring per-pipeline cost */
- pipeline: {
- /**
- * @description Hourly rate charged per active pipeline
- * @example 0.053
- */
- hourly_cost: number
- /**
- * @description Projected monthly cost for an active pipeline, based on an average 730-hour month. Pipelines are billed hourly, so this is an estimate, not a metered amount.
- * @example 38.69
- */
- monthly_cost: number
- }
- /** @description Usage-based streaming cost, expressed as a rate */
- streaming: {
+ memory_budget_ratio?: number
+ } | null
/**
- * @description Usage-based streaming rate per GB. Actual cost depends on the change volume.
- * @example 3
+ * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
+ * @example error
+ * @enum {string|null}
*/
- rate_per_gb: number
- }
- /** @description One-time cost for the initial table copy */
- table_copy: {
+ invalidated_slot_behavior?: 'error' | 'recreate' | null
/**
- * @description One-time initial-copy rate per GB
- * @example 0.6
+ * @description Replicator log level
+ * @example info
+ * @enum {string|null}
*/
- rate_per_gb: number
- /** @description Per-table initial-copy cost estimate */
- tables: {
- /**
- * @description Estimated on-disk size of the table in bytes
- * @example 10960896
- */
- estimated_bytes: number
- /**
- * @description Estimated one-time initial-copy cost for the table, in the response currency
- * @example 0.01
- */
- estimated_cost: number
- /**
- * @description Whether this table has a row filter. The estimate does not account for how many rows the filter excludes, so the actual replicated volume may be lower than shown.
- * @example false
- */
- is_row_filtered: boolean
+ log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
+ /** @description Maximum number of copy connections per table */
+ max_copy_connections_per_table?: number | null
+ /** @description Maximum number of table sync workers */
+ max_table_sync_workers?: number | null
+ /** @description Complete memory backpressure replacement. Omission preserves it; `null` resets server defaults. */
+ memory_backpressure?: {
/**
- * @description Table name
- * @example orders
+ * @description Memory usage ratio above which backpressure is activated
+ * @example 0.85
*/
- name: string
+ activate_threshold: number
/**
- * @description Table schema
- * @example public
+ * @description Memory usage ratio below which backpressure is released
+ * @example 0.75
*/
- schema: string
- }[]
- /**
- * @description Total estimated bytes across all tables
- * @example 11911168
- */
- total_bytes: number
- /**
- * @description Total estimated one-time initial-copy cost
- * @example 0.01
- */
- total_cost: number
- }
- }
- TablesResponse_Output: {
- /** @description List of tables */
- tables: {
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- id: number
- /**
- * @description Table name
- * @example orders
- */
- name: string
+ resume_threshold: number
+ } | null
/**
- * @description Table schema
- * @example public
+ * @description Milliseconds between one memory usage refresh and another
+ * @example 100
*/
- schema: string
- }[]
- }
- CreateTenantSourceResponse_Output: {
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- /**
- * @description Tenant id
- * @example tenant_9f3a2c
- */
- tenant_id: string
- }
- ReadPublicationsResponse_Output: {
- /** @description List of publications */
- publications: ({
+ memory_refresh_interval_ms?: number | null
/**
- * @description Publication name
+ * @description Publication name. Omission preserves the stored value; Pipelines rejects clearing it with `null`.
* @example pub_orders
*/
- name: string
- } & {
- [key: string]: unknown
- })[]
- }
- PublicationDetailsResponse_Output: {
- config:
- | ({
- /** @description Data-change operations to publish */
- operations: ('insert' | 'update' | 'delete' | 'truncate')[]
- /**
- * @description PostgreSQL 18+ generated-column publication behavior
- * @enum {string|null}
- */
- publish_generated_columns?: 'none' | 'stored' | null
- /** @description Whether partition changes use the partition root identity */
- publish_via_partition_root: boolean
- /** @enum {string} */
- type: 'all_tables'
- } & {
- [key: string]: unknown
- })
- | ({
- /** @description Data-change operations to publish */
- operations: ('insert' | 'update' | 'delete' | 'truncate')[]
- /**
- * @description PostgreSQL 18+ generated-column publication behavior
- * @enum {string|null}
- */
- publish_generated_columns?: 'none' | 'stored' | null
- /** @description Whether partition changes use the partition root identity */
- publish_via_partition_root: boolean
- /** @description Schemas whose tables are published */
- schemas: string[]
- /** @enum {string} */
- type: 'tables_in_schema'
- } & {
- [key: string]: unknown
- })
- | ({
- /** @description Data-change operations to publish */
- operations: ('insert' | 'update' | 'delete' | 'truncate')[]
- /**
- * @description PostgreSQL 18+ generated-column publication behavior
- * @enum {string|null}
- */
- publish_generated_columns?: 'none' | 'stored' | null
- /** @description Whether partition changes use the partition root identity */
- publish_via_partition_root: boolean
- tables: ({
- /** @description Columns to publish, or null for Postgres' default column set */
- columns?: string[] | null
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- id: number
- /**
- * @description Table name
- * @example orders
- */
- name: string
- /** @description A self-contained PostgreSQL row-filter expression, or null for none */
- row_filter?: string | null
- /**
- * @description Table schema
- * @example public
- */
- schema: string
- } & {
- [key: string]: unknown
- })[]
- /** @enum {string} */
- type: 'tables'
- } & {
- [key: string]: unknown
- })
- /**
- * @description Publication name
- * @example pub_orders
- */
- name: string
- /** @description Tables currently exposed by the publication */
- tables: ({
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- id: number
+ publication_name?: string | null
/**
- * @description Whether the table can own partitions
- * @enum {string}
+ * @description Milliseconds between one replication lag refresh and another
+ * @example 10000
*/
- kind: 'table' | 'partitioned_table'
+ replication_lag_refresh_interval_ms?: number | null
/**
- * @description Table name
- * @example orders
+ * @description Milliseconds between one retry and another for timed worker retries
+ * @example 10000
*/
- name: string
- /** @description The direct partition parent's table id, if any */
- partition_parent_id?: number | null
+ table_error_retry_delay_ms?: number | null
/**
- * @description Table schema
- * @example public
+ * @description Maximum number of automatic timed retry attempts
+ * @example 5
*/
- schema: string
- } & {
- [key: string]: unknown
- })[]
- }
- PutPublicationBody:
- | {
- /** @description Data-change operations to publish */
- operations: ('insert' | 'update' | 'delete' | 'truncate')[]
- /**
- * @description PostgreSQL 18+ generated-column publication behavior
- * @enum {string|null}
- */
- publish_generated_columns?: 'none' | 'stored' | null
- /** @description Whether partition changes use the partition root identity */
- publish_via_partition_root?: boolean
- /** @enum {string} */
- type: 'all_tables'
- }
- | {
- /** @description Data-change operations to publish */
- operations: ('insert' | 'update' | 'delete' | 'truncate')[]
- /**
- * @description PostgreSQL 18+ generated-column publication behavior
- * @enum {string|null}
- */
- publish_generated_columns?: 'none' | 'stored' | null
- /** @description Whether partition changes use the partition root identity */
- publish_via_partition_root?: boolean
- /** @description Schemas whose tables are published */
- schemas: string[]
- /** @enum {string} */
- type: 'tables_in_schema'
- }
- | {
- /** @description Data-change operations to publish */
- operations: ('insert' | 'update' | 'delete' | 'truncate')[]
- /**
- * @description PostgreSQL 18+ generated-column publication behavior
- * @enum {string|null}
- */
- publish_generated_columns?: 'none' | 'stored' | null
- /** @description Whether partition changes use the partition root identity */
- publish_via_partition_root?: boolean
- tables: {
- /** @description Columns to publish, or null for Postgres' default column set */
- columns?: string[] | null
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- id: number
- /** @description A self-contained PostgreSQL row-filter expression, or null for none */
- row_filter?: string | null
- }[]
- /** @enum {string} */
- type: 'tables'
- }
- ReadTablesResponse_Output: {
- /** @description List of tables */
- tables: ({
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- id: number
- /**
- * @description Whether the table can own partitions
- * @enum {string}
- */
- kind: 'table' | 'partitioned_table'
- /**
- * @description Table name
- * @example orders
- */
- name: string
- /** @description The direct partition parent's table id, if any */
- partition_parent_id?: number | null
- /**
- * @description Table schema
- * @example public
- */
- schema: string
- } & {
- [key: string]: unknown
- })[]
- }
- ReadColumnsResponse_Output: {
- /** @description Table columns in ordinal position order */
- columns: ({
- /**
- * @description Column name
- * @example created_at
- */
- name: string
- /** @description Whether the column accepts null values */
- nullable: boolean
- /** @description Whether the column belongs to the table's primary key */
- primary_key: boolean
- /**
- * @description Postgres-formatted column type
- * @example timestamptz
- */
- type: string
- } & {
- [key: string]: unknown
- })[]
- }
- RealtimeConfigResponse: {
- /** @description Sets connection pool size for Realtime Authorization */
- connection_pool: number | null
- /** @description Sets maximum number of bytes per second rate per channel limit */
- max_bytes_per_second: number | null
- /** @description Sets maximum number of channels per client rate limit */
- max_channels_per_client: number | null
- /** @description Sets maximum number of concurrent users rate limit */
- max_concurrent_users: number | null
- /** @description Sets maximum number of events per second rate per channel limit */
- max_events_per_second: number | null
- /** @description Sets maximum number of joins per second rate limit */
- max_joins_per_second: number | null
- /** @description Sets maximum number of payload size in KB rate limit */
- max_payload_size_in_kb: number | null
- /** @description Sets maximum number of presence events per second rate limit */
- max_presence_events_per_second: number | null
- /** @description Sets connection pool size used to create Postgres Changes subscriptions */
- postgres_changes_pool: number | null
- /** @description Whether to enable presence */
- presence_enabled: boolean
- /** @description Whether to only allow private channels */
- private_only: boolean | null
- /** @description Disables the Realtime service for this project when true. Set to false to re-enable it. */
- suspend: boolean | null
- }
- RegionsInfo: {
- all: {
- smartGroup: {
- /** @enum {string} */
- code: 'americas' | 'emea' | 'apac'
- name: string
- /** @enum {string} */
- type: 'smartGroup'
- }[]
- specific: {
- /** @enum {string} */
- code:
- | 'us-east-1'
- | 'us-east-2'
- | 'us-west-1'
- | 'us-west-2'
- | 'ap-southeast-1'
- | 'ap-northeast-1'
- | 'ap-northeast-2'
- | 'ap-east-1'
- | 'ap-southeast-2'
- | 'eu-west-1'
- | 'eu-west-2'
- | 'eu-west-3'
- | 'eu-north-1'
- | 'eu-central-1'
- | 'eu-central-2'
- | 'ca-central-1'
- | 'ap-south-1'
- | 'sa-east-1'
- name: string
- /** @enum {string} */
- provider: 'AWS' | 'AWS_K8S' | 'AWS_NIMBUS'
- /** @enum {string} */
- status?: 'capacity' | 'other'
- /** @enum {string} */
- type: 'specific'
- }[]
- }
- recommendations: {
- smartGroup: {
- /** @enum {string} */
- code: 'americas' | 'emea' | 'apac'
- name: string
- /** @enum {string} */
- type: 'smartGroup'
- }
- specific: {
- /** @enum {string} */
- code:
- | 'us-east-1'
- | 'us-east-2'
- | 'us-west-1'
- | 'us-west-2'
- | 'ap-southeast-1'
- | 'ap-northeast-1'
- | 'ap-northeast-2'
- | 'ap-east-1'
- | 'ap-southeast-2'
- | 'eu-west-1'
- | 'eu-west-2'
- | 'eu-west-3'
- | 'eu-north-1'
- | 'eu-central-1'
- | 'eu-central-2'
- | 'ca-central-1'
- | 'ap-south-1'
- | 'sa-east-1'
- name: string
- /** @enum {string} */
- provider: 'AWS' | 'AWS_K8S' | 'AWS_NIMBUS'
- /** @enum {string} */
- status?: 'capacity' | 'other'
- /** @enum {string} */
- type: 'specific'
- }[]
- }
- }
- RemoveProjectResponse: {
- id: number
- name: string
- ref: string
- vercel?: {
- resourceUninstallFailure: boolean
- }
- }
- ReplicationDestinationResponse: {
- /** @description Destination configuration */
- config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size: number
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id: string
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id: string
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- }
- }
- }
- | {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database: string
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string}
- */
- engine: 'merge_tree' | 'replacing_merge_tree'
- /**
- * @description Persisted ClickHouse HTTP(S) endpoint URL
- * @example http://clickhouse.example.com:8123
- */
- url: string
- /**
- * @description ClickHouse user name
- * @example default
- */
- user: string
- }
- }
- | {
- iceberg:
+ table_error_retry_max_attempts?: number | null
+ /** @description Initial-copy selection. Omission preserves it; `null` resets to copying all tables. */
+ table_sync_copy?:
+ | (
| {
- supabase: {
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref: string
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
- }
+ /** @enum {string} */
+ type: 'include_all_tables'
}
| {
- rest: {
- /**
- * @description Iceberg REST catalog URI
- * @example https://catalog.example.com
- */
- catalog_uri: string
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string
- /**
- * @description S3-compatible storage endpoint
- * @example https://s3.example.com
- */
- s3_endpoint: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
- }
- }
- }
- | {
- ducklake: {
- /**
- * @description Persisted DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description Persisted DuckLake metadata schema
- * @example ducklake
- */
- metadata_schema?: string
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size: number
- /**
- * @description Persisted S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string
- /**
- * @description Persisted S3 URL style
- * @example path
- */
- s3_url_style?: string
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean
- }
- }
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id: string
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database: string
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema: string
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user: string
- }
- }
- /**
- * @description Destination id
- * @example 2001
- */
- id: number
- /**
- * @description Destination name
- * @example bq-analytics
- */
- name: string
- /**
- * @description Tenant id
- * @example tenant_9f3a2c
- */
- tenant_id: string
- }
- ReplicationDestinationsResponse: {
- /** @description List of destinations */
- destinations: {
- /** @description Destination configuration */
- config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size: number
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id: string
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id: string
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- }
- }
- }
- | {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database: string
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string}
- */
- engine: 'merge_tree' | 'replacing_merge_tree'
- /**
- * @description Persisted ClickHouse HTTP(S) endpoint URL
- * @example http://clickhouse.example.com:8123
- */
- url: string
- /**
- * @description ClickHouse user name
- * @example default
- */
- user: string
- }
- }
- | {
- iceberg:
- | {
- supabase: {
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref: string
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
- }
- }
- | {
- rest: {
- /**
- * @description Iceberg REST catalog URI
- * @example https://catalog.example.com
- */
- catalog_uri: string
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string
- /**
- * @description S3-compatible storage endpoint
- * @example https://s3.example.com
- */
- s3_endpoint: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
- }
- }
- }
- | {
- ducklake: {
- /**
- * @description Persisted DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description Persisted DuckLake metadata schema
- * @example ducklake
- */
- metadata_schema?: string
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size: number
- /**
- * @description Persisted S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string
- /**
- * @description Persisted S3 URL style
- * @example path
- */
- s3_url_style?: string
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean
- }
- }
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id: string
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database: string
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema: string
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user: string
- }
- }
- /**
- * @description Destination id
- * @example 2001
- */
- id: number
- /**
- * @description Destination name
- * @example bq-analytics
- */
- name: string
- /**
- * @description Tenant id
- * @example tenant_9f3a2c
- */
- tenant_id: string
- }[]
- }
- ReplicationPipelineReplicationStatusResponse: {
- /** @description Stats about apply worker lag */
- apply_lag?: {
- /**
- * @description Whether the slot currently has an active replication connection.
- * @example true
- */
- active: boolean
- /**
- * @description Bytes between the current WAL location and the confirmed flush LSN.
- * @example 2048
- */
- confirmed_flush_lsn_bytes: number
- /**
- * @description Flush lag expressed in milliseconds.
- * @example 1200
- */
- flush_lag?: number
- /**
- * @description Milliseconds elapsed since the walsender last received client feedback. This can be present even when write and flush lag are unavailable.
- * @example 5000
- */
- reply_time_lag?: number
- /**
- * @description Bytes between the current WAL location and the slot restart LSN.
- * @example 1024
- */
- restart_lsn_bytes: number
- /**
- * @description How many bytes of WAL are still safe to build up before the limit of the slot is reached. `null` means Postgres reports unlimited slot WAL retention.
- * @example 8192
- */
- safe_wal_size_bytes: number | null
- /**
- * @description WAL availability status reported by Postgres for the slot.
- * @example reserved
- * @enum {string}
- */
- wal_status?: 'reserved' | 'extended' | 'unreserved' | 'lost' | 'unknown'
- /**
- * @description Write lag expressed in milliseconds.
- * @example 1500
- */
- write_lag?: number
- }
- /**
- * @description Pipeline id
- * @example 1012
- */
- pipeline_id: number
- /** @description Table statuses */
- table_statuses: {
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- id: number
- /**
- * @description Table name
- * @example orders
- */
- name: string
- /**
- * @description Table schema
- * @example public
- */
- schema: string
- /** @description Table replication state */
- state:
- | {
- /** @enum {string} */
- name: 'queued'
- }
- | {
- /** @enum {string} */
- name: 'copying_table'
- }
- | {
- /** @enum {string} */
- name: 'copied_table'
- }
- | {
- /** @enum {string} */
- name: 'following_wal'
- }
- | {
- /** @enum {string} */
- name: 'error'
- reason: string
- retry_policy:
- | {
- /** @enum {string} */
- policy: 'no_retry'
- }
- | {
- /** @enum {string} */
- policy: 'manual_retry'
- }
- | {
- /**
- * @description Next retry time (RFC 3339 timestamp)
- * @example 2025-01-02T03:04:05Z
- */
- next_retry: string
- /** @enum {string} */
- policy: 'timed_retry'
- }
- solution?: string
- }
- /**
- * @deprecated
- * @description Deprecated compatibility alias for `id`.
- * @example 16408
- */
- table_id: number
- /**
- * @deprecated
- * @description Deprecated unquoted `schema.name` compatibility representation.
- * @example public.orders
- */
- table_name: string
- /** @description Stats about table sync worker lag */
- table_sync_lag?: {
- /**
- * @description Whether the slot currently has an active replication connection.
- * @example true
- */
- active: boolean
- /**
- * @description Bytes between the current WAL location and the confirmed flush LSN.
- * @example 2048
- */
- confirmed_flush_lsn_bytes: number
- /**
- * @description Flush lag expressed in milliseconds.
- * @example 1200
- */
- flush_lag?: number
- /**
- * @description Milliseconds elapsed since the walsender last received client feedback. This can be present even when write and flush lag are unavailable.
- * @example 5000
- */
- reply_time_lag?: number
- /**
- * @description Bytes between the current WAL location and the slot restart LSN.
- * @example 1024
- */
- restart_lsn_bytes: number
- /**
- * @description How many bytes of WAL are still safe to build up before the limit of the slot is reached. `null` means Postgres reports unlimited slot WAL retention.
- * @example 8192
- */
- safe_wal_size_bytes: number | null
- /**
- * @description WAL availability status reported by Postgres for the slot.
- * @example reserved
- * @enum {string}
- */
- wal_status?: 'reserved' | 'extended' | 'unreserved' | 'lost' | 'unknown'
- /**
- * @description Write lag expressed in milliseconds.
- * @example 1500
- */
- write_lag?: number
- }
- }[]
- }
- /** @description Pipeline */
- ReplicationPipelineResponse: {
- /** @description Pipeline configuration */
- config: {
- /** @description Batch configuration */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Persisted ratio of process memory reserved for incoming stream batch bytes
- * @example 0.2
- */
- memory_budget_ratio?: number
- }
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string}
- */
- invalidated_slot_behavior?: 'error' | 'recreate'
- /**
- * @description Replicator log level
- * @example info
- * @enum {string}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error'
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number
- /** @description Memory-based backpressure configuration */
- memory_backpressure?: {
- /**
- * @description Persisted memory usage ratio that activates backpressure
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Persisted memory usage ratio that releases backpressure
- * @example 0.75
- */
- resume_threshold: number
- }
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number
- /**
- * @description Publication name
- * @example pub_orders
- */
- publication_name: string
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number
- /** @description Selection rules for tables participating in initial table copy */
- table_sync_copy?:
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- }
- /**
- * @description Destination id
- * @example 2001
- */
- destination_id: number
- /**
- * @description Destination name
- * @example bq-analytics
- */
- destination_name: string
- /**
- * @description Pipeline id
- * @example 1012
- */
- id: number
- /**
- * @description Replicator id
- * @example 9001
- */
- replicator_id: number
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- /**
- * @description Source name
- * @example main-db
- */
- source_name: string
- /**
- * @description Tenant id
- * @example tenant_9f3a2c
- */
- tenant_id: string
- }
- ReplicationPipelinesResponse: {
- /** @description List of pipelines */
- pipelines: {
- /** @description Pipeline configuration */
- config: {
- /** @description Batch configuration */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Persisted ratio of process memory reserved for incoming stream batch bytes
- * @example 0.2
- */
- memory_budget_ratio?: number
- }
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string}
- */
- invalidated_slot_behavior?: 'error' | 'recreate'
- /**
- * @description Replicator log level
- * @example info
- * @enum {string}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error'
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number
- /** @description Memory-based backpressure configuration */
- memory_backpressure?: {
- /**
- * @description Persisted memory usage ratio that activates backpressure
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Persisted memory usage ratio that releases backpressure
- * @example 0.75
- */
- resume_threshold: number
- }
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number
- /**
- * @description Publication name
- * @example pub_orders
- */
- publication_name: string
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number
- /** @description Selection rules for tables participating in initial table copy */
- table_sync_copy?:
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- }
- /**
- * @description Destination id
- * @example 2001
- */
- destination_id: number
- /**
- * @description Destination name
- * @example bq-analytics
- */
- destination_name: string
- /**
- * @description Pipeline id
- * @example 1012
- */
- id: number
- /**
- * @description Replicator id
- * @example 9001
- */
- replicator_id: number
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- /**
- * @description Source name
- * @example main-db
- */
- source_name: string
- /**
- * @description Tenant id
- * @example tenant_9f3a2c
- */
- tenant_id: string
- }[]
- }
- ReplicationPipelineStatusResponse: {
- /**
- * @description Pipeline id
- * @example 1012
- */
- pipeline_id: number
- /** @description Pipeline status */
- status: {
- /**
- * @example started
- * @enum {string}
- */
- name: 'stopped' | 'starting' | 'started' | 'stopping' | 'unknown' | 'failed'
- }
- }
- ReplicationPipelineVersionResponse: {
- /** @description New pipeline version */
- new_version?: {
- /**
- * @description Version id
- * @example 3
- */
- id: number
- /**
- * @description Version name
- * @example v0.3.0
- */
- name: string
- }
- /**
- * @description Pipeline id
- * @example 1012
- */
- pipeline_id: number
- /** @description Current pipeline version */
- version: {
- /**
- * @description Version id
- * @example 3
- */
- id: number
- /**
- * @description Version name
- * @example v0.3.0
- */
- name: string
- }
- }
- ReplicationPublicationsResponse: {
- /** @description List of publications */
- publications: {
- /**
- * @description Publication name
- * @example pub_orders
- */
- name: string
- /** @description Publication tables */
- tables: {
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- id: number
- /**
- * @description Table name
- * @example orders
- */
- name: string
- /**
- * @description Table schema
- * @example public
- */
- schema: string
- }[]
- }[]
- }
- ReplicationSourcesResponse: {
- /** @description List of sources */
- sources: {
- /** @description Source configuration */
- config: {
- /**
- * @description Source host
- * @example db.internal
- */
- host: string
- /**
- * @description Source name
- * @example main-db
- */
- name: string
- /**
- * @description Source port
- * @example 5432
- */
- port: number
- /**
- * @description Source username
- * @example etl_user
- */
- username: string
- }
- /**
- * @description Source id
- * @example 3001
- */
- id: number
- /**
- * @description Source name
- * @example main-db
- */
- name: string
- /**
- * @description Tenant id
- * @example tenant_9f3a2c
- */
- tenant_id: string
- }[]
- }
- ReplicationTablesResponse: {
- /** @description List of tables */
- tables: {
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- id: number
- /**
- * @description Table name
- * @example orders
- */
- name: string
- /**
- * @description Table schema
- * @example public
- */
- schema: string
- }[]
- }
- RequestUpgradeBody: {
- note?: string
- /** @enum {string} */
- requested_plan: 'Pro' | 'Team' | 'Enterprise'
- }
- RequestUpgradeResponse: {
- message: string
- }
- ResetPasswordBody: {
- /** Format: email */
- email: string
- /** Format: uri */
- redirectTo?: string
- }
- ResizeBody: {
- volume_size_gb: number
- }
- ResolveConversationBody: {
- /** @enum {string} */
- aiSupportStatus: 'user_resolved' | 'bot_resolved'
- chatId: string
- conversationId: string
- }
- RestartProjectBody: {
- database_identifier?: string
- }
- RestartServicesBody: {
- restartRequest: {
- database_identifier?: string
- region: string
- services: (
- | 'adminapi'
- | 'api-gateway'
- | 'envoy'
- | 'functions'
- | 'gotrue'
- | 'kong'
- | 'pgbouncer'
- | 'pgsodium'
- | 'postgresql'
- | 'postgrest'
- | 'realtime'
- | 'storage'
- | 'walg'
- | 'autoshutdown'
- )[]
- source_notification_id?: string
- }
- }
- RestoreLogicalBackupBody: {
- id: number
- }
- RestorePhysicalBackupBody: {
- id: number
- recovery_time_target?: string
- }
- RevokeAuthorizedOAuthAppResponse: {
- authorized_at?: string
- icon?: string
- id: string
- name: string
- website: string
- }
- RollbackTablesBody: {
- /**
- * @description Rollback type
- * @example individual
- * @enum {string}
- */
- rollback_type: 'individual' | 'full'
- /** @description Rollback target */
- target:
- | {
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- table_id: number
- /** @enum {string} */
- type: 'single_table'
- }
- | {
- /** @enum {string} */
- type: 'all_errored_tables'
- }
- | {
- /** @enum {string} */
- type: 'all_tables'
- }
- }
- RollbackTablesResponse: {
- /**
- * @description Pipeline id
- * @example 1012
- */
- pipeline_id: number
- /** @description Rolled back tables */
- tables: {
- /** @description Table replication state */
- new_state:
- | {
- /** @enum {string} */
- name: 'queued'
- }
- | {
- /** @enum {string} */
- name: 'copying_table'
- }
- | {
- /** @enum {string} */
- name: 'copied_table'
- }
- | {
- /** @enum {string} */
- name: 'following_wal'
- }
- | {
- /** @enum {string} */
- name: 'error'
- reason: string
- retry_policy:
- | {
- /** @enum {string} */
- policy: 'no_retry'
- }
- | {
- /** @enum {string} */
- policy: 'manual_retry'
- }
- | {
- /**
- * @description Next retry time (RFC 3339 timestamp)
- * @example 2025-01-02T03:04:05Z
- */
- next_retry: string
- /** @enum {string} */
- policy: 'timed_retry'
- }
- solution?: string
- }
- /**
- * @description Table id (Postgres OID)
- * @example 16408
- */
- table_id: number
- }[]
- }
- RunQueryBody: {
- /** @default false */
- disable_statement_timeout?: boolean
- parameters?: unknown[]
- query: string
- }
- SendExitSurveyBody: {
- additionalFeedback?: string
- exitAction?: string
- orgSlug?: string
- projectRef?: string
- reasons: string
- }
- SendFeedbackBody: {
- additionalRedirectUrls?: string
- affectedServices?: string
- allowSupportAccess?: boolean
- browserInformation?: string
- category: string
- dashboardLogs?: string
- dashboardSentryIssueId?: string
- dashboardStudioVersion?: string
- library?: string
- message: string
- organizationSlug?: string
- pathname?: string
- projectRef?: string
- severity?: string
- siteUrl?: string
- subject?: string
- tags: string[]
- threadRef?: string
- urlToAirTable?: string
- verified?: boolean
- }
- SendFeedbackResponse: {
- conversationId?: string
- result: string
- }
- SendUpgradeSurveyBody: {
- additionalFeedback?: string
- currentPlan?: string
- orgSlug?: string
- prevPlan?: string
- reasons: string[]
- }
- ServiceVersions: {
- gotrue?: string
- postgrest?: string
- 'supabase-postgres': string
- }
- SetupIntentRequest: {
- hcaptchaToken?: string
- }
- SetupIntentResponse: {
- client_secret: string
- pending_subscription_flow_enabled_for_creation: boolean
- }
- SignedUrlResponse: {
- signedUrl: string
- }
- SignedUrlsResponse: {
- error: string | null
- path: string | null
- signedUrl: string | null
- }
- SignUpBody: {
- /** Format: email */
- email: string
- password: string
- /** Format: uri */
- redirectTo?: string
- }
- StorageAnalyticsBucketDeleteResponse: {
- message: string
- }
- StorageAnalyticsBucketNamespaceTablesResponse: {
- data: {
- name: string
- namespace: string[]
- }[]
- }
- StorageAnalyticsBucketResponse: {
- created_at: string
- name: string
- updated_at: string
- }
- StorageAnalyticsBucketsResponse: {
- data: {
- created_at: string
- name: string
- updated_at: string
- }[]
- }
- StorageBucketResponse: {
- allowed_mime_types?: string[]
- created_at: string
- file_size_limit?: number
- id: string
- name: string
- owner: string
- public: boolean
- type?: ('STANDARD' | 'ANALYTICS') | string
- updated_at: string
- }
- StorageConfigResponse: {
- capabilities: {
- iceberg_catalog: boolean
- list_v2: boolean
- }
- databasePoolMode: string
- external: {
- /** @enum {string} */
- upstreamTarget: 'main' | 'canary'
- }
- features: {
- icebergCatalog: {
- enabled: boolean
- maxCatalogs: number
- maxNamespaces: number
- maxTables: number
- }
- imageTransformation: {
- enabled: boolean
- }
- purgeCache: {
- enabled: boolean
- }
- s3Protocol: {
- enabled: boolean
- }
- vectorBuckets: {
- enabled: boolean
- maxBuckets: number
- maxIndexes: number
- }
- }
- /** Format: int64 */
- fileSizeLimit: number
- migrationVersion: string
- }
- StorageListResponseV2: {
- folders: {
- key?: string
- name: string
- }[]
- hasNext: boolean
- nextCursor?: string
- objects: {
- created_at: string
- id: string
- key?: string
- last_accessed_at: string
- metadata: {
- cacheControl?: string | null
- contentLength?: number | null
- eTag?: string | null
- httpStatusCode?: number | null
- lastModified?: string | null
- mimetype?: string | null
- size?: number | null
- } | null
- name: string
- updated_at: string
- }[]
- }
- StorageObject: {
- bucket_id?: string
- buckets?: {
- allowed_mime_types?: string[]
- created_at: string
- file_size_limit?: number
- id: string
- name: string
- owner: string
- public: boolean
- type?: ('STANDARD' | 'ANALYTICS') | string
- updated_at: string
- }
- created_at: string | null
- id: string | null
- last_accessed_at: string | null
- metadata: {
- [key: string]: unknown
- } | null
- name: string
- owner?: string
- updated_at: string | null
- }
- StorageVectorBucketListIndexesResponse: {
- indexes: {
- creationTime?: number
- dataType: 'float32' | string
- dimension: number
- distanceMetric: ('cosine' | 'euclidean' | 'dotproduct') | string
- indexName: string
- metadataConfiguration?: {
- nonFilterableMetadataKeys?: string[]
- }
- vectorBucketName: string
- }[]
- nextToken?: string
- }
- StorageVectorBucketResponse: {
- vectorBucketName: string
- }
- StorageVectorBucketsResponse: {
- nextToken?: string
- vectorBuckets: {
- vectorBucketName: string
- }[]
- }
- SupavisorConfigResponse: {
- connection_string: string
- /** @description Use connection_string instead */
- connectionString: string
- /** @enum {string} */
- database_type: 'PRIMARY' | 'READ_REPLICA'
- db_host: string
- db_name: string
- db_port: number
- db_user: string
- default_pool_size: number | null
- identifier: string
- is_using_scram_auth: boolean
- max_client_conn: number | null
- /** @enum {string} */
- pool_mode: 'transaction' | 'session'
- }
- SyncConversationMessagesBody: {
- affectedServices?: string
- allowSupportAccess?: boolean
- browserInformation?: string
- category?: string
- chatId: string
- conversationId?: string
- /** @default false */
- isInitial?: boolean
- library?: string
- messages: {
- content: string
- id: string
- /** @enum {string} */
- role: 'user' | 'assistant'
- }[]
- organizationSlug?: string
- projectRef?: string
- severity?: string
- subject: string
- }
- SyncConversationMessagesResponse: {
- conversationId?: string
- /** @enum {string} */
- result: 'success'
- }
- TaxIdResponse: {
- tax_id: {
- country: string
- type: string
- value: string
- } | null
- }
- TelemetryCallFeatureFlagsResponse: {
- [key: string]: unknown
- }
- TelemetryEventBodyV2: {
- action: string
- custom_properties: {
- [key: string]: unknown
- }
- groups?: {
- organization?: string
- project?: string
- }
- page_title: string
- page_url: string
- pathname: string
- ph: {
- language: string
- referrer: string
- search: string
- user_agent: string
- viewport_height: number
- viewport_width: number
- }
- }
- TelemetryFeatureFlagBody: {
- feature_flag_name: string
- feature_flag_value: unknown
- }
- TelemetryGroupsIdentityBody: {
- organization_slug?: string
- project_ref?: string
- }
- TelemetryGroupsResetBody: {
- reset_organization?: boolean
- reset_project?: boolean
- }
- TelemetryIdentifyBodyV2: {
- anonymous_id?: string
- organization_slug?: string
- project_ref?: string
- user_id: string
- }
- TemporaryApiKeyResponse_Output: {
- api_key: string
- }
- TransferProjectBody: {
- target_organization_slug: string
- }
- UnpauseProjectAvailableVersionsResponse: {
- available_versions: {
- /** @enum {string} */
- postgres_engine: '13' | '14' | '15' | '17' | '17-oriole'
- /** @enum {string} */
- release_channel: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
- version: string
- }[]
- }
- UnpauseProjectBody: {
- /**
- * @description Postgres engine version. If not provided, the latest version from the given release channel will be used.
- * @enum {string}
- */
- postgres_engine?: '15' | '17' | '17-oriole'
- /**
- * @description Release channel version. If not provided, GeneralAvailability will be used.
- * @enum {string}
- */
- release_channel?: 'internal' | 'alpha' | 'beta' | 'ga' | 'withdrawn' | 'preview'
- }
- UnpauseProjectResponse: {
- back_ups: {
- id: number
- }[]
- cloud_provider: string
- id: number
- organization_id: number
- region: string
- status: string
- }
- UpcomingInvoice: {
- amount_projected?: number
- amount_total: number
- billing_cycle_end: string
- billing_cycle_start: string
- currency: string
- customer_balance: number
- /** @enum {string} */
- fixed_fees_billing_mode: 'in_advance' | 'in_arrears'
- lines: {
- amount: number
- amount_before_discount: number
- breakdown?: {
- amount?: number
- /** @enum {string} */
- project_db_instance_size?:
- | 'pico'
- | 'nano'
- | 'micro'
- | 'small'
- | 'medium'
- | 'large'
- | 'xlarge'
- | '2xlarge'
- | '4xlarge'
- | '8xlarge'
- | '12xlarge'
- | '16xlarge'
- | '24xlarge'
- | '24xlarge_optimized_memory'
- | '24xlarge_optimized_cpu'
- | '24xlarge_high_memory'
- | '48xlarge'
- | '48xlarge_optimized_memory'
- | '48xlarge_optimized_cpu'
- | '48xlarge_high_memory'
- project_name: string
- project_ref: string
- /** @enum {string} */
- project_status?:
- | 'INACTIVE'
- | 'ACTIVE_HEALTHY'
- | 'ACTIVE_UNHEALTHY'
- | 'COMING_UP'
- | 'UNKNOWN'
- | 'GOING_DOWN'
- | 'INIT_FAILED'
- | 'REMOVED'
- | 'RESTORING'
- | 'UPGRADING'
- | 'PAUSING'
- | 'RESTORE_FAILED'
- | 'RESTARTING'
- | 'PAUSE_FAILED'
- | 'RESIZING'
- usage: number
- }[]
- description: string
- item_name: string
- metadata?: {
- is_branch?: boolean
- is_read_replica?: boolean
- }
- period?: {
- end: string
- start: string
- }
- proration: boolean
- quantity: number | null
- unit_price: number | null
- unit_price_desc: string | null
- usage_based: boolean
- /** @enum {string} */
- usage_metric?:
- | 'EGRESS'
- | 'CACHED_EGRESS'
- | 'DATABASE_SIZE'
- | 'STORAGE_SIZE'
- | 'MONTHLY_ACTIVE_USERS'
- | 'MONTHLY_ACTIVE_SSO_USERS'
- | 'FUNCTION_INVOCATIONS'
- | 'FUNCTION_CPU_MILLISECONDS'
- | 'STORAGE_IMAGES_TRANSFORMED'
- | 'REALTIME_MESSAGE_COUNT'
- | 'REALTIME_PEAK_CONNECTIONS'
- | 'DISK_SIZE_GB_HOURS_GP3'
- | 'DISK_SIZE_GB_HOURS_IO2'
- | 'AUTH_MFA_PHONE'
- | 'AUTH_MFA_WEB_AUTHN'
- | 'LOG_DRAIN_EVENTS'
- | 'MONTHLY_ACTIVE_THIRD_PARTY_USERS'
- | 'DISK_THROUGHPUT_GP3'
- | 'DISK_IOPS_GP3'
- | 'DISK_IOPS_IO2'
- | 'COMPUTE_HOURS_BRANCH'
- | 'COMPUTE_HOURS_XS'
- | 'COMPUTE_HOURS_SM'
- | 'COMPUTE_HOURS_MD'
- | 'COMPUTE_HOURS_L'
- | 'COMPUTE_HOURS_XL'
- | 'COMPUTE_HOURS_2XL'
- | 'COMPUTE_HOURS_4XL'
- | 'COMPUTE_HOURS_8XL'
- | 'COMPUTE_HOURS_12XL'
- | 'COMPUTE_HOURS_16XL'
- | 'COMPUTE_HOURS_24XL'
- | 'COMPUTE_HOURS_24XL_OPTIMIZED_CPU'
- | 'COMPUTE_HOURS_24XL_OPTIMIZED_MEMORY'
- | 'COMPUTE_HOURS_24XL_HIGH_MEMORY'
- | 'COMPUTE_HOURS_48XL'
- | 'COMPUTE_HOURS_48XL_OPTIMIZED_CPU'
- | 'COMPUTE_HOURS_48XL_OPTIMIZED_MEMORY'
- | 'COMPUTE_HOURS_48XL_HIGH_MEMORY'
- | 'CUSTOM_DOMAIN'
- | 'PITR_7'
- | 'PITR_14'
- | 'PITR_28'
- | 'IPV4'
- | 'LOG_DRAIN'
- | 'ETL_PIPELINE'
- | 'ETL_REPLICATED_DATA'
- | 'ETL_COPY_BACKFILL_DATA'
- | 'LOG_INGESTION'
- | 'LOG_QUERYING'
- | 'LOG_STORAGE'
- | 'ACTIVE_COMPUTE_HOURS'
- usage_original?: number
- }[]
- subscription_id: string
- tax: {
- currency: string
- tax_amount: number
- tax_rate_percentage: number
- total_amount_excluding_tax: number
- total_amount_including_tax: number
- } | null
- /** @enum {string} */
- tax_status: 'calculated' | 'not_applicable' | 'failed'
- }
- UpdateAddonBody: {
- /** @enum {string} */
- addon_type:
- | 'custom_domain'
- | 'compute_instance'
- | 'pitr'
- | 'ipv4'
- | 'auth_mfa_phone'
- | 'auth_mfa_web_authn'
- | 'log_drain'
- | 'etl_pipeline'
- /** @enum {string} */
- addon_variant:
- | 'ci_micro'
- | 'ci_small'
- | 'ci_medium'
- | 'ci_large'
- | 'ci_xlarge'
- | 'ci_2xlarge'
- | 'ci_4xlarge'
- | 'ci_8xlarge'
- | 'ci_12xlarge'
- | 'ci_16xlarge'
- | 'ci_24xlarge'
- | 'ci_24xlarge_optimized_cpu'
- | 'ci_24xlarge_optimized_memory'
- | 'ci_24xlarge_high_memory'
- | 'ci_48xlarge'
- | 'ci_48xlarge_optimized_cpu'
- | 'ci_48xlarge_optimized_memory'
- | 'ci_48xlarge_high_memory'
- | 'cd_default'
- | 'pitr_7'
- | 'pitr_14'
- | 'pitr_28'
- | 'ipv4_default'
- | 'auth_mfa_phone_default'
- | 'auth_mfa_web_authn_default'
- | 'log_drain_default'
- | 'etl_pipeline_default'
- }
- UpdateBackendParamsOpenapi: {
- config?:
- | {
- gzip?: boolean
- headers?: {
- [key: string]: string
- }
- /** @enum {string} */
- http?: 'http1' | 'http2'
- url?: string
- }
- | {
- api_key?: string
- region?: string
- }
- | {
- headers?: {
- [key: string]: string
- }
- password?: string | null
- url?: string
- username?: string | null
- }
- | {
- dsn?: string
- }
- | {
- api_token?: string
- dataset_name?: string
- domain?: string
- }
- | {
- ca_cert?: string
- cipher_key?: string
- client_cert?: string
- client_key?: string
- host?: string
- port?: number
- structured_data?: string
- /** @default false */
- tls?: boolean
- }
- | {
- access_key_id?: string
- batch_timeout?: number
- s3_bucket?: string
- secret_access_key?: string
- storage_region?: string
- }
- | {
- password?: string
- region?: string
- username?: string
- }
- | {
- endpoint?: string
- /** @default true */
- gzip?: boolean
- /** @default {} */
- headers?: {
- [key: string]: string
- }
- /** @default http/protobuf */
- protocol?: string
- }
- description?: string
- name?: string
- /** @enum {string} */
- type?:
- | 'postgres'
- | 'bigquery'
- | 'clickhouse'
- | 'webhook'
- | 'datadog'
- | 'loki'
- | 'sentry'
- | 's3'
- | 'axiom'
- | 'last9'
- | 'otlp'
- | 'syslog'
- }
- UpdateContentFolderBody: {
- name: string
- }
- UpdateConversationCustomFieldsBody: {
- /** @default false */
- allow_support_access?: boolean
- /** @default Problem */
- category?: string
- org_id: number
- project_ref?: string
- }
- UpdateConversationCustomFieldsResponse: {
- /** @enum {string} */
- result: 'success'
- }
- UpdateConversationLifecycleResponse: {
- /** @enum {string} */
- aiSupportStatus: 'bot_active' | 'escalated' | 'user_resolved' | 'bot_resolved'
- conversationId: string
- /** @enum {string} */
- result: 'success'
- }
- UpdateDiskAutoscaleConfig: {
- /**
- * @description Growth percentage for disk autoscaling
- * @default 50
- */
- growth_percent?: number
- /**
- * @description Maximum limit the disk size will grow to in GB
- * @default 61440
- */
- max_size_gb?: number
- /**
- * @description Minimum increment size for disk autoscaling in GB
- * @default 4
- */
- min_increment_gb?: number
- }
- UpdateEmailBody: {
- newEmail: string
- }
- UpdateGitHubConnectionBody: {
- branch_limit?: number
- new_branch_per_pr?: boolean
- supabase_changes_only?: boolean
- workdir?: string
- }
- UpdateGoTrueConfigBody: {
- API_MAX_REQUEST_DURATION?: number | null
- AUDIT_LOG_DISABLE_POSTGRES?: boolean | null
- CUSTOM_OAUTH_ENABLED?: boolean
- DB_MAX_POOL_SIZE?: number | null
- /** @enum {string|null} */
- DB_MAX_POOL_SIZE_UNIT?: 'connections' | 'percent' | null
- DISABLE_SIGNUP?: boolean | null
- EXTERNAL_ANONYMOUS_USERS_ENABLED?: boolean | null
- EXTERNAL_APPLE_ADDITIONAL_CLIENT_IDS?: string | null
- EXTERNAL_APPLE_CLIENT_ID?: string | null
- EXTERNAL_APPLE_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_APPLE_ENABLED?: boolean | null
- EXTERNAL_APPLE_SECRET?: string | null
- EXTERNAL_AZURE_CLIENT_ID?: string | null
- EXTERNAL_AZURE_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_AZURE_ENABLED?: boolean | null
- EXTERNAL_AZURE_SECRET?: string | null
- EXTERNAL_AZURE_URL?: string | null
- EXTERNAL_BITBUCKET_CLIENT_ID?: string | null
- EXTERNAL_BITBUCKET_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_BITBUCKET_ENABLED?: boolean | null
- EXTERNAL_BITBUCKET_SECRET?: string | null
- EXTERNAL_DISCORD_CLIENT_ID?: string | null
- EXTERNAL_DISCORD_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_DISCORD_ENABLED?: boolean | null
- EXTERNAL_DISCORD_SECRET?: string | null
- EXTERNAL_EMAIL_ENABLED?: boolean | null
- EXTERNAL_FACEBOOK_CLIENT_ID?: string | null
- EXTERNAL_FACEBOOK_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_FACEBOOK_ENABLED?: boolean | null
- EXTERNAL_FACEBOOK_SECRET?: string | null
- EXTERNAL_FIGMA_CLIENT_ID?: string | null
- EXTERNAL_FIGMA_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_FIGMA_ENABLED?: boolean | null
- EXTERNAL_FIGMA_SECRET?: string | null
- EXTERNAL_GITHUB_CLIENT_ID?: string | null
- EXTERNAL_GITHUB_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_GITHUB_ENABLED?: boolean | null
- EXTERNAL_GITHUB_SECRET?: string | null
- EXTERNAL_GITLAB_CLIENT_ID?: string | null
- EXTERNAL_GITLAB_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_GITLAB_ENABLED?: boolean | null
- EXTERNAL_GITLAB_SECRET?: string | null
- EXTERNAL_GITLAB_URL?: string | null
- EXTERNAL_GOOGLE_ADDITIONAL_CLIENT_IDS?: string | null
- EXTERNAL_GOOGLE_CLIENT_ID?: string | null
- EXTERNAL_GOOGLE_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_GOOGLE_ENABLED?: boolean | null
- EXTERNAL_GOOGLE_SECRET?: string | null
- EXTERNAL_GOOGLE_SKIP_NONCE_CHECK?: boolean | null
- EXTERNAL_KAKAO_CLIENT_ID?: string | null
- EXTERNAL_KAKAO_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_KAKAO_ENABLED?: boolean | null
- EXTERNAL_KAKAO_SECRET?: string | null
- EXTERNAL_KEYCLOAK_CLIENT_ID?: string | null
- EXTERNAL_KEYCLOAK_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_KEYCLOAK_ENABLED?: boolean | null
- EXTERNAL_KEYCLOAK_SECRET?: string | null
- EXTERNAL_KEYCLOAK_URL?: string | null
- EXTERNAL_LINKEDIN_OIDC_CLIENT_ID?: string | null
- EXTERNAL_LINKEDIN_OIDC_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_LINKEDIN_OIDC_ENABLED?: boolean | null
- EXTERNAL_LINKEDIN_OIDC_SECRET?: string | null
- EXTERNAL_NOTION_CLIENT_ID?: string | null
- EXTERNAL_NOTION_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_NOTION_ENABLED?: boolean | null
- EXTERNAL_NOTION_SECRET?: string | null
- EXTERNAL_PHONE_ENABLED?: boolean | null
- EXTERNAL_SLACK_CLIENT_ID?: string | null
- EXTERNAL_SLACK_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_SLACK_ENABLED?: boolean | null
- EXTERNAL_SLACK_OIDC_CLIENT_ID?: string | null
- EXTERNAL_SLACK_OIDC_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_SLACK_OIDC_ENABLED?: boolean | null
- EXTERNAL_SLACK_OIDC_SECRET?: string | null
- EXTERNAL_SLACK_SECRET?: string | null
- EXTERNAL_SPOTIFY_CLIENT_ID?: string | null
- EXTERNAL_SPOTIFY_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_SPOTIFY_ENABLED?: boolean | null
- EXTERNAL_SPOTIFY_SECRET?: string | null
- EXTERNAL_TWITCH_CLIENT_ID?: string | null
- EXTERNAL_TWITCH_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_TWITCH_ENABLED?: boolean | null
- EXTERNAL_TWITCH_SECRET?: string | null
- EXTERNAL_TWITTER_CLIENT_ID?: string | null
- EXTERNAL_TWITTER_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_TWITTER_ENABLED?: boolean | null
- EXTERNAL_TWITTER_SECRET?: string | null
- EXTERNAL_WEB3_ETHEREUM_ENABLED?: boolean | null
- EXTERNAL_WEB3_SOLANA_ENABLED?: boolean | null
- EXTERNAL_WORKOS_CLIENT_ID?: string | null
- EXTERNAL_WORKOS_ENABLED?: boolean | null
- EXTERNAL_WORKOS_SECRET?: string | null
- EXTERNAL_WORKOS_URL?: string | null
- EXTERNAL_X_CLIENT_ID?: string | null
- EXTERNAL_X_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_X_ENABLED?: boolean | null
- EXTERNAL_X_SECRET?: string | null
- EXTERNAL_ZOOM_CLIENT_ID?: string | null
- EXTERNAL_ZOOM_EMAIL_OPTIONAL?: boolean | null
- EXTERNAL_ZOOM_ENABLED?: boolean | null
- EXTERNAL_ZOOM_SECRET?: string | null
- HOOK_AFTER_USER_CREATED_ENABLED?: boolean | null
- HOOK_AFTER_USER_CREATED_SECRETS?: string | null
- HOOK_AFTER_USER_CREATED_URI?: string | null
- HOOK_BEFORE_USER_CREATED_ENABLED?: boolean | null
- HOOK_BEFORE_USER_CREATED_SECRETS?: string | null
- HOOK_BEFORE_USER_CREATED_URI?: string | null
- HOOK_CUSTOM_ACCESS_TOKEN_ENABLED?: boolean | null
- HOOK_CUSTOM_ACCESS_TOKEN_SECRETS?: string | null
- HOOK_CUSTOM_ACCESS_TOKEN_URI?: string | null
- HOOK_MFA_VERIFICATION_ATTEMPT_ENABLED?: boolean | null
- HOOK_MFA_VERIFICATION_ATTEMPT_SECRETS?: string | null
- HOOK_MFA_VERIFICATION_ATTEMPT_URI?: string | null
- HOOK_PASSWORD_VERIFICATION_ATTEMPT_ENABLED?: boolean | null
- HOOK_PASSWORD_VERIFICATION_ATTEMPT_SECRETS?: string | null
- HOOK_PASSWORD_VERIFICATION_ATTEMPT_URI?: string | null
- HOOK_SEND_EMAIL_ENABLED?: boolean | null
- HOOK_SEND_EMAIL_SECRETS?: string | null
- HOOK_SEND_EMAIL_URI?: string | null
- HOOK_SEND_SMS_ENABLED?: boolean | null
- HOOK_SEND_SMS_SECRETS?: string | null
- HOOK_SEND_SMS_URI?: string | null
- INDEX_WORKER_ENSURE_USER_SEARCH_INDEXES_EXIST?: boolean | null
- JWT_EXP?: number | null
- MAILER_ALLOW_UNVERIFIED_EMAIL_SIGN_INS?: boolean | null
- MAILER_AUTOCONFIRM?: boolean | null
- MAILER_NOTIFICATIONS_EMAIL_CHANGED_ENABLED?: boolean | null
- MAILER_NOTIFICATIONS_IDENTITY_LINKED_ENABLED?: boolean | null
- MAILER_NOTIFICATIONS_IDENTITY_UNLINKED_ENABLED?: boolean | null
- MAILER_NOTIFICATIONS_MFA_FACTOR_ENROLLED_ENABLED?: boolean | null
- MAILER_NOTIFICATIONS_MFA_FACTOR_UNENROLLED_ENABLED?: boolean | null
- MAILER_NOTIFICATIONS_PASSWORD_CHANGED_ENABLED?: boolean | null
- MAILER_NOTIFICATIONS_PHONE_CHANGED_ENABLED?: boolean | null
- MAILER_OTP_EXP?: number
- MAILER_OTP_LENGTH?: number | null
- MAILER_SECURE_EMAIL_CHANGE_ENABLED?: boolean | null
- MAILER_SUBJECTS_CONFIRMATION?: string | null
- MAILER_SUBJECTS_EMAIL_CHANGE?: string | null
- MAILER_SUBJECTS_EMAIL_CHANGED_NOTIFICATION?: string | null
- MAILER_SUBJECTS_IDENTITY_LINKED_NOTIFICATION?: string | null
- MAILER_SUBJECTS_IDENTITY_UNLINKED_NOTIFICATION?: string | null
- MAILER_SUBJECTS_INVITE?: string | null
- MAILER_SUBJECTS_MAGIC_LINK?: string | null
- MAILER_SUBJECTS_MFA_FACTOR_ENROLLED_NOTIFICATION?: string | null
- MAILER_SUBJECTS_MFA_FACTOR_UNENROLLED_NOTIFICATION?: string | null
- MAILER_SUBJECTS_PASSWORD_CHANGED_NOTIFICATION?: string | null
- MAILER_SUBJECTS_PHONE_CHANGED_NOTIFICATION?: string | null
- MAILER_SUBJECTS_REAUTHENTICATION?: string | null
- MAILER_SUBJECTS_RECOVERY?: string | null
- MAILER_TEMPLATES_CONFIRMATION_CONTENT?: string | null
- MAILER_TEMPLATES_EMAIL_CHANGE_CONTENT?: string | null
- MAILER_TEMPLATES_EMAIL_CHANGED_NOTIFICATION_CONTENT?: string | null
- MAILER_TEMPLATES_IDENTITY_LINKED_NOTIFICATION_CONTENT?: string | null
- MAILER_TEMPLATES_IDENTITY_UNLINKED_NOTIFICATION_CONTENT?: string | null
- MAILER_TEMPLATES_INVITE_CONTENT?: string | null
- MAILER_TEMPLATES_MAGIC_LINK_CONTENT?: string | null
- MAILER_TEMPLATES_MFA_FACTOR_ENROLLED_NOTIFICATION_CONTENT?: string | null
- MAILER_TEMPLATES_MFA_FACTOR_UNENROLLED_NOTIFICATION_CONTENT?: string | null
- MAILER_TEMPLATES_PASSWORD_CHANGED_NOTIFICATION_CONTENT?: string | null
- MAILER_TEMPLATES_PHONE_CHANGED_NOTIFICATION_CONTENT?: string | null
- MAILER_TEMPLATES_REAUTHENTICATION_CONTENT?: string | null
- MAILER_TEMPLATES_RECOVERY_CONTENT?: string | null
- MFA_ALLOW_LOW_AAL?: boolean | null
- MFA_MAX_ENROLLED_FACTORS?: number | null
- MFA_PHONE_ENROLL_ENABLED?: boolean | null
- MFA_PHONE_MAX_FREQUENCY?: number | null
- MFA_PHONE_OTP_LENGTH?: number | null
- MFA_PHONE_TEMPLATE?: string | null
- MFA_PHONE_VERIFY_ENABLED?: boolean | null
- MFA_TOTP_ENROLL_ENABLED?: boolean | null
- MFA_TOTP_VERIFY_ENABLED?: boolean | null
- MFA_WEB_AUTHN_ENROLL_ENABLED?: boolean | null
- MFA_WEB_AUTHN_VERIFY_ENABLED?: boolean | null
- NIMBUS_OAUTH_CLIENT_ID?: string | null
- NIMBUS_OAUTH_CLIENT_SECRET?: string | null
- OAUTH_SERVER_ALLOW_DYNAMIC_REGISTRATION?: boolean | null
- OAUTH_SERVER_AUTHORIZATION_PATH?: string | null
- OAUTH_SERVER_ENABLED?: boolean | null
- PASSKEY_ENABLED?: boolean
- PASSWORD_HIBP_ENABLED?: boolean | null
- PASSWORD_MIN_LENGTH?: number | null
- /** @enum {string|null} */
- PASSWORD_REQUIRED_CHARACTERS?:
- | 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789'
- | 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789'
- | 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789:!@#$%^&*()_+-=[]{};\'\\\\:"|<>?,./`~'
- | ''
- | null
- RATE_LIMIT_ANONYMOUS_USERS?: number | null
- RATE_LIMIT_EMAIL_SENT?: number | null
- RATE_LIMIT_OTP?: number | null
- RATE_LIMIT_SMS_SENT?: number | null
- RATE_LIMIT_TOKEN_REFRESH?: number | null
- RATE_LIMIT_VERIFY?: number | null
- RATE_LIMIT_WEB3?: number | null
- REFRESH_TOKEN_ROTATION_ENABLED?: boolean | null
- SAML_ALLOW_ENCRYPTED_ASSERTIONS?: boolean | null
- SAML_ENABLED?: boolean | null
- SAML_EXTERNAL_URL?: string | null
- SECURITY_CAPTCHA_ENABLED?: boolean | null
- /** @enum {string|null} */
- SECURITY_CAPTCHA_PROVIDER?: 'turnstile' | 'hcaptcha' | null
- SECURITY_CAPTCHA_SECRET?: string | null
- SECURITY_MANUAL_LINKING_ENABLED?: boolean | null
- SECURITY_REFRESH_TOKEN_REUSE_INTERVAL?: number | null
- SECURITY_SB_FORWARDED_FOR_ENABLED?: boolean | null
- SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD?: boolean | null
- SECURITY_UPDATE_PASSWORD_REQUIRE_REAUTHENTICATION?: boolean | null
- SESSIONS_INACTIVITY_TIMEOUT?: number | null
- SESSIONS_SINGLE_PER_USER?: boolean | null
- SESSIONS_TAGS?: string | null
- SESSIONS_TIMEBOX?: number | null
- SITE_URL?: string | null
- SMS_AUTOCONFIRM?: boolean | null
- SMS_MAX_FREQUENCY?: number | null
- SMS_MESSAGEBIRD_ACCESS_KEY?: string | null
- SMS_MESSAGEBIRD_ORIGINATOR?: string | null
- SMS_OTP_EXP?: number | null
- SMS_OTP_LENGTH?: number
- /** @enum {string|null} */
- SMS_PROVIDER?: 'messagebird' | 'textlocal' | 'twilio' | 'twilio_verify' | 'vonage' | null
- SMS_TEMPLATE?: string | null
- SMS_TEST_OTP?: string | null
- /** Format: date-time */
- SMS_TEST_OTP_VALID_UNTIL?: string | null
- SMS_TEXTLOCAL_API_KEY?: string | null
- SMS_TEXTLOCAL_SENDER?: string | null
- SMS_TWILIO_ACCOUNT_SID?: string | null
- SMS_TWILIO_AUTH_TOKEN?: string | null
- SMS_TWILIO_CONTENT_SID?: string | null
- SMS_TWILIO_MESSAGE_SERVICE_SID?: string | null
- SMS_TWILIO_VERIFY_ACCOUNT_SID?: string | null
- SMS_TWILIO_VERIFY_AUTH_TOKEN?: string | null
- SMS_TWILIO_VERIFY_MESSAGE_SERVICE_SID?: string | null
- SMS_VONAGE_API_KEY?: string | null
- SMS_VONAGE_API_SECRET?: string | null
- SMS_VONAGE_FROM?: string | null
- /** Format: email */
- SMTP_ADMIN_EMAIL?: string | null
- SMTP_HOST?: string | null
- SMTP_MAX_FREQUENCY?: number | null
- SMTP_PASS?: string | null
- SMTP_PORT?: string | null
- SMTP_SENDER_NAME?: string | null
- SMTP_USER?: string | null
- URI_ALLOW_LIST?: string | null
- WEBAUTHN_RP_DISPLAY_NAME?: string | null
- WEBAUTHN_RP_ID?: string | null
- WEBAUTHN_RP_ORIGINS?: string | null
- }
- UpdateGoTrueConfigHooksBody: {
- HOOK_AFTER_USER_CREATED_ENABLED?: boolean | null
- HOOK_AFTER_USER_CREATED_SECRETS?: string | null
- HOOK_AFTER_USER_CREATED_URI?: string | null
- HOOK_BEFORE_USER_CREATED_ENABLED?: boolean | null
- HOOK_BEFORE_USER_CREATED_SECRETS?: string | null
- HOOK_BEFORE_USER_CREATED_URI?: string | null
- HOOK_CUSTOM_ACCESS_TOKEN_ENABLED?: boolean | null
- HOOK_CUSTOM_ACCESS_TOKEN_SECRETS?: string | null
- HOOK_CUSTOM_ACCESS_TOKEN_URI?: string | null
- HOOK_MFA_VERIFICATION_ATTEMPT_ENABLED?: boolean | null
- HOOK_MFA_VERIFICATION_ATTEMPT_SECRETS?: string | null
- HOOK_MFA_VERIFICATION_ATTEMPT_URI?: string | null
- HOOK_PASSWORD_VERIFICATION_ATTEMPT_ENABLED?: boolean | null
- HOOK_PASSWORD_VERIFICATION_ATTEMPT_SECRETS?: string | null
- HOOK_PASSWORD_VERIFICATION_ATTEMPT_URI?: string | null
- HOOK_SEND_EMAIL_ENABLED?: boolean | null
- HOOK_SEND_EMAIL_SECRETS?: string | null
- HOOK_SEND_EMAIL_URI?: string | null
- HOOK_SEND_SMS_ENABLED?: boolean | null
- HOOK_SEND_SMS_SECRETS?: string | null
- HOOK_SEND_SMS_URI?: string | null
- }
- UpdateMemberBody: {
- role_id: number
- }
- UpdateMemberRoleBody: {
- description?: string
- name: string
- role_scoped_projects: string[]
- }
- UpdateNotificationBody: {
- /** Format: uuid */
- id: string
- /** @enum {string} */
- status: 'new' | 'seen' | 'archived'
- }[]
- UpdateNotificationExceptionBody: {
- /** Format: uuid */
- assigned_to?: string
- is_disabled?: boolean
- lint_category?: string
- lint_metadata?: {
- [key: string]: unknown
- }
- lint_name?: string
- note?: string
- }
- UpdateOrganizationBody: {
- additional_billing_emails?: string[]
- /** Format: email */
- billing_email?: string
- name?: string
- opt_in_tags?: (
- | 'AI_SQL_GENERATOR_OPT_IN'
- | 'AI_DATA_GENERATOR_OPT_IN'
- | 'AI_LOG_GENERATOR_OPT_IN'
- )[]
- }
- UpdateOrganizationResponse: {
- billing_email?: string
- id: number
- name: string
- opt_in_tags: string[]
- slug: string
- stripe_customer_id: string
- }
- /** @example {
- * "password": "correct-horse-battery-staple"
- * } */
- UpdatePasswordBody: {
- password: string
- }
- UpdatePgbouncerConfigBody: {
- default_pool_size?: number
- /**
- * @deprecated
- * @default options,extra_float_digits
- */
- ignore_startup_parameters?: string
- max_client_conn?: number
- /** @deprecated */
- pgbouncer_enabled?: boolean
- /**
- * @deprecated
- * @enum {string}
- */
- pool_mode?: 'transaction' | 'session' | 'statement'
- query_wait_timeout?: number
- reserve_pool_size?: number
- server_idle_timeout?: number
- server_lifetime?: number
- }
- UpdatePlatformAppBody: {
- description?: string
- name: string
- permissions: (
- | 'organizations_read'
- | 'organizations_create'
- | 'projects_read'
- | 'snippets_read'
- | 'organization_admin_read'
- | 'organization_admin_write'
- | 'members_read'
- | 'members_write'
- | 'organization_projects_read'
- | 'organization_projects_create'
- | 'platform_webhooks_organization_read'
- | 'platform_webhooks_organization_write'
- | 'project_admin_read'
- | 'project_admin_write'
- | 'action_runs_read'
- | 'action_runs_write'
- | 'advisors_read'
- | 'analytics_config_read'
- | 'analytics_config_write'
- | 'analytics_logs_read'
- | 'analytics_usage_read'
- | 'api_gateway_keys_read'
- | 'api_gateway_keys_write'
- | 'auth_config_read'
- | 'auth_config_write'
- | 'auth_signing_keys_read'
- | 'auth_signing_keys_write'
- | 'backups_read'
- | 'backups_write'
- | 'branching_development_create'
- | 'branching_development_delete'
- | 'branching_development_read'
- | 'branching_development_write'
- | 'branching_production_create'
- | 'branching_production_delete'
- | 'branching_production_read'
- | 'branching_production_write'
- | 'custom_domain_read'
- | 'custom_domain_write'
- | 'data_api_config_read'
- | 'data_api_config_write'
- | 'database_read'
- | 'database_write'
- | 'database_config_read'
- | 'database_config_write'
- | 'database_jit_read'
- | 'database_jit_write'
- | 'database_network_bans_read'
- | 'database_network_bans_write'
- | 'database_network_restrictions_read'
- | 'database_network_restrictions_write'
- | 'database_migrations_read'
- | 'database_migrations_write'
- | 'database_pooling_config_read'
- | 'database_pooling_config_write'
- | 'database_readonly_config_read'
- | 'database_readonly_config_write'
- | 'database_ssl_config_read'
- | 'database_ssl_config_write'
- | 'database_webhooks_config_read'
- | 'database_webhooks_config_write'
- | 'edge_functions_read'
- | 'edge_functions_write'
- | 'edge_functions_secrets_read'
- | 'edge_functions_secrets_write'
- | 'infra_add_ons_read'
- | 'infra_add_ons_write'
- | 'infra_disk_config_read'
- | 'infra_disk_config_write'
- | 'infra_read_replicas_read'
- | 'infra_read_replicas_write'
- | 'project_snippets_read'
- | 'project_snippets_write'
- | 'realtime_config_read'
- | 'realtime_config_write'
- | 'storage_read'
- | 'storage_write'
- | 'storage_config_read'
- | 'storage_config_write'
- | 'vanity_subdomain_read'
- | 'vanity_subdomain_write'
- | 'platform_webhooks_projects_read'
- | 'platform_webhooks_projects_write'
- | 'workers_read'
- | 'workers_write'
- )[]
- }
- UpdatePlatformAppInstallationResponse: {
- /** Format: uuid */
- app_id: string
- /** Format: date-time */
- created_at: string
- /** Format: uuid */
- id: string
- /** Format: uuid */
- installed_by: string
- organization_slug: string
- permissions: string[]
- /** Format: date-time */
- updated_at: string
- }
- UpdatePoolingConfigResponse: {
- default_pool_size?: number
- ignore_startup_parameters: string
- max_client_conn?: number
- pgbouncer_enabled: boolean
- /** @enum {string} */
- pgbouncer_status: 'COMING_UP' | 'COMING_DOWN' | 'RELOADING' | 'ENABLED' | 'DISABLED'
- /**
- * @deprecated
- * @description Cannot be changed, this is ignored
- * @enum {string}
- */
- pool_mode?: 'transaction' | 'session' | 'statement'
- server_idle_timeout?: number
- server_lifetime?: number
- }
- UpdatePostgrestConfigBody: {
- db_extra_search_path?: string
- db_pool?: number
- db_pool_acquisition_timeout?: number
- db_schema?: string
- max_rows?: number
- }
- UpdatePostgrestConfigResponse: {
- db_extra_search_path: string
- /** @description If `null`, the value is automatically configured based on compute size. */
- db_pool: number | null
- /** @description If `null`, the value is automatically configured to 10. */
- db_pool_acquisition_timeout: number | null
- db_schema: string
- max_rows: number
- }
- UpdatePrivateLinkBody: {
- requestedConfig: {
- enabled: boolean
- }
- }
- UpdateProfileBody: {
- first_name?: string
- last_name?: string
- /** Format: email */
- primary_email?: string
- username?: string
- }
- UpdateProjectBody: {
- name: string
- }
- UpdateRealtimeConfigBody: {
- /** @description Sets connection pool size for Realtime Authorization */
- connection_pool?: number
- /** @description Sets maximum number of bytes per second rate per channel limit */
- max_bytes_per_second?: number
- /** @description Sets maximum number of channels per client rate limit */
- max_channels_per_client?: number
- /** @description Sets maximum number of concurrent users rate limit */
- max_concurrent_users?: number
- /** @description Sets maximum number of events per second rate per channel limit */
- max_events_per_second?: number
- /** @description Sets maximum number of joins per second rate limit */
- max_joins_per_second?: number
- /** @description Sets maximum number of payload size in KB rate limit */
- max_payload_size_in_kb?: number
- /** @description Sets maximum number of presence events per second rate limit */
- max_presence_events_per_second?: number
- /** @description Sets connection pool size used to create Postgres Changes subscriptions */
- postgres_changes_pool?: number
- /** @description Whether to enable presence */
- presence_enabled?: boolean
- /** @description Whether to only allow private channels */
- private_only?: boolean
- /** @description Disables the Realtime service for this project when true. Set to false to re-enable it. */
- suspend?: boolean
- }
- UpdateReplicationDestinationBody: {
- /** @description Destination configuration */
- config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size?: number | null
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id?: string | null
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number | null
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id?: string | null
- /** @description BigQuery service account key */
- service_account_key?: string | null
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- } | null
- }
- }
- | {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database?: string | null
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string|null}
- */
- engine?: 'merge_tree' | 'replacing_merge_tree' | null
- /** @description ClickHouse password. Omit for passwordless access. */
- password?: string | null
- /**
- * @description ClickHouse HTTPS endpoint URL
- * @example https://clickhouse.example.com:8443
- */
- url?: string | null
- /**
- * @description ClickHouse user name
- * @example default
- */
- user?: string | null
- }
- }
- | {
- iceberg: {
- supabase: {
- /**
- * @description Catalog token
- * @example A jwt secret
- */
- catalog_token?: string | null
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref?: string | null
- /**
- * @description S3 access key ID
- * @example 53383b1d0cdb16a3afa63152656aa3cc
- */
- s3_access_key_id?: string | null
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region?: string | null
- /**
- * @description S3 secret access key
- * @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
- */
- s3_secret_access_key?: string | null
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name?: string | null
- }
- }
- }
- | {
- ducklake:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url?: string | null
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path?: string | null
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id?: string | null
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string | null
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string | null
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key?: string | null
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean | null
- }
- | {
- catalog:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url: string
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /** @enum {string} */
- type: 'postgres_url'
- }
- | {
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description Supabase project ref used as the DuckLake PostgreSQL catalog
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_project'
- }
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- storage:
- | {
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id: string
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint: string
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region: string
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key: string
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean | null
- /** @enum {string} */
- type: 's3'
- }
- | {
- /**
- * @description Storage bucket id used for DuckLake data files
- * @example ducklake
- */
- bucket: string
- /**
- * @description Optional description for the generated Supabase Storage S3 credential
- * @example DuckLake replication destination
- */
- credential_description?: string
- /**
- * @description Optional path prefix inside the bucket for DuckLake data files
- * @example replication
- */
- path?: string
- /**
- * @description Supabase project ref whose Object Storage S3 API stores DuckLake data files
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_storage'
- }
- }
- }
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id?: string | null
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database?: string | null
- /** @description Snowflake RSA private key PEM contents */
- private_key?: string | null
- /** @description Optional passphrase for encrypted private keys */
- private_key_passphrase?: string | null
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string | null
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema?: string | null
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user?: string | null
- }
- }
- /**
- * @description Destination name
- * @example bq-analytics
- */
- name: string
- }
- UpdateReplicationDestinationPipelineBody: {
- /** @description Destination configuration */
- destination_config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size?: number | null
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id?: string | null
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number | null
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id?: string | null
- /** @description BigQuery service account key */
- service_account_key?: string | null
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- } | null
- }
- }
- | {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database?: string | null
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string|null}
- */
- engine?: 'merge_tree' | 'replacing_merge_tree' | null
- /** @description ClickHouse password. Omit for passwordless access. */
- password?: string | null
- /**
- * @description ClickHouse HTTPS endpoint URL
- * @example https://clickhouse.example.com:8443
- */
- url?: string | null
- /**
- * @description ClickHouse user name
- * @example default
- */
- user?: string | null
- }
- }
- | {
- iceberg: {
- supabase: {
- /**
- * @description Catalog token
- * @example A jwt secret
- */
- catalog_token?: string | null
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref?: string | null
- /**
- * @description S3 access key ID
- * @example 53383b1d0cdb16a3afa63152656aa3cc
- */
- s3_access_key_id?: string | null
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region?: string | null
- /**
- * @description S3 secret access key
- * @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
- */
- s3_secret_access_key?: string | null
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name?: string | null
- }
- }
- }
- | {
- ducklake:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url?: string | null
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path?: string | null
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id?: string | null
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string | null
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string | null
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key?: string | null
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean | null
- table_sorting?: {
- tables?: {
- schema: string
- sort_by:
- | {
- columns: {
- /**
- * @description DuckLake sort direction
- * @example asc
- * @enum {string}
- */
- direction?: 'asc' | 'desc'
- /**
- * @description Source column name
- * @example created_at
- */
- name: string
- /**
- * @description Optional placement of null values in the DuckLake sort order
- * @example last
- * @enum {string|null}
- */
- nulls?: 'first' | 'last' | null
- }[]
- /** @enum {string} */
- kind: 'columns'
- }
- | {
- /** @enum {string} */
- kind: 'primary_key'
- }
- table: string
- }[]
- } | null
- }
- | {
- catalog:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url: string
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /** @enum {string} */
- type: 'postgres_url'
- }
- | {
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description Supabase project ref used as the DuckLake PostgreSQL catalog
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_project'
- }
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- storage:
- | {
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id: string
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint: string
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region: string
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key: string
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @example false
- */
- s3_use_ssl?: boolean | null
- /** @enum {string} */
- type: 's3'
- }
- | {
- /**
- * @description Storage bucket id used for DuckLake data files
- * @example ducklake
- */
- bucket: string
- /**
- * @description Optional description for the generated Supabase Storage S3 credential
- * @example DuckLake replication destination
- */
- credential_description?: string
- /**
- * @description Optional path prefix inside the bucket for DuckLake data files
- * @example replication
- */
- path?: string
- /**
- * @description Supabase project ref whose Object Storage S3 API stores DuckLake data files
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_storage'
- }
- table_sorting?: {
- tables?: {
- schema: string
- sort_by:
- | {
- columns: {
- /**
- * @description DuckLake sort direction
- * @example asc
- * @enum {string}
- */
- direction?: 'asc' | 'desc'
- /**
- * @description Source column name
- * @example created_at
- */
- name: string
- /**
- * @description Optional placement of null values in the DuckLake sort order
- * @example last
- * @enum {string|null}
- */
- nulls?: 'first' | 'last' | null
- }[]
- /** @enum {string} */
- kind: 'columns'
- }
- | {
- /** @enum {string} */
- kind: 'primary_key'
- }
- table: string
- }[]
- } | null
- }
- }
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id?: string | null
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database?: string | null
- /** @description Snowflake RSA private key PEM contents */
- private_key?: string | null
- /** @description Optional passphrase for encrypted private keys */
- private_key_passphrase?: string | null
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string | null
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema?: string | null
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user?: string | null
- }
- }
- /**
- * @description Destination name
- * @example bq-analytics
- */
- destination_name: string
- /** @description Pipeline configuration patch */
- pipeline_config: {
- /** @description Complete batch configuration replacement. Omission preserves it; `null` resets server defaults. */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Complete memory backpressure replacement. Omission preserves it; `null` resets server defaults. */
- memory_backpressure?: {
- /**
- * @description Memory usage ratio above which backpressure is activated
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Memory usage ratio below which backpressure is released
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name. Omission preserves the stored value; Pipelines rejects clearing it with `null`.
- * @example pub_orders
- */
- publication_name?: string | null
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Initial-copy selection. Omission preserves it; `null` resets to copying all tables. */
- table_sync_copy?:
- | (
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- )
- | null
- }
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- }
- UpdateReplicationPipelineBody: {
- /** @description Pipeline configuration patch */
- config: {
- /** @description Complete batch configuration replacement. Omission preserves it; `null` resets server defaults. */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Complete memory backpressure replacement. Omission preserves it; `null` resets server defaults. */
- memory_backpressure?: {
- /**
- * @description Memory usage ratio above which backpressure is activated
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Memory usage ratio below which backpressure is released
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name. Omission preserves the stored value; Pipelines rejects clearing it with `null`.
- * @example pub_orders
- */
- publication_name?: string | null
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Initial-copy selection. Omission preserves it; `null` resets to copying all tables. */
- table_sync_copy?:
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- | never
- }
- /**
- * @description Destination id
- * @example 2001
- */
- destination_id: number
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- }
- UpdateReplicationPipelineVersionBody: {
- /**
- * @description Pipeline version id
- * @example 4
- */
- version_id: number
- }
- UpdateReplicationPublicationBody: {
- /** @description Publication tables */
- tables: {
- /**
- * @description Table name
- * @example orders
- */
- name: string
- /**
- * @description Table schema
- * @example public
- */
- schema: string
- }[]
- }
- UpdateSecretsConfigBody: {
- change_tracking_id: string
- jwt_secret: string
- }
- UpdateSecretsResponse: {
- message: string
- }
- UpdateStorageBucketBody: {
- allowed_mime_types?: string[] | null
- file_size_limit?: number | null
- public: boolean
- }
- /** @example {
- * "fileSizeLimit": 10485760,
- * "features": {
- * "imageTransformation": {
- * "enabled": true
- * }
- * }
- * } */
- UpdateStorageConfigBody: {
- external?: {
- /** @enum {string} */
- upstreamTarget: 'main' | 'canary'
- }
- features?: {
- icebergCatalog?: {
- enabled: boolean
- maxCatalogs: number
- maxNamespaces: number
- maxTables: number
- }
- imageTransformation?: {
- enabled: boolean
- }
- purgeCache?: {
- enabled: boolean
- }
- s3Protocol?: {
- enabled: boolean
- }
- vectorBuckets?: {
- enabled: boolean
- maxBuckets: number
- maxIndexes: number
- }
- }
- /** Format: int64 */
- fileSizeLimit?: number
- }
- UpdateSubscriptionBody: {
- address?: {
- city?: string | null
- country: string
- line1: string
- line2?: string | null
- postal_code?: string | null
- state?: string | null
- }
- billing_name?: string
- payment_method?: string
- tax_id?: {
- country: string
- type: string
- value: string
- }
- /** @enum {string} */
- tier:
- | 'tier_free'
- | 'tier_pro'
- | 'tier_payg'
- | 'tier_team'
- | 'tier_enterprise'
- | 'tier_platform'
- }
- UpdateSubscriptionResponse: {
- pending_payment_intent_secret: string | null
- }
- UpdateUserBody: {
- ban_duration?: string
- }
- UpdateUserResponse: {
- aud?: string
- banned_until?: string
- confirmation_sent_at?: string
- confirmation_token?: string
- confirmed_at?: string
- created_at?: string
- deleted_at?: string
- email?: string
- email_change?: string
- email_change_confirm_status?: number
- email_change_sent_at?: string
- email_change_token_current?: string
- email_change_token_new?: string
- email_confirmed_at?: string
- encrypted_password?: string
- /** Format: uuid */
- id?: string
- /** Format: uuid */
- instance_id?: string
- invited_at?: string
- is_anonymous?: boolean
- is_sso_user?: boolean
- is_super_admin?: boolean
- last_sign_in_at?: string
- phone?: string
- phone_change?: string
- phone_change_sent_at?: string
- phone_change_token?: string
- phone_confirmed_at?: string
- raw_app_meta_data?: {
- [key: string]: unknown
- }
- raw_user_meta_data?: {
- [key: string]: unknown
- }
- reauthentication_sent_at?: string
- reauthentication_token?: string
- recovery_sent_at?: string
- recovery_token?: string
- role?: string
- updated_at?: string
- }
- UpdateVercelConnectionsBody: {
- env_sync_targets?: ('production' | 'preview' | 'development')[]
- public_env_var_prefix?: string
- }
- UpdateWarehouseCatalogBody: {
- /** @description Whether external catalog access should be enabled */
- enabled: boolean
- }
- UpsertContentBody: {
- content?:
- | {
- [key: string]: unknown
- }
- | {
- cells: (
- | {
- _id?: string
- /** @enum {string} */
- _tag: 'database_cell'
- chart?: {
- cumulative: boolean
- /** @enum {string} */
- scale: 'linear' | 'log'
- show_labels: boolean
- /** @enum {string} */
- type: 'bar' | 'line'
- x_column: string
- y_series: string[]
- }
- database_identifier?: string
- row_limit: number
- sql: string
- title?: string
- /** @enum {string} */
- view?: 'table' | 'chart'
- }
- | {
- _id?: string
- /** @enum {string} */
- _tag: 'log_cell'
- chart?: {
- cumulative: boolean
- /** @enum {string} */
- scale: 'linear' | 'log'
- show_labels: boolean
- /** @enum {string} */
- type: 'bar' | 'line'
- x_column: string
- y_series: string[]
- }
- sql: string
- time_range:
- | {
- /** @enum {string} */
- _tag: 'absolute_time_range'
- end: string
- start: string
- }
- | {
- /** @enum {string} */
- _tag: 'relative_time_range'
- amount: number
- /** @enum {string} */
- unit: 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'
- }
- title?: string
- /** @enum {string} */
- view?: 'table' | 'chart'
- }
- | {
- _id?: string
- /** @enum {string} */
- _tag: 'markdown_cell'
- text: string
- }
- )[]
- schema_version: number
- }
- description?: string
- /**
- * @description A missing `favorite` value means that the value will remained unchanged for updates. Defaults to `false` for inserts.
- * @default false
- */
- favorite?: boolean
- /** Format: uuid */
- folder_id?: string | null
- id?: string
- name: string
- owner_id?: number
- project_id?: number
- /** @enum {string} */
- type: 'sql' | 'report' | 'log_sql' | 'notebook'
- /** @enum {string} */
- visibility: 'user' | 'project' | 'org' | 'public'
- }
- UserAuditLogsResponse: {
- result: {
- action: {
- metadata?: {
- [key: string]: unknown
- }
- method: string
- name: string
- params?: {
- [key: string]: unknown
- }
- route: string
- status: number
- }
- actor: {
- app_id?: string
- app_name?: string
- email?: string
- /** @description Only present when token_type=app */
- installation_id?: string
- ip?: string
- /** @description JWT issuer. Only present for branching service JWTs */
- jwt_issuer?: string
- /** @description JWT subject. Only present for branching service JWTs */
- jwt_subject?: string
- oauth_app_id?: string
- oauth_app_name?: string
- /** @description Organization whose grant was used. Only present when token_type=oauth */
- organization_id?: string
- /** @description Marketplace partner that authenticated the request. Only present when token_type=partner */
- partner?: string
- /** @description The partner's own integration-installation id. Only present when token_type=partner and the integration is already installed. Distinct from installation_id, which is a Supabase platform-app installation */
- partner_installation_id?: string
- /** @description Email of the partner user who triggered the action. Only present when token_type=partner and the partner acted on behalf of one of its users */
- partner_user_email?: string
- /** @description Opaque user identifier in the partner's namespace. Only present when token_type=partner and the partner acted on behalf of one of its users */
- partner_user_id?: string
- /** @description GoTrue login session. Only present when token_type=jwt */
- session_id?: string
- /** @description Access token alias, as shown in the dashboard. Only present when token_type=v0, token_type=v1 or token_type=scoped_pat */
- token_alias?: string
- token_hash?: string
- /** @description Only present when token_type=scoped_pat */
- token_scope?: string
- token_type: string
- user_id?: string
- }
- organization_slug?: string
- project_ref?: string
- request_id: string
- timestamp: number
- }[]
- retention_period: number
- }
- UserBody: {
- aud?: string
- banned_until?: string
- confirmation_sent_at?: string
- confirmation_token?: string
- confirmed_at?: string
- created_at?: string
- deleted_at?: string
- email?: string
- email_change?: string
- email_change_confirm_status?: number
- email_change_sent_at?: string
- email_change_token_current?: string
- email_change_token_new?: string
- email_confirmed_at?: string
- encrypted_password?: string
- /** Format: uuid */
- id?: string
- /** Format: uuid */
- instance_id?: string
- invited_at?: string
- is_anonymous?: boolean
- is_sso_user?: boolean
- is_super_admin?: boolean
- last_sign_in_at?: string
- phone?: string
- phone_change?: string
- phone_change_sent_at?: string
- phone_change_token?: string
- phone_confirmed_at?: string
- raw_app_meta_data?: {
- [key: string]: unknown
- }
- raw_user_meta_data?: {
- [key: string]: unknown
- }
- reauthentication_sent_at?: string
- reauthentication_token?: string
- recovery_sent_at?: string
- recovery_token?: string
- role?: string
- updated_at?: string
- }
- ValidateDestinationResponse: {
- /** @description List of validation failures */
- validation_failures: {
- /**
- * @description Failure type
- * @example critical
- * @enum {string}
- */
- failure_type: 'critical' | 'warning'
- /**
- * @description Validation failure name
- * @example Validation Failed
- */
- name: string
- /**
- * @description Validation failure reason
- * @example The configuration is invalid
- */
- reason: string
- }[]
- }
- ValidatePipelineResponse: {
- /** @description List of validation failures */
- validation_failures: {
- /**
- * @description Failure type
- * @example critical
- * @enum {string}
- */
- failure_type: 'critical' | 'warning'
- /**
- * @description Validation failure name
- * @example Validation Failed
- */
- name: string
- /**
- * @description Validation failure reason
- * @example The configuration is invalid
- */
- reason: string
- }[]
- }
- ValidateReplicationDestinationBody: {
- /** @description Destination configuration */
- config:
- | {
- big_query: {
- /**
- * @description Number of concurrent BigQuery Storage Write API connections.
- * @example 8
- */
- connection_pool_size?: number | null
- /**
- * @description BigQuery dataset id
- * @example analytics
- */
- dataset_id: string
- /**
- * @description Maximum data staleness in minutes
- * @example 5
- */
- max_staleness_mins?: number | null
- /**
- * @description BigQuery project id
- * @example my-gcp-project
- */
- project_id: string
- /** @description BigQuery service account key */
- service_account_key: string
- /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
- table_options?: {
- tables?: {
- cluster_by?: string[]
- partition_by?:
- | (
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
- * @enum {string}
- */
- kind: 'time_column'
- }
- | {
- /**
- * @description Source column name
- * @example created_at
- */
- column: string
- /**
- * @description Exclusive end of the last partition range
- * @example 100
- */
- end: number
- /**
- * @description Width of each partition range
- * @example 10
- */
- interval: number
- /**
- * @description Partition by ranges of a replicated integer column
- * @enum {string}
- */
- kind: 'integer_range'
- /**
- * @description Inclusive start of the first partition range
- * @example 0
- */
- start: number
- }
- | {
- /**
- * @description Partition granularity
- * @example day
- * @enum {string}
- */
- granularity?: 'hour' | 'day' | 'month' | 'year'
- /**
- * @description Partition by the time at which BigQuery ingests each row
- * @enum {string}
- */
- kind: 'ingestion_time'
- }
- )
- | null
- /**
- * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
- * @example 16384
- */
- table_id: number
- }[]
- }
- }
- }
- | {
- clickhouse: {
- /**
- * @description ClickHouse target database
- * @example analytics
- */
- database: string
- /**
- * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
- * @example replacing_merge_tree
- * @enum {string}
- */
- engine?: 'merge_tree' | 'replacing_merge_tree'
- /** @description ClickHouse password. Omit for passwordless access. */
- password?: string | null
- /**
- * @description ClickHouse HTTPS endpoint URL
- * @example https://clickhouse.example.com:8443
- */
- url: string
- /**
- * @description ClickHouse user name
- * @example default
- */
- user: string
- }
- }
- | {
- iceberg: {
- supabase: {
- /**
- * @description Catalog token
- * @example A jwt secret
- */
- catalog_token: string
- /**
- * @description Namespace
- * @example my-namespace
- */
- namespace?: string | null
- /**
- * @description Project ref
- * @example abcdefghijklmnopqrst
- */
- project_ref: string
- /**
- * @description S3 access key ID
- * @example 53383b1d0cdb16a3afa63152656aa3cc
- */
- s3_access_key_id: string
- /**
- * @description S3 region
- * @example ap-southeast-1
- */
- s3_region: string
- /**
- * @description S3 secret access key
- * @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
- */
- s3_secret_access_key: string
- /**
- * @description Warehouse name
- * @example my-warehouse
- */
- warehouse_name: string
- }
- }
- }
- | {
- ducklake:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url: string
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @default ducklake
- * @example ducklake
- */
- metadata_schema?: string
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id?: string | null
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint?: string | null
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region?: string | null
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key?: string | null
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @default true
- * @example false
- */
- s3_use_ssl?: boolean
- }
- | {
- catalog:
- | {
- /**
- * @description DuckLake catalog URL
- * @example postgres://user:pass@localhost:5432/ducklake_catalog
- */
- catalog_url: string
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /** @enum {string} */
- type: 'postgres_url'
- }
- | {
- /**
- * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
- * @example ducklake
- */
- metadata_schema?: string | null
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- /**
- * @description Supabase project ref used as the DuckLake PostgreSQL catalog
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_project'
- }
- /**
- * @description Schema used for DuckLake metadata tables stored in PostgreSQL
- * @default ducklake
- * @example ducklake
- */
- metadata_schema?: string
- /**
- * @description Number of concurrent DuckDB connections.
- * @example 4
- */
- pool_size?: number | null
- storage:
- | {
- /**
- * @description DuckLake data path
- * @example s3://<bucket-name>/
- */
- data_path: string
- /**
- * @description S3-compatible storage access key ID
- * @example my-access-key
- */
- s3_access_key_id: string
- /**
- * @description S3-compatible storage endpoint
- * @example 127.0.0.1:5000/s3
- */
- s3_endpoint: string
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region: string
- /**
- * @description S3-compatible storage secret access key
- * @example my-secret-key
- */
- s3_secret_access_key: string
- /**
- * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
- * @example path
- * @enum {string|null}
- */
- s3_url_style?: 'path' | 'vhost' | null
- /**
- * @description Whether to use SSL for S3-compatible storage
- * @default true
- * @example false
- */
- s3_use_ssl?: boolean
- /** @enum {string} */
- type: 's3'
- }
- | {
- /**
- * @description Storage bucket id used for DuckLake data files
- * @example ducklake
- */
- bucket: string
- /**
- * @description Optional description for the generated Supabase Storage S3 credential
- * @example DuckLake replication destination
- */
- credential_description?: string
- /**
- * @description Optional path prefix inside the bucket for DuckLake data files
- * @example replication
- */
- path?: string
- /**
- * @description Supabase project ref whose Object Storage S3 API stores DuckLake data files
- * @example abcjuqabhgwjjutfvtpa
- */
- project_ref: string
- /** @enum {string} */
- type: 'supabase_storage'
- }
- }
- }
- | {
- snowflake: {
- /**
- * @description Snowflake account identifier
- * @example MYORG-MYACCOUNT
- */
- account_id: string
- /**
- * @description Snowflake target database
- * @example ANALYTICS
- */
- database: string
- /** @description Snowflake RSA private key PEM contents */
- private_key: string
- /** @description Optional passphrase for encrypted private keys */
- private_key_passphrase?: string | null
- /**
- * @description Optional Snowflake role
- * @example PIPELINES_ROLE
- */
- role?: string | null
- /**
- * @description Snowflake target schema
- * @example PUBLIC
- */
- schema: string
- /**
- * @description Snowflake user configured for key-pair authentication
- * @example PIPELINES_USER
- */
- user: string
- }
- }
- /** @description Pipeline configuration */
- pipeline_config?: {
- /** @description Batch configuration. Omit or use `null` for server defaults. */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Memory-based backpressure configuration. Omission enables server defaults; `null` disables it. */
- memory_backpressure?: {
- /**
- * @description Memory usage ratio above which backpressure is activated
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Memory usage ratio below which backpressure is released
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name
- * @example pub_orders
- */
- publication_name: string
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Selection rules for tables participating in initial table copy. Omit or use `null` to copy all tables. */
- table_sync_copy?:
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- | never
- }
- /**
- * @description Source id
- * @example 1
- */
- source_id?: number
- }
- ValidateReplicationPipelineBody: {
- /** @description Pipeline configuration */
- config: {
- /** @description Batch configuration. Omit or use `null` for server defaults. */
- batch?: {
- /**
- * @description Maximum preferred byte size for one source batch
- * @example 8388608
- */
- max_bytes?: number
- /**
- * @description Maximum fill time in milliseconds
- * @example 200
- */
- max_fill_ms?: number
- /**
- * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
- * @example 0.2
- */
- memory_budget_ratio?: number
- } | null
- /**
- * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
- * @example error
- * @enum {string|null}
- */
- invalidated_slot_behavior?: 'error' | 'recreate' | null
- /**
- * @description Replicator log level
- * @example info
- * @enum {string|null}
- */
- log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
- /** @description Maximum number of copy connections per table */
- max_copy_connections_per_table?: number | null
- /** @description Maximum number of table sync workers */
- max_table_sync_workers?: number | null
- /** @description Memory-based backpressure configuration. Omission enables server defaults; `null` disables it. */
- memory_backpressure?: {
- /**
- * @description Memory usage ratio above which backpressure is activated
- * @example 0.85
- */
- activate_threshold: number
- /**
- * @description Memory usage ratio below which backpressure is released
- * @example 0.75
- */
- resume_threshold: number
- } | null
- /**
- * @description Milliseconds between one memory usage refresh and another
- * @example 100
- */
- memory_refresh_interval_ms?: number | null
- /**
- * @description Publication name
- * @example pub_orders
- */
- publication_name: string
- /**
- * @description Milliseconds between one replication lag refresh and another
- * @example 10000
- */
- replication_lag_refresh_interval_ms?: number | null
- /**
- * @description Milliseconds between one retry and another for timed worker retries
- * @example 10000
- */
- table_error_retry_delay_ms?: number | null
- /**
- * @description Maximum number of automatic timed retry attempts
- * @example 5
- */
- table_error_retry_max_attempts?: number | null
- /** @description Selection rules for tables participating in initial table copy. Omit or use `null` to copy all tables. */
- table_sync_copy?:
- | {
- /** @enum {string} */
- type: 'include_all_tables'
- }
- | {
- /** @enum {string} */
- type: 'skip_all_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be performed
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'include_tables'
- }
- | {
- /**
- * @description Table ids for which copy should be skipped
- * @example [
- * 16408
- * ]
- */
- table_ids: number[]
- /** @enum {string} */
- type: 'skip_tables'
- }
- | never
- }
- /**
- * @description Source id
- * @example 3001
- */
- source_id: number
- }
- ValidateSpamBody: {
- content: string
- subject: string
- }
- ValidateSpamResponse: {
- rules: {
- desc: string
- name: string
- score: number
- }[]
- }
- VercelRedirectResponse: {
- url: string
- }
- VerifyEmailBody: {
- token: string
- }
- VerifyEmailResponse: {
- /** @enum {string} */
- result: 'success'
- }
- WarehouseCatalogResponse: {
- /** @description External catalog credentials. Present only when enabled. */
- credentials?: {
- /**
- * @description DuckLake catalog Postgres URL
- * @example postgres://postgres:<pwd>@db.example.supabase.co:5432/postgres
- */
- catalog_url: string
- /**
- * @description DuckLake object storage path
- * @example s3://warehouse/
- */
- data_path: string
- /**
- * @description DuckLake metadata schema in the catalog database
- * @example ducklake
- */
- metadata_schema: string
- /** @description S3 access key id */
- s3_access_key_id: string
- /**
- * @description S3-compatible storage endpoint without protocol
- * @example abcjuqabhgwjjutfvtpa.storage.supabase.co/storage/v1/s3
- */
- s3_endpoint: string
- /**
- * @description S3-compatible storage region
- * @example us-east-1
- */
- s3_region: string
- /** @description S3 secret access key */
- s3_secret_access_key: string
- }
- /** @description Whether external catalog access is enabled */
- enabled: boolean
- }
- WarehouseSetupBody: {
- /**
- * @description Whether to configure and install the Warehouse FDW in the project database. Defaults to false.
- * @example false
- */
- install_fdw?: boolean
- /** @description Schemas and individual tables to copy. Schema targets expand to the eligible tables present when the request is processed. */
- targets: (
- | {
- /**
- * @description Postgres schema whose currently eligible tables should be copied
- * @example public
- */
- schema: string
- /** @enum {string} */
- type: 'schema'
- }
- | {
- /**
- * @description Postgres table name
- * @example orders
- */
- name: string
- /**
- * @description Postgres schema name
- * @example public
- */
- schema: string
- /** @enum {string} */
- type: 'table'
- }
- )[]
- }
- WarehouseSetupResponse: {
- /**
- * @description Warehouse replication pipeline id
- * @example 101
- */
- pipeline_id: number
- /** @description Tables with Warehouse copies */
- tables: {
- /**
- * @description DuckLake schema-qualified table name
- * @example public.orders
- */
- copy_name: string
- /**
- * @description Replication lag in milliseconds, when available
- * @example 12000
- */
- lag_ms?: number
- /**
- * Format: date-time
- * @description Last sync timestamp, when available
- * @example 2026-06-23T17:48:00Z
- */
- last_synced_at?: string
- /**
- * @description Postgres table name
- * @example orders
- */
- name: string
- /**
- * @description Postgres schema name
- * @example public
- */
- schema: string
- /**
- * @description Warehouse copy sync state derived from replication status
- * @example live
- * @enum {string}
- */
- state: 'syncing' | 'live' | 'error'
- /**
- * @description Warehouse table size in bytes, when available
- * @example 197912092672
- */
- warehouse_size_bytes?: number
- }[]
- }
- WarehouseSetupStatusResponse: {
- /** @description Project database FDW setup markers used to derive the Warehouse FDW phase */
- fdw_status: {
- /**
- * @description Whether fdw_warehouse is available to install on the project database instance
- * @example true
- */
- extension_available: boolean
- /**
- * @description Whether the fdw_warehouse extension exists in the project database
- * @example true
- */
- extension_installed: boolean
- /**
- * @description Whether the Warehouse foreign schema import has exposed the Warehouse snapshots table
- * @example true
- */
- foreign_schema_imported: boolean
- /**
- * @description Whether the local Warehouse schema exists in the project database
- * @example true
- */
- schema_created: boolean
- /**
- * @description Whether the Warehouse foreign server exists in the project database
- * @example true
- */
- server_configured: boolean
- /**
- * @description Whether the Warehouse foreign data wrapper exists in the project database
- * @example true
- */
- wrapper_installed: boolean
- }
- /**
- * @description Warehouse replication pipeline id when it exists
- * @example 101
- */
- pipeline_id?: number
- /**
- * @description Overall Warehouse setup status derived from replication state
- * @example copying
- * @enum {string}
- */
- setup_status: 'not_started' | 'setting_up' | 'copying' | 'complete' | 'error'
- /** @description Warehouse setup phases in execution order */
- steps: {
- /**
- * @description Best-effort progress or error message derived from Warehouse state
- * @example Pending initial copy: public.orders:copying_table
- */
- message?: string
- /**
- * @description Observable Warehouse setup phase
- * @example warehouse_copy
- * @enum {string}
- */
- name: 'warehouse_pipeline' | 'warehouse_copy' | 'warehouse_fdw'
- /**
- * @description Derived Warehouse setup step status
- * @example running
- * @enum {string}
- */
- status: 'waiting' | 'running' | 'completed' | 'skipped' | 'error'
- }[]
- /** @description Warehouse linked tables and replication-derived sync state */
- tables: {
- /**
- * @description DuckLake schema-qualified table name
- * @example public.orders
- */
- copy_name: string
- /**
- * @description Replication lag in milliseconds, when available
- * @example 12000
- */
- lag_ms?: number
- /**
- * Format: date-time
- * @description Last sync timestamp, when available
- * @example 2026-06-23T17:48:00Z
- */
- last_synced_at?: string
- /**
- * @description Postgres table name
- * @example orders
- */
- name: string
- /**
- * @description Postgres schema name
- * @example public
- */
- schema: string
- /**
- * @description Warehouse copy sync state derived from replication status
- * @example live
- * @enum {string}
- */
- state: 'syncing' | 'live' | 'error'
- /**
- * @description Warehouse table size in bytes, when available
- * @example 197912092672
- */
- warehouse_size_bytes?: number
- }[]
- }
- WarehouseTableSnapshotsResponse: {
- /** @description Available Warehouse snapshots for the project catalog. */
- snapshots: {
- /**
- * @description Snapshot author, when available.
- * @example postgres
- */
- author: string | null
- /** @description Snapshot change metadata returned by the Warehouse FDW. */
- changes: string | null
- /** @description Additional snapshot commit metadata returned by the Warehouse FDW. */
- commit_extra_info: string | null
- /** @description Snapshot commit message, when available. */
- commit_message: string | null
- /**
- * @description DuckLake schema version. Returned as a string because the source value is bigint.
- * @example 7
- */
- schema_version: string | null
- /**
- * @description DuckLake snapshot id. Returned as a string because the source value is bigint.
- * @example 42
- */
- snapshot_id: string
- /**
- * @description Snapshot timestamp returned by the Warehouse FDW.
- * @example 2026-06-24 08:00:00+00
- */
- snapshot_time: string | null
- }[]
- }
- WarehouseTablesResponse: {
- /** @description Tables with Warehouse copies */
- tables: {
- /**
- * @description DuckLake schema-qualified table name
- * @example public.orders
- */
- copy_name: string
- /**
- * @description Replication lag in milliseconds, when available
- * @example 12000
- */
- lag_ms?: number
- /**
- * Format: date-time
- * @description Last sync timestamp, when available
- * @example 2026-06-23T17:48:00Z
- */
- last_synced_at?: string
- /**
- * @description Postgres table name
- * @example orders
- */
- name: string
- /**
- * @description Postgres schema name
- * @example public
- */
- schema: string
- /**
- * @description Warehouse copy sync state derived from replication status
- * @example live
- * @enum {string}
- */
- state: 'syncing' | 'live' | 'error'
- /**
- * @description Warehouse table size in bytes, when available
- * @example 197912092672
- */
- warehouse_size_bytes?: number
- }[]
- }
- WorkflowRunResponse: {
- branch_id: string
- check_run_id: number | null
- created_at: string
- git_config?: unknown
- id: string
- /** @enum {string} */
- status:
- | 'CREATING_PROJECT'
- | 'RUNNING_MIGRATIONS'
- | 'MIGRATIONS_PASSED'
- | 'MIGRATIONS_FAILED'
- | 'FUNCTIONS_DEPLOYED'
- | 'FUNCTIONS_FAILED'
- updated_at: string
- workdir: string | null
- }
- }
- responses: never
- parameters: never
- requestBodies: never
- headers: never
- pathItems: never
-}
-export type $defs = Record<string, never>
-export interface operations {
- DestinationsController_getDestinations: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description All destinations for the project. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['DestinationsResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while listing destinations. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- DestinationsController_createDestination: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['CreateDestinationBody']
- }
- }
- responses: {
- /** @description Destination created. */
- 201: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['CreateDestinationResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while creating destination. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- DestinationsPipelinesController_createDestinationPipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['CreateReplicationDestinationPipelineBody']
- }
- }
- responses: {
- /** @description Destination and pipeline created. */
- 201: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['CreateDestinationPipelineResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while creating destination or pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- DestinationsPipelinesController_updateDestinationPipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Destination id */
- destination_id: number
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['UpdateReplicationDestinationPipelineBody']
- }
- }
- responses: {
- /** @description Destination and pipeline updated. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while updating destination or pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- DestinationsPipelinesController_deleteDestinationPipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Destination id */
- destination_id: number
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Destination and pipeline deleted. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['DeleteDestinationPipelineResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Pipeline or destination not found. */
- 404: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Pipeline is still active. */
- 409: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while deleting destination or pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- DestinationsController_getDestination: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Destination id */
- destination_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Destination details. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['DestinationResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while retrieving destination. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- DestinationsController_updateDestination: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Destination id */
- destination_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['UpdateDestinationBody']
- }
- }
- responses: {
- /** @description Destination updated. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while updating destination. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- DestinationsController_deleteDestination: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Destination id */
- destination_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Destination deleted. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Destination not found. */
- 404: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Destination has an active or attached pipeline. */
- 409: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while deleting destination. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- DestinationsController_validateDestination: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['ValidateDestinationBody']
- }
- }
- responses: {
- /** @description Validation completed. */
- 201: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['ValidateDestinationResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while validating destination. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_getPipelines: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description All pipelines for the project. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PipelinesResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while listing pipelines. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_createPipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['CreatePipelineBody']
- }
- }
- responses: {
- /** @description Pipeline created. */
- 201: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['CreatePipelineResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while creating pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_getPipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Pipeline details. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PipelineResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while retrieving pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_updatePipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['UpdatePipelineBody']
- }
- }
- responses: {
- /** @description Pipeline updated. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while updating pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_deletePipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Pipeline deleted. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Pipeline not found. */
- 404: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Pipeline is still active. */
- 409: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while deleting pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_getPipelineReplicationStatus: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Pipeline replication status. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PipelineReplicationStatusResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while retrieving replication status. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_restartPipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Pipeline restart accepted. */
- 202: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Pipeline is not running. */
- 409: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while restarting pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_rollbackTables: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['RollbackTablesBody']
- }
- }
- responses: {
- /** @description New table states after rollback. */
- 201: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['RollbackTablesResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while rolling back tables. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_startPipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Pipeline started. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while starting pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_getPipelineStatus: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Current pipeline status. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PipelineStatusResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while retrieving pipeline status. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_stopPipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Pipeline stopped. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while stopping pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_getPipelineVersion: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Current pipeline version. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PipelineVersionResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while retrieving pipeline version. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_updatePipelineVersion: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Pipeline id */
- pipeline_id: number
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['UpdatePipelineVersionBody']
- }
- }
- responses: {
- /** @description Pipeline version updated. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while updating pipeline version. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- PipelinesController_validatePipeline: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['ValidatePipelineBody']
- }
- }
- responses: {
- /** @description Validation completed. */
- 201: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['ValidatePipelineResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while validating pipeline. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- SourcesController_getSources: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description All sources for the project. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['SourcesResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while listing sources. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- SourcesController_createSource: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description Source created. */
- 201: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['CreateSourceResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while creating source. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- SourcesController_getPublications: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
- }
- cookie?: never
- }
- requestBody?: never
- responses: {
- /** @description All publications for the source. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PublicationsResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while listing publications. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- SourcesController_createPublication: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
- }
- cookie?: never
- }
- requestBody: {
- content: {
- 'application/json': components['schemas']['CreatePublicationBody']
- }
- }
- responses: {
- /** @description Publication created. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while creating publication. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- }
- }
- SourcesController_updatePublication: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Publication name */
- publication_name: string
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
+ /** @enum {string} */
+ type: 'skip_all_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be performed
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'include_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be skipped
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'skip_tables'
+ }
+ )
+ | null
}
- cookie?: never
+ /**
+ * @description Source id
+ * @example 3001
+ */
+ source_id: number
}
- requestBody: {
- content: {
- 'application/json': components['schemas']['UpdatePublicationBody']
- }
+ UpdateSecretsConfigBody: {
+ change_tracking_id: string
+ jwt_secret: string
}
- responses: {
- /** @description Publication updated. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while updating publication. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
+ UpdateSecretsResponse_Output: {
+ message: string
}
- }
- SourcesController_deletePublication: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Publication name */
- publication_name: string
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
- }
- cookie?: never
+ UpdateStorageBucketBody: {
+ allowed_mime_types?: string[] | null
+ file_size_limit?: number | null
+ public: boolean
+ /** @enum {string} */
+ versioning_status?: 'ENABLED' | 'SUSPENDED'
}
- requestBody?: never
- responses: {
- /** @description Publication deleted. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
+ /** @example {
+ * "fileSizeLimit": 10485760,
+ * "features": {
+ * "imageTransformation": {
+ * "enabled": true
+ * }
+ * }
+ * } */
+ UpdateStorageConfigBody: {
+ external?: {
+ /** @enum {string} */
+ upstreamTarget: 'main' | 'canary'
}
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
+ features?: {
+ icebergCatalog?: {
+ enabled: boolean
+ maxCatalogs: number
+ maxNamespaces: number
+ maxTables: number
}
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
+ imageTransformation?: {
+ enabled: boolean
}
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
+ purgeCache?: {
+ enabled: boolean
}
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
+ s3Protocol?: {
+ enabled: boolean
}
- content?: never
- }
- /** @description Source not found. */
- 404: {
- headers: {
- [name: string]: unknown
+ vectorBuckets?: {
+ enabled: boolean
+ maxBuckets: number
+ maxIndexes: number
}
- content?: never
}
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
+ /** Format: int64 */
+ fileSizeLimit?: number
+ }
+ UpdateSubscriptionBody: {
+ address?: {
+ city?: string | null
+ country: string
+ line1: string
+ line2?: string | null
+ postal_code?: string | null
+ state?: string | null
}
- /** @description Unexpected error while deleting publication. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
+ billing_name?: string
+ payment_method?: string
+ tax_id?: {
+ country: string
+ type: string
+ value: string
}
+ /** @enum {string} */
+ tier: 'tier_free' | 'tier_pro' | 'tier_payg' | 'tier_team'
}
- }
- SourcesController_getCostEstimate: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Publication name */
- publication_name: string
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
- }
- cookie?: never
+ UpdateSubscriptionResponse_Output: {
+ pending_payment_intent_secret: string | null
}
- requestBody?: never
- responses: {
- /** @description Cost estimate for replicating the publication. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['CostEstimateResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
+ UpdateUserBody: {
+ ban_duration?: string
+ }
+ UpdateUserResponse: {
+ aud?: string
+ banned_until?: string
+ confirmation_sent_at?: string
+ confirmation_token?: string
+ confirmed_at?: string
+ created_at?: string
+ deleted_at?: string
+ email?: string
+ email_change?: string
+ email_change_confirm_status?: number
+ email_change_sent_at?: string
+ email_change_token_current?: string
+ email_change_token_new?: string
+ email_confirmed_at?: string
+ encrypted_password?: string
+ /** Format: uuid */
+ id?: string
+ /** Format: uuid */
+ instance_id?: string
+ invited_at?: string
+ is_anonymous?: boolean
+ is_sso_user?: boolean
+ is_super_admin?: boolean
+ last_sign_in_at?: string
+ phone?: string
+ phone_change?: string
+ phone_change_sent_at?: string
+ phone_change_token?: string
+ phone_confirmed_at?: string
+ raw_app_meta_data?: {
+ [key: string]: unknown
}
- /** @description Unexpected error while estimating replication cost. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
+ raw_user_meta_data?: {
+ [key: string]: unknown
}
+ reauthentication_sent_at?: string
+ reauthentication_token?: string
+ recovery_sent_at?: string
+ recovery_token?: string
+ role?: string
+ updated_at?: string
}
- }
- SourcesController_getTables: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
- }
- cookie?: never
+ UpdateVercelConnectionsBody: {
+ env_sync_targets?: ('production' | 'preview' | 'development')[]
+ public_env_var_prefix?: string
}
- requestBody?: never
- responses: {
- /** @description All tables for the source. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['TablesResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while listing tables. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
+ UpdateWarehouseCatalogBody: {
+ /** @description Whether external catalog access should be enabled */
+ enabled: boolean
}
- }
- TenantsController_deleteTenant: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
+ UpsertContentBody: {
+ content?:
+ | {
+ [key: string]: unknown
+ }
+ | {
+ cells: (
+ | {
+ _id?: string
+ /** @enum {string} */
+ _tag: 'database_cell'
+ chart?: {
+ cumulative: boolean
+ /** @enum {string} */
+ scale: 'linear' | 'log'
+ show_labels: boolean
+ /** @enum {string} */
+ type: 'bar' | 'line'
+ x_column: string
+ y_series: string[]
+ }
+ database_identifier?: string
+ row_limit: number
+ sql: string
+ title?: string
+ /** @enum {string} */
+ view?: 'table' | 'chart'
+ }
+ | {
+ _id?: string
+ /** @enum {string} */
+ _tag: 'log_cell'
+ chart?: {
+ cumulative: boolean
+ /** @enum {string} */
+ scale: 'linear' | 'log'
+ show_labels: boolean
+ /** @enum {string} */
+ type: 'bar' | 'line'
+ x_column: string
+ y_series: string[]
+ }
+ sql: string
+ time_range:
+ | {
+ /** @enum {string} */
+ _tag: 'absolute_time_range'
+ end: string
+ start: string
+ }
+ | {
+ /** @enum {string} */
+ _tag: 'relative_time_range'
+ amount: number
+ /** @enum {string} */
+ unit: 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'
+ }
+ title?: string
+ /** @enum {string} */
+ view?: 'table' | 'chart'
+ }
+ | {
+ _id?: string
+ /** @enum {string} */
+ _tag: 'markdown_cell'
+ text: string
+ }
+ )[]
+ schema_version: number
+ }
+ description?: string
+ /**
+ * @description A missing `favorite` value means that the value will remained unchanged for updates. Defaults to `false` for inserts.
+ * @default false
+ */
+ favorite?: boolean
+ /** Format: uuid */
+ folder_id?: string | null
+ id?: string
+ name: string
+ owner_id?: number
+ project_id?: number
+ /** @enum {string} */
+ type: 'sql' | 'report' | 'log_sql' | 'notebook'
+ /** @enum {string} */
+ visibility: 'user' | 'project' | 'org' | 'public'
}
- requestBody?: never
- responses: {
- /** @description Tenant deleted. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Tenant not found. */
- 404: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Tenant has active pipelines. */
- 409: {
- headers: {
- [name: string]: unknown
+ UserAuditLogsResponse: {
+ result: {
+ action: {
+ metadata?: {
+ [key: string]: unknown
+ } | null
+ method: string
+ name: string
+ params?: {
+ [key: string]: unknown
+ } | null
+ route: string
+ status: number
}
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
+ actor: {
+ app_id?: string | null
+ app_name?: string | null
+ email?: string | null
+ /** @description Only present when token_type=app */
+ installation_id?: string | null
+ ip?: string | null
+ /** @description JWT issuer. Only present for branching service JWTs */
+ jwt_issuer?: string | null
+ /** @description JWT subject. Only present for branching service JWTs */
+ jwt_subject?: string | null
+ oauth_app_id?: string | null
+ oauth_app_name?: string | null
+ /** @description Organization whose grant was used. Only present when token_type=oauth */
+ organization_id?: string | null
+ /** @description Marketplace partner that authenticated the request. Only present when token_type=partner */
+ partner?: string | null
+ /** @description The partner's own integration-installation id. Only present when token_type=partner and the integration is already installed. Distinct from installation_id, which is a Supabase platform-app installation */
+ partner_installation_id?: string | null
+ /** @description Email of the partner user who triggered the action. Only present when token_type=partner and the partner acted on behalf of one of its users */
+ partner_user_email?: string | null
+ /** @description Opaque user identifier in the partner's namespace. Only present when token_type=partner and the partner acted on behalf of one of its users */
+ partner_user_id?: string | null
+ /** @description GoTrue login session. Only present when token_type=jwt */
+ session_id?: string | null
+ /** @description Access token alias, as shown in the dashboard. Only present when token_type=v0, token_type=v1 or token_type=scoped_pat */
+ token_alias?: string | null
+ token_hash?: string | null
+ /** @description Only present when token_type=scoped_pat */
+ token_scope?: string | null
+ token_type: string
+ user_id?: string | null
}
- content?: never
+ organization_slug?: string | null
+ project_ref?: string | null
+ request_id: string
+ timestamp: number
+ }[]
+ retention_period: number
+ }
+ UserBody: {
+ aud?: string
+ banned_until?: string
+ confirmation_sent_at?: string
+ confirmation_token?: string
+ confirmed_at?: string
+ created_at?: string
+ deleted_at?: string
+ email?: string
+ email_change?: string
+ email_change_confirm_status?: number
+ email_change_sent_at?: string
+ email_change_token_current?: string
+ email_change_token_new?: string
+ email_confirmed_at?: string
+ encrypted_password?: string
+ /** Format: uuid */
+ id?: string
+ /** Format: uuid */
+ instance_id?: string
+ invited_at?: string
+ is_anonymous?: boolean
+ is_sso_user?: boolean
+ is_super_admin?: boolean
+ last_sign_in_at?: string
+ phone?: string
+ phone_change?: string
+ phone_change_sent_at?: string
+ phone_change_token?: string
+ phone_confirmed_at?: string
+ raw_app_meta_data?: {
+ [key: string]: unknown
}
- /** @description Unexpected error while deleting tenant. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
+ raw_user_meta_data?: {
+ [key: string]: unknown
}
+ reauthentication_sent_at?: string
+ reauthentication_token?: string
+ recovery_sent_at?: string
+ recovery_token?: string
+ role?: string
+ updated_at?: string
}
- }
- TenantsSourcesController_createTenantSource: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- }
- cookie?: never
+ ValidateDestinationBody: {
+ /** @description Destination configuration */
+ config:
+ | {
+ big_query: {
+ /**
+ * @description Number of concurrent BigQuery Storage Write API connections.
+ * @example 8
+ */
+ connection_pool_size?: number | null
+ /**
+ * @description BigQuery dataset id
+ * @example analytics
+ */
+ dataset_id: string
+ /**
+ * @description Maximum data staleness in minutes
+ * @example 5
+ */
+ max_staleness_mins?: number | null
+ /**
+ * @description BigQuery project id
+ * @example my-gcp-project
+ */
+ project_id: string
+ /** @description BigQuery service account key */
+ service_account_key: string
+ /** @description Per-table partitioning and clustering, applied only when the physical table is created or recreated */
+ table_options?: {
+ tables?: {
+ cluster_by?: string[]
+ partition_by?:
+ | (
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by a replicated `DATE`, `TIMESTAMP`, or `DATETIME` column
+ * @enum {string}
+ */
+ kind: 'time_column'
+ }
+ | {
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ column: string
+ /**
+ * @description Exclusive end of the last partition range
+ * @example 100
+ */
+ end: number
+ /**
+ * @description Width of each partition range
+ * @example 10
+ */
+ interval: number
+ /**
+ * @description Partition by ranges of a replicated integer column
+ * @enum {string}
+ */
+ kind: 'integer_range'
+ /**
+ * @description Inclusive start of the first partition range
+ * @example 0
+ */
+ start: number
+ }
+ | {
+ /**
+ * @description Partition granularity
+ * @example day
+ * @enum {string}
+ */
+ granularity?: 'hour' | 'day' | 'month' | 'year'
+ /**
+ * @description Partition by the time at which BigQuery ingests each row
+ * @enum {string}
+ */
+ kind: 'ingestion_time'
+ }
+ )
+ | null
+ /**
+ * @description Source PostgreSQL table OID, stable across renames for the relation lifetime
+ * @example 16384
+ */
+ table_id: number
+ }[]
+ }
+ }
+ }
+ | {
+ clickhouse: {
+ /**
+ * @description ClickHouse target database
+ * @example analytics
+ */
+ database: string
+ /**
+ * @description Table engine used for replicated tables. Defaults to `replacing_merge_tree` server-side when omitted.
+ * @example replacing_merge_tree
+ * @enum {string}
+ */
+ engine?: 'merge_tree' | 'replacing_merge_tree'
+ /** @description ClickHouse password. Omit for passwordless access. */
+ password?: string | null
+ /**
+ * @description ClickHouse HTTPS endpoint URL
+ * @example https://clickhouse.example.com:8443
+ */
+ url: string
+ /**
+ * @description ClickHouse user name
+ * @example default
+ */
+ user: string
+ }
+ }
+ | {
+ iceberg: {
+ supabase: {
+ /**
+ * @description Catalog token
+ * @example A jwt secret
+ */
+ catalog_token: string
+ /**
+ * @description Namespace
+ * @example my-namespace
+ */
+ namespace?: string | null
+ /**
+ * @description Project ref
+ * @example abcdefghijklmnopqrst
+ */
+ project_ref: string
+ /**
+ * @description S3 access key ID
+ * @example 53383b1d0cdb16a3afa63152656aa3cc
+ */
+ s3_access_key_id: string
+ /**
+ * @description S3 region
+ * @example ap-southeast-1
+ */
+ s3_region: string
+ /**
+ * @description S3 secret access key
+ * @example 25a0c5e69d847088a3e6ffb901adf4d19bbf74a400dec2ee49f46401039b3258
+ */
+ s3_secret_access_key: string
+ /**
+ * @description Warehouse name
+ * @example my-warehouse
+ */
+ warehouse_name: string
+ }
+ }
+ }
+ | {
+ ducklake:
+ | {
+ /**
+ * @description DuckLake catalog URL
+ * @example postgres://user:pass@localhost:5432/ducklake_catalog
+ */
+ catalog_url: string
+ /**
+ * @description DuckLake data path
+ * @example s3://<bucket-name>/
+ */
+ data_path: string
+ /**
+ * @description Schema used for DuckLake metadata tables stored in PostgreSQL
+ * @default ducklake
+ * @example ducklake
+ */
+ metadata_schema?: string
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /**
+ * @description S3-compatible storage access key ID
+ * @example my-access-key
+ */
+ s3_access_key_id?: string | null
+ /**
+ * @description S3-compatible storage endpoint
+ * @example 127.0.0.1:5000/s3
+ */
+ s3_endpoint?: string | null
+ /**
+ * @description S3-compatible storage region
+ * @example us-east-1
+ */
+ s3_region?: string | null
+ /**
+ * @description S3-compatible storage secret access key
+ * @example my-secret-key
+ */
+ s3_secret_access_key?: string | null
+ /**
+ * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
+ * @example path
+ * @enum {string|null}
+ */
+ s3_url_style?: 'path' | 'vhost' | null
+ /**
+ * @description Whether to use SSL for S3-compatible storage
+ * @default true
+ * @example false
+ */
+ s3_use_ssl?: boolean
+ table_sorting?: {
+ tables?: {
+ schema: string
+ sort_by:
+ | {
+ columns: {
+ /**
+ * @description DuckLake sort direction
+ * @example asc
+ * @enum {string}
+ */
+ direction?: 'asc' | 'desc'
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ name: string
+ /**
+ * @description Optional placement of null values in the DuckLake sort order
+ * @example last
+ * @enum {string|null}
+ */
+ nulls?: 'first' | 'last' | null
+ }[]
+ /** @enum {string} */
+ kind: 'columns'
+ }
+ | {
+ /** @enum {string} */
+ kind: 'primary_key'
+ }
+ table: string
+ }[]
+ }
+ }
+ | {
+ catalog:
+ | {
+ /**
+ * @description DuckLake catalog URL
+ * @example postgres://user:pass@localhost:5432/ducklake_catalog
+ */
+ catalog_url: string
+ /**
+ * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
+ * @example ducklake
+ */
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /** @enum {string} */
+ type: 'postgres_url'
+ }
+ | {
+ /**
+ * @description Schema used for DuckLake metadata tables stored in this PostgreSQL catalog. Overrides `metadata_schema` when provided.
+ * @example ducklake
+ */
+ metadata_schema?: string | null
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ /**
+ * @description Supabase project ref used as the DuckLake PostgreSQL catalog
+ * @example abcjuqabhgwjjutfvtpa
+ */
+ project_ref: string
+ /** @enum {string} */
+ type: 'supabase_project'
+ }
+ /**
+ * @description Schema used for DuckLake metadata tables stored in PostgreSQL
+ * @default ducklake
+ * @example ducklake
+ */
+ metadata_schema?: string
+ /**
+ * @description Number of concurrent DuckDB connections.
+ * @example 4
+ */
+ pool_size?: number | null
+ storage:
+ | {
+ /**
+ * @description DuckLake data path
+ * @example s3://<bucket-name>/
+ */
+ data_path: string
+ /**
+ * @description S3-compatible storage access key ID
+ * @example my-access-key
+ */
+ s3_access_key_id: string
+ /**
+ * @description S3-compatible storage endpoint
+ * @example 127.0.0.1:5000/s3
+ */
+ s3_endpoint: string
+ /**
+ * @description S3-compatible storage region
+ * @example us-east-1
+ */
+ s3_region: string
+ /**
+ * @description S3-compatible storage secret access key
+ * @example my-secret-key
+ */
+ s3_secret_access_key: string
+ /**
+ * @description S3 URL style: `path` (MinIO/Supabase) or `vhost` (AWS)
+ * @example path
+ * @enum {string|null}
+ */
+ s3_url_style?: 'path' | 'vhost' | null
+ /**
+ * @description Whether to use SSL for S3-compatible storage
+ * @default true
+ * @example false
+ */
+ s3_use_ssl?: boolean
+ /** @enum {string} */
+ type: 's3'
+ }
+ | {
+ /**
+ * @description Storage bucket id used for DuckLake data files
+ * @example ducklake
+ */
+ bucket: string
+ /**
+ * @description Optional description for the generated Supabase Storage S3 credential
+ * @example DuckLake replication destination
+ */
+ credential_description?: string
+ /**
+ * @description Optional path prefix inside the bucket for DuckLake data files
+ * @example replication
+ */
+ path?: string
+ /**
+ * @description Supabase project ref whose Object Storage S3 API stores DuckLake data files
+ * @example abcjuqabhgwjjutfvtpa
+ */
+ project_ref: string
+ /** @enum {string} */
+ type: 'supabase_storage'
+ }
+ table_sorting?: {
+ tables?: {
+ schema: string
+ sort_by:
+ | {
+ columns: {
+ /**
+ * @description DuckLake sort direction
+ * @example asc
+ * @enum {string}
+ */
+ direction?: 'asc' | 'desc'
+ /**
+ * @description Source column name
+ * @example created_at
+ */
+ name: string
+ /**
+ * @description Optional placement of null values in the DuckLake sort order
+ * @example last
+ * @enum {string|null}
+ */
+ nulls?: 'first' | 'last' | null
+ }[]
+ /** @enum {string} */
+ kind: 'columns'
+ }
+ | {
+ /** @enum {string} */
+ kind: 'primary_key'
+ }
+ table: string
+ }[]
+ }
+ }
+ }
+ | {
+ snowflake: {
+ /**
+ * @description Snowflake account identifier
+ * @example MYORG-MYACCOUNT
+ */
+ account_id: string
+ /**
+ * @description Snowflake target database
+ * @example ANALYTICS
+ */
+ database: string
+ /** @description Snowflake RSA private key PEM contents */
+ private_key: string
+ /** @description Optional passphrase for encrypted private keys */
+ private_key_passphrase?: string | null
+ /**
+ * @description Optional Snowflake role
+ * @example PIPELINES_ROLE
+ */
+ role?: string | null
+ /**
+ * @description Snowflake target schema
+ * @example PUBLIC
+ */
+ schema: string
+ /**
+ * @description Snowflake user configured for key-pair authentication
+ * @example PIPELINES_USER
+ */
+ user: string
+ }
+ }
+ /** @description Pipeline configuration */
+ pipeline_config?: {
+ /** @description Batch configuration. Omit or use `null` for server defaults. */
+ batch?: {
+ /**
+ * @description Maximum preferred byte size for one source batch
+ * @example 8388608
+ */
+ max_bytes?: number
+ /**
+ * @description Maximum fill time in milliseconds
+ * @example 200
+ */
+ max_fill_ms?: number
+ /**
+ * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
+ * @example 0.2
+ */
+ memory_budget_ratio?: number
+ } | null
+ /**
+ * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
+ * @example error
+ * @enum {string|null}
+ */
+ invalidated_slot_behavior?: 'error' | 'recreate' | null
+ /**
+ * @description Replicator log level
+ * @example info
+ * @enum {string|null}
+ */
+ log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
+ /** @description Maximum number of copy connections per table */
+ max_copy_connections_per_table?: number | null
+ /** @description Maximum number of table sync workers */
+ max_table_sync_workers?: number | null
+ /** @description Memory-based backpressure configuration. Omission enables server defaults; `null` disables it. */
+ memory_backpressure?: {
+ /**
+ * @description Memory usage ratio above which backpressure is activated
+ * @example 0.85
+ */
+ activate_threshold: number
+ /**
+ * @description Memory usage ratio below which backpressure is released
+ * @example 0.75
+ */
+ resume_threshold: number
+ } | null
+ /**
+ * @description Milliseconds between one memory usage refresh and another
+ * @example 100
+ */
+ memory_refresh_interval_ms?: number | null
+ /**
+ * @description Publication name
+ * @example pub_orders
+ */
+ publication_name: string
+ /**
+ * @description Milliseconds between one replication lag refresh and another
+ * @example 10000
+ */
+ replication_lag_refresh_interval_ms?: number | null
+ /**
+ * @description Milliseconds between one retry and another for timed worker retries
+ * @example 10000
+ */
+ table_error_retry_delay_ms?: number | null
+ /**
+ * @description Maximum number of automatic timed retry attempts
+ * @example 5
+ */
+ table_error_retry_max_attempts?: number | null
+ /** @description Selection rules for tables participating in initial table copy. Omit or use `null` to copy all tables. */
+ table_sync_copy?:
+ | (
+ | {
+ /** @enum {string} */
+ type: 'include_all_tables'
+ }
+ | {
+ /** @enum {string} */
+ type: 'skip_all_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be performed
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'include_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be skipped
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'skip_tables'
+ }
+ )
+ | null
+ } | null
+ /**
+ * @description Source id
+ * @example 1
+ */
+ source_id?: number | null
}
- requestBody?: never
- responses: {
- /** @description Tenant and source created. */
- 201: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['CreateTenantSourceResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while creating tenant or source. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
+ ValidateDestinationResponse_Output: {
+ /** @description List of validation failures */
+ validation_failures: {
+ /**
+ * @description Failure type
+ * @example critical
+ * @enum {string}
+ */
+ failure_type: 'critical' | 'warning'
+ /**
+ * @description Validation failure name
+ * @example Validation Failed
+ */
+ name: string
+ /**
+ * @description Validation failure reason
+ * @example The configuration is invalid
+ */
+ reason: string
+ }[]
}
- }
- V2SourcesController_getPublications: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
+ ValidatePipelineBody: {
+ /** @description Pipeline configuration */
+ config: {
+ /** @description Batch configuration. Omit or use `null` for server defaults. */
+ batch?: {
+ /**
+ * @description Maximum preferred byte size for one source batch
+ * @example 8388608
+ */
+ max_bytes?: number
+ /**
+ * @description Maximum fill time in milliseconds
+ * @example 200
+ */
+ max_fill_ms?: number
+ /**
+ * @description Ratio of process memory reserved for incoming stream batch bytes, in (0, 1]
+ * @example 0.2
+ */
+ memory_budget_ratio?: number
+ } | null
+ /**
+ * @description Behavior when the replication slot is invalidated. `error` prevents pipeline startup and requires manual intervention. `recreate` automatically recreates the slot and restarts replication from scratch.
+ * @example error
+ * @enum {string|null}
+ */
+ invalidated_slot_behavior?: 'error' | 'recreate' | null
+ /**
+ * @description Replicator log level
+ * @example info
+ * @enum {string|null}
+ */
+ log_level?: 'trace' | 'debug' | 'info' | 'warn' | 'error' | null
+ /** @description Maximum number of copy connections per table */
+ max_copy_connections_per_table?: number | null
+ /** @description Maximum number of table sync workers */
+ max_table_sync_workers?: number | null
+ /** @description Memory-based backpressure configuration. Omission enables server defaults; `null` disables it. */
+ memory_backpressure?: {
+ /**
+ * @description Memory usage ratio above which backpressure is activated
+ * @example 0.85
+ */
+ activate_threshold: number
+ /**
+ * @description Memory usage ratio below which backpressure is released
+ * @example 0.75
+ */
+ resume_threshold: number
+ } | null
+ /**
+ * @description Milliseconds between one memory usage refresh and another
+ * @example 100
+ */
+ memory_refresh_interval_ms?: number | null
+ /**
+ * @description Publication name
+ * @example pub_orders
+ */
+ publication_name: string
+ /**
+ * @description Milliseconds between one replication lag refresh and another
+ * @example 10000
+ */
+ replication_lag_refresh_interval_ms?: number | null
+ /**
+ * @description Milliseconds between one retry and another for timed worker retries
+ * @example 10000
+ */
+ table_error_retry_delay_ms?: number | null
+ /**
+ * @description Maximum number of automatic timed retry attempts
+ * @example 5
+ */
+ table_error_retry_max_attempts?: number | null
+ /** @description Selection rules for tables participating in initial table copy. Omit or use `null` to copy all tables. */
+ table_sync_copy?:
+ | (
+ | {
+ /** @enum {string} */
+ type: 'include_all_tables'
+ }
+ | {
+ /** @enum {string} */
+ type: 'skip_all_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be performed
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'include_tables'
+ }
+ | {
+ /**
+ * @description Table ids for which copy should be skipped
+ * @example [
+ * 16408
+ * ]
+ */
+ table_ids: number[]
+ /** @enum {string} */
+ type: 'skip_tables'
+ }
+ )
+ | null
}
- cookie?: never
+ /**
+ * @description Source id
+ * @example 3001
+ */
+ source_id: number
}
- requestBody?: never
- responses: {
- /** @description All publications for the source. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['ReadPublicationsResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while listing publications. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
+ ValidatePipelineResponse_Output: {
+ /** @description List of validation failures */
+ validation_failures: {
+ /**
+ * @description Failure type
+ * @example critical
+ * @enum {string}
+ */
+ failure_type: 'critical' | 'warning'
+ /**
+ * @description Validation failure name
+ * @example Validation Failed
+ */
+ name: string
+ /**
+ * @description Validation failure reason
+ * @example The configuration is invalid
+ */
+ reason: string
+ }[]
}
- }
- V2SourcesController_getPublication: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Publication name */
- publication_name: string
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
- }
- cookie?: never
+ ValidateSpamBody: {
+ content: string
+ subject: string
}
- requestBody?: never
- responses: {
- /** @description The publication. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PublicationDetailsResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Source or publication not found. */
- 404: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while reading publication. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
+ ValidateSpamResponse: {
+ rules: {
+ desc: string
+ name: string
+ score: number
+ }[]
}
- }
- V2SourcesController_putPublication: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Publication name */
- publication_name: string
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
- }
- cookie?: never
+ VercelRedirectResponse: {
+ url: string
}
- requestBody: {
- content: {
- 'application/json': components['schemas']['PutPublicationBody']
- }
+ VerifyEmailBody: {
+ token: string
}
- responses: {
- /** @description The publication after applying the configuration. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PublicationDetailsResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while writing publication. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
+ VerifyEmailResponse: {
+ /** @enum {string} */
+ result: 'success'
}
- }
- V2SourcesController_deletePublication: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Publication name */
- publication_name: string
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
+ WarehouseCatalogResponse: {
+ /** @description External catalog credentials. Present only when enabled. */
+ credentials?: {
+ /**
+ * @description DuckLake catalog Postgres URL
+ * @example postgres://postgres:<pwd>@db.example.supabase.co:5432/postgres
+ */
+ catalog_url: string
+ /**
+ * @description DuckLake object storage path
+ * @example s3://warehouse/
+ */
+ data_path: string
+ /**
+ * @description DuckLake metadata schema in the catalog database
+ * @example ducklake
+ */
+ metadata_schema: string
+ /** @description S3 access key id */
+ s3_access_key_id: string
+ /**
+ * @description S3-compatible storage endpoint without protocol
+ * @example abcjuqabhgwjjutfvtpa.storage.supabase.co/storage/v1/s3
+ */
+ s3_endpoint: string
+ /**
+ * @description S3-compatible storage region
+ * @example us-east-1
+ */
+ s3_region: string
+ /** @description S3 secret access key */
+ s3_secret_access_key: string
}
- cookie?: never
+ /** @description Whether external catalog access is enabled */
+ enabled: boolean
}
- requestBody?: never
- responses: {
- /** @description Publication deleted. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
- }
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Source or publication not found. */
- 404: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while deleting publication. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
+ WarehouseSetupBody: {
+ /**
+ * @description Whether to configure and install the Warehouse FDW in the project database. Defaults to false.
+ * @example false
+ */
+ install_fdw?: boolean
+ /** @description Schemas and individual tables to copy. Schema targets expand to the eligible tables present when the request is processed. */
+ targets: (
+ | {
+ /**
+ * @description Postgres schema whose currently eligible tables should be copied
+ * @example public
+ */
+ schema: string
+ /** @enum {string} */
+ type: 'schema'
+ }
+ | {
+ /**
+ * @description Postgres table name
+ * @example orders
+ */
+ name: string
+ /**
+ * @description Postgres schema name
+ * @example public
+ */
+ schema: string
+ /** @enum {string} */
+ type: 'table'
+ }
+ )[]
}
- }
- V2SourcesController_getTables: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
- }
- cookie?: never
+ WarehouseSetupResponse: {
+ /**
+ * @description Warehouse replication pipeline id
+ * @example 101
+ */
+ pipeline_id: number
+ /** @description Tables with Warehouse copies */
+ tables: {
+ /**
+ * @description DuckLake schema-qualified table name
+ * @example public.orders
+ */
+ copy_name: string
+ /**
+ * @description Replication lag in milliseconds, when available
+ * @example 12000
+ */
+ lag_ms?: number
+ /**
+ * Format: date-time
+ * @description Last sync timestamp, when available
+ * @example 2026-06-23T17:48:00Z
+ */
+ last_synced_at?: string
+ /**
+ * @description Postgres table name
+ * @example orders
+ */
+ name: string
+ /**
+ * @description Postgres schema name
+ * @example public
+ */
+ schema: string
+ /**
+ * @description Warehouse copy sync state derived from replication status
+ * @example live
+ * @enum {string}
+ */
+ state: 'syncing' | 'live' | 'error'
+ /**
+ * @description Warehouse table size in bytes, when available
+ * @example 197912092672
+ */
+ warehouse_size_bytes?: number
+ }[]
}
- requestBody?: never
- responses: {
- /** @description All tables for the source. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['ReadTablesResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while listing tables. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
+ WarehouseSetupStatusResponse: {
+ /** @description Project database FDW setup markers used to derive the Warehouse FDW phase */
+ fdw_status: {
+ /**
+ * @description Whether fdw_warehouse is available to install on the project database instance
+ * @example true
+ */
+ extension_available: boolean
+ /**
+ * @description Whether the fdw_warehouse extension exists in the project database
+ * @example true
+ */
+ extension_installed: boolean
+ /**
+ * @description Whether the Warehouse foreign schema import has exposed the Warehouse snapshots table
+ * @example true
+ */
+ foreign_schema_imported: boolean
+ /**
+ * @description Whether the local Warehouse schema exists in the project database
+ * @example true
+ */
+ schema_created: boolean
+ /**
+ * @description Whether the Warehouse foreign server exists in the project database
+ * @example true
+ */
+ server_configured: boolean
+ /**
+ * @description Whether the Warehouse foreign data wrapper exists in the project database
+ * @example true
+ */
+ wrapper_installed: boolean
}
+ /**
+ * @description Warehouse replication pipeline id when it exists
+ * @example 101
+ */
+ pipeline_id?: number
+ /**
+ * @description Overall Warehouse setup status derived from replication state
+ * @example copying
+ * @enum {string}
+ */
+ setup_status: 'not_started' | 'setting_up' | 'copying' | 'complete' | 'error'
+ /** @description Warehouse setup phases in execution order */
+ steps: {
+ /**
+ * @description Best-effort progress or error message derived from Warehouse state
+ * @example Pending initial copy: public.orders:copying_table
+ */
+ message?: string
+ /**
+ * @description Observable Warehouse setup phase
+ * @example warehouse_copy
+ * @enum {string}
+ */
+ name: 'warehouse_pipeline' | 'warehouse_copy' | 'warehouse_fdw'
+ /**
+ * @description Derived Warehouse setup step status
+ * @example running
+ * @enum {string}
+ */
+ status: 'waiting' | 'running' | 'completed' | 'skipped' | 'error'
+ }[]
+ /** @description Warehouse linked tables and replication-derived sync state */
+ tables: {
+ /**
+ * @description DuckLake schema-qualified table name
+ * @example public.orders
+ */
+ copy_name: string
+ /**
+ * @description Replication lag in milliseconds, when available
+ * @example 12000
+ */
+ lag_ms?: number
+ /**
+ * Format: date-time
+ * @description Last sync timestamp, when available
+ * @example 2026-06-23T17:48:00Z
+ */
+ last_synced_at?: string
+ /**
+ * @description Postgres table name
+ * @example orders
+ */
+ name: string
+ /**
+ * @description Postgres schema name
+ * @example public
+ */
+ schema: string
+ /**
+ * @description Warehouse copy sync state derived from replication status
+ * @example live
+ * @enum {string}
+ */
+ state: 'syncing' | 'live' | 'error'
+ /**
+ * @description Warehouse table size in bytes, when available
+ * @example 197912092672
+ */
+ warehouse_size_bytes?: number
+ }[]
}
- }
- V2SourcesController_getTableColumns: {
- parameters: {
- query?: never
- header?: never
- path: {
- /** @description Project ref */
- ref: string
- /** @description Source id */
- source_id: number
- /** @description Table id (Postgres OID) */
- table_id: number
- }
- cookie?: never
+ WarehouseTableSnapshotsResponse: {
+ /** @description Available Warehouse snapshots for the project catalog. */
+ snapshots: {
+ /**
+ * @description Snapshot author, when available.
+ * @example postgres
+ */
+ author: string | null
+ /** @description Snapshot change metadata returned by the Warehouse FDW. */
+ changes: string | null
+ /** @description Additional snapshot commit metadata returned by the Warehouse FDW. */
+ commit_extra_info: string | null
+ /** @description Snapshot commit message, when available. */
+ commit_message: string | null
+ /**
+ * @description DuckLake schema version. Returned as a string because the source value is bigint.
+ * @example 7
+ */
+ schema_version: string | null
+ /**
+ * @description DuckLake snapshot id. Returned as a string because the source value is bigint.
+ * @example 42
+ */
+ snapshot_id: string
+ /**
+ * @description Snapshot timestamp returned by the Warehouse FDW.
+ * @example 2026-06-24 08:00:00+00
+ */
+ snapshot_time: string | null
+ }[]
}
- requestBody?: never
- responses: {
- /** @description All columns for the table. */
- 200: {
- headers: {
- [name: string]: unknown
- }
- content: {
- 'application/json': components['schemas']['ReadColumnsResponse_Output']
- }
- }
- /** @description Unauthorized */
- 401: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Forbidden action */
- 403: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Source or table not found. */
- 404: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Rate limit exceeded */
- 429: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
- /** @description Unexpected error while listing columns. */
- 500: {
- headers: {
- [name: string]: unknown
- }
- content?: never
- }
+ WarehouseTablesResponse: {
+ /** @description Tables with Warehouse copies */
+ tables: {
+ /**
+ * @description DuckLake schema-qualified table name
+ * @example public.orders
+ */
+ copy_name: string
+ /**
+ * @description Replication lag in milliseconds, when available
+ * @example 12000
+ */
+ lag_ms?: number
+ /**
+ * Format: date-time
+ * @description Last sync timestamp, when available
+ * @example 2026-06-23T17:48:00Z
+ */
+ last_synced_at?: string
+ /**
+ * @description Postgres table name
+ * @example orders
+ */
+ name: string
+ /**
+ * @description Postgres schema name
+ * @example public
+ */
+ schema: string
+ /**
+ * @description Warehouse copy sync state derived from replication status
+ * @example live
+ * @enum {string}
+ */
+ state: 'syncing' | 'live' | 'error'
+ /**
+ * @description Warehouse table size in bytes, when available
+ * @example 197912092672
+ */
+ warehouse_size_bytes?: number
+ }[]
+ }
+ WorkflowRunResponse: {
+ branch_id: string
+ check_run_id: number | null
+ created_at: string
+ git_config?: unknown
+ id: string
+ /** @enum {string} */
+ status:
+ | 'CREATING_PROJECT'
+ | 'RUNNING_MIGRATIONS'
+ | 'MIGRATIONS_PASSED'
+ | 'MIGRATIONS_FAILED'
+ | 'FUNCTIONS_DEPLOYED'
+ | 'FUNCTIONS_FAILED'
+ updated_at: string
+ workdir: string | null
}
}
+ responses: never
+ parameters: never
+ requestBodies: never
+ headers: never
+ pathItems: never
+}
+export type $defs = Record<string, never>
+export interface operations {
GoTrueConfigController_getGoTrueConfig: {
parameters: {
query?: never
@@ -23883,6 +18609,32 @@ export interface operations {
}
}
}
+ VercelConnectionsController_enableVercelConnectionJitAccess: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ connection_id: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Failed to enable JIT database access for given connection id */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ }
+ }
VercelConnectionsController_syncVercelConnectionEnvironments: {
parameters: {
query?: never
@@ -24156,7 +18908,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationResponse'][]
+ 'application/json': components['schemas']['OrganizationResponse_Output'][]
}
}
/** @description Failed to retrieve user's organizations */
@@ -24208,7 +18960,49 @@ export interface operations {
}
requires_indirect_tax_declaration: boolean
restriction_data: {
- [key: string]: string
+ /** Format: date-time */
+ billing_period_end?: string
+ /** Format: date-time */
+ grace_period_end?: string
+ grace_period_manually_extended?: boolean
+ /** Format: date-time */
+ lifted_at?: string
+ reason?: string
+ /** Format: date */
+ report_date?: string
+ restrictions?: 'drop_requests_402'[]
+ usage_stats?: {
+ /** Format: date */
+ report_date: string
+ total_auth_billing_period_mau_billing_period?: number
+ total_cached_egress_gb_billing_period?: number
+ total_db_size_gb_billing_period?: number
+ total_func_invocations_billing_period?: number
+ total_log_query_gb_billing_period?: number
+ total_realtime_message_count_billing_period?: number
+ total_realtime_peak_connection_billing_period?: number
+ total_regular_egress_gb_billing_period?: number
+ total_storage_size_gb_billing_period?: number
+ }
+ violation_data?: {
+ [key: string]: {
+ current: number
+ limit: number
+ }
+ }
+ violations?: (
+ | 'exceed_db_size_quota'
+ | 'exceed_egress_quota'
+ | 'exceed_cached_egress_quota'
+ | 'exceed_edge_functions_count_quota'
+ | 'exceed_edge_functions_invocations_quota'
+ | 'exceed_monthly_active_users_quota'
+ | 'exceed_realtime_connection_count_quota'
+ | 'exceed_realtime_message_count_quota'
+ | 'exceed_storage_size_quota'
+ | 'exceed_log_query_quota'
+ | 'overdue_payment'
+ )[]
} | null
restriction_status: ('grace_period' | 'grace_period_over' | 'restricted') | null
slug: string
@@ -24244,7 +19038,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationSlugResponse']
+ 'application/json': components['schemas']['OrganizationSlugResponse_Output']
}
}
/** @description Unauthorized */
@@ -24339,7 +19133,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateOrganizationResponse']
+ 'application/json': components['schemas']['UpdateOrganizationResponse_Output']
}
}
/** @description Unauthorized */
@@ -24389,7 +19183,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LFBackend'][]
+ 'application/json': components['schemas']['LFBackend_Output'][]
}
}
/** @description Unauthorized */
@@ -24443,7 +19237,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LFBackend']
+ 'application/json': components['schemas']['LFBackend_Output']
}
}
/** @description Unauthorized */
@@ -24508,7 +19302,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LFBackend']
+ 'application/json': components['schemas']['LFBackend_Output']
}
}
/** @description Unauthorized */
@@ -24614,7 +19408,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LFBackend']
+ 'application/json': components['schemas']['LFBackend_Output']
}
}
/** @description Unauthorized */
@@ -24666,7 +19460,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BackendConnectionTest']
+ 'application/json': components['schemas']['BackendConnectionTest_Output']
}
}
/** @description Unauthorized */
@@ -24716,7 +19510,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ListPlatformAppsResponse']
+ 'application/json': components['schemas']['ListPlatformAppsResponse_Output']
}
}
/** @description Unauthorized */
@@ -24763,7 +19557,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreatePlatformAppResponse']
+ 'application/json': components['schemas']['CreatePlatformAppResponse_Output']
}
}
/** @description Unauthorized */
@@ -24807,7 +19601,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetPlatformAppResponse']
+ 'application/json': components['schemas']['GetPlatformAppResponse_Output']
}
}
/** @description Unauthorized */
@@ -24897,7 +19691,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetPlatformAppResponse']
+ 'application/json': components['schemas']['GetPlatformAppResponse_Output']
}
}
/** @description Unauthorized */
@@ -24941,7 +19735,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ListPlatformAppSigningKeysResponse']
+ 'application/json': components['schemas']['ListPlatformAppSigningKeysResponse_Output']
}
}
/** @description Unauthorized */
@@ -24985,7 +19779,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreatePlatformAppSigningKeyResponse']
+ 'application/json': components['schemas']['CreatePlatformAppSigningKeyResponse_Output']
}
}
/** @description Unauthorized */
@@ -25071,7 +19865,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ListPlatformAppInstallationsResponse']
+ 'application/json': components['schemas']['ListPlatformAppInstallationsResponse_Output']
}
}
/** @description Unauthorized */
@@ -25118,7 +19912,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['InstallPlatformAppResponse']
+ 'application/json': components['schemas']['InstallPlatformAppResponse_Output']
}
}
/** @description Unauthorized */
@@ -25162,7 +19956,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetPlatformAppInstallationResponse']
+ 'application/json': components['schemas']['GetPlatformAppInstallationResponse_Output']
}
}
/** @description Unauthorized */
@@ -25248,7 +20042,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdatePlatformAppInstallationResponse']
+ 'application/json': components['schemas']['UpdatePlatformAppInstallationResponse_Output']
}
}
/** @description Unauthorized */
@@ -25296,7 +20090,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AuditLogsResponse']
+ 'application/json': components['schemas']['AuditLogsResponse_Output']
}
}
/** @description Unauthorized */
@@ -25350,7 +20144,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationSlugAvailableVersionsResponse']
+ 'application/json': components['schemas']['OrganizationSlugAvailableVersionsResponse_Output']
}
}
/** @description Unauthorized */
@@ -25400,7 +20194,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreditBalanceResponse']
+ 'application/json': components['schemas']['CreditBalanceResponse_Output']
}
}
/** @description Unauthorized */
@@ -25448,7 +20242,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PreviewCreditTopUpResponse']
+ 'application/json': components['schemas']['PreviewCreditTopUpResponse_Output']
}
}
/** @description Unauthorized */
@@ -25496,7 +20290,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreditRedemptionResponse']
+ 'application/json': components['schemas']['CreditRedemptionResponse_Output']
}
}
/** @description Unauthorized */
@@ -25551,7 +20345,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreditsTopUpResponse']
+ 'application/json': components['schemas']['CreditsTopUpResponse_Output']
}
}
/** @description Unauthorized */
@@ -25604,7 +20398,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['Invoice'][]
+ 'application/json': components['schemas']['Invoice_Output'][]
}
}
/** @description Unauthorized */
@@ -25705,7 +20499,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['Invoice']
+ 'application/json': components['schemas']['Invoice_Output']
}
}
/** @description Unauthorized */
@@ -25756,7 +20550,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['InvoicePaymentLinkResponse']
+ 'application/json': components['schemas']['InvoicePaymentLinkResponse_Output']
}
}
/** @description Unauthorized */
@@ -25807,7 +20601,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['InvoiceReceiptResponse']
+ 'application/json': components['schemas']['InvoiceReceiptResponse_Output']
}
}
/** @description Receipt not available for this invoice type or status */
@@ -25871,7 +20665,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpcomingInvoice']
+ 'application/json': components['schemas']['UpcomingInvoice_Output']
}
}
/** @description Unauthorized */
@@ -25921,7 +20715,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PlansResponse']
+ 'application/json': components['schemas']['PlansResponse_Output']
}
}
/** @description Unauthorized */
@@ -26025,7 +20819,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateSubscriptionResponse']
+ 'application/json': components['schemas']['UpdateSubscriptionResponse_Output']
}
}
/** @description Unauthorized */
@@ -26139,7 +20933,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PreviewSubscriptionChangeResponse']
+ 'application/json': components['schemas']['PreviewSubscriptionChangeResponse_Output']
}
}
/** @description Unauthorized */
@@ -26194,7 +20988,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['RequestUpgradeResponse']
+ 'application/json': components['schemas']['RequestUpgradeResponse_Output']
}
}
/** @description Unauthorized */
@@ -26296,7 +21090,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetCloudMarketplaceRedirectUrlResponse']
+ 'application/json': components['schemas']['GetCloudMarketplaceRedirectUrlResponse_Output']
}
}
/** @description Unauthorized */
@@ -26346,7 +21140,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CustomerResponse']
+ 'application/json': components['schemas']['CustomerResponse_Output']
}
}
/** @description Unauthorized */
@@ -26448,7 +21242,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrgDocumentUrlResponse']
+ 'application/json': components['schemas']['OrgDocumentUrlResponse_Output']
}
}
/** @description Only organizations on Team, Enterprise or Platform Plan can access our ISO 27001 certificate. */
@@ -26500,7 +21294,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrgDocumentUrlResponse']
+ 'application/json': components['schemas']['OrgDocumentUrlResponse_Output']
}
}
/** @description Only organizations on Team, Enterprise or Platform Plan can access our SOC2 Type 2 report. */
@@ -26552,7 +21346,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrgDocumentUrlResponse']
+ 'application/json': components['schemas']['OrgDocumentUrlResponse_Output']
}
}
/** @description Only organizations on Team, Enterprise or Platform Plan can access our standard security questionnaire. */
@@ -26604,7 +21398,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ListEntitlementsResponse']
+ 'application/json': components['schemas']['ListEntitlementsResponse_Output']
}
}
/** @description Unauthorized */
@@ -26647,7 +21441,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['Member'][]
+ 'application/json': components['schemas']['Member_Output'][]
}
}
/** @description Failed to retrieve organization's members */
@@ -26882,7 +21676,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['InvitationResponse']
+ 'application/json': components['schemas']['InvitationResponse_Output']
}
}
/** @description Unauthorized */
@@ -27044,7 +21838,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['InvitationByTokenResponse']
+ 'application/json': components['schemas']['InvitationByTokenResponse_Output']
}
}
/** @description Failed to get organization invitation by token */
@@ -27102,7 +21896,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['MfaStatusResponse']
+ 'application/json': components['schemas']['MfaStatusResponse_Output']
}
}
/** @description Unauthorized */
@@ -27157,7 +21951,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['MfaStatusResponse']
+ 'application/json': components['schemas']['MfaStatusResponse_Output']
}
}
/** @description Unauthorized */
@@ -27216,7 +22010,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['MemberWithFreeProjectLimit'][]
+ 'application/json': components['schemas']['MemberWithFreeProjectLimit_Output'][]
}
}
/** @description Unauthorized */
@@ -27268,7 +22062,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OAuthAppResponse'][]
+ 'application/json': components['schemas']['OAuthAppResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -27315,7 +22109,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateOAuthAppResponse']
+ 'application/json': components['schemas']['CreateOAuthAppResponse_Output']
}
}
/** @description Unauthorized */
@@ -27359,7 +22153,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ListOAuthAppClientSecretsResponse']
+ 'application/json': components['schemas']['ListOAuthAppClientSecretsResponse_Output']
}
}
/** @description Unauthorized */
@@ -27403,7 +22197,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateOAuthAppClientSecretResponse']
+ 'application/json': components['schemas']['CreateOAuthAppClientSecretResponse_Output']
}
}
/** @description Unauthorized */
@@ -27494,7 +22288,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PutOAuthAppResponse']
+ 'application/json': components['schemas']['PutOAuthAppResponse_Output']
}
}
/** @description Unauthorized */
@@ -27538,7 +22332,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DeleteOAuthAppResponse']
+ 'application/json': components['schemas']['DeleteOAuthAppResponse_Output']
}
}
/** @description Unauthorized */
@@ -27582,7 +22376,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['RevokeAuthorizedOAuthAppResponse']
+ 'application/json': components['schemas']['RevokeAuthorizedOAuthAppResponse_Output']
}
}
/** @description Unauthorized */
@@ -27627,7 +22421,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ApproveAuthorizationResponse']
+ 'application/json': components['schemas']['ApproveAuthorizationResponse_Output']
}
}
/** @description Unauthorized */
@@ -27672,7 +22466,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DeclineAuthorizationResponse']
+ 'application/json': components['schemas']['DeclineAuthorizationResponse_Output']
}
}
/** @description Unauthorized */
@@ -27715,7 +22509,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PaymentsResponse']
+ 'application/json': components['schemas']['PaymentsResponse_Output']
}
}
/** @description Unauthorized */
@@ -27869,7 +22663,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SetupIntentResponse']
+ 'application/json': components['schemas']['SetupIntentResponse_Output']
}
}
/** @description Unauthorized */
@@ -27932,7 +22726,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationProjectsResponse']
+ 'application/json': components['schemas']['OrganizationProjectsResponse_Output']
}
}
/** @description Failed to retrieve projects */
@@ -27961,7 +22755,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationRoleResponse']
+ 'application/json': components['schemas']['OrganizationRoleResponse_Output']
}
}
/** @description Unauthorized */
@@ -28353,7 +23147,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['TaxIdResponse']
+ 'application/json': components['schemas']['TaxIdResponse_Output']
}
}
/** @description Unauthorized */
@@ -28408,7 +23202,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrgUsageResponse']
+ 'application/json': components['schemas']['OrgUsageResponse_Output']
}
}
/** @description Unauthorized */
@@ -28463,7 +23257,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrgDailyUsageResponse']
+ 'application/json': components['schemas']['OrgDailyUsageResponse_Output']
}
}
/** @description Unauthorized */
@@ -28514,7 +23308,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OrganizationResponse']
+ 'application/json': components['schemas']['OrganizationResponse_Output']
}
}
/** @description Failed to create organization billed by AWS Marketplace */
@@ -28566,7 +23360,49 @@ export interface operations {
}
requires_indirect_tax_declaration: boolean
restriction_data: {
- [key: string]: string
+ /** Format: date-time */
+ billing_period_end?: string
+ /** Format: date-time */
+ grace_period_end?: string
+ grace_period_manually_extended?: boolean
+ /** Format: date-time */
+ lifted_at?: string
+ reason?: string
+ /** Format: date */
+ report_date?: string
+ restrictions?: 'drop_requests_402'[]
+ usage_stats?: {
+ /** Format: date */
+ report_date: string
+ total_auth_billing_period_mau_billing_period?: number
+ total_cached_egress_gb_billing_period?: number
+ total_db_size_gb_billing_period?: number
+ total_func_invocations_billing_period?: number
+ total_log_query_gb_billing_period?: number
+ total_realtime_message_count_billing_period?: number
+ total_realtime_peak_connection_billing_period?: number
+ total_regular_egress_gb_billing_period?: number
+ total_storage_size_gb_billing_period?: number
+ }
+ violation_data?: {
+ [key: string]: {
+ current: number
+ limit: number
+ }
+ }
+ violations?: (
+ | 'exceed_db_size_quota'
+ | 'exceed_egress_quota'
+ | 'exceed_cached_egress_quota'
+ | 'exceed_edge_functions_count_quota'
+ | 'exceed_edge_functions_invocations_quota'
+ | 'exceed_monthly_active_users_quota'
+ | 'exceed_realtime_connection_count_quota'
+ | 'exceed_realtime_message_count_quota'
+ | 'exceed_storage_size_quota'
+ | 'exceed_log_query_quota'
+ | 'overdue_payment'
+ )[]
} | null
restriction_status: ('grace_period' | 'grace_period_over' | 'restricted') | null
slug: string
@@ -28632,7 +23468,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PreviewOrganizationCreationResponse']
+ 'application/json': components['schemas']['PreviewOrganizationCreationResponse_Output']
}
}
}
@@ -28712,7 +23548,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PostgresExtension'][]
+ 'application/json': components['schemas']['PostgresExtension_Output'][]
}
}
/** @description Unauthorized */
@@ -29757,7 +24593,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ListProjectsPaginatedResponse']
+ 'application/json': components['schemas']['ListProjectsPaginatedResponse_Output']
}
}
}
@@ -29780,7 +24616,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateProjectResponse']
+ 'application/json': components['schemas']['CreateProjectResponse_Output']
}
}
}
@@ -29804,7 +24640,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectResourceWarningsResponse'][]
+ 'application/json': components['schemas']['ProjectResourceWarningsResponse_Output'][]
}
}
}
@@ -29826,7 +24662,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectDetailResponse']
+ 'application/json': components['schemas']['ProjectDetailResponse_Output']
}
}
/** @description Unauthorized */
@@ -29869,7 +24705,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['RemoveProjectResponse']
+ 'application/json': components['schemas']['RemoveProjectResponse_Output']
}
}
/** @description Unauthorized */
@@ -29916,7 +24752,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectRefResponse']
+ 'application/json': components['schemas']['ProjectRefResponse_Output']
}
}
/** @description Unauthorized */
@@ -29970,7 +24806,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30022,7 +24858,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30075,7 +24911,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30128,7 +24964,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30181,7 +25017,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30236,7 +25072,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30290,7 +25126,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30345,7 +25181,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30399,7 +25235,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30454,7 +25290,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30508,7 +25344,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30560,7 +25396,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30612,7 +25448,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30668,7 +25504,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectServiceHealthResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30720,7 +25556,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30770,7 +25606,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AnalyticsResponse']
+ 'application/json': components['schemas']['AnalyticsResponse_Output']
}
}
/** @description Unauthorized */
@@ -30820,7 +25656,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LFBackend'][]
+ 'application/json': components['schemas']['LFBackend_Output'][]
}
}
/** @description Unauthorized */
@@ -30874,7 +25710,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LFBackend']
+ 'application/json': components['schemas']['LFBackend_Output']
}
}
/** @description Unauthorized */
@@ -30939,7 +25775,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LFBackend']
+ 'application/json': components['schemas']['LFBackend_Output']
}
}
/** @description Unauthorized */
@@ -31045,7 +25881,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LFBackend']
+ 'application/json': components['schemas']['LFBackend_Output']
}
}
/** @description Unauthorized */
@@ -31092,12 +25928,12 @@ export interface operations {
}
requestBody?: never
responses: {
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BackendConnectionTest']
+ 'application/json': components['schemas']['BackendConnectionTest_Output']
}
}
/** @description Unauthorized */
@@ -31358,7 +26194,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectAddonsResponse']
+ 'application/json': components['schemas']['ProjectAddonsResponse_Output']
}
}
/** @description Unauthorized */
@@ -31536,7 +26372,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PgbouncerConfigResponse']
+ 'application/json': components['schemas']['PgbouncerConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -31590,7 +26426,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdatePoolingConfigResponse']
+ 'application/json': components['schemas']['UpdatePoolingConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -31640,7 +26476,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PgbouncerStatusResponse']
+ 'application/json': components['schemas']['PgbouncerStatusResponse_Output']
}
}
/** @description Unauthorized */
@@ -31690,7 +26526,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetPostgrestConfigResponse']
+ 'application/json': components['schemas']['GetPostgrestConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -31744,7 +26580,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdatePostgrestConfigResponse']
+ 'application/json': components['schemas']['UpdatePostgrestConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -31795,7 +26631,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['RealtimeConfigResponse']
+ 'application/json': components['schemas']['RealtimeConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -31936,7 +26772,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UpdateSecretsResponse']
+ 'application/json': components['schemas']['UpdateSecretsResponse_Output']
}
}
/** @description Unauthorized */
@@ -31986,7 +26822,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetJwtSecretUpdateStatus']
+ 'application/json': components['schemas']['GetJwtSecretUpdateStatus_Output']
}
}
/** @description Unauthorized */
@@ -32036,7 +26872,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageConfigResponse']
+ 'application/json': components['schemas']['StorageConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -32090,7 +26926,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageConfigResponse']
+ 'application/json': components['schemas']['StorageConfigResponse_Output']
}
}
/** @description Unauthorized */
@@ -32140,7 +26976,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SupavisorConfigResponse'][]
+ 'application/json': components['schemas']['SupavisorConfigResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -32204,7 +27040,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetUserContentResponse']
+ 'application/json': components['schemas']['GetUserContentResponse_Output']
}
}
/** @description Unauthorized */
@@ -32308,7 +27144,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['BulkDeleteUserContentResponse'][]
+ 'application/json': components['schemas']['BulkDeleteUserContentResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -32361,7 +27197,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetContentCountV2Response']
+ 'application/json': components['schemas']['GetContentCountV2Response_Output']
}
}
/** @description Unauthorized */
@@ -32419,7 +27255,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetUserContentFolderResponse']
+ 'application/json': components['schemas']['GetUserContentFolderResponse_Output']
}
}
/** @description Unauthorized */
@@ -32473,7 +27309,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateUserContentFolderResponse']
+ 'application/json': components['schemas']['CreateUserContentFolderResponse_Output']
}
}
/** @description Unauthorized */
@@ -32578,7 +27414,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetUserContentFolderResponse']
+ 'application/json': components['schemas']['GetUserContentFolderResponse_Output']
}
}
/** @description Unauthorized */
@@ -32683,7 +27519,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetUserContentByIdResponse']
+ 'application/json': components['schemas']['GetUserContentByIdResponse_Output']
}
}
/** @description Unauthorized */
@@ -32805,7 +27641,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DatabaseDetailResponse'][]
+ 'application/json': components['schemas']['DatabaseDetailResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -32848,7 +27684,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DatabaseStatusResponse'][]
+ 'application/json': components['schemas']['DatabaseStatusResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -32901,7 +27737,9 @@ export interface operations {
headers: {
[name: string]: unknown
}
- content?: never
+ content: {
+ 'application/json': components['schemas']['UpdatePasswordResponse_Output']
+ }
}
/** @description Unauthorized */
401: {
@@ -32950,7 +27788,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DiskResponse']
+ 'application/json': components['schemas']['DiskResponse_Output']
}
}
/** @description Unauthorized */
@@ -33052,7 +27890,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DiskAutoscaleConfig']
+ 'application/json': components['schemas']['DiskAutoscaleConfig_Output']
}
}
/** @description Unauthorized */
@@ -33106,7 +27944,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DiskAutoscaleConfig']
+ 'application/json': components['schemas']['DiskAutoscaleConfig_Output']
}
}
/** @description Unauthorized */
@@ -33156,7 +27994,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DiskUtilMetricsResponse']
+ 'application/json': components['schemas']['DiskUtilMetricsResponse_Output']
}
}
/** @description Unauthorized */
@@ -33379,7 +28217,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['LoadBalancerDetailResponse'][]
+ 'application/json': components['schemas']['LoadBalancerDetailResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -33422,7 +28260,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectMembersResponse']
+ 'application/json': components['schemas']['ProjectMembersResponse_Output']
}
}
/** @description Unauthorized */
@@ -33720,7 +28558,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PauseStatusResponse']
+ 'application/json': components['schemas']['PauseStatusResponse_Output']
}
}
/** @description Unauthorized */
@@ -33763,7 +28601,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetPrivateLinkResponse']
+ 'application/json': components['schemas']['GetPrivateLinkResponse_Output']
}
}
/** @description Unauthorized */
@@ -34166,7 +29004,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UnpauseProjectResponse']
+ 'application/json': components['schemas']['UnpauseProjectResponse_Output']
}
}
/** @description Unauthorized */
@@ -34216,7 +29054,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['UnpauseProjectAvailableVersionsResponse']
+ 'application/json': components['schemas']['UnpauseProjectAvailableVersionsResponse_Output']
}
}
/** @description Unauthorized */
@@ -34266,7 +29104,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetProjectLintsResponse']
+ 'application/json': components['schemas']['GetProjectLintsResponse_Output']
}
}
/** @description Unauthorized */
@@ -34309,7 +29147,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ServiceVersions']
+ 'application/json': components['schemas']['ServiceVersions_Output']
}
}
/** @description Unauthorized */
@@ -34352,7 +29190,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectSettingsResponse']
+ 'application/json': components['schemas']['ProjectSettingsResponse_Output']
}
}
/** @description Unauthorized */
@@ -34406,7 +29244,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectSensitivityResponse']
+ 'application/json': components['schemas']['ProjectSensitivityResponse_Output']
}
}
/** @description Unauthorized */
@@ -34553,7 +29391,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PreviewProjectTransferResponse']
+ 'application/json': components['schemas']['PreviewProjectTransferResponse_Output']
}
}
/** @description Unauthorized */
@@ -34591,12 +29429,12 @@ export interface operations {
}
requestBody?: never
responses: {
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ProjectWakeResponse']
+ 'application/json': components['schemas']['ProjectWakeResponse_Output']
}
}
/** @description Unauthorized */
@@ -34658,12 +29496,12 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['RegionsInfo']
+ 'application/json': components['schemas']['RegionsInfo_Output']
}
}
}
}
- ReplicationDestinationsController_getDestinations: {
+ DestinationsController_getDestinations: {
parameters: {
query?: never
header?: never
@@ -34681,7 +29519,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationDestinationsResponse']
+ 'application/json': components['schemas']['DestinationsResponse_Output']
}
}
/** @description Unauthorized */
@@ -34714,7 +29552,7 @@ export interface operations {
}
}
}
- ReplicationDestinationsController_createDestination: {
+ DestinationsController_createDestination: {
parameters: {
query?: never
header?: never
@@ -34726,17 +29564,17 @@ export interface operations {
}
requestBody: {
content: {
- 'application/json': components['schemas']['CreateReplicationDestinationBody']
+ 'application/json': components['schemas']['CreateDestinationBody']
}
}
responses: {
/** @description Destination created. */
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateDestinationResponse']
+ 'application/json': components['schemas']['CreateDestinationResponse_Output']
}
}
/** @description Unauthorized */
@@ -34778,7 +29616,7 @@ export interface operations {
}
}
}
- ReplicationDestinationsPipelinesController_createDestinationPipeline: {
+ DestinationsPipelinesController_createDestinationPipeline: {
parameters: {
query?: never
header?: never
@@ -34795,12 +29633,12 @@ export interface operations {
}
responses: {
/** @description Destination and pipeline created. */
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateDestinationPipelineResponse']
+ 'application/json': components['schemas']['CreateDestinationPipelineResponse_Output']
}
}
/** @description Unauthorized */
@@ -34842,7 +29680,7 @@ export interface operations {
}
}
}
- ReplicationDestinationsPipelinesController_updateDestinationPipeline: {
+ DestinationsPipelinesController_updateDestinationPipeline: {
parameters: {
query?: never
header?: never
@@ -34908,7 +29746,7 @@ export interface operations {
}
}
}
- ReplicationDestinationsPipelinesController_deleteDestinationPipeline: {
+ DestinationsPipelinesController_deleteDestinationPipeline: {
parameters: {
query?: never
header?: never
@@ -34930,7 +29768,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['DeleteDestinationPipelineResponse']
+ 'application/json': components['schemas']['DeleteDestinationPipelineResponse_Output']
}
}
/** @description Unauthorized */
@@ -34986,7 +29824,7 @@ export interface operations {
}
}
}
- ReplicationDestinationsController_getDestination: {
+ DestinationsController_getDestination: {
parameters: {
query?: never
header?: never
@@ -35006,7 +29844,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationDestinationResponse']
+ 'application/json': components['schemas']['DestinationResponse_Output']
}
}
/** @description Unauthorized */
@@ -35039,7 +29877,7 @@ export interface operations {
}
}
}
- ReplicationDestinationsController_updateDestination: {
+ DestinationsController_updateDestination: {
parameters: {
query?: never
header?: never
@@ -35053,7 +29891,7 @@ export interface operations {
}
requestBody: {
content: {
- 'application/json': components['schemas']['UpdateReplicationDestinationBody']
+ 'application/json': components['schemas']['UpdateDestinationBody']
}
}
responses: {
@@ -35103,7 +29941,7 @@ export interface operations {
}
}
}
- ReplicationDestinationsController_deleteDestination: {
+ DestinationsController_deleteDestination: {
parameters: {
query?: never
header?: never
@@ -35177,7 +30015,7 @@ export interface operations {
}
}
}
- ReplicationDestinationsController_validateDestination: {
+ DestinationsController_validateDestination: {
parameters: {
query?: never
header?: never
@@ -35189,17 +30027,17 @@ export interface operations {
}
requestBody: {
content: {
- 'application/json': components['schemas']['ValidateReplicationDestinationBody']
+ 'application/json': components['schemas']['ValidateDestinationBody']
}
}
responses: {
/** @description Validation completed. */
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ValidateDestinationResponse']
+ 'application/json': components['schemas']['ValidateDestinationResponse_Output']
}
}
/** @description Unauthorized */
@@ -35232,7 +30070,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_getPipelines: {
+ PipelinesController_getPipelines: {
parameters: {
query?: never
header?: never
@@ -35250,7 +30088,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationPipelinesResponse']
+ 'application/json': components['schemas']['PipelinesResponse_Output']
}
}
/** @description Unauthorized */
@@ -35283,7 +30121,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_createPipeline: {
+ PipelinesController_createPipeline: {
parameters: {
query?: never
header?: never
@@ -35295,17 +30133,17 @@ export interface operations {
}
requestBody: {
content: {
- 'application/json': components['schemas']['CreateReplicationPipelineBody']
+ 'application/json': components['schemas']['CreatePipelineBody']
}
}
responses: {
/** @description Pipeline created. */
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreatePipelineResponse']
+ 'application/json': components['schemas']['CreatePipelineResponse_Output']
}
}
/** @description Unauthorized */
@@ -35347,7 +30185,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_getPipeline: {
+ PipelinesController_getPipeline: {
parameters: {
query?: never
header?: never
@@ -35367,7 +30205,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationPipelineResponse']
+ 'application/json': components['schemas']['PipelineResponse_Output']
}
}
/** @description Unauthorized */
@@ -35400,7 +30238,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_updatePipeline: {
+ PipelinesController_updatePipeline: {
parameters: {
query?: never
header?: never
@@ -35414,7 +30252,7 @@ export interface operations {
}
requestBody: {
content: {
- 'application/json': components['schemas']['UpdateReplicationPipelineBody']
+ 'application/json': components['schemas']['UpdatePipelineBody']
}
}
responses: {
@@ -35464,7 +30302,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_deletePipeline: {
+ PipelinesController_deletePipeline: {
parameters: {
query?: never
header?: never
@@ -35538,7 +30376,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_getPipelineReplicationStatus: {
+ PipelinesController_getPipelineReplicationStatus: {
parameters: {
query?: never
header?: never
@@ -35558,7 +30396,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationPipelineReplicationStatusResponse']
+ 'application/json': components['schemas']['PipelineReplicationStatusResponse_Output']
}
}
/** @description Unauthorized */
@@ -35591,7 +30429,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_restartPipeline: {
+ PipelinesController_restartPipeline: {
parameters: {
query?: never
header?: never
@@ -35658,7 +30496,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_rollbackTables: {
+ PipelinesController_rollbackTables: {
parameters: {
query?: never
header?: never
@@ -35677,12 +30515,12 @@ export interface operations {
}
responses: {
/** @description New table states after rollback. */
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['RollbackTablesResponse']
+ 'application/json': components['schemas']['RollbackTablesResponse_Output']
}
}
/** @description Unauthorized */
@@ -35724,7 +30562,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_startPipeline: {
+ PipelinesController_startPipeline: {
parameters: {
query?: never
header?: never
@@ -35784,7 +30622,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_getPipelineStatus: {
+ PipelinesController_getPipelineStatus: {
parameters: {
query?: never
header?: never
@@ -35804,7 +30642,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationPipelineStatusResponse']
+ 'application/json': components['schemas']['PipelineStatusResponse_Output']
}
}
/** @description Unauthorized */
@@ -35837,7 +30675,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_stopPipeline: {
+ PipelinesController_stopPipeline: {
parameters: {
query?: never
header?: never
@@ -35897,7 +30735,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_getPipelineVersion: {
+ PipelinesController_getPipelineVersion: {
parameters: {
query?: never
header?: never
@@ -35917,7 +30755,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationPipelineVersionResponse']
+ 'application/json': components['schemas']['PipelineVersionResponse_Output']
}
}
/** @description Unauthorized */
@@ -35950,7 +30788,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_updatePipelineVersion: {
+ PipelinesController_updatePipelineVersion: {
parameters: {
query?: never
header?: never
@@ -35964,7 +30802,7 @@ export interface operations {
}
requestBody: {
content: {
- 'application/json': components['schemas']['UpdateReplicationPipelineVersionBody']
+ 'application/json': components['schemas']['UpdatePipelineVersionBody']
}
}
responses: {
@@ -36014,7 +30852,7 @@ export interface operations {
}
}
}
- ReplicationPipelinesController_validatePipeline: {
+ PipelinesController_validatePipeline: {
parameters: {
query?: never
header?: never
@@ -36026,17 +30864,17 @@ export interface operations {
}
requestBody: {
content: {
- 'application/json': components['schemas']['ValidateReplicationPipelineBody']
+ 'application/json': components['schemas']['ValidatePipelineBody']
}
}
responses: {
/** @description Validation completed. */
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ValidatePipelineResponse']
+ 'application/json': components['schemas']['ValidatePipelineResponse_Output']
}
}
/** @description Unauthorized */
@@ -36069,7 +30907,7 @@ export interface operations {
}
}
}
- ReplicationSourcesController_getSources: {
+ SourcesController_getSources: {
parameters: {
query?: never
header?: never
@@ -36087,7 +30925,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationSourcesResponse']
+ 'application/json': components['schemas']['SourcesResponse_Output']
}
}
/** @description Unauthorized */
@@ -36120,7 +30958,7 @@ export interface operations {
}
}
}
- ReplicationSourcesController_createSource: {
+ SourcesController_createSource: {
parameters: {
query?: never
header?: never
@@ -36133,12 +30971,12 @@ export interface operations {
requestBody?: never
responses: {
/** @description Source created. */
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateSourceResponse']
+ 'application/json': components['schemas']['CreateSourceResponse_Output']
}
}
/** @description Unauthorized */
@@ -36180,7 +31018,7 @@ export interface operations {
}
}
}
- ReplicationSourcesController_getPublications: {
+ SourcesController_getPublications: {
parameters: {
query?: never
header?: never
@@ -36200,7 +31038,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationPublicationsResponse']
+ 'application/json': components['schemas']['PublicationsResponse_Output']
}
}
/** @description Unauthorized */
@@ -36233,7 +31071,7 @@ export interface operations {
}
}
}
- ReplicationSourcesController_createPublication: {
+ SourcesController_createPublication: {
parameters: {
query?: never
header?: never
@@ -36247,7 +31085,7 @@ export interface operations {
}
requestBody: {
content: {
- 'application/json': components['schemas']['CreateReplicationPublicationBody']
+ 'application/json': components['schemas']['CreatePublicationBody']
}
}
responses: {
@@ -36297,7 +31135,7 @@ export interface operations {
}
}
}
- ReplicationSourcesController_updatePublication: {
+ SourcesController_updatePublication: {
parameters: {
query?: never
header?: never
@@ -36313,7 +31151,7 @@ export interface operations {
}
requestBody: {
content: {
- 'application/json': components['schemas']['UpdateReplicationPublicationBody']
+ 'application/json': components['schemas']['UpdatePublicationBody']
}
}
responses: {
@@ -36363,7 +31201,7 @@ export interface operations {
}
}
}
- ReplicationSourcesController_deletePublication: {
+ SourcesController_deletePublication: {
parameters: {
query?: never
header?: never
@@ -36409,13 +31247,193 @@ export interface operations {
}
content?: never
}
- /** @description Source not found. */
+ /** @description Source not found. */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unexpected error while deleting publication. */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ }
+ }
+ SourcesController_getCostEstimate: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Publication name */
+ publication_name: string
+ /** @description Project ref */
+ ref: string
+ /** @description Source id */
+ source_id: number
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Cost estimate for replicating the publication. */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['CostEstimateResponse_Output']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unexpected error while estimating replication cost. */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ }
+ }
+ SourcesController_getTables: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ /** @description Source id */
+ source_id: number
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description All tables for the source. */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['TablesResponse_Output']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unexpected error while listing tables. */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ }
+ }
+ TenantsController_deleteTenant: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Tenant deleted. */
+ 200: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
+ 402: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['PlanGateErrorBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Tenant not found. */
404: {
headers: {
[name: string]: unknown
}
content?: never
}
+ /** @description Tenant has active pipelines. */
+ 409: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Rate limit exceeded */
429: {
headers: {
@@ -36423,7 +31441,7 @@ export interface operations {
}
content?: never
}
- /** @description Unexpected error while deleting publication. */
+ /** @description Unexpected error while deleting tenant. */
500: {
headers: {
[name: string]: unknown
@@ -36432,13 +31450,71 @@ export interface operations {
}
}
}
- ReplicationSourcesController_getCostEstimate: {
+ TenantsSourcesController_createTenantSource: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Tenant and source created. */
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['CreateTenantSourceResponse_Output']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
+ 402: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['PlanGateErrorBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unexpected error while creating tenant or source. */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ }
+ }
+ V2SourcesController_getPublications: {
parameters: {
query?: never
header?: never
path: {
- /** @description Publication name */
- publication_name: string
/** @description Project ref */
ref: string
/** @description Source id */
@@ -36448,13 +31524,13 @@ export interface operations {
}
requestBody?: never
responses: {
- /** @description Cost estimate for replicating the publication. */
+ /** @description All publications for the source. */
200: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CostEstimateResponse']
+ 'application/json': components['schemas']['ReadPublicationsResponse_Output']
}
}
/** @description Unauthorized */
@@ -36478,7 +31554,7 @@ export interface operations {
}
content?: never
}
- /** @description Unexpected error while estimating replication cost. */
+ /** @description Unexpected error while listing publications. */
500: {
headers: {
[name: string]: unknown
@@ -36487,11 +31563,13 @@ export interface operations {
}
}
}
- ReplicationSourcesController_getTables: {
+ V2SourcesController_getPublication: {
parameters: {
query?: never
header?: never
path: {
+ /** @description Publication name */
+ publication_name: string
/** @description Project ref */
ref: string
/** @description Source id */
@@ -36501,13 +31579,13 @@ export interface operations {
}
requestBody?: never
responses: {
- /** @description All tables for the source. */
+ /** @description The publication. */
200: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ReplicationTablesResponse']
+ 'application/json': components['schemas']['PublicationDetailsResponse_Output']
}
}
/** @description Unauthorized */
@@ -36524,6 +31602,13 @@ export interface operations {
}
content?: never
}
+ /** @description Source or publication not found. */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Rate limit exceeded */
429: {
headers: {
@@ -36531,7 +31616,7 @@ export interface operations {
}
content?: never
}
- /** @description Unexpected error while listing tables. */
+ /** @description Unexpected error while reading publication. */
500: {
headers: {
[name: string]: unknown
@@ -36540,24 +31625,43 @@ export interface operations {
}
}
}
- ReplicationTenantsController_deleteTenant: {
+ V2SourcesController_putPublication: {
parameters: {
query?: never
header?: never
path: {
+ /** @description Publication name */
+ publication_name: string
/** @description Project ref */
ref: string
+ /** @description Source id */
+ source_id: number
}
cookie?: never
}
- requestBody?: never
+ requestBody: {
+ content: {
+ 'application/json': components['schemas']['PutPublicationBody']
+ }
+ }
responses: {
- /** @description Tenant deleted. */
+ /** @description The publication after applying the configuration. */
200: {
headers: {
[name: string]: unknown
}
- content?: never
+ content: {
+ 'application/json': components['schemas']['PublicationDetailsResponse_Output']
+ }
+ }
+ /** @description Publication created. */
+ 201: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['PublicationDetailsResponse_Output']
+ }
}
/** @description Unauthorized */
401: {
@@ -36582,15 +31686,70 @@ export interface operations {
}
content?: never
}
- /** @description Tenant not found. */
- 404: {
+ /** @description Rate limit exceeded */
+ 429: {
headers: {
[name: string]: unknown
}
content?: never
}
- /** @description Tenant has active pipelines. */
- 409: {
+ /** @description Unexpected error while writing publication. */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ }
+ }
+ V2SourcesController_deletePublication: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Publication name */
+ publication_name: string
+ /** @description Project ref */
+ ref: string
+ /** @description Source id */
+ source_id: number
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Publication absent after the request. */
+ 204: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
+ 402: {
+ headers: {
+ [name: string]: unknown
+ }
+ content: {
+ 'application/json': components['schemas']['PlanGateErrorBody']
+ }
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Source or publication not found. */
+ 404: {
headers: {
[name: string]: unknown
}
@@ -36603,7 +31762,7 @@ export interface operations {
}
content?: never
}
- /** @description Unexpected error while deleting tenant. */
+ /** @description Unexpected error while deleting publication. */
500: {
headers: {
[name: string]: unknown
@@ -36612,25 +31771,30 @@ export interface operations {
}
}
}
- ReplicationTenantsSourcesController_createTenantSource: {
+ V2SourcesController_getTables: {
parameters: {
- query?: never
+ query?: {
+ /** @description Restrict results to this schema */
+ schema?: string
+ }
header?: never
path: {
/** @description Project ref */
ref: string
+ /** @description Source id */
+ source_id: number
}
cookie?: never
}
requestBody?: never
responses: {
- /** @description Tenant and source created. */
+ /** @description All tables for the source. */
200: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateTenantSourceResponse']
+ 'application/json': components['schemas']['ReadTablesResponse_Output']
}
}
/** @description Unauthorized */
@@ -36640,14 +31804,60 @@ export interface operations {
}
content?: never
}
- /** @description This feature requires the Pro, Team, or Enterprise organization plan. */
- 402: {
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unexpected error while listing tables. */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ }
+ }
+ V2SourcesController_getTableColumns: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Project ref */
+ ref: string
+ /** @description Source id */
+ source_id: number
+ /** @description Table id (Postgres OID) */
+ table_id: number
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description All columns for the table. */
+ 200: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PlanGateErrorBody']
+ 'application/json': components['schemas']['ReadColumnsResponse_Output']
+ }
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
}
+ content?: never
}
/** @description Forbidden action */
403: {
@@ -36656,6 +31866,13 @@ export interface operations {
}
content?: never
}
+ /** @description Source or table not found. */
+ 404: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
/** @description Rate limit exceeded */
429: {
headers: {
@@ -36663,7 +31880,7 @@ export interface operations {
}
content?: never
}
- /** @description Unexpected error while creating tenant or source. */
+ /** @description Unexpected error while listing columns. */
500: {
headers: {
[name: string]: unknown
@@ -36766,7 +31983,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageAnalyticsBucketsResponse']
+ 'application/json': components['schemas']['StorageAnalyticsBucketsResponse_Output']
}
}
/** @description Unauthorized */
@@ -36820,7 +32037,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageAnalyticsBucketResponse']
+ 'application/json': components['schemas']['StorageAnalyticsBucketResponse_Output']
}
}
/** @description Unauthorized */
@@ -36872,7 +32089,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageAnalyticsBucketDeleteResponse']
+ 'application/json': components['schemas']['StorageAnalyticsBucketDeleteResponse_Output']
}
}
/** @description Unauthorized */
@@ -36924,7 +32141,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['NamespacesResponse']
+ 'application/json': components['schemas']['NamespacesResponse_Output']
}
}
/** @description Unauthorized */
@@ -37082,7 +32299,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageAnalyticsBucketNamespaceTablesResponse']
+ 'application/json': components['schemas']['StorageAnalyticsBucketNamespaceTablesResponse_Output']
}
}
/** @description Unauthorized */
@@ -37139,7 +32356,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['NamespaceTableResponse']
+ 'application/json': components['schemas']['NamespaceTableResponse_Output']
}
}
/** @description Unauthorized */
@@ -37248,7 +32465,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetArchiveResponse']
+ 'application/json': components['schemas']['GetArchiveResponse_Output']
}
}
/** @description Unauthorized */
@@ -37352,7 +32569,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageBucketResponse'][]
+ 'application/json': components['schemas']['StorageBucketResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -37456,7 +32673,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageBucketResponse']
+ 'application/json': components['schemas']['StorageBucketResponse_Output']
}
}
/** @description Unauthorized */
@@ -37720,7 +32937,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CopyObjectResponse']
+ 'application/json': components['schemas']['CopyObjectResponse_Output']
}
}
/** @description Unauthorized */
@@ -37776,7 +32993,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageObject'][]
+ 'application/json': components['schemas']['StorageObject_Output'][]
}
}
/** @description Unauthorized */
@@ -37832,7 +33049,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageListResponseV2']
+ 'application/json': components['schemas']['StorageListResponseV2_Output']
}
}
/** @description Unauthorized */
@@ -37942,7 +33159,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['PublicUrlResponse']
+ 'application/json': components['schemas']['PublicUrlResponse_Output']
}
}
/** @description Unauthorized */
@@ -37998,7 +33215,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SignedUrlResponse']
+ 'application/json': components['schemas']['SignedUrlResponse_Output']
}
}
/** @description Unauthorized */
@@ -38054,7 +33271,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['SignedUrlsResponse'][]
+ 'application/json': components['schemas']['SignedUrlsResponse_Output'][]
}
}
/** @description Unauthorized */
@@ -38226,7 +33443,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['GetStorageCredentialsResponse']
+ 'application/json': components['schemas']['GetStorageCredentialsResponse_Output']
}
}
/** @description Unauthorized */
@@ -38280,7 +33497,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['CreateStorageCredentialResponse']
+ 'application/json': components['schemas']['CreateStorageCredentialResponse_Output']
}
}
/** @description Unauthorized */
@@ -38382,7 +33599,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageVectorBucketsResponse']
+ 'application/json': components['schemas']['StorageVectorBucketsResponse_Output']
}
}
/** @description Unauthorized */
@@ -38485,7 +33702,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageVectorBucketResponse']
+ 'application/json': components['schemas']['StorageVectorBucketResponse_Output']
}
}
/** @description Unauthorized */
@@ -38585,7 +33802,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['StorageVectorBucketListIndexesResponse']
+ 'application/json': components['schemas']['StorageVectorBucketListIndexesResponse_Output']
}
}
/** @description Unauthorized */
@@ -38737,7 +33954,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['OverdueInvoiceCount'][]
+ 'application/json': components['schemas']['OverdueInvoiceCount_Output'][]
}
}
}
@@ -38758,7 +33975,7 @@ export interface operations {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['AccountRequestDetailsDto']
+ 'application/json': components['schemas']['AccountRequestDetailsDto_Output']
}
}
}
@@ -38774,12 +33991,12 @@ export interface operations {
}
requestBody?: never
responses: {
- 200: {
+ 201: {
headers: {
[name: string]: unknown
}
content: {
- 'application/json': components['schemas']['ConfirmResponseDto']
+ 'application/json': components['schemas']['ConfirmResponseDto_Output']
}
}
}
diff --git a/packages/common/telemetry-constants.ts b/packages/common/telemetry-constants.ts
index 3517f0eb28e..171040bd626 100644
--- a/packages/common/telemetry-constants.ts
+++ b/packages/common/telemetry-constants.ts
@@ -2956,7 +2956,7 @@ export interface AuditLogDrainRemovedEvent {
}
type AdvisorCategory =
- components['schemas']['GetProjectLintsResponse'][number]['categories'][number]
+ components['schemas']['GetProjectLintsResponse_Output'][number]['categories'][number]
type AdvisorLevel = 'ERROR' | 'WARN' | 'INFO'
/**
diff --git a/packages/ui-patterns/src/ComputeBadge/index.tsx b/packages/ui-patterns/src/ComputeBadge/index.tsx
index 43d673c5cb3..71cdda04a7a 100644
--- a/packages/ui-patterns/src/ComputeBadge/index.tsx
+++ b/packages/ui-patterns/src/ComputeBadge/index.tsx
@@ -4,7 +4,7 @@ import { cn } from 'ui'
interface ComputeBadgeProps extends HTMLAttributes<HTMLDivElement> {
infraComputeSize:
- | components['schemas']['ProjectDetailResponse']['infra_compute_size']
+ | components['schemas']['ProjectDetailResponse_Output']['infra_compute_size']
| '>16XL'
| undefined
icon?: ReactNode