@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/accounts.md

@@ -0,0 +1,644 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.accounts`: Accounts
+
+16 operations (13 read, 1 write, 2 billable).
+
+No hand-written client covers this area. Call it through `g8.api.accounts.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [accounts.d.ts](accounts.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`generateOutreachPlan`](#op-generateoutreachplan) | `POST /api/v1/accounts/{account_id}/generate-outreach-plan` | billable | `sequences:run` | Generate Outreach Plan |
+| [`generateStakeholderOutreach`](#op-generatestakeholderoutreach) | `POST /api/v1/accounts/{account_id}/stakeholders/{stakeholder_id}/generate-outreach` | billable | `sequences:run` | Generate Stakeholder Outreach |
+| [`getAccountAdoptionMatrix`](#op-getaccountadoptionmatrix) | `GET /api/v1/accounts/{account_id}/adoption-matrix` | read | `companies:read` | Get Account Adoption Matrix |
+| [`getAccountBilling`](#op-getaccountbilling) | `GET /api/v1/accounts/{account_id}/billing` | read | `companies:read` | Get Account Billing |
+| [`getAccountCompanyContacts`](#op-getaccountcompanycontacts) | `GET /api/v1/accounts/{mashup_company_id}/contacts` | read | `companies:read` | Get Account Company Contacts |
+| [`getAccountIntentSignals`](#op-getaccountintentsignals) | `GET /api/v1/accounts/{account_id}/intent-signals` | read | `companies:read` | Get Account Intent Signals |
+| [`getAccountTrialJourney`](#op-getaccounttrialjourney) | `GET /api/v1/accounts/{account_id}/trial-journey` | read | `companies:read` | Get Account Trial Journey |
+| [`getIntentSignal`](#op-getintentsignal) | `GET /api/v1/accounts/intent-signal` | read | `companies:read` | Get Intent Signal |
+| [`getRevenueSummary`](#op-getrevenuesummary) | `GET /api/v1/accounts/revenue-summary` | read | `companies:read` | Get Revenue Summary |
+| [`getTrialDropoffFunnel`](#op-gettrialdropofffunnel) | `GET /api/v1/accounts/trial-dropoff-funnel` | read | `companies:read` | Get Trial Dropoff Funnel |
+| [`getTrialDropoffStep`](#op-gettrialdropoffstep) | `GET /api/v1/accounts/trial-dropoff-funnel/step` | read | `companies:read` | Get Trial Dropoff Step |
+| [`getTrialInsight`](#op-gettrialinsight) | `POST /api/v1/accounts/{account_id}/trial-insight` | write | `companies:write` | Get Trial Insight |
+| [`getTrialOverview`](#op-gettrialoverview) | `GET /api/v1/accounts/trial-overview` | read | `companies:read` | Get Trial Overview |
+| [`getTrialOverviewList`](#op-gettrialoverviewlist) | `GET /api/v1/accounts/trial-overview/list` | read | `companies:read` | Get Trial Overview List |
+| [`listAccountDocumentsBatch`](#op-listaccountdocumentsbatch) | `GET /api/v1/accounts/documents` | read | `companies:read` | List Account Documents Batch |
+| [`listAccountsEnriched`](#op-listaccountsenriched) | `GET /api/v1/accounts/enriched` | read | `companies:read` | List Accounts Enriched |
+
+---
+
+<a id="op-generateoutreachplan"></a>
+
+### `g8.api.accounts.generateOutreachPlan(input)`
+
+**Generate Outreach Plan**
+
+- HTTP: `POST /api/v1/accounts/{account_id}/generate-outreach-plan`
+- operationId: `generate_outreach_plan_accounts__account_id__generate_outreach_plan_post` (also callable as `g8.api.call("generate_outreach_plan_accounts__account_id__generate_outreach_plan_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `sequences:run`
+
+Draft a multi-touch outreach plan across every stakeholder on the account.
+
+THIS RUNS A LARGE LANGUAGE MODEL and spends credits (`billable`). It is a
+PLAN - days, channels and message outlines - and nothing is scheduled or
+sent.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.account_id` | `string` | yes | Account id: the account UUID or the company id. |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.accounts.generateOutreachPlan({ path: { account_id: "id" } });
+```
+
+---
+
+<a id="op-generatestakeholderoutreach"></a>
+
+### `g8.api.accounts.generateStakeholderOutreach(input)`
+
+**Generate Stakeholder Outreach**
+
+- HTTP: `POST /api/v1/accounts/{account_id}/stakeholders/{stakeholder_id}/generate-outreach`
+- operationId: `generate_stakeholder_outreach_accounts__account_id__stakeholders__stakeholder_id__generate_outreach_post` (also callable as `g8.api.call("generate_stakeholder_outreach_accounts__account_id__stakeholders__stakeholder_id__generate_outreach_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `sequences:run`
+
+Draft one email, LinkedIn message or call script for one stakeholder.
+
+THIS RUNS A LARGE LANGUAGE MODEL and spends credits, which is why it is
+tiered `billable`. It DRAFTS: nothing is sent. Grounded in the
+organisation's campaign brief and the stakeholder's own record; `warnings`
+says what was missing. 404 when the account or stakeholder is not found.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.account_id` | `string` | yes | Account id: the account UUID or the company id. |
+| `path.stakeholder_id` | `string` | yes | The stakeholder (contact) to write for. |
+| `body` | `AccountStakeholderOutreachRequest` | yes | Request body; fields below. |
+
+Body fields (`AccountStakeholderOutreachRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.type` | `"email" \| "linkedin" \| "call_script"` | yes | What to draft for this stakeholder. |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.accounts.generateStakeholderOutreach({
+  path: { account_id: "id", stakeholder_id: "id" },
+  body: { type: "email" },
+});
+```
+
+---
+
+<a id="op-getaccountadoptionmatrix"></a>
+
+### `g8.api.accounts.getAccountAdoptionMatrix(input)`
+
+**Get Account Adoption Matrix**
+
+- HTTP: `GET /api/v1/accounts/{account_id}/adoption-matrix`
+- operationId: `get_account_adoption_matrix_accounts__account_id__adoption_matrix_get` (also callable as `g8.api.call("get_account_adoption_matrix_accounts__account_id__adoption_matrix_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Which parts of the product this account has taken up, and which it has not.
+
+Open-shaped: the feature list grows with the product, and a dropped entry
+would read as "not adopted" rather than "not reported".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.account_id` | `string` | yes | Account id: the account UUID or the company id. |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getAccountAdoptionMatrix({ path: { account_id: "id" } });
+```
+
+---
+
+<a id="op-getaccountbilling"></a>
+
+### `g8.api.accounts.getAccountBilling(input)`
+
+**Get Account Billing**
+
+- HTTP: `GET /api/v1/accounts/{account_id}/billing`
+- operationId: `get_account_billing_accounts__account_id__billing_get` (also callable as `g8.api.call("get_account_billing_accounts__account_id__billing_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+What this account is paying: plan, next bill, and two years of invoices.
+
+Reads the billing provider's synced rows - it never calls the provider and
+never returns a provider credential. Missing billing data degrades to
+nulls and empty lists rather than a 404, so the shape is stable for an
+account that has never been billed.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.account_id` | `string` | yes | Account id: the account UUID or the company id. |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getAccountBilling({ path: { account_id: "id" } });
+```
+
+---
+
+<a id="op-getaccountcompanycontacts"></a>
+
+### `g8.api.accounts.getAccountCompanyContacts(input)`
+
+**Get Account Company Contacts**
+
+- HTTP: `GET /api/v1/accounts/{mashup_company_id}/contacts`
+- operationId: `get_account_company_contacts_accounts__mashup_company_id__contacts_get` (also callable as `g8.api.call("get_account_company_contacts_accounts__mashup_company_id__contacts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+The people at one TRIAL company - the account drawer's nested list.
+
+Account-native: it answers only for a company that is a trial account in
+your org, and is a 404 otherwise. `last_active` is always null (there is no
+per-contact product-usage join) and sparse fields are flagged in
+`data_availability`, so a blank reads as "unknown" rather than "empty".
+
+The per-record company gate is re-declared on the route on the SAME
+integer-id namespace the app's `verify_company_pk_access_dep` resolves.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.mashup_company_id` | `integer` | yes | The company's integer id. |
+| `query.limit` | `integer` | no | default `50` |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getAccountCompanyContacts({ path: { mashup_company_id: 123 } });
+```
+
+---
+
+<a id="op-getaccountintentsignals"></a>
+
+### `g8.api.accounts.getAccountIntentSignals(input)`
+
+**Get Account Intent Signals**
+
+- HTTP: `GET /api/v1/accounts/{account_id}/intent-signals`
+- operationId: `get_account_intent_signals_accounts__account_id__intent_signals_get` (also callable as `g8.api.call("get_account_intent_signals_accounts__account_id__intent_signals_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Buying-intent activity attributed to this account's domain.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.account_id` | `string` | yes | Account id: the account UUID or the company id. |
+| `query.limit` | `integer` | no | default `20` |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getAccountIntentSignals({ path: { account_id: "id" } });
+```
+
+---
+
+<a id="op-getaccounttrialjourney"></a>
+
+### `g8.api.accounts.getAccountTrialJourney(input)`
+
+**Get Account Trial Journey**
+
+- HTTP: `GET /api/v1/accounts/{account_id}/trial-journey`
+- operationId: `get_account_trial_journey_accounts__account_id__trial_journey_get` (also callable as `g8.api.call("get_account_trial_journey_accounts__account_id__trial_journey_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+What this account actually did during its trial, in order.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.account_id` | `string` | yes | Account id: the account UUID or the company id. |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getAccountTrialJourney({ path: { account_id: "id" } });
+```
+
+---
+
+<a id="op-getintentsignal"></a>
+
+### `g8.api.accounts.getIntentSignal(input?)`
+
+**Get Intent Signal**
+
+- HTTP: `GET /api/v1/accounts/intent-signal`
+- operationId: `get_intent_signal_accounts_intent_signal_get` (also callable as `g8.api.call("get_intent_signal_accounts_intent_signal_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Organisation-wide buying intent, from your own website visitors.
+
+The rollup behind the per-account `/accounts/{account_id}/intent-signals`.
+An organisation with no visitor data yet gets an honest empty state rather
+than zeros that read as "nobody is interested".
+
+**Input**: none.
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getIntentSignal();
+```
+
+---
+
+<a id="op-getrevenuesummary"></a>
+
+### `g8.api.accounts.getRevenueSummary(input?)`
+
+**Get Revenue Summary**
+
+- HTTP: `GET /api/v1/accounts/revenue-summary`
+- operationId: `get_revenue_summary_accounts_revenue_summary_get` (also callable as `g8.api.call("get_revenue_summary_accounts_revenue_summary_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+How many accounts sit in each revenue bucket.
+
+Uses the same status rule as `/accounts/enriched`, so the counts here and
+the rows there always agree - which is the whole point of reading it.
+
+**Input**: none.
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getRevenueSummary();
+```
+
+---
+
+<a id="op-gettrialdropofffunnel"></a>
+
+### `g8.api.accounts.getTrialDropoffFunnel(input?)`
+
+**Get Trial Dropoff Funnel**
+
+- HTTP: `GET /api/v1/accounts/trial-dropoff-funnel`
+- operationId: `get_trial_dropoff_funnel_accounts_trial_dropoff_funnel_get` (also callable as `g8.api.call("get_trial_dropoff_funnel_accounts_trial_dropoff_funnel_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Where trials stop, step by step.
+
+Rate-limited per caller on its own budget, separately from the insight
+route - it fans out across the org in Postgres and is the expensive read
+on this surface.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Window, in days. default `30` |
+| `query.limit` | `integer` | no | default `100` |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getTrialDropoffFunnel();
+```
+
+---
+
+<a id="op-gettrialdropoffstep"></a>
+
+### `g8.api.accounts.getTrialDropoffStep(input)`
+
+**Get Trial Dropoff Step**
+
+- HTTP: `GET /api/v1/accounts/trial-dropoff-funnel/step`
+- operationId: `get_trial_dropoff_step_accounts_trial_dropoff_funnel_step_get` (also callable as `g8.api.call("get_trial_dropoff_step_accounts_trial_dropoff_funnel_step_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Who fell out at one step of the funnel, and what they had done first.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.step_key` | `string` | yes | The funnel step to drill into. |
+| `query.days` | `integer` | no | Window, in days. default `30` |
+| `query.limit` | `integer` | no | default `100` |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getTrialDropoffStep({ query: { step_key: "example" } });
+```
+
+---
+
+<a id="op-gettrialinsight"></a>
+
+### `g8.api.accounts.getTrialInsight(input)`
+
+**Get Trial Insight**
+
+- HTTP: `POST /api/v1/accounts/{account_id}/trial-insight`
+- operationId: `get_trial_insight_accounts__account_id__trial_insight_post` (also callable as `g8.api.call("get_trial_insight_accounts__account_id__trial_insight_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `companies:write`
+
+Why this trial is stalling, and the next thing to try.
+
+POST only because it is rate-limited per caller and bounded work, NOT
+because it changes anything: it is rule-based, spends no credits, sends
+nothing and writes nothing. It is classified read-only for exactly that
+reason, so a read-only key can call it - which matters, because it is the
+diagnosis you want before touching a customer.
+
+429 when the hourly budget is exhausted.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.account_id` | `string` | yes | Account id: the account UUID or the company id. |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getTrialInsight({ path: { account_id: "id" } });
+```
+
+---
+
+<a id="op-gettrialoverview"></a>
+
+### `g8.api.accounts.getTrialOverview(input?)`
+
+**Get Trial Overview**
+
+- HTTP: `GET /api/v1/accounts/trial-overview`
+- operationId: `get_trial_overview_accounts_trial_overview_get` (also callable as `g8.api.call("get_trial_overview_accounts_trial_overview_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Headline trial numbers for your own organisation.
+
+Carries an honest `data_availability` map: a block whose source table is
+not populated reports that it has no data rather than a misleading zero.
+Read it before treating any number here as a fact.
+
+Always your own tenant. The app's cross-tenant `scope=platform` branch is
+graph8-staff tooling and is not reachable through this API.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.view` | `string` | no | Count trials by company or by contact. default `"companies"` |
+
+**Returns** `ApiResponse_OrgPayload_`: the envelope `{ data: OrgPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getTrialOverview();
+```
+
+---
+
+<a id="op-gettrialoverviewlist"></a>
+
+### `g8.api.accounts.getTrialOverviewList(input?)`
+
+**Get Trial Overview List**
+
+- HTTP: `GET /api/v1/accounts/trial-overview/list`
+- operationId: `get_trial_overview_list_accounts_trial_overview_list_get` (also callable as `g8.api.call("get_trial_overview_list_accounts_trial_overview_list_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+The records behind one headline number.
+
+Built from the same predicates as the aggregate, so the list and the count
+cannot drift. When the source table is unpopulated it answers
+`data_available=false` with an empty list - again, not a misleading zero.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.metric` | `string` | no | Which headline number to drill into. default `""` |
+| `query.view` | `string` | no | Companies or contacts. default `"companies"` |
+| `query.status` | `string` | no | Active or expired trials. default `"active"` |
+| `query.segment` | `string` | no | Enrichment segment, when `view=contacts`. default `"all"` |
+| `query.limit` | `integer` | no | default `100` |
+
+**Returns** `ApiResponse_OrgListPayload_`: the envelope `{ data: OrgListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`OrgListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.getTrialOverviewList();
+```
+
+---
+
+<a id="op-listaccountdocumentsbatch"></a>
+
+### `g8.api.accounts.listAccountDocumentsBatch(input)`
+
+**List Account Documents Batch**
+
+- HTTP: `GET /api/v1/accounts/documents`
+- operationId: `list_account_documents_batch_accounts_documents_get` (also callable as `g8.api.call("list_account_documents_batch_accounts_documents_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Documents for MANY accounts in one call, grouped by account.
+
+Account-native: it resolves ids across both the account and company id
+namespaces and folds workflow steps into the result. Scoped - an id the
+caller cannot see is dropped from the response rather than 403ing the
+whole batch.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.account_ids` | `string` | yes | Comma-separated account ids. The batch ceiling is the app's own. |
+| `query.folder` | `string \| null` | no | Only documents in this folder. |
+| `query.include_content` | `boolean` | no | Include the full document bodies. Off by default because the payload grows by orders of magnitude when it is on. default `false` |
+
+**Returns** `ApiResponse_OrgListPayload_`: the envelope `{ data: OrgListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`OrgListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.listAccountDocumentsBatch({ query: { account_ids: "id" } });
+```
+
+---
+
+<a id="op-listaccountsenriched"></a>
+
+### `g8.api.accounts.listAccountsEnriched(input?)`
+
+**List Accounts Enriched**
+
+- HTTP: `GET /api/v1/accounts/enriched`
+- operationId: `list_accounts_enriched_accounts_enriched_get` (also callable as `g8.api.call("list_accounts_enriched_accounts_enriched_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Accounts with their revenue and CRM overlays joined on.
+
+The account-native read, and the one with no `/companies` twin: it joins
+the canonical company record to `cb_accounts` (Stripe, MRR, churn) and to
+the ABM overlay, coalescing the fields that appear on more than one of
+them. Scoped to what the caller may see.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.skip` | `integer` | no | default `0` |
+| `query.limit` | `integer` | no | default `1000` |
+| `query.search` | `string \| null` | no | Match on company name or domain. |
+| `query.status` | `string \| null` | no | Lifecycle status, e.g. `trial` or `customer`. |
+| `query.lifecycle_id` | `string \| null` | no | Filter to one lifecycle stage. |
+| `query.website_status` | `string \| null` | no | Filter on website-check state. |
+| `query.in_pipeline` | `boolean` | no | Only accounts with an open deal. default `false` |
+| `query.include_attribution` | `boolean` | no | Include first-touch attribution. default `false` |
+| `query.canonical_trial_cohort` | `boolean` | no | Use the same trial cohort `/accounts/trial-overview` uses, so the rows here and the counts there agree. Off by default, matching the app. default `false` |
+| `query.include_sessions` | `boolean` | no | Attach recent product-session links. default `false` |
+
+**Returns** `ApiResponse_OrgListPayload_`: the envelope `{ data: OrgListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`OrgListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.accounts.listAccountsEnriched();
+```