Resource methods
Complete TypeScript and Python SDK method map for the public Combined API.
Every public REST operation has a matching SDK method. TypeScript names are shown first; Python uses the snake-case name in the last column.
Accounts and catalogue
| REST operation | TypeScript | Python |
|---|---|---|
GET /v1/accounts | accounts.list(options?) | accounts.list(options=...) |
GET /v1/catalog | catalog.list(accountId, options?) | catalog.list(account_id, options=...) |
GET /v1/connector-definitions | connectorDefinitions.list(support?, options?) | connector_definitions.list(support=..., options=...) |
support is ready, preview, or planned. The catalogue returns granted Sources, logical dataset names, fields, types, classifications, and freshness used to compose SQL.
Sources
| REST operation | TypeScript | Python |
|---|---|---|
GET /v1/sources | sources.list(accountId, input?, options?) | sources.list(account_id, cursor=..., limit=..., query=..., options=...) |
GET /v1/sources/{sourceId} | sources.retrieve(accountId, sourceId, options?) | sources.retrieve(account_id, source_id, options=...) |
POST /v1/sources/{sourceId}/run | sources.run(accountId, sourceId, trigger?, options?) | sources.run(account_id, source_id, trigger=..., options=...) |
POST /v1/sources/{sourceId}/pause | sources.pause(accountId, sourceId, options?) | sources.pause(account_id, source_id, options=...) |
POST /v1/sources/{sourceId}/resume | sources.resume(accountId, sourceId, options?) | sources.resume(account_id, source_id, options=...) |
POST /v1/sources/{sourceId}/authorization-requests | sources.requestAuthorization(accountId, sourceId, email, scopes?, options?) | sources.request_authorization(account_id, source_id, email, requested_scopes=..., options=...) |
DELETE /v1/sources/{sourceId} | sources.delete(accountId, sourceId, confirmation, options?) | sources.delete(account_id, source_id, confirmation, options=...) |
List input supports opaque cursor, limit, and a case-insensitive query. Run triggers are manual, first_sync, retry, or recovery; normal callers should use manual. Pause stops scheduled ingestion without deleting the Source. Delete queues the governed deletion workflow and requires the confirmation text shown by the product.
Authorization and schema review
| REST operation | TypeScript | Python |
|---|---|---|
POST /v1/source-authorization-requests | sourceAuthorizationRequests.create(accountId, connectorKey, email, options?) | source_authorization_requests.create(account_id, connector_key, email, options=...) |
GET /v1/source-authorization-requests/{requestId} | sourceAuthorizationRequests.retrieve(accountId, requestId, options?) | source_authorization_requests.retrieve(account_id, request_id, options=...) |
POST /v1/schema-reviews/{reviewId} | schemaReviews.decide(accountId, reviewId, decision, reason, options?) | schema_reviews.decide(account_id, review_id, decision, reason, options=...) |
Schema decisions are accepted or rejected. Record a concise reason because the decision is retained as operational evidence.
SQL and receipts
| REST operation | TypeScript | Python |
|---|---|---|
POST /v1/sql | sql.query(input, options?) | sql.query(account_id, sql, parameters=..., max_rows=..., options=...) |
GET /v1/query-receipts/{receiptId} | queryReceipts.retrieve(accountId, receiptId, options?) | query_receipts.retrieve(account_id, receipt_id, options=...) |
SQL defaults parameters to an empty list and maxRows/max_rows to 1,000 in the SDKs. A query result includes receiptId, columns, rows, row count, truncation, duration, estimated input bytes when available, and the evaluated grant version. Receipts contain audit metadata and hashes, not result content.
Grants
| REST operation | TypeScript | Python |
|---|---|---|
GET /v1/grants | grants.list(accountId, principalId?, options?) | grants.list(account_id, principal_id=..., options=...) |
POST /v1/grants | grants.create(input, options?) | grants.create(account_id, principal_id, source_id, permission=..., dataset_ids=..., expires_at=..., max_rows=..., max_bytes=..., max_queries_per_minute=..., options=...) |
DELETE /v1/grants/{grantId} | grants.revoke(accountId, grantId, options?) | grants.revoke(account_id, grant_id, options=...) |
Grant defaults are permission query, all datasets when datasetIds is empty, no expiry, 1,000 rows, 268,435,456 bytes, and 60 queries per minute. Set tighter limits when the principal does not require those maxima.
Activity
| REST operation | TypeScript | Python |
|---|---|---|
GET /v1/activity | activity.list(accountId, input?, options?) | activity.list(account_id, cursor=..., limit=..., family=..., source_id=..., query=..., from_time=..., to_time=..., options=...) |
GET /v1/activity/{eventId} | activity.retrieve(accountId, eventId, options?) | activity.retrieve(account_id, event_id, options=...) |
Activity filters include family, Source, text, and ISO 8601 from/to bounds. Events and detail are content-free operational evidence; they can link runs, deliveries, and a query receipt without exposing the underlying returned rows.
Request options and return envelopes
TypeScript RequestOptions supports signal and idempotencyKey; Python RequestOptions supports idempotency_key. Resource methods unwrap ordinary { data, correlationId } envelopes. TypeScript page results expose data, page.nextCursor, page.hasMore, and correlationId; Python returns a Page dataclass with data, next_cursor, has_more, and correlation_id.