@elevasis/sdk 0.7.11 → 0.7.12

package/reference/platform-tools/adapters.mdx

@@ -1,907 +0,0 @@
----
-title: Typed Adapters
-description: Type-safe wrappers over platform.call() for all integrations and platform tools -- Attio, Stripe, Notion, Google Sheets, and more -- with full autocomplete, compile-time checking, and zero boilerplate
-loadWhen: "Using typed adapters instead of raw platform.call(), or needs to know what adapter methods are available"
----
-
-Typed adapters are ergonomic wrappers over `platform.call()` that provide full TypeScript autocomplete and compile-time type checking. They eliminate stringly-typed method names, manual `as Promise<T>` casts, and repeated credential passing.
-
-Both patterns work simultaneously -- adapters compile down to `platform.call()` with zero runtime overhead.
-
-**Coverage:** 12 integration adapters (58 methods) + 9 platform tool adapters (57 methods) = 115 total typed methods.
-
-```typescript
-// Before: raw platform.call()
-const records = await platform.call({
-  tool: 'attio',
-  method: 'listRecords',
-  credential: 'my-attio',
-  params: { object: 'deals' }
-}) as unknown as QueryRecordsResult
-
-// After: typed adapter
-const attio = createAttioAdapter('my-attio')
-const records = await attio.listRecords({ object: 'deals' })
-//    ^-- QueryRecordsResult (fully typed, autocomplete on params)
-```
-
-All adapters are imported from `@elevasis/sdk/worker` -- the same subpath as `platform`.
-
----
-
-## Quick Reference
-
-### Integration Adapters (factory pattern, credential required)
-
-| Import                            | Methods |
-| --------------------------------- | ------- |
-| `createAttioAdapter(cred)`        | 12      |
-| `createStripeAdapter(cred)`       | 6       |
-| `createNotionAdapter(cred)`       | 8       |
-| `createGoogleSheetsAdapter(cred)` | 13      |
-| `createInstantlyAdapter(cred)`    | 5       |
-| `createSignatureApiAdapter(cred)` | 4       |
-| `createResendAdapter(cred)`       | 2       |
-| `createDropboxAdapter(cred)`      | 2       |
-| `createApifyAdapter(cred)`        | 1       |
-| `createGmailAdapter(cred)`        | 1       |
-| `createMailsoAdapter(cred)`       | 1       |
-| `createTombaAdapter(cred)`        | 3       |
-
-### Platform Adapters (singletons, no credential)
-
-| Import          | Methods |
-| --------------- | ------- |
-| `acqDb`         | 35      |
-| `scheduler`     | 9       |
-| `storage`       | 5       |
-| `pdf`           | 2       |
-| `approval`      | 2       |
-| `notifications` | 1       |
-| `llm`           | 1       |
-| `execution`     | 1       |
-| `email`         | 1       |
-
-### Generic Factory
-
-| Import                                        | Description                        |
-| --------------------------------------------- | ---------------------------------- |
-| `createAdapter<TMap>(tool, methods, cred?)` | Build custom adapters for any tool |
-
-```typescript
-import {
-  // Integration adapters
-  createAttioAdapter, createStripeAdapter, createNotionAdapter,
-  createGoogleSheetsAdapter, createInstantlyAdapter,
-  createSignatureApiAdapter, createResendAdapter, createDropboxAdapter,
-  createApifyAdapter, createGmailAdapter, createMailsoAdapter,
-  createTombaAdapter,
-  // Platform adapters
-  acqDb, scheduler, storage, pdf, approval, notifications, llm, execution, email,
-  // Generic factory
-  createAdapter,
-} from '@elevasis/sdk/worker'
-```
-
----
-
-## Attio CRM Adapter
-
-Factory pattern -- bind a credential once, use 12 typed methods.
-
-```typescript
-const attio = createAttioAdapter('my-attio-credential')
-```
-
-### Methods
-
-| Method            | Params                  | Returns                 |
-| ----------------- | ----------------------- | ----------------------- |
-| `createRecord`    | `CreateRecordParams`    | `CreateRecordResult`    |
-| `updateRecord`    | `UpdateRecordParams`    | `UpdateRecordResult`    |
-| `listRecords`     | `QueryRecordsParams`    | `QueryRecordsResult`    |
-| `getRecord`       | `GetRecordParams`       | `GetRecordResult`       |
-| `deleteRecord`    | `DeleteRecordParams`    | `DeleteRecordResult`    |
-| `listObjects`     | none                    | `ListObjectsResult`     |
-| `listAttributes`  | `ListAttributesParams`  | `ListAttributesResult`  |
-| `createAttribute` | `CreateAttributeParams` | `CreateAttributeResult` |
-| `updateAttribute` | `UpdateAttributeParams` | `UpdateAttributeResult` |
-| `createNote`      | `CreateNoteParams`      | `CreateNoteResult`      |
-| `listNotes`       | `ListNotesParams`       | `ListNotesResult`       |
-| `deleteNote`      | `DeleteNoteParams`      | `DeleteNoteResult`      |
-
-### Examples
-
-```typescript
-// Create a company record
-const company = await attio.createRecord({
-  object: 'companies',
-  values: {
-    name: [{ value: 'Acme Corp' }],
-    domains: [{ domain: 'acme.com' }],
-  },
-})
-
-// Query deals with filters
-const deals = await attio.listRecords({
-  object: 'deals',
-  filter: {
-    operator: 'and',
-    filters: [
-      { field: 'stage', operator: 'equals', value: 'proposal' },
-    ],
-  },
-  sorts: [{ field: 'created_at', direction: 'desc' }],
-  limit: 20,
-})
-
-// Get a specific record
-const record = await attio.getRecord({
-  object: 'people',
-  recordId: 'rec_abc123',
-})
-
-// List all objects (no params)
-const objects = await attio.listObjects()
-
-// Create a note on a record
-await attio.createNote({
-  parentObject: 'deals',
-  parentRecordId: 'rec_abc123',
-  title: 'Discovery call notes',
-  content: 'Key takeaways from the call...',
-})
-```
-
-Multiple adapters with different credentials work simultaneously:
-
-```typescript
-const prodAttio = createAttioAdapter('prod-attio')
-const testAttio = createAttioAdapter('test-attio')
-```
-
----
-
-## Stripe Adapter
-
-Factory pattern -- 6 methods for payment links and checkout sessions.
-
-```typescript
-const stripe = createStripeAdapter('my-stripe-credential')
-```
-
-### Methods
-
-| Method                  | Params                        | Returns                       |
-| ----------------------- | ----------------------------- | ----------------------------- |
-| `createPaymentLink`     | `CreatePaymentLinkParams`     | `CreatePaymentLinkResult`     |
-| `getPaymentLink`        | `GetPaymentLinkParams`        | `GetPaymentLinkResult`        |
-| `updatePaymentLink`     | `UpdatePaymentLinkParams`     | `UpdatePaymentLinkResult`     |
-| `listPaymentLinks`      | `ListPaymentLinksParams`      | `ListPaymentLinksResult`      |
-| `createAutoPaymentLink` | `CreateAutoPaymentLinkParams` | `CreateAutoPaymentLinkResult` |
-| `createCheckoutSession` | `CreateCheckoutSessionParams` | `CreateCheckoutSessionResult` |
-
----
-
-## Notion Adapter
-
-Factory pattern -- 8 methods for page and block operations.
-
-```typescript
-const notion = createNotionAdapter('my-notion-credential')
-```
-
-### Methods
-
-| Method            | Params                  | Returns                 |
-| ----------------- | ----------------------- | ----------------------- |
-| `listAllPages`    | none                    | `ListAllPagesResult`    |
-| `readPage`        | `ReadPageParams`        | `ReadPageResult`        |
-| `createPage`      | `CreatePageParams`      | `CreatePageResult`      |
-| `updatePageTitle` | `UpdatePageTitleParams` | `UpdatePageTitleResult` |
-| `appendBlocks`    | `AppendBlocksParams`    | `AppendBlocksResult`    |
-| `updateBlocks`    | `UpdateBlocksParams`    | `UpdateBlocksResult`    |
-| `deletePage`      | `DeletePageParams`      | `DeletePageResult`      |
-| `deleteBlocks`    | `DeleteBlocksParams`    | `DeleteBlocksResult`    |
-
----
-
-## Google Sheets Adapter
-
-Factory pattern -- 13 methods including workflow-friendly helpers (getRowByValue, upsertRow, filterRows).
-
-```typescript
-const sheets = createGoogleSheetsAdapter('my-google-credential')
-```
-
-### Methods
-
-| Method                   | Params                         | Returns                        |
-| ------------------------ | ------------------------------ | ------------------------------ |
-| `readSheet`              | `ReadSheetParams`              | `ReadSheetResult`              |
-| `writeSheet`             | `WriteSheetParams`             | `WriteSheetResult`             |
-| `appendRows`             | `AppendRowsParams`             | `AppendRowsResult`             |
-| `clearRange`             | `ClearRangeParams`             | `ClearRangeResult`             |
-| `getSpreadsheetMetadata` | `GetSpreadsheetMetadataParams` | `GetSpreadsheetMetadataResult` |
-| `batchUpdate`            | `BatchUpdateParams`            | `BatchUpdateResult`            |
-| `getHeaders`             | `GetHeadersParams`             | `GetHeadersResult`             |
-| `getLastRow`             | `GetLastRowParams`             | `GetLastRowResult`             |
-| `getRowByValue`          | `GetRowByValueParams`          | `GetRowByValueResult`          |
-| `updateRowByValue`       | `UpdateRowByValueParams`       | `UpdateRowByValueResult`       |
-| `upsertRow`              | `UpsertRowParams`              | `UpsertRowResult`              |
-| `filterRows`             | `FilterRowsParams`             | `FilterRowsResult`             |
-| `deleteRowByValue`       | `DeleteRowByValueParams`       | `DeleteRowByValueResult`       |
-
----
-
-## Instantly Adapter
-
-Factory pattern -- 5 methods for email campaign management.
-
-```typescript
-const instantly = createInstantlyAdapter('my-instantly-credential')
-```
-
-### Methods
-
-| Method                  | Params                        | Returns                       |
-| ----------------------- | ----------------------------- | ----------------------------- |
-| `sendReply`             | `SendReplyParams`             | `SendReplyResult`             |
-| `removeFromSubsequence` | `RemoveFromSubsequenceParams` | `RemoveFromSubsequenceResult` |
-| `getEmails`             | `GetEmailsParams`             | `GetEmailsResult`             |
-| `updateInterestStatus`  | `UpdateInterestStatusParams`  | `UpdateInterestStatusResult`  |
-| `addToCampaign`         | `AddToCampaignParams`         | `AddToCampaignResult`         |
-
----
-
-## SignatureAPI Adapter
-
-Factory pattern -- 4 methods for eSignature envelope operations.
-
-```typescript
-const signatureApi = createSignatureApiAdapter('my-signatureapi-credential')
-```
-
-### Methods
-
-| Method             | Params                   | Returns                  |
-| ------------------ | ------------------------ | ------------------------ |
-| `createEnvelope`   | `CreateEnvelopeParams`   | `CreateEnvelopeResult`   |
-| `voidEnvelope`     | `VoidEnvelopeParams`     | `VoidEnvelopeResult`     |
-| `downloadDocument` | `DownloadDocumentParams` | `DownloadDocumentResult` |
-| `getEnvelope`      | `GetEnvelopeParams`      | `GetEnvelopeResult`      |
-
----
-
-## Resend Adapter
-
-Factory pattern -- 2 methods for transactional email.
-
-```typescript
-const resend = createResendAdapter('my-resend-credential')
-```
-
-### Methods
-
-| Method      | Params                  | Returns                 |
-| ----------- | ----------------------- | ----------------------- |
-| `sendEmail` | `ResendSendEmailParams` | `ResendSendEmailResult` |
-| `getEmail`  | `ResendGetEmailParams`  | `ResendGetEmailResult`  |
-
----
-
-## Dropbox Adapter
-
-Factory pattern -- 2 methods for file operations.
-
-```typescript
-const dropbox = createDropboxAdapter('my-dropbox-credential')
-```
-
-### Methods
-
-| Method         | Params               | Returns              |
-| -------------- | -------------------- | -------------------- |
-| `uploadFile`   | `UploadFileParams`   | `UploadFileResult`   |
-| `createFolder` | `CreateFolderParams` | `CreateFolderResult` |
-
----
-
-## Apify Adapter
-
-Factory pattern -- 1 method for running web scraping actors.
-
-```typescript
-const apify = createApifyAdapter('my-apify-credential')
-```
-
-### Methods
-
-| Method     | Params           | Returns          |
-| ---------- | ---------------- | ---------------- |
-| `runActor` | `RunActorParams` | `RunActorResult` |
-
----
-
-## Gmail Adapter
-
-Factory pattern -- 1 method for sending email via Gmail API.
-
-```typescript
-const gmail = createGmailAdapter('my-gmail-credential')
-```
-
-### Methods
-
-| Method      | Params                 | Returns                |
-| ----------- | ---------------------- | ---------------------- |
-| `sendEmail` | `GmailSendEmailParams` | `GmailSendEmailResult` |
-
----
-
-## Mailso Adapter
-
-Factory pattern -- 1 method for email verification.
-
-```typescript
-const mailso = createMailsoAdapter('my-mailso-credential')
-```
-
-### Methods
-
-| Method        | Params                    | Returns                   |
-| ------------- | ------------------------- | ------------------------- |
-| `verifyEmail` | `MailsoVerifyEmailParams` | `MailsoVerifyEmailResult` |
-
----
-
-## Tomba Adapter
-
-Factory pattern -- 3 methods for email discovery and verification.
-
-```typescript
-const tomba = createTombaAdapter('elevasis-tomba')
-```
-
-**Credential type:** `api-key-secret` (requires both API Key and API Secret)
-
-### Methods
-
-| Method          | Params                     | Returns                    |
-| --------------- | -------------------------- | -------------------------- |
-| `emailFinder`   | `TombaEmailFinderParams`   | `TombaEmailFinderResult`   |
-| `domainSearch`  | `TombaDomainSearchParams`  | `TombaDomainSearchResult`  |
-| `emailVerifier` | `TombaEmailVerifierParams` | `TombaEmailVerifierResult` |
-
-### Examples
-
-```typescript
-// Find email by name + domain
-const found = await tomba.emailFinder({
-  domain: 'stripe.com',
-  firstName: 'John',
-  lastName: 'Doe',
-})
-
-// List all emails at a domain (up to 10)
-const results = await tomba.domainSearch({ domain: 'stripe.com' })
-
-// Verify a known email address
-const verified = await tomba.emailVerifier({ email: 'john@stripe.com' })
-```
-
----
-
-## Scheduler Adapter
-
-Singleton -- 9 methods for task schedule management.
-
-```typescript
-import { scheduler } from '@elevasis/sdk/worker'
-```
-
-### Methods
-
-| Method                           | Params                         | Returns                |
-| -------------------------------- | ------------------------------ | ---------------------- |
-| `createSchedule`                 | `CreateScheduleInput`          | `TaskSchedule`         |
-| `updateAnchor`                   | `{ scheduleId, anchorAt }`     | `TaskSchedule`         |
-| `deleteSchedule`                 | `{ scheduleId }`               | `void`                 |
-| `findByIdempotencyKey`           | `{ idempotencyKey }`           | `TaskSchedule | null` |
-| `deleteScheduleByIdempotencyKey` | `{ idempotencyKey }`           | `void`                 |
-| `listSchedules`                  | `{ status?, limit?, offset? }` | `TaskSchedule[]`       |
-| `getSchedule`                    | `{ scheduleId }`               | `TaskSchedule`         |
-| `cancelSchedule`                 | `{ scheduleId }`               | `void`                 |
-| `cancelSchedulesByMetadata`      | `{ metadata }`                 | `{ cancelledCount }`   |
-
-### Examples
-
-```typescript
-// Create a relative schedule (follow-up sequence)
-const schedule = await scheduler.createSchedule({
-  organizationId: context.organizationId,
-  name: 'Proposal follow-up',
-  target: { resourceType: 'workflow', resourceId: 'send-followup' },
-  scheduleConfig: {
-    type: 'relative',
-    anchorAt: '2026-03-15T10:00:00Z',
-    anchorLabel: 'proposal_sent_date',
-    items: [
-      { offset: '+3d', payload: { step: 'first-followup' }, label: 'First follow-up' },
-      { offset: '+7d', payload: { step: 'second-followup' }, label: 'Second follow-up' },
-    ],
-  },
-  metadata: { dealId: 'deal-123', contactEmail: 'jane@acme.com' },
-  idempotencyKey: 'proposal-followup-deal-123',
-})
-
-// Reschedule (update anchor)
-await scheduler.updateAnchor({
-  scheduleId: schedule.id,
-  anchorAt: '2026-03-20T10:00:00Z',
-})
-
-// Find by idempotency key (check if already created)
-const existing = await scheduler.findByIdempotencyKey({
-  idempotencyKey: 'proposal-followup-deal-123',
-})
-
-// Cancel all schedules matching metadata
-await scheduler.cancelSchedulesByMetadata({
-  metadata: { dealId: 'deal-123' },
-})
-
-// List active schedules
-const schedules = await scheduler.listSchedules({
-  status: 'active',
-  limit: 50,
-})
-```
-
----
-
-## Storage Adapter
-
-Singleton -- 5 methods for file storage operations.
-
-```typescript
-import { storage } from '@elevasis/sdk/worker'
-```
-
-All paths are relative to the organization's storage prefix. The platform injects the organization prefix server-side.
-
-### Methods
-
-| Method            | Params                  | Returns                  |
-| ----------------- | ----------------------- | ------------------------ |
-| `upload`          | `StorageUploadInput`    | `StorageUploadOutput`    |
-| `download`        | `StorageDownloadInput`  | `StorageDownloadOutput`  |
-| `createSignedUrl` | `StorageSignedUrlInput` | `StorageSignedUrlOutput` |
-| `delete`          | `StorageDeleteInput`    | `StorageDeleteOutput`    |
-| `list`            | `StorageListInput`      | `StorageListOutput`      |
-
-### Examples
-
-```typescript
-// Upload a PDF
-await storage.upload({
-  bucket: 'acquisition',
-  path: 'proposals/deal-123/proposal.pdf',
-  content: base64PdfContent,
-  contentType: 'application/pdf',
-})
-
-// Generate a signed URL (temporary access)
-const { signedUrl } = await storage.createSignedUrl({
-  bucket: 'acquisition',
-  path: 'proposals/deal-123/proposal.pdf',
-})
-
-// Download a file
-const file = await storage.download({
-  bucket: 'acquisition',
-  path: 'proposals/deal-123/proposal.pdf',
-})
-
-// List files under a prefix
-const files = await storage.list({
-  bucket: 'acquisition',
-  path: 'proposals/deal-123/',
-})
-
-// Delete a file
-await storage.delete({
-  bucket: 'acquisition',
-  path: 'proposals/deal-123/old-proposal.pdf',
-})
-```
-
----
-
-## Notification Adapter
-
-Singleton -- 1 method for sending in-app team notifications.
-
-```typescript
-import { notifications } from '@elevasis/sdk/worker'
-```
-
-`userId` and `organizationId` are injected server-side from the execution context -- you never pass them.
-
-### Method
-
-| Method   | Params                 | Returns |
-| -------- | ---------------------- | ------- |
-| `create` | `NotificationSDKInput` | `void`  |
-
-`NotificationSDKInput` fields: `category`, `title`, `message`, `actionUrl?`, `metadata?`
-
-### Example
-
-```typescript
-await notifications.create({
-  category: 'acquisition',
-  title: 'New lead qualified',
-  message: 'Acme Corp has been qualified and moved to proposal stage.',
-  actionUrl: '/deals/deal-123',
-})
-```
-
----
-
-## LLM Adapter
-
-Singleton -- 1 method with a generic `<T>` for typed structured output.
-
-```typescript
-import { llm } from '@elevasis/sdk/worker'
-```
-
-No API keys needed -- keys are resolved server-side from environment variables.
-
-### Method
-
-| Method          | Params                                 | Returns                    |
-| --------------- | -------------------------------------- | -------------------------- |
-| `generate<T>` | `Omit<LLMGenerateRequest, 'signal'>` | `LLMGenerateResponse<T>` |
-
-The `signal` property (AbortSignal) is not serializable over the postMessage boundary. Abort is handled at the worker level via the parent process sending an abort message.
-
-### Example
-
-```typescript
-interface Classification {
-  category: 'interested' | 'not-interested' | 'bounced'
-  confidence: number
-  summary: string
-}
-
-const response = await llm.generate<Classification>({
-  provider: 'anthropic',
-  model: 'claude-sonnet-4-5',
-  messages: [
-    { role: 'system', content: 'Classify this email reply.' },
-    { role: 'user', content: emailText },
-  ],
-  responseSchema: {
-    type: 'object',
-    properties: {
-      category: { type: 'string', enum: ['interested', 'not-interested', 'bounced'] },
-      confidence: { type: 'number', minimum: 0, maximum: 1 },
-      summary: { type: 'string' },
-    },
-    required: ['category', 'confidence', 'summary'],
-  },
-  temperature: 0.1,
-})
-
-// response.output is typed as Classification
-const { category, confidence, summary } = response.output
-```
-
----
-
-## AcqDb Adapter
-
-Singleton -- 35 methods for acquisition database management (lists, companies, contacts, deals, deal-sync). `organizationId` is injected server-side -- never pass it.
-
-```typescript
-import { acqDb } from '@elevasis/sdk/worker'
-```
-
-### Methods
-
-**List operations:**
-
-| Method       | Params                                       | Returns     |
-| ------------ | -------------------------------------------- | ----------- |
-| `listLists`  | none                                         | `AcqList[]` |
-| `createList` | `Omit<CreateListParams, 'organizationId'>` | `AcqList`   |
-| `updateList` | `{ id } & UpdateListParams`                  | `AcqList`   |
-| `deleteList` | `{ id }`                                     | `void`      |
-
-**Company operations:**
-
-| Method          | Params                                          | Returns              |
-| --------------- | ----------------------------------------------- | -------------------- |
-| `createCompany` | `Omit<CreateCompanyParams, 'organizationId'>` | `AcqCompany`         |
-| `upsertCompany` | `Omit<UpsertCompanyParams, 'organizationId'>` | `AcqCompany`         |
-| `updateCompany` | `{ id } & UpdateCompanyParams`                  | `AcqCompany`         |
-| `getCompany`    | `{ id }`                                        | `AcqCompany | null` |
-| `listCompanies` | `{ filters? }`                                  | `AcqCompany[]`       |
-| `deleteCompany` | `{ id }`                                        | `void`               |
-
-**Contact operations:**
-
-| Method               | Params                                          | Returns                         |
-| -------------------- | ----------------------------------------------- | ------------------------------- |
-| `createContact`      | `Omit<CreateContactParams, 'organizationId'>` | `AcqContact`                    |
-| `upsertContact`      | `Omit<UpsertContactParams, 'organizationId'>` | `AcqContact`                    |
-| `updateContact`      | `{ id } & UpdateContactParams`                  | `AcqContact`                    |
-| `getContact`         | `{ id }`                                        | `AcqContact | null`            |
-| `getContactByEmail`  | `{ email }`                                     | `AcqContact | null`            |
-| `listContacts`       | `{ filters?, pagination? }`                     | `PaginatedResult<AcqContact>` |
-| `deleteContact`      | `{ id }`                                        | `void`                          |
-| `bulkImportContacts` | `Omit<BulkImportParams, 'organizationId'>`    | `BulkImportResult`              |
-
-**Deal operations:**
-
-| Method                 | Params                                       | Returns           |
-| ---------------------- | -------------------------------------------- | ----------------- |
-| `upsertDeal`           | `Omit<UpsertDealParams, 'organizationId'>` | `AcqDeal`         |
-| `getDealByEmail`       | `{ email }`                                  | `AcqDeal | null` |
-| `getDealByEnvelopeId`  | `{ envelopeId }`                             | `AcqDeal | null` |
-| `updateDealEnvelopeId` | `{ attioDealId, envelopeId }`                | `AcqDeal | null` |
-| `getDealByAttioId`     | `{ attioDealId }`                            | `AcqDeal | null` |
-
-**Deal-sync operations:**
-
-| Method                          | Params                                                  | Returns                               |
-| ------------------------------- | ------------------------------------------------------- | ------------------------------------- |
-| `updateDiscoveryData`           | `Omit<UpdateDiscoveryDataParams, 'organizationId'>`   | `void`                                |
-| `updateProposalData`            | `Omit<UpdateProposalDataParams, 'organizationId'>`    | `void`                                |
-| `markProposalSent`              | `Omit<MarkProposalSentParams, 'organizationId'>`      | `void`                                |
-| `markProposalReviewed`          | `Omit<MarkProposalReviewedParams, 'organizationId'>`  | `void`                                |
-| `updateCloseLostReason`         | `Omit<UpdateCloseLostReasonParams, 'organizationId'>` | `void`                                |
-| `updateFees`                    | `Omit<UpdateFeesParams, 'organizationId'>`            | `void`                                |
-| `syncDealStage`                 | `Omit<SyncDealStageParams, 'organizationId'>`         | `void`                                |
-| `setContactNurture`             | `Omit<SetContactNurtureParams, 'organizationId'>`     | `void`                                |
-| `cancelSchedulesAndHitlByEmail` | `Omit<..., 'organizationId'>`                         | `{ schedulesCancelled, hitlDeleted }` |
-| `cancelHitlByDealId`            | `Omit<..., 'organizationId'>`                         | `{ hitlDeleted }`                     |
-| `clearDealFields`               | `Omit<ClearDealFieldsParams, 'organizationId'>`       | `void`                                |
-| `deleteDeal`                    | `Omit<DeleteDealParams, 'organizationId'>`            | `void`                                |
-
-### Example
-
-```typescript
-const deal = await acqDb.getDealByEmail({ email: 'jane@acme.com' })
-if (!deal) {
-  await acqDb.upsertDeal({
-    attioDealId: 'deal-123',
-    contactEmail: 'jane@acme.com',
-  })
-}
-
-// Bulk import contacts
-await acqDb.bulkImportContacts({
-  listId: 'list-abc',
-  contacts: [
-    { email: 'a@example.com', firstName: 'Alice' },
-    { email: 'b@example.com', firstName: 'Bob' },
-  ],
-})
-```
-
----
-
-## PDF Adapter
-
-Singleton -- 2 methods for rendering PDFDocument structures to files or buffers. No credential required.
-
-```typescript
-import { pdf } from '@elevasis/sdk/worker'
-```
-
-### Methods
-
-| Method           | Params                                            | Returns                     |
-| ---------------- | ------------------------------------------------- | --------------------------- |
-| `render`         | `{ document, theme?, storage: { bucket, path } }` | `{ success, pdfUrl, size }` |
-| `renderToBuffer` | `{ document, theme? }`                            | `{ buffer }`                |
-
-### Example
-
-```typescript
-// Render to storage (returns a URL)
-const result = await pdf.render({
-  document: proposalDocument,
-  storage: { bucket: 'acquisition', path: 'proposals/deal-123/proposal.pdf' },
-})
-console.log(result.pdfUrl)
-
-// Render to buffer (for inline processing)
-const { buffer } = await pdf.renderToBuffer({
-  document: proposalDocument,
-})
-```
-
----
-
-## Approval Adapter
-
-Singleton -- 2 methods for creating and managing human-in-the-loop (HITL) approval tasks. No credential required.
-
-```typescript
-import { approval } from '@elevasis/sdk/worker'
-```
-
-### Methods
-
-| Method             | Params                                                                                   | Returns       |
-| ------------------ | ---------------------------------------------------------------------------------------- | ------------- |
-| `create`           | `{ actions, context, description?, priority?, humanCheckpoint?, metadata?, expiresAt? }` | `{ id }`      |
-| `deleteByMetadata` | `{ metadata, status? }`                                                                  | `{ deleted }` |
-
-### Example
-
-```typescript
-// Create an approval gate
-const task = await approval.create({
-  actions: [
-    { id: 'approve', label: 'Approve', type: 'primary' },
-    { id: 'reject', label: 'Reject', type: 'danger' },
-  ],
-  context: { dealId: 'deal-123', proposalUrl: 'https://...' },
-  description: 'Review proposal for Acme Corp',
-  humanCheckpoint: 'proposal-review',
-  metadata: { dealId: 'deal-123' },
-})
-
-// Clean up stale tasks
-await approval.deleteByMetadata({
-  metadata: { dealId: 'deal-123' },
-  status: 'pending',
-})
-```
-
----
-
-## Execution Adapter
-
-Singleton -- 1 method for triggering another resource (workflow or agent) as a nested child execution. No credential required.
-
-```typescript
-import { execution } from '@elevasis/sdk/worker'
-```
-
-### Method
-
-| Method    | Params                   | Returns                                    |
-| --------- | ------------------------ | ------------------------------------------ |
-| `trigger` | `{ resourceId, input? }` | `{ success, executionId, output, error? }` |
-
-### Example
-
-```typescript
-const result = await execution.trigger({
-  resourceId: 'send-welcome-sequence',
-  input: { userId: newUser.id, email: newUser.email },
-})
-
-if (!result.success) {
-  throw new Error(`Child workflow failed: ${result.error}`)
-}
-```
-
-Nested executions are tracked with depth up to a maximum of 5 levels.
-
----
-
-## Email Adapter
-
-Singleton -- 1 method for sending platform emails to organization members (from `notifications@elevasis.io`). For client-facing emails, use the Resend or Instantly integration adapters instead.
-
-```typescript
-import { email } from '@elevasis/sdk/worker'
-```
-
-### Method
-
-| Method | Params                                                                          | Returns                     |
-| ------ | ------------------------------------------------------------------------------- | --------------------------- |
-| `send` | `{ subject, html?, text?, userIds?, targetRole?, targetAll?, replyTo?, tags? }` | `{ sent, failed, errors? }` |
-
-### Example
-
-```typescript
-// Notify all org members
-await email.send({
-  subject: 'New deal closed',
-  text: 'Acme Corp has signed the contract.',
-  targetAll: true,
-})
-
-// Notify specific users
-await email.send({
-  subject: 'Action required',
-  html: '\<p\>Please review the proposal.\</p\>',
-  userIds: ['user-abc', 'user-def'],
-})
-```
-
----
-
-## Custom Adapters with `createAdapter`
-
-The generic `createAdapter` factory is exported for building adapters for any tool. Define a type map and call the factory.
-
-```typescript
-import { createAdapter } from '@elevasis/sdk/worker'
-
-// 1. Define a type map
-type MyToolMap = {
-  doSomething: { params: { input: string }; result: { output: string } }
-  listItems:   { params: { limit?: number }; result: { items: string[] } }
-  getStatus:   { params: Record<string, never>; result: { healthy: boolean } }
-}
-
-// 2. Create the adapter
-const myTool = createAdapter<MyToolMap>('my-tool', [
-  'doSomething', 'listItems', 'getStatus',
-], 'my-credential')  // credential is optional
-
-// 3. Use it (fully typed)
-const result = await myTool.doSomething({ input: 'hello' })
-//    ^-- { output: string }
-const status = await myTool.getStatus()
-//    ^-- { healthy: boolean } (zero-arg because params is Record<string, never>)
-```
-
-Method names are compile-time checked against the type map keys -- misspelling a method name is a compile error.
-
----
-
-All typed adapters compile to `platform.call()` internally -- you can use either interchangeably.
-
-## When to Use Adapters vs `platform.call()`
-
-| Scenario                                                              | Use               |
-| --------------------------------------------------------------------- | ----------------- |
-| Tool has a typed adapter (all integrations + platform tools)          | Adapter           |
-| Need autocomplete and type safety                                     | Adapter           |
-| New dispatcher method added server-side, no SDK update yet            | `platform.call()` |
-| Tool without a typed adapter (supabase, session-memory, status, http) | `platform.call()` |
-
-`platform.call()` remains the universal escape hatch. Every adapter call compiles down to it. Both approaches work simultaneously with no conflicts.
-
----
-
-For the full inventory of all platform tools (including those without typed adapters), see [Platform Tools](index.mdx).
-
----
-
-## Error Handling
-
-All adapter calls throw `PlatformToolError` on failure, with a `code` field and `retryable` flag:
-
-```typescript
-import { PlatformToolError } from '@elevasis/sdk/worker'
-
-try {
-  await attio.listRecords({ object: 'deals' })
-} catch (err) {
-  if (err instanceof PlatformToolError) {
-    console.log(err.message)    // Human-readable error
-    console.log(err.code)       // e.g., 'rate_limit_exceeded', 'credentials_missing'
-    console.log(err.retryable)  // true for transient errors
-  }
-}
-```
-
-Retryable error codes: `rate_limit_exceeded`, `network_error`, `timeout_error`, `api_error`, `service_unavailable`, `server_unavailable`.
-
-Timeouts: LLM calls have a 120s timeout. All other tool calls have a 60s timeout.
-
----
-
-**Last Updated:** 2026-03-05