@fusebase/fusebase-gate-sdk 2.2.2-sdk.19 → 2.2.2-sdk.20

package/dist/apis/IsolatedStoresApi.d.ts

@@ -0,0 +1,372 @@
+/**
+ * IsolatedStores API
+ *
+ * Generated from contract introspection
+ * Domain: isolated-stores
+ */
+import type { Client } from "../runtime/transport";
+import type { CountIsolatedStoreNoSqlDocumentsRequestContract, CountIsolatedStoreNoSqlDocumentsResponseContract, CreateIsolatedStoreCheckpointRequestContract, CreateIsolatedStoreCheckpointResponseContract, CreateIsolatedStoreNoSqlCollectionRequestContract, CreateIsolatedStoreNoSqlCollectionResponseContract, CreateIsolatedStoreRequestContract, CreateIsolatedStoreResponseContract, DeleteIsolatedStoreNoSqlDocumentResponseContract, DeleteIsolatedStoreStageResponseContract, ImportIsolatedStoreNoSqlDocumentsRequestContract, ImportIsolatedStoreNoSqlDocumentsResponseContract, InitIsolatedStoreStageRequestContract, InitIsolatedStoreStageResponseContract, IsolatedStoreIdInPathRequired, IsolatedStoreListResponseContract, IsolatedStoreNoSqlCollectionNameInPathRequired, IsolatedStoreNoSqlDocumentIdInPathRequired, IsolatedStoreNoSqlDocumentResponseContract, IsolatedStoreNoSqlListCollectionsResponseContract, IsolatedStoreResponseContract, IsolatedStoreRevisionIdInPathRequired, IsolatedStoreRevisionListResponseContract, IsolatedStoreSqlBatchInsertRequestContract, IsolatedStoreSqlBatchInsertResponseContract, IsolatedStoreSqlCountRequestContract, IsolatedStoreSqlCountResponseContract, IsolatedStoreSqlDeleteRequestContract, IsolatedStoreSqlDeleteResponseContract, IsolatedStoreSqlDescribeTableResponseContract, IsolatedStoreSqlExecuteRequestContract, IsolatedStoreSqlExecuteResponseContract, IsolatedStoreSqlImportRequestContract, IsolatedStoreSqlImportResponseContract, IsolatedStoreSqlInsertRequestContract, IsolatedStoreSqlInsertResponseContract, IsolatedStoreSqlListTablesResponseContract, IsolatedStoreSqlQueryRequestContract, IsolatedStoreSqlQueryResponseContract, IsolatedStoreSqlSchemaNameInQueryOptional, IsolatedStoreSqlSelectRequestContract, IsolatedStoreSqlSelectResponseContract, IsolatedStoreSqlTableNameInPathRequired, IsolatedStoreSqlUpdateRequestContract, IsolatedStoreSqlUpdateResponseContract, IsolatedStoreStageInPathRequired, IsolatedStoreStageListResponseContract, orgIdInPathRequired, PutIsolatedStoreNoSqlDocumentRequestContract, PutIsolatedStoreNoSqlDocumentResponseContract, QueryIsolatedStoreNoSqlDocumentsRequestContract, QueryIsolatedStoreNoSqlDocumentsResponseContract, RestoreIsolatedStoreRevisionResponseContract } from "../types";
+export declare class IsolatedStoresApi {
+    private client;
+    constructor(client: Client);
+    /**
+     * Batch insert rows
+     * Inserts multiple rows into a postgres table with a shared column set. Row cap per request is floor(65535 / columnCount) (Postgres bind-parameter limit). For very large loads use importIsolatedStoreSqlRows (COPY FROM STDIN).
+     */
+    batchInsertIsolatedStoreSqlRows(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: IsolatedStoreSqlBatchInsertRequestContract;
+    }): Promise<IsolatedStoreSqlBatchInsertResponseContract>;
+    /**
+     * Count isolated store NoSQL documents
+     * Counts documents in a nosql/mongodb_atlas isolated store stage using the same portable filter operators as query: eq, ne, gt, gte, lt, lte, in, and exists.
+     */
+    countIsolatedStoreNoSqlDocuments(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: CountIsolatedStoreNoSqlDocumentsRequestContract;
+    }): Promise<CountIsolatedStoreNoSqlDocumentsResponseContract>;
+    /**
+     * Count rows
+     * Counts rows in a postgres table using simple structured filters. Useful for pagination without writing raw SQL.
+     */
+    countIsolatedStoreSqlRows(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: IsolatedStoreSqlCountRequestContract;
+    }): Promise<IsolatedStoreSqlCountResponseContract>;
+    /**
+     * Create isolated store
+     * Registers a low-level store and binds it to the organization scope plus a isolated source scope such as app or app_feature.
+     */
+    createIsolatedStore(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: CreateIsolatedStoreRequestContract;
+    }): Promise<CreateIsolatedStoreResponseContract>;
+    /**
+     * Create isolated store checkpoint
+     * Creates a new revision marker for the selected stage instance. For sql/postgres stages, gate also creates a physical pg_dump snapshot; for nosql/mongodb_atlas stages, gate creates a physical mongodump archive. The resulting file URL is stored in snapshotRef; a caller-provided snapshotRef is preserved in revision metadata as an external reference.
+     */
+    createIsolatedStoreCheckpoint(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: CreateIsolatedStoreCheckpointRequestContract;
+    }): Promise<CreateIsolatedStoreCheckpointResponseContract>;
+    /**
+     * Create isolated store NoSQL collection
+     * Creates a collection for a nosql/mongodb_atlas isolated store stage. Collection names use safe identifiers with letters, numbers, and underscores.
+     */
+    createIsolatedStoreNoSqlCollection(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: CreateIsolatedStoreNoSqlCollectionRequestContract;
+    }): Promise<CreateIsolatedStoreNoSqlCollectionResponseContract>;
+    /**
+     * Delete isolated store NoSQL document
+     * Deletes a document by `_id` from a nosql/mongodb_atlas isolated store stage.
+     */
+    deleteIsolatedStoreNoSqlDocument(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+            collectionName: IsolatedStoreNoSqlCollectionNameInPathRequired;
+            documentId: IsolatedStoreNoSqlDocumentIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DeleteIsolatedStoreNoSqlDocumentResponseContract>;
+    /**
+     * Delete rows
+     * Deletes rows from a postgres table using structured filters. Filterless deletes are blocked unless allowAll=true is explicitly set.
+     */
+    deleteIsolatedStoreSqlRows(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: IsolatedStoreSqlDeleteRequestContract;
+    }): Promise<IsolatedStoreSqlDeleteResponseContract>;
+    /**
+     * Delete isolated store stage
+     * Removes the stage instance and its revisions. When the stage was auto-provisioned on the isolated Postgres or isolated Mongo server, gate also drops the provisioned database after registry rows are removed.
+     */
+    deleteIsolatedStoreStage(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<DeleteIsolatedStoreStageResponseContract>;
+    /**
+     * Describe isolated store SQL table
+     * Returns postgres column metadata for a single table in the selected isolated store stage instance.
+     */
+    describeIsolatedStoreSqlTable(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+            tableName: IsolatedStoreSqlTableNameInPathRequired;
+        };
+        query?: {
+            schemaName?: IsolatedStoreSqlSchemaNameInQueryOptional;
+        };
+        headers?: Record<string, string>;
+    }): Promise<IsolatedStoreSqlDescribeTableResponseContract>;
+    /**
+     * Run writable SQL statement
+     * Runs a single SQL statement with execute access against the postgres binding of the selected isolated store stage instance.
+     */
+    executeIsolatedStoreSql(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: IsolatedStoreSqlExecuteRequestContract;
+    }): Promise<IsolatedStoreSqlExecuteResponseContract>;
+    /**
+     * Get isolated store
+     * Returns a single isolated store by store global id within the organization scope.
+     */
+    getIsolatedStore(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<IsolatedStoreResponseContract>;
+    /**
+     * Get isolated store NoSQL document
+     * Gets a document by `_id` from a nosql/mongodb_atlas isolated store stage. The document identity comes from the `documentId` path parameter.
+     */
+    getIsolatedStoreNoSqlDocument(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+            collectionName: IsolatedStoreNoSqlCollectionNameInPathRequired;
+            documentId: IsolatedStoreNoSqlDocumentIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<IsolatedStoreNoSqlDocumentResponseContract>;
+    /**
+     * Import NDJSON documents
+     * Imports newline-delimited JSON documents into a Mongo collection. Use this bulk path for large seed or migration-style writes instead of per-document tool calls.
+     */
+    importIsolatedStoreNoSqlDocuments(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: ImportIsolatedStoreNoSqlDocumentsRequestContract;
+    }): Promise<ImportIsolatedStoreNoSqlDocumentsResponseContract>;
+    /**
+     * Import CSV or TSV rows
+     * Imports CSV or TSV payloads into a postgres table using server-side COPY FROM STDIN. Use this bulk path for large seeds or migrations instead of repeated row inserts. Max UTF-8 payload size defaults to 64MiB (override ISOLATED_SQL_IMPORT_MAX_PAYLOAD_BYTES; hard cap 256MiB); split larger files across multiple calls.
+     */
+    importIsolatedStoreSqlRows(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: IsolatedStoreSqlImportRequestContract;
+    }): Promise<IsolatedStoreSqlImportResponseContract>;
+    /**
+     * Initialize isolated store stage
+     * Creates a stage instance. For postgres and mongodb_atlas, gate can auto-provision a dedicated stage database when the corresponding isolated server is configured; otherwise an explicit bindingConfig is required.
+     */
+    initIsolatedStoreStage(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: InitIsolatedStoreStageRequestContract;
+    }): Promise<InitIsolatedStoreStageResponseContract>;
+    /**
+     * Insert row
+     * Inserts a single row into a postgres table and optionally returns selected columns.
+     */
+    insertIsolatedStoreSqlRow(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: IsolatedStoreSqlInsertRequestContract;
+    }): Promise<IsolatedStoreSqlInsertResponseContract>;
+    /**
+     * List isolated store NoSQL collections
+     * Lists collections for a nosql/mongodb_atlas isolated store stage. The same contract can be backed by a local isolated Mongo server in development.
+     */
+    listIsolatedStoreNoSqlCollections(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<IsolatedStoreNoSqlListCollectionsResponseContract>;
+    /**
+     * List isolated store revisions
+     * Returns version checkpoints for a specific isolated store stage instance.
+     */
+    listIsolatedStoreRevisions(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<IsolatedStoreRevisionListResponseContract>;
+    /**
+     * List isolated stores
+     * Returns the isolated store registry for the organization. This is a control-plane endpoint behind FEATURE_FLAGS=isolated_stores.
+     */
+    listIsolatedStores(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<IsolatedStoreListResponseContract>;
+    /**
+     * List isolated store SQL tables
+     * Returns postgres tables and views for the requested isolated store stage instance. Token access must include the matching isolated_store_stage_instance resource scope.
+     */
+    listIsolatedStoreSqlTables(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        query?: {
+            schemaName?: IsolatedStoreSqlSchemaNameInQueryOptional;
+        };
+        headers?: Record<string, string>;
+    }): Promise<IsolatedStoreSqlListTablesResponseContract>;
+    /**
+     * List isolated store stages
+     * Returns stage instances for the selected isolated store. MVP uses separate stage instances for dev and prod.
+     */
+    listIsolatedStoreStages(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<IsolatedStoreStageListResponseContract>;
+    /**
+     * Put isolated store NoSQL document
+     * Upserts a document by `_id` into a nosql/mongodb_atlas isolated store stage. The `documentId` path parameter is the source of truth for `_id` and overrides any `_id` inside the body document.
+     */
+    putIsolatedStoreNoSqlDocument(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+            collectionName: IsolatedStoreNoSqlCollectionNameInPathRequired;
+            documentId: IsolatedStoreNoSqlDocumentIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: PutIsolatedStoreNoSqlDocumentRequestContract;
+    }): Promise<PutIsolatedStoreNoSqlDocumentResponseContract>;
+    /**
+     * Query isolated store NoSQL documents
+     * Queries documents from a nosql/mongodb_atlas isolated store stage using portable filters, sort and pagination. Supported operators are eq, ne, gt, gte, lt, lte, in, and exists. Default limit is 100, max limit is 500, max filters is 20, and max sort fields is 5.
+     */
+    queryIsolatedStoreNoSqlDocuments(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: QueryIsolatedStoreNoSqlDocumentsRequestContract;
+    }): Promise<QueryIsolatedStoreNoSqlDocumentsResponseContract>;
+    /**
+     * Run read-only SQL query
+     * Runs a single read-only SQL statement against the postgres binding of the selected isolated store stage instance.
+     */
+    queryIsolatedStoreSql(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: IsolatedStoreSqlQueryRequestContract;
+    }): Promise<IsolatedStoreSqlQueryResponseContract>;
+    /**
+     * Restore isolated store revision
+     * Restores a sql/postgres or nosql/mongodb_atlas stage from a previously created physical file snapshot. For auto-provisioned dedicated stage databases, gate recreates or clears the target database before running pg_restore or mongorestore. Only file:// snapshotRef values are restorable in MVP.
+     */
+    restoreIsolatedStoreRevision(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+            revisionId: IsolatedStoreRevisionIdInPathRequired;
+        };
+        headers?: Record<string, string>;
+    }): Promise<RestoreIsolatedStoreRevisionResponseContract>;
+    /**
+     * Select rows
+     * Reads rows from a postgres table using simple filters, sort, limit and offset. This is the primary low-overhead runtime read surface.
+     */
+    selectIsolatedStoreSqlRows(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: IsolatedStoreSqlSelectRequestContract;
+    }): Promise<IsolatedStoreSqlSelectResponseContract>;
+    /**
+     * Update rows
+     * Updates rows in a postgres table using structured filters. Filterless updates are blocked unless allowAll=true is explicitly set.
+     */
+    updateIsolatedStoreSqlRows(params: {
+        path: {
+            orgId: orgIdInPathRequired;
+            storeId: IsolatedStoreIdInPathRequired;
+            stage: IsolatedStoreStageInPathRequired;
+        };
+        headers?: Record<string, string>;
+        body: IsolatedStoreSqlUpdateRequestContract;
+    }): Promise<IsolatedStoreSqlUpdateResponseContract>;
+}