@clientcasa/sdk 0.1.2 → 0.3.0

package/README.md

@@ -14,141 +14,159 @@ Works in Node.js 18+, modern browsers, Edge runtimes, Cloudflare Workers, and De
 
 ## Quick start
 
-Get an API key from **Settings → API Keys** in your dashboard.
+Get an API key from **Settings → API Keys** in your dashboard, then:
 
 ```ts
 import { ClientCasa } from '@clientcasa/sdk'
 
-const cc = new ClientCasa({
-  apiKey: process.env.CLIENTCASA_API_KEY!,
-})
+const cc = new ClientCasa()
+const security = { apiKey: process.env.CLIENTCASA_API_KEY ?? '' }
 
 // List clients
-const { data, error } = await cc.clients.list({
-  query: { pageSize: 25 },
-})
-if (error) throw new Error(error.error.message)
-for (const client of data.data) {
+const result = await cc.clients.listClients(security, { pageSize: 25 })
+for (const client of result.data) {
   console.log(client.name, client.status)
 }
 
 // Create a client
-const { data: created } = await cc.clients.create({
-  body: { name: 'Acme Inc.', status: 'active' },
+const created = await cc.clients.createClient(security, {
+  name: 'Acme Inc.',
+  status: 'active',
 })
 
 // Get one by ID
-const { data: fetched } = await cc.clients.get({
-  path: { id: created!.id },
-})
+const fetched = await cc.clients.getClient(security, { id: created.id })
 
 // Update
-await cc.clients.update({
-  path: { id: created!.id },
-  body: { notes: 'Updated via SDK' },
+await cc.clients.updateClient(security, {
+  id: created.id,
+  clientUpdate: { notes: 'Updated via SDK' },
 })
 
 // Delete
-await cc.clients.delete({ path: { id: created!.id } })
+await cc.clients.deleteClient(security, { id: created.id })
 ```
 
+Errors are thrown — wrap calls in `try/catch` to handle them.
+
 ## OAuth (third-party apps)
 
 If you're building a third-party app that acts on behalf of a user, use the access token from your OAuth flow:
 
 ```ts
-const cc = new ClientCasa({
-  accessToken: 'eyJhbGc...', // from /api/auth/oauth2/token
-})
+const security = { bearer: 'eyJhbGc...' }  // from /api/auth/oauth2/token
+const result = await cc.clients.listClients(security, {})
 ```
 
 See the [OAuth Apps guide](https://www.clientcasa.com/docs/api/oauth-apps) for the full authorization-code-with-PKCE flow.
 
 ## Resources
 
-The client exposes one accessor per v1 resource:
+The client exposes one accessor per v1 resource. Method names follow the verb-then-resource pattern (`listClients`, `createInvoice`, `getPayout`, etc.):
 
 | Accessor | Methods | Notes |
 |---|---|---|
-| `cc.clients` | list, create, get, update, delete | |
-| `cc.contacts` | list, create, get, update, delete | |
-| `cc.projects` | list, create, get, update, delete | |
-| `cc.invoices` | list, create, get, update, delete | Status is payment-derived; only `draft`, `sent`, `void` writable |
-| `cc.proposals` | list, create, get, update, delete | Tiptap content not editable via API |
-| `cc.contracts` | list, create, get, update, delete | Create makes drafts only; signing is dashboard-managed |
-| `cc.payments` | list, create, get, update | Immutable — no delete. Refunds are negative-amount entries with `kind=refund` |
-| `cc.payouts` | list, get | Read-only — Stripe-managed |
-| `cc.timeEntries` | list, create, get, update, delete | |
-| `cc.milestones` | list, create, get, update, delete | Polymorphic parent (`parentType: 'projects' | 'proposals'`) |
-| `cc.calendarEvents` | list, create, get, update, delete | Externally-synced events are read-only |
-| `cc.inquiries` | list, create, get, update, delete | New inquiries land in `status: 'new'`; `converted` is set by the dashboard |
-| `cc.transactions` | list, create, get, update, delete | |
-| `cc.catalogItems` | list, create, get, update, delete | |
-| `cc.webhooks` | list, create, get, update, delete | Secret is write-only |
+| `cc.clients` | listClients, createClient, getClient, updateClient, deleteClient | |
+| `cc.contacts` | listContacts, createContact, getContact, updateContact, deleteContact | |
+| `cc.projects` | listProjects, createProject, getProject, updateProject, deleteProject | |
+| `cc.invoices` | listInvoices, createInvoice, getInvoice, updateInvoice, deleteInvoice | Status is payment-derived; only `draft`, `sent`, `void` writable |
+| `cc.proposals` | listProposals, createProposal, getProposal, updateProposal, deleteProposal | Tiptap content not editable via API |
+| `cc.contracts` | listContracts, createContract, getContract, updateContract, deleteContract | Create makes drafts only; signing is dashboard-managed |
+| `cc.payments` | listPayments, createPayment, getPayment, updatePayment | Immutable — no delete. Refunds are negative-amount entries with `kind=refund` |
+| `cc.payouts` | listPayouts, getPayout | Read-only — Stripe-managed |
+| `cc.timeEntries` | listTimeEntries, createTimeEntry, getTimeEntry, updateTimeEntry, deleteTimeEntry | |
+| `cc.milestones` | listMilestones, createMilestone, getMilestone, updateMilestone, deleteMilestone | Polymorphic parent (`parentType: 'projects' \| 'proposals'`) |
+| `cc.calendarEvents` | listCalendarEvents, createCalendarEvent, getCalendarEvent, updateCalendarEvent, deleteCalendarEvent | Externally-synced events are read-only |
+| `cc.inquiries` | listInquiries, createInquiry, getInquiry, updateInquiry, deleteInquiry | Inquiries land in `status: 'new'`; `converted` set by the dashboard |
+| `cc.transactions` | listTransactions, createTransaction, getTransaction, updateTransaction, deleteTransaction | |
+| `cc.catalogItems` | listCatalogItems, createCatalogItem, getCatalogItem, updateCatalogItem, deleteCatalogItem | |
+| `cc.webhooks` | listWebhooks, createWebhook, getWebhook, updateWebhook, deleteWebhook | Secret is write-only |
 
 ## Error handling
 
-Every method returns `{ data, error }`:
+Methods throw typed errors on non-2xx responses. Each operation has its own named error class:
 
 ```ts
-const { data, error } = await cc.clients.get({ path: { id: 'bad-id' } })
-if (error) {
-  console.error(error.error.code)      // 'not_found' | 'unauthorized' | …
-  console.error(error.error.message)
-  console.error(error.error.requestId) // for support tickets
-  return
+import { ClientCasa } from '@clientcasa/sdk'
+import { APIError, HTTPClientErrors } from '@clientcasa/sdk/models/errors'
+
+try {
+  const result = await cc.clients.getClient(security, { id: 'bad-id' })
+  console.log(result.name)
+} catch (err) {
+  if (err instanceof APIError) {
+    console.error(err.statusCode)            // 404
+    console.error(err.message)               // human-readable
+    // Decoded error body if the response was JSON:
+    // err.body has { error: { code, message, requestId, details? } }
+  } else {
+    throw err
+  }
 }
-console.log(data.name) // type-narrowed
 ```
 
+See [`docs/models/errors/`](./docs/models/errors) for per-operation error types.
+
 ## Idempotency
 
-Pass an `Idempotency-Key` header on writes to safely retry:
+Pass an `Idempotency-Key` header on write operations to safely retry:
 
 ```ts
-await cc.invoices.create({
-  body: { /* … */ },
-  headers: { 'Idempotency-Key': '7c9e6679-7425-40de-944b-e07fc1f90ae7' },
-})
+import { randomUUID } from 'node:crypto'
+
+await cc.invoices.createInvoice(
+  security,
+  {
+    clientId: 'cli_...',
+    issueDate: '2026-05-19',
+    dueDate: '2026-06-18',
+    lineItems: [{ description: 'Consult', quantity: 1, unitPrice: 500, taxable: false }],
+  },
+  { headers: { 'Idempotency-Key': randomUUID() } },
+)
 ```
 
-The same key replayed within 24h returns the cached response. See [Idempotency](https://www.clientcasa.com/docs/api/idempotency) for details.
+The same key replayed within 24h returns the cached response. See the [Idempotency guide](https://www.clientcasa.com/docs/integrations/idempotent-writes) for the full pattern, including payments and refunds.
 
 ## Configuration
 
 ```ts
+import { ClientCasa } from '@clientcasa/sdk'
+
 new ClientCasa({
-  apiKey: '…',           // or accessToken
-  accessToken: '…',      // OAuth Bearer
-  baseUrl: '…',          // override (defaults to https://www.clientcasa.com)
-  fetch: customFetch,    // BYO fetch (undici, cross-fetch, etc.)
+  // Optional default API key — applied to every method that takes `security`.
+  // Per-call security still overrides if both are set.
+  apiKey: process.env.CLIENTCASA_API_KEY ?? '',
+  // Override the production base URL (e.g., for staging or test envs)
+  serverURL: 'https://www.clientcasa.com',
+  // Override the underlying HTTP client (e.g., to inject middleware)
+  httpClient: undefined,
+  // Custom retry config (defaults are already sensible)
+  retryConfig: undefined,
+  // Per-call timeout in milliseconds
+  timeoutMs: 30_000,
 })
 ```
 
 ## TypeScript
 
-All DTOs are exported as types:
+All DTOs are exported under the `@clientcasa/sdk/models` subpath:
 
 ```ts
-import type { ClientDTO, InvoiceCreate, PaginationMeta } from '@clientcasa/sdk'
+import type { Client, InvoiceCreate, PaginationMeta } from '@clientcasa/sdk/models'
 ```
 
-## Development
+Per-operation request/response types live under `@clientcasa/sdk/models/operations`.
 
-The SDK is generated from the live OpenAPI spec at `/api/v1/openapi.json`. To regenerate after API changes:
+## Contributing
 
-```bash
-# From repo root: dump the current spec
-pnpm --filter @clientcasa/app generate:openapi-spec
+This SDK is auto-generated from the [ClientCasa OpenAPI spec](https://www.clientcasa.com/api/v1/openapi.json) by [Speakeasy](https://www.speakeasy.com). Most changes belong upstream in the API, not here.
 
-# Regenerate the SDK client + types
-pnpm --filter @clientcasa/sdk gen
+- **Found a bug or want a feature?** [Open an issue](https://github.com/clientcasa/sdk-typescript/issues) — include the SDK version, what you tried, and the unexpected behavior.
+- **Want to suggest an SDK-specific improvement** (ergonomics, retries, packaging)? Open an issue and we'll discuss before code.
+- **Security issue?** See [SECURITY.md](./SECURITY.md). Do not file a public issue.
 
-# Build
-pnpm --filter @clientcasa/sdk build
-```
-
-The CI build fails if the committed `openapi.json` or `src/generated/` are out of sync with the registry, so contributors can't forget to run `gen`.
+Pull requests touching `src/generated/` will be regenerated and overwritten — please don't edit generated code directly. See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full contributor guide.
 
 ## Versioning
 
@@ -175,7 +193,7 @@ ClientCasa API: REST API for ClientCasa — proposals, contracts, time tracking,
   * [Idempotency](#idempotency)
   * [Configuration](#configuration)
   * [TypeScript](#typescript)
-  * [Development](#development)
+  * [Contributing](#contributing)
   * [Versioning](#versioning)
   * [License](#license)
   * [SDK Installation](#sdk-installation)
@@ -184,6 +202,7 @@ ClientCasa API: REST API for ClientCasa — proposals, contracts, time tracking,
   * [Authentication](#authentication)
   * [Available Resources and Operations](#available-resources-and-operations)
   * [Standalone functions](#standalone-functions)
+  * [Pagination](#pagination)
   * [Retries](#retries)
   * [Error Handling](#error-handling-1)
   * [Server Selection](#server-selection)
@@ -243,11 +262,13 @@ import { ClientCasa } from "@clientcasa/sdk";
 const clientCasa = new ClientCasa();
 
 async function run() {
-  const result = await clientCasa.clients.listClients({
+  const result = await clientCasa.clients.list({
     apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
   }, {});
 
-  console.log(result);
+  for await (const page of result) {
+    console.log(page);
+  }
 }
 
 run();
@@ -278,9 +299,11 @@ import { ClientCasa } from "@clientcasa/sdk";
 const clientCasa = new ClientCasa();
 
 async function run() {
-  const result = await clientCasa.clients.listClients({}, {});
+  const result = await clientCasa.clients.list({}, {});
 
-  console.log(result);
+  for await (const page of result) {
+    console.log(page);
+  }
 }
 
 run();
@@ -296,119 +319,119 @@ run();
 
 ### [CalendarEvents](docs/sdks/calendarevents/README.md)
 
-* [listCalendarEvents](docs/sdks/calendarevents/README.md#listcalendarevents) - List calendar events
-* [createCalendarEvent](docs/sdks/calendarevents/README.md#createcalendarevent) - Create a calendar event
-* [getCalendarEvent](docs/sdks/calendarevents/README.md#getcalendarevent) - Get a calendar event
-* [deleteCalendarEvent](docs/sdks/calendarevents/README.md#deletecalendarevent) - Delete a calendar event
-* [updateCalendarEvent](docs/sdks/calendarevents/README.md#updatecalendarevent) - Update a calendar event
+* [list](docs/sdks/calendarevents/README.md#list) - List calendar events
+* [create](docs/sdks/calendarevents/README.md#create) - Create a calendar event
+* [get](docs/sdks/calendarevents/README.md#get) - Get a calendar event
+* [delete](docs/sdks/calendarevents/README.md#delete) - Delete a calendar event
+* [update](docs/sdks/calendarevents/README.md#update) - Update a calendar event
 
 ### [CatalogItems](docs/sdks/catalogitems/README.md)
 
-* [listCatalogItems](docs/sdks/catalogitems/README.md#listcatalogitems) - List catalog items
-* [createCatalogItem](docs/sdks/catalogitems/README.md#createcatalogitem) - Create a catalog item
-* [getCatalogItem](docs/sdks/catalogitems/README.md#getcatalogitem) - Get a catalog item
-* [deleteCatalogItem](docs/sdks/catalogitems/README.md#deletecatalogitem) - Delete a catalog item
-* [updateCatalogItem](docs/sdks/catalogitems/README.md#updatecatalogitem) - Update a catalog item
+* [list](docs/sdks/catalogitems/README.md#list) - List catalog items
+* [create](docs/sdks/catalogitems/README.md#create) - Create a catalog item
+* [get](docs/sdks/catalogitems/README.md#get) - Get a catalog item
+* [delete](docs/sdks/catalogitems/README.md#delete) - Delete a catalog item
+* [update](docs/sdks/catalogitems/README.md#update) - Update a catalog item
 
 ### [Clients](docs/sdks/clients/README.md)
 
-* [listClients](docs/sdks/clients/README.md#listclients) - List clients
-* [createClient](docs/sdks/clients/README.md#createclient) - Create a client
-* [getClient](docs/sdks/clients/README.md#getclient) - Get a client
-* [deleteClient](docs/sdks/clients/README.md#deleteclient) - Delete a client
-* [updateClient](docs/sdks/clients/README.md#updateclient) - Update a client
+* [list](docs/sdks/clients/README.md#list) - List clients
+* [create](docs/sdks/clients/README.md#create) - Create a client
+* [get](docs/sdks/clients/README.md#get) - Get a client
+* [delete](docs/sdks/clients/README.md#delete) - Delete a client
+* [update](docs/sdks/clients/README.md#update) - Update a client
 
 ### [Contacts](docs/sdks/contacts/README.md)
 
-* [listContacts](docs/sdks/contacts/README.md#listcontacts) - List contacts
-* [createContact](docs/sdks/contacts/README.md#createcontact) - Create a contact
-* [getContact](docs/sdks/contacts/README.md#getcontact) - Get a contact
-* [deleteContact](docs/sdks/contacts/README.md#deletecontact) - Delete a contact
-* [updateContact](docs/sdks/contacts/README.md#updatecontact) - Update a contact
+* [list](docs/sdks/contacts/README.md#list) - List contacts
+* [create](docs/sdks/contacts/README.md#create) - Create a contact
+* [get](docs/sdks/contacts/README.md#get) - Get a contact
+* [delete](docs/sdks/contacts/README.md#delete) - Delete a contact
+* [update](docs/sdks/contacts/README.md#update) - Update a contact
 
 ### [Contracts](docs/sdks/contracts/README.md)
 
-* [listContracts](docs/sdks/contracts/README.md#listcontracts) - List contracts
-* [createContract](docs/sdks/contracts/README.md#createcontract) - Create a draft contract
-* [getContract](docs/sdks/contracts/README.md#getcontract) - Get a contract
-* [deleteContract](docs/sdks/contracts/README.md#deletecontract) - Delete a contract (only drafts)
-* [updateContract](docs/sdks/contracts/README.md#updatecontract) - Update a contract (limited fields)
+* [list](docs/sdks/contracts/README.md#list) - List contracts
+* [create](docs/sdks/contracts/README.md#create) - Create a draft contract
+* [get](docs/sdks/contracts/README.md#get) - Get a contract
+* [delete](docs/sdks/contracts/README.md#delete) - Delete a contract (only drafts)
+* [update](docs/sdks/contracts/README.md#update) - Update a contract (limited fields)
 
 ### [Inquiries](docs/sdks/inquiries/README.md)
 
-* [listInquiries](docs/sdks/inquiries/README.md#listinquiries) - List inquiries
-* [createInquiry](docs/sdks/inquiries/README.md#createinquiry) - Create an inquiry
-* [getInquiry](docs/sdks/inquiries/README.md#getinquiry) - Get an inquiry
-* [deleteInquiry](docs/sdks/inquiries/README.md#deleteinquiry) - Delete an inquiry
-* [updateInquiry](docs/sdks/inquiries/README.md#updateinquiry) - Update an inquiry
+* [list](docs/sdks/inquiries/README.md#list) - List inquiries
+* [create](docs/sdks/inquiries/README.md#create) - Create an inquiry
+* [get](docs/sdks/inquiries/README.md#get) - Get an inquiry
+* [delete](docs/sdks/inquiries/README.md#delete) - Delete an inquiry
+* [update](docs/sdks/inquiries/README.md#update) - Update an inquiry
 
 ### [Invoices](docs/sdks/invoices/README.md)
 
-* [listInvoices](docs/sdks/invoices/README.md#listinvoices) - List invoices
-* [createInvoice](docs/sdks/invoices/README.md#createinvoice) - Create an invoice
-* [getInvoice](docs/sdks/invoices/README.md#getinvoice) - Get an invoice
-* [deleteInvoice](docs/sdks/invoices/README.md#deleteinvoice) - Delete an invoice (only drafts)
-* [updateInvoice](docs/sdks/invoices/README.md#updateinvoice) - Update an invoice (line items not editable in v1)
+* [list](docs/sdks/invoices/README.md#list) - List invoices
+* [create](docs/sdks/invoices/README.md#create) - Create an invoice
+* [get](docs/sdks/invoices/README.md#get) - Get an invoice
+* [delete](docs/sdks/invoices/README.md#delete) - Delete an invoice (only drafts)
+* [update](docs/sdks/invoices/README.md#update) - Update an invoice (line items not editable in v1)
 
 ### [Milestones](docs/sdks/milestones/README.md)
 
-* [listMilestones](docs/sdks/milestones/README.md#listmilestones) - List milestones
-* [createMilestone](docs/sdks/milestones/README.md#createmilestone) - Create a milestone
-* [getMilestone](docs/sdks/milestones/README.md#getmilestone) - Get a milestone
-* [deleteMilestone](docs/sdks/milestones/README.md#deletemilestone) - Delete a milestone
-* [updateMilestone](docs/sdks/milestones/README.md#updatemilestone) - Update a milestone
+* [list](docs/sdks/milestones/README.md#list) - List milestones
+* [create](docs/sdks/milestones/README.md#create) - Create a milestone
+* [get](docs/sdks/milestones/README.md#get) - Get a milestone
+* [delete](docs/sdks/milestones/README.md#delete) - Delete a milestone
+* [update](docs/sdks/milestones/README.md#update) - Update a milestone
 
 ### [Payments](docs/sdks/payments/README.md)
 
-* [listPayments](docs/sdks/payments/README.md#listpayments) - List payments
-* [createPayment](docs/sdks/payments/README.md#createpayment) - Record a manual payment
-* [getPayment](docs/sdks/payments/README.md#getpayment) - Get a payment
-* [updatePayment](docs/sdks/payments/README.md#updatepayment) - Update a payment (notes/reference only — payments are otherwise immutable)
+* [list](docs/sdks/payments/README.md#list) - List payments
+* [create](docs/sdks/payments/README.md#create) - Record a manual payment
+* [get](docs/sdks/payments/README.md#get) - Get a payment
+* [update](docs/sdks/payments/README.md#update) - Update a payment (notes/reference only — payments are otherwise immutable)
 
 ### [Payouts](docs/sdks/payouts/README.md)
 
-* [listPayouts](docs/sdks/payouts/README.md#listpayouts) - List payouts
-* [getPayout](docs/sdks/payouts/README.md#getpayout) - Get a payout
+* [list](docs/sdks/payouts/README.md#list) - List payouts
+* [get](docs/sdks/payouts/README.md#get) - Get a payout
 
 ### [Projects](docs/sdks/projects/README.md)
 
-* [listProjects](docs/sdks/projects/README.md#listprojects) - List projects
-* [createProject](docs/sdks/projects/README.md#createproject) - Create a project
-* [getProject](docs/sdks/projects/README.md#getproject) - Get a project
-* [deleteProject](docs/sdks/projects/README.md#deleteproject) - Delete a project
-* [updateProject](docs/sdks/projects/README.md#updateproject) - Update a project
+* [list](docs/sdks/projects/README.md#list) - List projects
+* [create](docs/sdks/projects/README.md#create) - Create a project
+* [get](docs/sdks/projects/README.md#get) - Get a project
+* [delete](docs/sdks/projects/README.md#delete) - Delete a project
+* [update](docs/sdks/projects/README.md#update) - Update a project
 
 ### [Proposals](docs/sdks/proposals/README.md)
 
-* [listProposals](docs/sdks/proposals/README.md#listproposals) - List proposals
-* [createProposal](docs/sdks/proposals/README.md#createproposal) - Create a proposal (metadata only — rich-text content is dashboard-managed)
-* [getProposal](docs/sdks/proposals/README.md#getproposal) - Get a proposal
-* [deleteProposal](docs/sdks/proposals/README.md#deleteproposal) - Delete a proposal (only drafts)
-* [updateProposal](docs/sdks/proposals/README.md#updateproposal) - Update a proposal
+* [list](docs/sdks/proposals/README.md#list) - List proposals
+* [create](docs/sdks/proposals/README.md#create) - Create a proposal (metadata only — rich-text content is dashboard-managed)
+* [get](docs/sdks/proposals/README.md#get) - Get a proposal
+* [delete](docs/sdks/proposals/README.md#delete) - Delete a proposal (only drafts)
+* [update](docs/sdks/proposals/README.md#update) - Update a proposal
 
 ### [TimeEntries](docs/sdks/timeentries/README.md)
 
-* [listTimeEntries](docs/sdks/timeentries/README.md#listtimeentries) - List time entries
-* [createTimeEntry](docs/sdks/timeentries/README.md#createtimeentry) - Create a time entry
-* [getTimeEntry](docs/sdks/timeentries/README.md#gettimeentry) - Get a time entry
-* [deleteTimeEntry](docs/sdks/timeentries/README.md#deletetimeentry) - Delete a time entry
-* [updateTimeEntry](docs/sdks/timeentries/README.md#updatetimeentry) - Update a time entry
+* [list](docs/sdks/timeentries/README.md#list) - List time entries
+* [create](docs/sdks/timeentries/README.md#create) - Create a time entry
+* [get](docs/sdks/timeentries/README.md#get) - Get a time entry
+* [delete](docs/sdks/timeentries/README.md#delete) - Delete a time entry
+* [update](docs/sdks/timeentries/README.md#update) - Update a time entry
 
 ### [Transactions](docs/sdks/transactions/README.md)
 
-* [listTransactions](docs/sdks/transactions/README.md#listtransactions) - List transactions
-* [createTransaction](docs/sdks/transactions/README.md#createtransaction) - Create a transaction (expense or charge)
-* [getTransaction](docs/sdks/transactions/README.md#gettransaction) - Get a transaction
-* [deleteTransaction](docs/sdks/transactions/README.md#deletetransaction) - Delete a transaction
-* [updateTransaction](docs/sdks/transactions/README.md#updatetransaction) - Update a transaction
+* [list](docs/sdks/transactions/README.md#list) - List transactions
+* [create](docs/sdks/transactions/README.md#create) - Create a transaction (expense or charge)
+* [get](docs/sdks/transactions/README.md#get) - Get a transaction
+* [delete](docs/sdks/transactions/README.md#delete) - Delete a transaction
+* [update](docs/sdks/transactions/README.md#update) - Update a transaction
 
 ### [Webhooks](docs/sdks/webhooks/README.md)
 
-* [listWebhooks](docs/sdks/webhooks/README.md#listwebhooks) - List webhook subscriptions
-* [createWebhook](docs/sdks/webhooks/README.md#createwebhook) - Subscribe to events
-* [getWebhook](docs/sdks/webhooks/README.md#getwebhook) - Get a webhook
-* [deleteWebhook](docs/sdks/webhooks/README.md#deletewebhook) - Delete a webhook
-* [updateWebhook](docs/sdks/webhooks/README.md#updatewebhook) - Update a webhook
+* [list](docs/sdks/webhooks/README.md#list) - List webhook subscriptions
+* [create](docs/sdks/webhooks/README.md#create) - Subscribe to events
+* [get](docs/sdks/webhooks/README.md#get) - Get a webhook
+* [delete](docs/sdks/webhooks/README.md#delete) - Delete a webhook
+* [update](docs/sdks/webhooks/README.md#update) - Update a webhook
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -428,81 +451,113 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`calendarEventsCreateCalendarEvent`](docs/sdks/calendarevents/README.md#createcalendarevent) - Create a calendar event
-- [`calendarEventsDeleteCalendarEvent`](docs/sdks/calendarevents/README.md#deletecalendarevent) - Delete a calendar event
-- [`calendarEventsGetCalendarEvent`](docs/sdks/calendarevents/README.md#getcalendarevent) - Get a calendar event
-- [`calendarEventsListCalendarEvents`](docs/sdks/calendarevents/README.md#listcalendarevents) - List calendar events
-- [`calendarEventsUpdateCalendarEvent`](docs/sdks/calendarevents/README.md#updatecalendarevent) - Update a calendar event
-- [`catalogItemsCreateCatalogItem`](docs/sdks/catalogitems/README.md#createcatalogitem) - Create a catalog item
-- [`catalogItemsDeleteCatalogItem`](docs/sdks/catalogitems/README.md#deletecatalogitem) - Delete a catalog item
-- [`catalogItemsGetCatalogItem`](docs/sdks/catalogitems/README.md#getcatalogitem) - Get a catalog item
-- [`catalogItemsListCatalogItems`](docs/sdks/catalogitems/README.md#listcatalogitems) - List catalog items
-- [`catalogItemsUpdateCatalogItem`](docs/sdks/catalogitems/README.md#updatecatalogitem) - Update a catalog item
-- [`clientsCreateClient`](docs/sdks/clients/README.md#createclient) - Create a client
-- [`clientsDeleteClient`](docs/sdks/clients/README.md#deleteclient) - Delete a client
-- [`clientsGetClient`](docs/sdks/clients/README.md#getclient) - Get a client
-- [`clientsListClients`](docs/sdks/clients/README.md#listclients) - List clients
-- [`clientsUpdateClient`](docs/sdks/clients/README.md#updateclient) - Update a client
-- [`contactsCreateContact`](docs/sdks/contacts/README.md#createcontact) - Create a contact
-- [`contactsDeleteContact`](docs/sdks/contacts/README.md#deletecontact) - Delete a contact
-- [`contactsGetContact`](docs/sdks/contacts/README.md#getcontact) - Get a contact
-- [`contactsListContacts`](docs/sdks/contacts/README.md#listcontacts) - List contacts
-- [`contactsUpdateContact`](docs/sdks/contacts/README.md#updatecontact) - Update a contact
-- [`contractsCreateContract`](docs/sdks/contracts/README.md#createcontract) - Create a draft contract
-- [`contractsDeleteContract`](docs/sdks/contracts/README.md#deletecontract) - Delete a contract (only drafts)
-- [`contractsGetContract`](docs/sdks/contracts/README.md#getcontract) - Get a contract
-- [`contractsListContracts`](docs/sdks/contracts/README.md#listcontracts) - List contracts
-- [`contractsUpdateContract`](docs/sdks/contracts/README.md#updatecontract) - Update a contract (limited fields)
-- [`inquiriesCreateInquiry`](docs/sdks/inquiries/README.md#createinquiry) - Create an inquiry
-- [`inquiriesDeleteInquiry`](docs/sdks/inquiries/README.md#deleteinquiry) - Delete an inquiry
-- [`inquiriesGetInquiry`](docs/sdks/inquiries/README.md#getinquiry) - Get an inquiry
-- [`inquiriesListInquiries`](docs/sdks/inquiries/README.md#listinquiries) - List inquiries
-- [`inquiriesUpdateInquiry`](docs/sdks/inquiries/README.md#updateinquiry) - Update an inquiry
-- [`invoicesCreateInvoice`](docs/sdks/invoices/README.md#createinvoice) - Create an invoice
-- [`invoicesDeleteInvoice`](docs/sdks/invoices/README.md#deleteinvoice) - Delete an invoice (only drafts)
-- [`invoicesGetInvoice`](docs/sdks/invoices/README.md#getinvoice) - Get an invoice
-- [`invoicesListInvoices`](docs/sdks/invoices/README.md#listinvoices) - List invoices
-- [`invoicesUpdateInvoice`](docs/sdks/invoices/README.md#updateinvoice) - Update an invoice (line items not editable in v1)
-- [`milestonesCreateMilestone`](docs/sdks/milestones/README.md#createmilestone) - Create a milestone
-- [`milestonesDeleteMilestone`](docs/sdks/milestones/README.md#deletemilestone) - Delete a milestone
-- [`milestonesGetMilestone`](docs/sdks/milestones/README.md#getmilestone) - Get a milestone
-- [`milestonesListMilestones`](docs/sdks/milestones/README.md#listmilestones) - List milestones
-- [`milestonesUpdateMilestone`](docs/sdks/milestones/README.md#updatemilestone) - Update a milestone
-- [`paymentsCreatePayment`](docs/sdks/payments/README.md#createpayment) - Record a manual payment
-- [`paymentsGetPayment`](docs/sdks/payments/README.md#getpayment) - Get a payment
-- [`paymentsListPayments`](docs/sdks/payments/README.md#listpayments) - List payments
-- [`paymentsUpdatePayment`](docs/sdks/payments/README.md#updatepayment) - Update a payment (notes/reference only — payments are otherwise immutable)
-- [`payoutsGetPayout`](docs/sdks/payouts/README.md#getpayout) - Get a payout
-- [`payoutsListPayouts`](docs/sdks/payouts/README.md#listpayouts) - List payouts
-- [`projectsCreateProject`](docs/sdks/projects/README.md#createproject) - Create a project
-- [`projectsDeleteProject`](docs/sdks/projects/README.md#deleteproject) - Delete a project
-- [`projectsGetProject`](docs/sdks/projects/README.md#getproject) - Get a project
-- [`projectsListProjects`](docs/sdks/projects/README.md#listprojects) - List projects
-- [`projectsUpdateProject`](docs/sdks/projects/README.md#updateproject) - Update a project
-- [`proposalsCreateProposal`](docs/sdks/proposals/README.md#createproposal) - Create a proposal (metadata only — rich-text content is dashboard-managed)
-- [`proposalsDeleteProposal`](docs/sdks/proposals/README.md#deleteproposal) - Delete a proposal (only drafts)
-- [`proposalsGetProposal`](docs/sdks/proposals/README.md#getproposal) - Get a proposal
-- [`proposalsListProposals`](docs/sdks/proposals/README.md#listproposals) - List proposals
-- [`proposalsUpdateProposal`](docs/sdks/proposals/README.md#updateproposal) - Update a proposal
-- [`timeEntriesCreateTimeEntry`](docs/sdks/timeentries/README.md#createtimeentry) - Create a time entry
-- [`timeEntriesDeleteTimeEntry`](docs/sdks/timeentries/README.md#deletetimeentry) - Delete a time entry
-- [`timeEntriesGetTimeEntry`](docs/sdks/timeentries/README.md#gettimeentry) - Get a time entry
-- [`timeEntriesListTimeEntries`](docs/sdks/timeentries/README.md#listtimeentries) - List time entries
-- [`timeEntriesUpdateTimeEntry`](docs/sdks/timeentries/README.md#updatetimeentry) - Update a time entry
-- [`transactionsCreateTransaction`](docs/sdks/transactions/README.md#createtransaction) - Create a transaction (expense or charge)
-- [`transactionsDeleteTransaction`](docs/sdks/transactions/README.md#deletetransaction) - Delete a transaction
-- [`transactionsGetTransaction`](docs/sdks/transactions/README.md#gettransaction) - Get a transaction
-- [`transactionsListTransactions`](docs/sdks/transactions/README.md#listtransactions) - List transactions
-- [`transactionsUpdateTransaction`](docs/sdks/transactions/README.md#updatetransaction) - Update a transaction
-- [`webhooksCreateWebhook`](docs/sdks/webhooks/README.md#createwebhook) - Subscribe to events
-- [`webhooksDeleteWebhook`](docs/sdks/webhooks/README.md#deletewebhook) - Delete a webhook
-- [`webhooksGetWebhook`](docs/sdks/webhooks/README.md#getwebhook) - Get a webhook
-- [`webhooksListWebhooks`](docs/sdks/webhooks/README.md#listwebhooks) - List webhook subscriptions
-- [`webhooksUpdateWebhook`](docs/sdks/webhooks/README.md#updatewebhook) - Update a webhook
+- [`calendarEventsCreate`](docs/sdks/calendarevents/README.md#create) - Create a calendar event
+- [`calendarEventsDelete`](docs/sdks/calendarevents/README.md#delete) - Delete a calendar event
+- [`calendarEventsGet`](docs/sdks/calendarevents/README.md#get) - Get a calendar event
+- [`calendarEventsList`](docs/sdks/calendarevents/README.md#list) - List calendar events
+- [`calendarEventsUpdate`](docs/sdks/calendarevents/README.md#update) - Update a calendar event
+- [`catalogItemsCreate`](docs/sdks/catalogitems/README.md#create) - Create a catalog item
+- [`catalogItemsDelete`](docs/sdks/catalogitems/README.md#delete) - Delete a catalog item
+- [`catalogItemsGet`](docs/sdks/catalogitems/README.md#get) - Get a catalog item
+- [`catalogItemsList`](docs/sdks/catalogitems/README.md#list) - List catalog items
+- [`catalogItemsUpdate`](docs/sdks/catalogitems/README.md#update) - Update a catalog item
+- [`clientsCreate`](docs/sdks/clients/README.md#create) - Create a client
+- [`clientsDelete`](docs/sdks/clients/README.md#delete) - Delete a client
+- [`clientsGet`](docs/sdks/clients/README.md#get) - Get a client
+- [`clientsList`](docs/sdks/clients/README.md#list) - List clients
+- [`clientsUpdate`](docs/sdks/clients/README.md#update) - Update a client
+- [`contactsCreate`](docs/sdks/contacts/README.md#create) - Create a contact
+- [`contactsDelete`](docs/sdks/contacts/README.md#delete) - Delete a contact
+- [`contactsGet`](docs/sdks/contacts/README.md#get) - Get a contact
+- [`contactsList`](docs/sdks/contacts/README.md#list) - List contacts
+- [`contactsUpdate`](docs/sdks/contacts/README.md#update) - Update a contact
+- [`contractsCreate`](docs/sdks/contracts/README.md#create) - Create a draft contract
+- [`contractsDelete`](docs/sdks/contracts/README.md#delete) - Delete a contract (only drafts)
+- [`contractsGet`](docs/sdks/contracts/README.md#get) - Get a contract
+- [`contractsList`](docs/sdks/contracts/README.md#list) - List contracts
+- [`contractsUpdate`](docs/sdks/contracts/README.md#update) - Update a contract (limited fields)
+- [`inquiriesCreate`](docs/sdks/inquiries/README.md#create) - Create an inquiry
+- [`inquiriesDelete`](docs/sdks/inquiries/README.md#delete) - Delete an inquiry
+- [`inquiriesGet`](docs/sdks/inquiries/README.md#get) - Get an inquiry
+- [`inquiriesList`](docs/sdks/inquiries/README.md#list) - List inquiries
+- [`inquiriesUpdate`](docs/sdks/inquiries/README.md#update) - Update an inquiry
+- [`invoicesCreate`](docs/sdks/invoices/README.md#create) - Create an invoice
+- [`invoicesDelete`](docs/sdks/invoices/README.md#delete) - Delete an invoice (only drafts)
+- [`invoicesGet`](docs/sdks/invoices/README.md#get) - Get an invoice
+- [`invoicesList`](docs/sdks/invoices/README.md#list) - List invoices
+- [`invoicesUpdate`](docs/sdks/invoices/README.md#update) - Update an invoice (line items not editable in v1)
+- [`milestonesCreate`](docs/sdks/milestones/README.md#create) - Create a milestone
+- [`milestonesDelete`](docs/sdks/milestones/README.md#delete) - Delete a milestone
+- [`milestonesGet`](docs/sdks/milestones/README.md#get) - Get a milestone
+- [`milestonesList`](docs/sdks/milestones/README.md#list) - List milestones
+- [`milestonesUpdate`](docs/sdks/milestones/README.md#update) - Update a milestone
+- [`paymentsCreate`](docs/sdks/payments/README.md#create) - Record a manual payment
+- [`paymentsGet`](docs/sdks/payments/README.md#get) - Get a payment
+- [`paymentsList`](docs/sdks/payments/README.md#list) - List payments
+- [`paymentsUpdate`](docs/sdks/payments/README.md#update) - Update a payment (notes/reference only — payments are otherwise immutable)
+- [`payoutsGet`](docs/sdks/payouts/README.md#get) - Get a payout
+- [`payoutsList`](docs/sdks/payouts/README.md#list) - List payouts
+- [`projectsCreate`](docs/sdks/projects/README.md#create) - Create a project
+- [`projectsDelete`](docs/sdks/projects/README.md#delete) - Delete a project
+- [`projectsGet`](docs/sdks/projects/README.md#get) - Get a project
+- [`projectsList`](docs/sdks/projects/README.md#list) - List projects
+- [`projectsUpdate`](docs/sdks/projects/README.md#update) - Update a project
+- [`proposalsCreate`](docs/sdks/proposals/README.md#create) - Create a proposal (metadata only — rich-text content is dashboard-managed)
+- [`proposalsDelete`](docs/sdks/proposals/README.md#delete) - Delete a proposal (only drafts)
+- [`proposalsGet`](docs/sdks/proposals/README.md#get) - Get a proposal
+- [`proposalsList`](docs/sdks/proposals/README.md#list) - List proposals
+- [`proposalsUpdate`](docs/sdks/proposals/README.md#update) - Update a proposal
+- [`timeEntriesCreate`](docs/sdks/timeentries/README.md#create) - Create a time entry
+- [`timeEntriesDelete`](docs/sdks/timeentries/README.md#delete) - Delete a time entry
+- [`timeEntriesGet`](docs/sdks/timeentries/README.md#get) - Get a time entry
+- [`timeEntriesList`](docs/sdks/timeentries/README.md#list) - List time entries
+- [`timeEntriesUpdate`](docs/sdks/timeentries/README.md#update) - Update a time entry
+- [`transactionsCreate`](docs/sdks/transactions/README.md#create) - Create a transaction (expense or charge)
+- [`transactionsDelete`](docs/sdks/transactions/README.md#delete) - Delete a transaction
+- [`transactionsGet`](docs/sdks/transactions/README.md#get) - Get a transaction
+- [`transactionsList`](docs/sdks/transactions/README.md#list) - List transactions
+- [`transactionsUpdate`](docs/sdks/transactions/README.md#update) - Update a transaction
+- [`webhooksCreate`](docs/sdks/webhooks/README.md#create) - Subscribe to events
+- [`webhooksDelete`](docs/sdks/webhooks/README.md#delete) - Delete a webhook
+- [`webhooksGet`](docs/sdks/webhooks/README.md#get) - Get a webhook
+- [`webhooksList`](docs/sdks/webhooks/README.md#list) - List webhook subscriptions
+- [`webhooksUpdate`](docs/sdks/webhooks/README.md#update) - Update a webhook
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
 
+<!-- Start Pagination [pagination] -->
+## Pagination
+
+Some of the endpoints in this SDK support pagination. To use pagination, you
+make your SDK calls as usual, but the returned response object will also be an
+async iterable that can be consumed using the [`for await...of`][for-await-of]
+syntax.
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+
+Here's an example of one such pagination call:
+
+```typescript
+import { ClientCasa } from "@clientcasa/sdk";
+
+const clientCasa = new ClientCasa();
+
+async function run() {
+  const result = await clientCasa.clients.list({
+    apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
+  }, {});
+
+  for await (const page of result) {
+    console.log(page);
+  }
+}
+
+run();
+
+```
+<!-- End Pagination [pagination] -->
+
 <!-- Start Retries [retries] -->
 ## Retries
 
@@ -515,7 +570,7 @@ import { ClientCasa } from "@clientcasa/sdk";
 const clientCasa = new ClientCasa();
 
 async function run() {
-  const result = await clientCasa.clients.listClients(
+  const result = await clientCasa.clients.list(
     {
       apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
     },
@@ -534,7 +589,9 @@ async function run() {
     },
   );
 
-  console.log(result);
+  for await (const page of result) {
+    console.log(page);
+  }
 }
 
 run();
@@ -559,11 +616,13 @@ const clientCasa = new ClientCasa({
 });
 
 async function run() {
-  const result = await clientCasa.clients.listClients({
+  const result = await clientCasa.clients.list({
     apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
   }, {});
 
-  console.log(result);
+  for await (const page of result) {
+    console.log(page);
+  }
 }
 
 run();
@@ -576,13 +635,14 @@ run();
 
 [`ClientCasaError`](./src/models/errors/client-casa-error.ts) is the base class for all HTTP error responses. It has the following properties:
 
-| Property            | Type       | Description                                            |
-| ------------------- | ---------- | ------------------------------------------------------ |
-| `error.message`     | `string`   | Error message                                          |
-| `error.statusCode`  | `number`   | HTTP response status code eg `404`                     |
-| `error.headers`     | `Headers`  | HTTP response headers                                  |
-| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned. |
-| `error.rawResponse` | `Response` | Raw HTTP response                                      |
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
 ### Example
 ```typescript
@@ -593,17 +653,25 @@ const clientCasa = new ClientCasa();
 
 async function run() {
   try {
-    const result = await clientCasa.clients.listClients({
+    const result = await clientCasa.clients.list({
       apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
     }, {});
 
-    console.log(result);
+    for await (const page of result) {
+      console.log(page);
+    }
   } catch (error) {
+    // The base class for HTTP error responses
     if (error instanceof errors.ClientCasaError) {
       console.log(error.message);
       console.log(error.statusCode);
       console.log(error.body);
       console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.ApiError) {
+        console.log(error.data$.error); // models.ErrorT
+      }
     }
   }
 }
@@ -613,8 +681,9 @@ run();
 ```
 
 ### Error Classes
-**Primary error:**
+**Primary errors:**
 * [`ClientCasaError`](./src/models/errors/client-casa-error.ts): The base class for HTTP error responses.
+  * [`ApiError`](./src/models/errors/api-error.ts): Generic error.
 
 <details><summary>Less common errors (6)</summary>
 
@@ -648,11 +717,13 @@ const clientCasa = new ClientCasa({
 });
 
 async function run() {
-  const result = await clientCasa.clients.listClients({
+  const result = await clientCasa.clients.list({
     apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
   }, {});
 
-  console.log(result);
+  for await (const page of result) {
+    console.log(page);
+  }
 }
 
 run();