@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/customerSuccess.md

@@ -0,0 +1,776 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.customerSuccess`: Customer success
+
+19 operations (10 read, 5 write, 2 destructive, 1 billable, 1 external).
+
+No hand-written client covers this area. Call it through `g8.api.customerSuccess.*` 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: [customerSuccess.d.ts](customerSuccess.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`archiveTranscript`](#op-archivetranscript) | `PATCH /api/v1/customer-success/transcripts/{transcript_id}/archive` | destructive | `companies:delete` | Archive Transcript |
+| [`connectDriveFolder`](#op-connectdrivefolder) | `POST /api/v1/customer-success/companies/{company_id}/drive-folder` | write | `companies:write` | Connect Drive Folder |
+| [`disconnectDriveFolder`](#op-disconnectdrivefolder) | `DELETE /api/v1/customer-success/companies/{company_id}/drive-folder` | destructive | `companies:delete` | Disconnect Drive Folder |
+| [`getBrief`](#op-getbrief) | `GET /api/v1/customer-success/companies/{company_id}/brief` | read | `companies:read` | Get Brief |
+| [`getCompanyContext`](#op-getcompanycontext) | `GET /api/v1/customer-success/companies/{company_id}/context` | read | `companies:read` | Get Company Context |
+| [`getCompanyInbox`](#op-getcompanyinbox) | `GET /api/v1/customer-success/companies/{company_id}/inbox` | read | `companies:read` | Get Company Inbox |
+| [`getContactInbox`](#op-getcontactinbox) | `GET /api/v1/customer-success/contacts/{contact_id}/inbox` | read | `companies:read` | Get Contact Inbox |
+| [`getDriveFolder`](#op-getdrivefolder) | `GET /api/v1/customer-success/companies/{company_id}/drive-folder` | read | `companies:read` | Get Drive Folder |
+| [`getDriveFolderFiles`](#op-getdrivefolderfiles) | `GET /api/v1/customer-success/companies/{company_id}/drive-folder-files` | read | `companies:read` | Get Drive Folder Files |
+| [`getTranscript`](#op-gettranscript) | `GET /api/v1/customer-success/companies/{company_id}/transcripts/{transcript_id}` | read | `companies:read` | Get Transcript |
+| [`linkTranscriptToAccount`](#op-linktranscripttoaccount) | `PATCH /api/v1/customer-success/transcripts/{transcript_id}/link` | write | `companies:write` | Link Transcript To Account |
+| [`linkTranscriptToMeeting`](#op-linktranscripttomeeting) | `PATCH /api/v1/customer-success/meetings/{meeting_id}/link-transcript` | write | `companies:write` | Link Transcript To Meeting |
+| [`listCompanyMeetings`](#op-listcompanymeetings) | `GET /api/v1/customer-success/companies/{company_id}/meetings` | read | `companies:read` | List Company Meetings |
+| [`listCompanyTranscripts`](#op-listcompanytranscripts) | `GET /api/v1/customer-success/companies/{company_id}/transcripts` | read | `companies:read` | List Company Transcripts |
+| [`listUnlinkedTranscripts`](#op-listunlinkedtranscripts) | `GET /api/v1/customer-success/companies/{company_id}/unlinked-transcripts` | read | `companies:read` | List Unlinked Transcripts |
+| [`synthesizeBrief`](#op-synthesizebrief) | `POST /api/v1/customer-success/companies/{company_id}/brief/synthesize` | billable | `knowledge:run` | Synthesize Brief |
+| [`triggerCompanySync`](#op-triggercompanysync) | `POST /api/v1/customer-success/companies/{company_id}/sync` | external | `integrations:run` | Trigger Company Sync |
+| [`unarchiveTranscript`](#op-unarchivetranscript) | `PATCH /api/v1/customer-success/transcripts/{transcript_id}/unarchive` | write | `companies:write` | Unarchive Transcript |
+| [`unlinkTranscriptFromMeeting`](#op-unlinktranscriptfrommeeting) | `PATCH /api/v1/customer-success/meetings/{meeting_id}/unlink-transcript` | write | `companies:write` | Unlink Transcript From Meeting |
+
+---
+
+<a id="op-archivetranscript"></a>
+
+### `g8.api.customerSuccess.archiveTranscript(input)`
+
+**Archive Transcript**
+
+- HTTP: `PATCH /api/v1/customer-success/transcripts/{transcript_id}/archive`
+- operationId: `archive_transcript_customer_success_transcripts__transcript_id__archive_patch` (also callable as `g8.api.call("archive_transcript_customer_success_transcripts__transcript_id__archive_patch", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `companies:delete`
+
+Take a transcript out of the client's view.
+
+REVERSIBLE - `/unarchive` puts it back, and nothing is deleted. It is
+still tiered `destructive`, because that is what the shared `/archive`
+rule derives for every archive route in the contract and an exception here
+would make the tier mean two things.
+
+No company gate on the route: this is addressed by transcript, not by
+company, so the caller's company scope is what authorises it - exactly as
+the app has it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.transcript_id` | `string` | yes | Transcript 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
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.customerSuccess.archiveTranscript({ path: { transcript_id: "id" } });
+```
+
+---
+
+<a id="op-connectdrivefolder"></a>
+
+### `g8.api.customerSuccess.connectDriveFolder(input)`
+
+**Connect Drive Folder**
+
+- HTTP: `POST /api/v1/customer-success/companies/{company_id}/drive-folder`
+- operationId: `connect_drive_folder_customer_success_companies__company_id__drive_folder_post` (also callable as `g8.api.call("connect_drive_folder_customer_success_companies__company_id__drive_folder_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `companies:write`
+
+Map a folder in the organisation's Google Drive to this client. OWNER/ADMIN.
+
+Uses the Workspace connection the organisation already has - no new grant
+is made. Mapping the same Drive folder again UPDATES it, and mapping a
+different folder to the same Library folder REPLACES that mapping. A sync
+is queued straight away so the files start importing. 400 when the
+company is not an active client.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | Company id. |
+| `body` | `CustomerSuccessDriveFolderConnectRequest` | yes | Request body; fields below. |
+
+Body fields (`CustomerSuccessDriveFolderConnectRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.folder_id` | `string` | yes | Google Drive folder id. |
+| `body.folder_name` | `string` | yes | Folder name, as shown in Drive. |
+| `body.label` | `string \| null` | no |  |
+| `body.library_folder_id` | `string \| null` | no | Library folder id. REPLACES any other mapping to the same Library folder. |
+| `body.library_folder_path` | `string \| null` | no |  |
+| `body.local_folder_key` | `string \| null` | no | Which Library folder the files land in. Derived when omitted. |
+| `body.local_folder_name` | `string \| null` | no |  |
+
+**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.customerSuccess.connectDriveFolder({
+  path: { company_id: "id" },
+  body: { folder_id: "id", folder_name: "Example" },
+});
+```
+
+---
+
+<a id="op-disconnectdrivefolder"></a>
+
+### `g8.api.customerSuccess.disconnectDriveFolder(input)`
+
+**Disconnect Drive Folder**
+
+- HTTP: `DELETE /api/v1/customer-success/companies/{company_id}/drive-folder`
+- operationId: `disconnect_drive_folder_customer_success_companies__company_id__drive_folder_delete` (also callable as `g8.api.call("disconnect_drive_folder_customer_success_companies__company_id__drive_folder_delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `companies:delete`
+
+Unmap Drive folders from this client. OWNER/ADMIN.
+
+WITH NO SELECTOR, EVERY MAPPING FOR THIS CLIENT IS REMOVED. With one or
+more selectors, only the mappings matching all of them are removed. The
+files in Drive, and anything already imported, are left alone.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | Company id. |
+| `query.folder_id` | `string \| null` | no | Select the mapping by Google Drive folder id. |
+| `query.local_folder_key` | `string \| null` | no | Select the mapping by Library folder key. |
+| `query.library_folder_id` | `string \| null` | no | Select the mapping by Library folder id. |
+| `query.library_folder_path` | `string \| null` | no | Select the mapping by Library folder path. |
+
+**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
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.customerSuccess.disconnectDriveFolder({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-getbrief"></a>
+
+### `g8.api.customerSuccess.getBrief(input)`
+
+**Get Brief**
+
+- HTTP: `GET /api/v1/customer-success/companies/{company_id}/brief`
+- operationId: `get_brief_customer_success_companies__company_id__brief_get` (also callable as `g8.api.call("get_brief_customer_success_companies__company_id__brief_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+The last brief written for this client. Reading it costs nothing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | 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.customerSuccess.getBrief({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-getcompanycontext"></a>
+
+### `g8.api.customerSuccess.getCompanyContext(input)`
+
+**Get Company Context**
+
+- HTTP: `GET /api/v1/customer-success/companies/{company_id}/context`
+- operationId: `get_company_context_customer_success_companies__company_id__context_get` (also callable as `g8.api.call("get_company_context_customer_success_companies__company_id__context_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Everything known about this client, in one read.
+
+The assembled picture - contacts, activity, brief state, linked records -
+rather than a single table. Open-shaped, because what belongs in "the
+context" grows with the product and a dropped section would read as
+"nothing there".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | 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.customerSuccess.getCompanyContext({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-getcompanyinbox"></a>
+
+### `g8.api.customerSuccess.getCompanyInbox(input)`
+
+**Get Company Inbox**
+
+- HTTP: `GET /api/v1/customer-success/companies/{company_id}/inbox`
+- operationId: `get_company_inbox_customer_success_companies__company_id__inbox_get` (also callable as `g8.api.call("get_company_inbox_customer_success_companies__company_id__inbox_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Every conversation with anyone at this company, across channels.
+
+The company-level view of the inbox: merged and ordered by date, rather
+than one thread per contact.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | Company id. |
+| `query.limit` | `integer` | no | default `50` |
+| `query.offset` | `integer` | no | default `0` |
+
+**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.customerSuccess.getCompanyInbox({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-getcontactinbox"></a>
+
+### `g8.api.customerSuccess.getContactInbox(input)`
+
+**Get Contact Inbox**
+
+- HTTP: `GET /api/v1/customer-success/contacts/{contact_id}/inbox`
+- operationId: `get_contact_inbox_customer_success_contacts__contact_id__inbox_get` (also callable as `g8.api.call("get_contact_inbox_customer_success_contacts__contact_id__inbox_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+The same rollup, narrowed to ONE person at the company.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.contact_id` | `string` | yes | Contact id. |
+| `query.limit` | `integer` | no | default `50` |
+| `query.offset` | `integer` | no | default `0` |
+
+**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.customerSuccess.getContactInbox({ path: { contact_id: "id" } });
+```
+
+---
+
+<a id="op-getdrivefolder"></a>
+
+### `g8.api.customerSuccess.getDriveFolder(input)`
+
+**Get Drive Folder**
+
+- HTTP: `GET /api/v1/customer-success/companies/{company_id}/drive-folder`
+- operationId: `get_drive_folder_customer_success_companies__company_id__drive_folder_get` (also callable as `g8.api.call("get_drive_folder_customer_success_companies__company_id__drive_folder_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+The client's primary mapped folder, its first 50 files, and every mapping.
+
+`connected=false` when nothing is mapped. When Drive cannot be reached
+the mapping is still returned, with `error` set and no files, rather
+than failing the read.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | 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.customerSuccess.getDriveFolder({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-getdrivefolderfiles"></a>
+
+### `g8.api.customerSuccess.getDriveFolderFiles(input)`
+
+**Get Drive Folder Files**
+
+- HTTP: `GET /api/v1/customer-success/companies/{company_id}/drive-folder-files`
+- operationId: `get_drive_folder_files_customer_success_companies__company_id__drive_folder_files_get` (also callable as `g8.api.call("get_drive_folder_files_customer_success_companies__company_id__drive_folder_files_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Files (up to 200) in ONE mapped folder.
+
+Pick the mapping with one selector, checked in this order: `folder_id`,
+`library_folder_id`, `library_folder_path`, `local_folder_key`. With none,
+the primary mapping is used.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | Company id. |
+| `query.folder_id` | `string \| null` | no | Select the mapping by Google Drive folder id. |
+| `query.local_folder_key` | `string \| null` | no | Select the mapping by Library folder key. |
+| `query.library_folder_id` | `string \| null` | no | Select the mapping by Library folder id. |
+| `query.library_folder_path` | `string \| null` | no | Select the mapping by Library folder path. |
+
+**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.customerSuccess.getDriveFolderFiles({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-gettranscript"></a>
+
+### `g8.api.customerSuccess.getTranscript(input)`
+
+**Get Transcript**
+
+- HTTP: `GET /api/v1/customer-success/companies/{company_id}/transcripts/{transcript_id}`
+- operationId: `get_transcript_customer_success_companies__company_id__transcripts__transcript_id__get` (also callable as `g8.api.call("get_transcript_customer_success_companies__company_id__transcripts__transcript_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+One transcript in full, with its participants.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | Company id. |
+| `path.transcript_id` | `string` | yes | Transcript 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.customerSuccess.getTranscript({ path: { company_id: "id", transcript_id: "id" } });
+```
+
+---
+
+<a id="op-linktranscripttoaccount"></a>
+
+### `g8.api.customerSuccess.linkTranscriptToAccount(input)`
+
+**Link Transcript To Account**
+
+- HTTP: `PATCH /api/v1/customer-success/transcripts/{transcript_id}/link`
+- operationId: `link_transcript_to_account_customer_success_transcripts__transcript_id__link_patch` (also callable as `g8.api.call("link_transcript_to_account_customer_success_transcripts__transcript_id__link_patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `companies:write`
+
+Attach a transcript to an account.
+
+This is what makes a call count: once linked, it feeds the context and the
+synthesised brief. Candidates come from
+`/customer-success/companies/{id}/unlinked-transcripts`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.transcript_id` | `string` | yes | Transcript id. |
+| `body` | `CustomerSuccessTranscriptLinkRequest` | yes | Request body; fields below. |
+
+Body fields (`CustomerSuccessTranscriptLinkRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.account_id` | `string` | yes | The account the transcript belongs to. |
+
+**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.customerSuccess.linkTranscriptToAccount({ path: { transcript_id: "id" }, body: { account_id: "id" } });
+```
+
+---
+
+<a id="op-linktranscripttomeeting"></a>
+
+### `g8.api.customerSuccess.linkTranscriptToMeeting(input)`
+
+**Link Transcript To Meeting**
+
+- HTTP: `PATCH /api/v1/customer-success/meetings/{meeting_id}/link-transcript`
+- operationId: `link_transcript_to_meeting_customer_success_meetings__meeting_id__link_transcript_patch` (also callable as `g8.api.call("link_transcript_to_meeting_customer_success_meetings__meeting_id__link_transcript_patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `companies:write`
+
+Say which transcript belongs to which meeting.
+
+Different from `/transcripts/{id}/link`: that one attaches a transcript to
+an ACCOUNT, this one attaches it to a specific calendar event. A
+transcript can need both.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.meeting_id` | `string` | yes | Calendar meeting id. |
+| `body` | `CustomerSuccessMeetingTranscriptLinkRequest` | yes | Request body; fields below. |
+
+Body fields (`CustomerSuccessMeetingTranscriptLinkRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.transcript_id` | `string` | yes | The transcript to attach to this meeting. |
+
+**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.customerSuccess.linkTranscriptToMeeting({ path: { meeting_id: "id" }, body: { transcript_id: "id" } });
+```
+
+---
+
+<a id="op-listcompanymeetings"></a>
+
+### `g8.api.customerSuccess.listCompanyMeetings(input)`
+
+**List Company Meetings**
+
+- HTTP: `GET /api/v1/customer-success/companies/{company_id}/meetings`
+- operationId: `list_company_meetings_customer_success_companies__company_id__meetings_get` (also callable as `g8.api.call("list_company_meetings_customer_success_companies__company_id__meetings_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Calendar meetings with this client, and which transcript each one has.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | Company id. |
+| `query.limit` | `integer` | no | default `50` |
+| `query.offset` | `integer` | no | default `0` |
+
+**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.customerSuccess.listCompanyMeetings({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-listcompanytranscripts"></a>
+
+### `g8.api.customerSuccess.listCompanyTranscripts(input)`
+
+**List Company Transcripts**
+
+- HTTP: `GET /api/v1/customer-success/companies/{company_id}/transcripts`
+- operationId: `list_company_transcripts_customer_success_companies__company_id__transcripts_get` (also callable as `g8.api.call("list_company_transcripts_customer_success_companies__company_id__transcripts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Call transcripts linked to this client. Archived ones are hidden by default.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | Company id. |
+| `query.participant_email` | `string \| null` | no | Only calls this person was on. |
+| `query.transcript_type` | `string \| null` | no | Filter by transcript kind. |
+| `query.include_archived` | `boolean` | no | Include archived transcripts. default `false` |
+| `query.limit` | `integer` | no | default `50` |
+| `query.offset` | `integer` | no | default `0` |
+
+**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.customerSuccess.listCompanyTranscripts({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-listunlinkedtranscripts"></a>
+
+### `g8.api.customerSuccess.listUnlinkedTranscripts(input)`
+
+**List Unlinked Transcripts**
+
+- HTTP: `GET /api/v1/customer-success/companies/{company_id}/unlinked-transcripts`
+- operationId: `list_unlinked_transcripts_customer_success_companies__company_id__unlinked_transcripts_get` (also callable as `g8.api.call("list_unlinked_transcripts_customer_success_companies__company_id__unlinked_transcripts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `companies:read`
+
+Transcripts that PROBABLY belong to this client but are not attached yet.
+
+The candidate list for `PATCH /customer-success/transcripts/{id}/link`.
+Attaching one is what makes it show up in the brief and the context.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | Company id. |
+| `query.date` | `string \| null` | no | Only transcripts from this date (YYYY-MM-DD). |
+| `query.limit` | `integer` | no | default `20` |
+
+**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.customerSuccess.listUnlinkedTranscripts({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-synthesizebrief"></a>
+
+### `g8.api.customerSuccess.synthesizeBrief(input)`
+
+**Synthesize Brief**
+
+- HTTP: `POST /api/v1/customer-success/companies/{company_id}/brief/synthesize`
+- operationId: `synthesize_brief_customer_success_companies__company_id__brief_synthesize_post` (also callable as `g8.api.call("synthesize_brief_customer_success_companies__company_id__brief_synthesize_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `knowledge:run`
+
+Write a fresh brief from everything currently known about this client.
+
+THIS RUNS A LARGE LANGUAGE MODEL and therefore spends credits - the
+handler calls the model directly and converts its failures into 502s. It
+is classified `billable` by an explicit rule for that reason: as a plain
+write it would make "spend model credits on every account we have" the
+same grant as "rename a company".
+
+502 when the model is unavailable, which is distinct from a 500: retry it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | 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.customerSuccess.synthesizeBrief({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-triggercompanysync"></a>
+
+### `g8.api.customerSuccess.triggerCompanySync(input)`
+
+**Trigger Company Sync**
+
+- HTTP: `POST /api/v1/customer-success/companies/{company_id}/sync`
+- operationId: `trigger_company_sync_customer_success_companies__company_id__sync_post` (also callable as `g8.api.call("trigger_company_sync_customer_success_companies__company_id__sync_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `integrations:run`
+
+Re-pull this client's context from the sources that feed it.
+
+Reaches outside graph8 for the meeting and transcript sources, which is
+why it gates on `integrations:run` rather than plain write. Call it when the
+context looks stale; it is otherwise on a schedule.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `string` | yes | 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
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.customerSuccess.triggerCompanySync({ path: { company_id: "id" } });
+```
+
+---
+
+<a id="op-unarchivetranscript"></a>
+
+### `g8.api.customerSuccess.unarchiveTranscript(input)`
+
+**Unarchive Transcript**
+
+- HTTP: `PATCH /api/v1/customer-success/transcripts/{transcript_id}/unarchive`
+- operationId: `unarchive_transcript_customer_success_transcripts__transcript_id__unarchive_patch` (also callable as `g8.api.call("unarchive_transcript_customer_success_transcripts__transcript_id__unarchive_patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `companies:write`
+
+Put an archived transcript back in the client's view.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.transcript_id` | `string` | yes | Transcript 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.customerSuccess.unarchiveTranscript({ path: { transcript_id: "id" } });
+```
+
+---
+
+<a id="op-unlinktranscriptfrommeeting"></a>
+
+### `g8.api.customerSuccess.unlinkTranscriptFromMeeting(input)`
+
+**Unlink Transcript From Meeting**
+
+- HTTP: `PATCH /api/v1/customer-success/meetings/{meeting_id}/unlink-transcript`
+- operationId: `unlink_transcript_from_meeting_customer_success_meetings__meeting_id__unlink_transcript_patch` (also callable as `g8.api.call("unlink_transcript_from_meeting_customer_success_meetings__meeting_id__unlink_transcript_patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `companies:write`
+
+Detach a transcript from a meeting. The transcript itself survives.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.meeting_id` | `string` | yes | Calendar meeting 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.customerSuccess.unlinkTranscriptFromMeeting({ path: { meeting_id: "id" } });
+```