@graph8/sdk 0.245.0 → 0.260.0

package/docs/api/teamMembers.md

@@ -0,0 +1,1040 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.teamMembers`: Team members
+
+21 operations (7 read, 8 write, 2 destructive, 3 billable, 1 external).
+
+No hand-written client covers this area. Call it through `g8.api.teamMembers.*` 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: [teamMembers.d.ts](teamMembers.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`cloneTeamMember`](#op-cloneteammember) | `POST /api/v1/team-members/{team_member_id}/clone` | write | `team:write` | Clone Team Member |
+| [`createTeamMember`](#op-createteammember) | `POST /api/v1/team-members` | write | `team:write` | Create Team Member |
+| [`createTeamMemberNote`](#op-createteammembernote) | `POST /api/v1/team-members/{team_member_id}/notes` | write | `team:write` | Create Team Member Note |
+| [`deleteTeamMember`](#op-deleteteammember) | `DELETE /api/v1/team-members/{team_member_id}` | destructive | `team:delete` | Delete Team Member |
+| [`deleteTeamMemberNote`](#op-deleteteammembernote) | `DELETE /api/v1/team-members/{team_member_id}/notes/{note_id}` | destructive | `team:delete` | Delete Team Member Note |
+| [`enrichMyProfileFromLinkedin`](#op-enrichmyprofilefromlinkedin) | `POST /api/v1/team-members/me/enrich-linkedin` | billable | `team:run` | Enrich My Profile From Linkedin |
+| [`enrichTeamMemberFromLinkedin`](#op-enrichteammemberfromlinkedin) | `POST /api/v1/team-members/{team_member_id}/enrich-linkedin` | billable | `team:run` | Enrich Team Member From Linkedin |
+| [`generateMemberPost`](#op-generatememberpost) | `POST /api/v1/team-members/{team_member_id}/generate-post` | billable | `team:run` | Generate Member Post |
+| [`getMyTeamMember`](#op-getmyteammember) | `GET /api/v1/team-members/me` | read | `team:read` | Get My Team Member |
+| [`getTeamMember`](#op-getteammember) | `GET /api/v1/team-members/{team_member_id}` | read | `team:read` | Get Team Member |
+| [`getTeamMemberCompanies`](#op-getteammembercompanies) | `GET /api/v1/team-members/{team_member_id}/companies` | read | `team:read` | Get Team Member Companies |
+| [`getTeamMemberContent`](#op-getteammembercontent) | `GET /api/v1/team-members/{team_member_id}/content` | read | `team:read` | Get Team Member Content |
+| [`getTeamMemberDeals`](#op-getteammemberdeals) | `GET /api/v1/team-members/{team_member_id}/deals` | read | `team:read` | Get Team Member Deals |
+| [`importMySocialProfile`](#op-importmysocialprofile) | `POST /api/v1/team-members/me/import-social` | write | `team:write` | Import My Social Profile |
+| [`listTeamMemberNotes`](#op-listteammembernotes) | `GET /api/v1/team-members/{team_member_id}/notes` | read | `team:read` | List Team Member Notes |
+| [`listTeamMembers`](#op-listteammembers) | `GET /api/v1/team-members` | read | `team:read` | List Team Members |
+| [`syncMyDesktopProfile`](#op-syncmydesktopprofile) | `POST /api/v1/team-members/me/sync-desktop-profile` | write | `team:write` | Sync My Desktop Profile |
+| [`syncTeamMembers`](#op-syncteammembers) | `POST /api/v1/team-members/sync` | external | `team:run` | Sync Team Members |
+| [`updateMyTeamMember`](#op-updatemyteammember) | `PATCH /api/v1/team-members/me` | write | `team:write` | Update My Team Member |
+| [`updateTeamMember`](#op-updateteammember) | `PATCH /api/v1/team-members/{team_member_id}` | write | `team:write` | Update Team Member |
+| [`updateTeamMemberNote`](#op-updateteammembernote) | `PUT /api/v1/team-members/{team_member_id}/notes/{note_id}` | write | `team:write` | Update Team Member Note |
+
+---
+
+<a id="op-cloneteammember"></a>
+
+### `g8.api.teamMembers.cloneTeamMember(input)`
+
+**Clone Team Member**
+
+- HTTP: `POST /api/v1/team-members/{team_member_id}/clone`
+- operationId: `clone_team_member_team_members__team_member_id__clone_post` (also callable as `g8.api.call("clone_team_member_team_members__team_member_id__clone_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `team:write`
+
+Create an AI clone of a member, carrying their voice and expertise.
+
+A NEW roster record, marked as a clone. The original is untouched, and the
+clone is excluded from the directory list unless `include_clones=true`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `body` | `MemberCloneRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberCloneRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string \| null` | no | Name for the clone. Defaults to '<Original Name> (AI Clone)'. |
+
+**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.teamMembers.cloneTeamMember({ path: { team_member_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-createteammember"></a>
+
+### `g8.api.teamMembers.createTeamMember(input)`
+
+**Create Team Member**
+
+- HTTP: `POST /api/v1/team-members`
+- operationId: `create_team_member_team_members_post` (also callable as `g8.api.call("create_team_member_team_members_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `team:write`
+
+Add someone to the roster.
+
+This creates a DIRECTORY record, not a login. It does not invite anyone,
+grant any permission, or put them in the identity provider - a member
+created here can own a deal and be assigned a task, and cannot sign in.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `MemberCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes | Full name. min length 1, max length 255 |
+| `body.department` | `string \| null` | no | Department. max length 100 |
+| `body.email` | `string (email) \| null` | no | Email address. |
+| `body.linkedin_url` | `string \| null` | no | LinkedIn profile URL. |
+| `body.phone` | `string \| null` | no | Phone number. max length 50 |
+| `body.title` | `string \| null` | no | Job title. max length 255 |
+
+**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.teamMembers.createTeamMember({ body: { name: "Example" } });
+```
+
+---
+
+<a id="op-createteammembernote"></a>
+
+### `g8.api.teamMembers.createTeamMemberNote(input)`
+
+**Create Team Member Note**
+
+- HTTP: `POST /api/v1/team-members/{team_member_id}/notes`
+- operationId: `create_team_member_note_team_members__team_member_id__notes_post` (also callable as `g8.api.call("create_team_member_note_team_members__team_member_id__notes_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `team:write`
+
+Leave an internal note on a member.
+
+MENTIONING SOMEONE NOTIFIES THEM. Mentions carry an id, a name and
+optionally an email, and the note itself is org-internal.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `body` | `MemberNoteCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberNoteCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.content` | `string` | yes | Note content. |
+| `body.mentioned_users` | `Array<MemberNoteMention>` | 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.teamMembers.createTeamMemberNote({ path: { team_member_id: "id" }, body: { content: "example" } });
+```
+
+---
+
+<a id="op-deleteteammember"></a>
+
+### `g8.api.teamMembers.deleteTeamMember(input)`
+
+**Delete Team Member**
+
+- HTTP: `DELETE /api/v1/team-members/{team_member_id}`
+- operationId: `delete_team_member_team_members__team_member_id__delete` (also callable as `g8.api.call("delete_team_member_team_members__team_member_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `team:delete`
+
+Remove someone from the roster.
+
+This does NOT remove them from the organisation or revoke their login -
+that is a different decision and it is not published on this API. What it
+does remove is the row that deals and tasks point at as their owner.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member 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.teamMembers.deleteTeamMember({ path: { team_member_id: "id" } });
+```
+
+---
+
+<a id="op-deleteteammembernote"></a>
+
+### `g8.api.teamMembers.deleteTeamMemberNote(input)`
+
+**Delete Team Member Note**
+
+- HTTP: `DELETE /api/v1/team-members/{team_member_id}/notes/{note_id}`
+- operationId: `delete_team_member_note_team_members__team_member_id__notes__note_id__delete` (also callable as `g8.api.call("delete_team_member_note_team_members__team_member_id__notes__note_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `team:delete`
+
+Delete a note.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `path.note_id` | `string` | yes | Note 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.teamMembers.deleteTeamMemberNote({ path: { team_member_id: "id", note_id: "id" } });
+```
+
+---
+
+<a id="op-enrichmyprofilefromlinkedin"></a>
+
+### `g8.api.teamMembers.enrichMyProfileFromLinkedin(input)`
+
+**Enrich My Profile From Linkedin**
+
+- HTTP: `POST /api/v1/team-members/me/enrich-linkedin`
+- operationId: `enrich_my_profile_from_linkedin_team_members_me_enrich_linkedin_post` (also callable as `g8.api.call("enrich_my_profile_from_linkedin_team_members_me_enrich_linkedin_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `team:run`
+
+Fill the key-holder's own record from their LinkedIn profile.
+
+THIS SPENDS ENRICHMENT CREDIT - it calls a paid provider - which is why it
+gates on `team:run` rather than plain write.
+
+`overwrite` defaults to false, so it fills EMPTY fields only. Turning it
+on replaces values the person wrote themselves.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `MemberLinkedInEnrichRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberLinkedInEnrichRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.linkedin_url` | `string` | yes | LinkedIn profile URL to enrich from. |
+| `body.overwrite` | `boolean` | no | Replace fields the person has already filled. Default fills empty fields only. default `false` |
+
+**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.teamMembers.enrichMyProfileFromLinkedin({ body: { linkedin_url: "https://example.com" } });
+```
+
+---
+
+<a id="op-enrichteammemberfromlinkedin"></a>
+
+### `g8.api.teamMembers.enrichTeamMemberFromLinkedin(input)`
+
+**Enrich Team Member From Linkedin**
+
+- HTTP: `POST /api/v1/team-members/{team_member_id}/enrich-linkedin`
+- operationId: `enrich_team_member_from_linkedin_team_members__team_member_id__enrich_linkedin_post` (also callable as `g8.api.call("enrich_team_member_from_linkedin_team_members__team_member_id__enrich_linkedin_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `team:run`
+
+Fill somebody else's record from their LinkedIn profile.
+
+THIS SPENDS ENRICHMENT CREDIT. `overwrite` defaults to false, so it fills
+empty fields only.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `body` | `MemberLinkedInEnrichRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberLinkedInEnrichRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.linkedin_url` | `string` | yes | LinkedIn profile URL to enrich from. |
+| `body.overwrite` | `boolean` | no | Replace fields the person has already filled. Default fills empty fields only. default `false` |
+
+**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.teamMembers.enrichTeamMemberFromLinkedin({
+  path: { team_member_id: "id" },
+  body: { linkedin_url: "https://example.com" },
+});
+```
+
+---
+
+<a id="op-generatememberpost"></a>
+
+### `g8.api.teamMembers.generateMemberPost(input)`
+
+**Generate Member Post**
+
+- HTTP: `POST /api/v1/team-members/{team_member_id}/generate-post`
+- operationId: `generate_member_post_team_members__team_member_id__generate_post_post` (also callable as `g8.api.call("generate_member_post_team_members__team_member_id__generate_post_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `team:run`
+
+Draft a social post in this member's voice.
+
+THIS RUNS A MODEL and therefore spends credits, which is why it gates on
+`team:run`. It DRAFTS: nothing is posted anywhere.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member 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.teamMembers.generateMemberPost({ path: { team_member_id: "id" } });
+```
+
+---
+
+<a id="op-getmyteammember"></a>
+
+### `g8.api.teamMembers.getMyTeamMember(input?)`
+
+**Get My Team Member**
+
+- HTTP: `GET /api/v1/team-members/me`
+- operationId: `get_my_team_member_team_members_me_get` (also callable as `g8.api.call("get_my_team_member_team_members_me_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `team:read`
+
+The roster record of the person who minted this key.
+
+AUTO-CREATES the record if that person has none yet, which is why an
+organisation-scoped key is refused here rather than being given a
+synthetic identity to create a record for.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.include_preferences` | `boolean` | no | Include the member's preferences blob. default `false` |
+
+**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.teamMembers.getMyTeamMember();
+```
+
+---
+
+<a id="op-getteammember"></a>
+
+### `g8.api.teamMembers.getTeamMember(input)`
+
+**Get Team Member**
+
+- HTTP: `GET /api/v1/team-members/{team_member_id}`
+- operationId: `get_team_member_team_members__team_member_id__get` (also callable as `g8.api.call("get_team_member_team_members__team_member_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `team:read`
+
+One roster record. A directory read, not an administrative one.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `query.include_preferences` | `boolean` | no | Include the member's preferences blob. default `false` |
+
+**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.teamMembers.getTeamMember({ path: { team_member_id: "id" } });
+```
+
+---
+
+<a id="op-getteammembercompanies"></a>
+
+### `g8.api.teamMembers.getTeamMemberCompanies(input)`
+
+**Get Team Member Companies**
+
+- HTTP: `GET /api/v1/team-members/{team_member_id}/companies`
+- operationId: `get_team_member_companies_team_members__team_member_id__companies_get` (also callable as `g8.api.call("get_team_member_companies_team_members__team_member_id__companies_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `team:read`
+
+The companies this person owns.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `query.limit` | `integer` | no | default `100` |
+| `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.teamMembers.getTeamMemberCompanies({ path: { team_member_id: "id" } });
+```
+
+---
+
+<a id="op-getteammembercontent"></a>
+
+### `g8.api.teamMembers.getTeamMemberContent(input)`
+
+**Get Team Member Content**
+
+- HTTP: `GET /api/v1/team-members/{team_member_id}/content`
+- operationId: `get_team_member_content_team_members__team_member_id__content_get` (also callable as `g8.api.call("get_team_member_content_team_members__team_member_id__content_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `team:read`
+
+Content written in this person's voice, including anything drafted for them.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `query.limit` | `integer` | no | default `100` |
+| `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.teamMembers.getTeamMemberContent({ path: { team_member_id: "id" } });
+```
+
+---
+
+<a id="op-getteammemberdeals"></a>
+
+### `g8.api.teamMembers.getTeamMemberDeals(input)`
+
+**Get Team Member Deals**
+
+- HTTP: `GET /api/v1/team-members/{team_member_id}/deals`
+- operationId: `get_team_member_deals_team_members__team_member_id__deals_get` (also callable as `g8.api.call("get_team_member_deals_team_members__team_member_id__deals_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `team:read`
+
+The deals this person owns. The quickest answer to "what is on X's plate".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `query.limit` | `integer` | no | default `100` |
+| `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.teamMembers.getTeamMemberDeals({ path: { team_member_id: "id" } });
+```
+
+---
+
+<a id="op-importmysocialprofile"></a>
+
+### `g8.api.teamMembers.importMySocialProfile(input)`
+
+**Import My Social Profile**
+
+- HTTP: `POST /api/v1/team-members/me/import-social`
+- operationId: `import_my_social_profile_team_members_me_import_social_post` (also callable as `g8.api.call("import_my_social_profile_team_members_me_import_social_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `team:write`
+
+Fill the key-holder's own record from a LinkedIn or Twitter profile.
+
+The profile arrives in the body - nothing is fetched and no credit is
+spent. EMPTY fields are filled; values the person wrote are kept. Skills
+MERGE into expertise (capped at 15), up to three `recent_posts` are
+appended to the writing samples (ten kept), and a sent `job_history`
+REPLACES the stored one.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `MemberSocialImportRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberSocialImportRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.platform` | `"linkedin" \| "twitter"` | yes | Where the profile came from. |
+| `body.profile_url` | `string` | yes | Profile URL. |
+| `body.about` | `string \| null` | no | Full bio / about section. |
+| `body.avatar_url` | `string \| null` | no | Profile picture URL. |
+| `body.bio` | `string \| null` | no | Twitter bio. |
+| `body.current_company` | `string \| null` | no | Current company name. |
+| `body.current_title` | `string \| null` | no | Current job title. |
+| `body.followers` | `string \| null` | no | Follower count. |
+| `body.following` | `string \| null` | no | Following count. |
+| `body.headline` | `string \| null` | no | LinkedIn headline or Twitter bio. |
+| `body.job_history` | `Array<MemberJobHistoryItem> \| null` | no | Full job history. REPLACES the stored history when sent. |
+| `body.location` | `string \| null` | no | Location. |
+| `body.name` | `string \| null` | no | Display name. |
+| `body.recent_posts` | `Array<Record<string, unknown>> \| null` | no | Recent posts, used as writing samples. Each needs `text`; `scraped_at` is optional. At most three are taken per call. |
+| `body.skills` | `Array<string> \| null` | no | Skills / expertise list. |
+| `body.username` | `string \| null` | no | Twitter username. |
+| `body.website` | `string \| null` | no | Personal website URL. |
+
+**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.teamMembers.importMySocialProfile({ body: { platform: "linkedin", profile_url: "https://example.com" } });
+```
+
+---
+
+<a id="op-listteammembernotes"></a>
+
+### `g8.api.teamMembers.listTeamMemberNotes(input)`
+
+**List Team Member Notes**
+
+- HTTP: `GET /api/v1/team-members/{team_member_id}/notes`
+- operationId: `list_team_member_notes_team_members__team_member_id__notes_get` (also callable as `g8.api.call("list_team_member_notes_team_members__team_member_id__notes_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `team:read`
+
+Internal notes colleagues keep on this person. Never customer-facing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+
+**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.teamMembers.listTeamMemberNotes({ path: { team_member_id: "id" } });
+```
+
+---
+
+<a id="op-listteammembers"></a>
+
+### `g8.api.teamMembers.listTeamMembers(input?)`
+
+**List Team Members**
+
+- HTTP: `GET /api/v1/team-members`
+- operationId: `list_team_members_team_members_get` (also callable as `g8.api.call("list_team_members_team_members_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `team:read`
+
+Everyone in the organisation's roster.
+
+On the app's DIRECTORY router, not its admin one: this is what every deal
+owner and task assignee picker resolves names through, so it is gated on
+`settings:read` OR `team:read` rather than on administrator access.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.status` | `string \| null` | no | Filter by status. |
+| `query.source` | `string \| null` | no | Filter by how the record was created: `propelauth`, `manual` or `clone`. |
+| `query.search` | `string \| null` | no | Match on name or email. |
+| `query.include_clones` | `boolean` | no | Include AI clone records. default `false` |
+| `query.sync` | `boolean` | no | Pull the identity provider's membership list before answering. Slower, and it WRITES: it creates a member row for anyone in the organisation who has none yet. default `false` |
+| `query.limit` | `integer` | no | default `100` |
+| `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.teamMembers.listTeamMembers();
+```
+
+---
+
+<a id="op-syncmydesktopprofile"></a>
+
+### `g8.api.teamMembers.syncMyDesktopProfile(input)`
+
+**Sync My Desktop Profile**
+
+- HTTP: `POST /api/v1/team-members/me/sync-desktop-profile`
+- operationId: `sync_my_desktop_profile_team_members_me_sync_desktop_profile_post` (also callable as `g8.api.call("sync_my_desktop_profile_team_members_me_sync_desktop_profile_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `team:write`
+
+Fill the key-holder's own record from a desktop-client profile record.
+
+The shape is the graph8 Desktop app's local profile record. EMPTY fields
+only - a value the person already has is never overwritten, including the
+job history. Skills and interests merge (capped at 15 each); education,
+follower counts, recommendations and accomplishments land in the member's
+preferences blob.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `MemberDesktopProfileSyncRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberDesktopProfileSyncRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.about` | `string \| null` | no |  |
+| `body.accomplishments_json` | `Array<Record<string, unknown>> \| null` | no |  |
+| `body.banner_photo_url` | `string \| null` | no |  |
+| `body.captured_at` | `string \| null` | no |  |
+| `body.connection_count` | `integer \| null` | no |  |
+| `body.education_json` | `Array<MemberDesktopEducationItem> \| null` | no |  |
+| `body.experiences_json` | `Array<MemberDesktopExperienceItem> \| null` | no |  |
+| `body.first_name` | `string \| null` | no |  |
+| `body.follower_count` | `integer \| null` | no |  |
+| `body.full_name` | `string \| null` | no |  |
+| `body.headline` | `string \| null` | no |  |
+| `body.interests_json` | `Array<MemberDesktopInterestItem> \| null` | no |  |
+| `body.is_hiring` | `boolean \| null` | no |  |
+| `body.is_open_to_work` | `boolean \| null` | no |  |
+| `body.last_name` | `string \| null` | no |  |
+| `body.linkedin_id` | `string \| null` | no |  |
+| `body.location` | `string \| null` | no |  |
+| `body.profile_photo_url` | `string \| null` | no |  |
+| `body.profile_url` | `string \| null` | no |  |
+| `body.recommendations_json` | `Array<Record<string, unknown>> \| null` | no |  |
+| `body.skills_json` | `Array<MemberDesktopSkillItem> \| 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.teamMembers.syncMyDesktopProfile({ body: {} });
+```
+
+---
+
+<a id="op-syncteammembers"></a>
+
+### `g8.api.teamMembers.syncTeamMembers(input?)`
+
+**Sync Team Members**
+
+- HTTP: `POST /api/v1/team-members/sync`
+- operationId: `sync_team_members_team_members_sync_post` (also callable as `g8.api.call("sync_team_members_team_members_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: `team:run`
+
+Create a roster record for every org member who has none yet.
+
+Reads the identity provider, so it gates on `team:run` rather than plain
+write. IDEMPOTENT: it only ever fills gaps, and the response says how many
+it created, so running it twice is a no-op rather than a duplicate.
+
+**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
+// 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.teamMembers.syncTeamMembers();
+```
+
+---
+
+<a id="op-updatemyteammember"></a>
+
+### `g8.api.teamMembers.updateMyTeamMember(input)`
+
+**Update My Team Member**
+
+- HTTP: `PATCH /api/v1/team-members/me`
+- operationId: `update_my_team_member_team_members_me_patch` (also callable as `g8.api.call("update_my_team_member_team_members_me_patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `team:write`
+
+Edit the key-holder's own roster record. Omitted fields are left alone.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `MemberUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.achievements` | `Array<string> \| null` | no |  |
+| `body.avatar_url` | `string \| null` | no |  |
+| `body.bio_full` | `string \| null` | no |  |
+| `body.bio_short` | `string \| null` | no |  |
+| `body.certifications` | `Array<string> \| null` | no |  |
+| `body.company` | `string \| null` | no | max length 255 |
+| `body.custom_notes` | `string \| null` | no |  |
+| `body.department` | `string \| null` | no | max length 100 |
+| `body.expertise_areas` | `Array<string> \| null` | no |  |
+| `body.languages` | `Array<string> \| null` | no |  |
+| `body.linkedin_url` | `string \| null` | no |  |
+| `body.name` | `string \| null` | no | min length 1, max length 255 |
+| `body.personal_interests` | `Array<string> \| null` | no |  |
+| `body.personal_website` | `string \| null` | no |  |
+| `body.phone` | `string \| null` | no | max length 50 |
+| `body.preferences` | `Record<string, unknown> \| null` | no | Merged into the member's preferences blob, key by key. |
+| `body.responsibilities` | `string \| null` | no |  |
+| `body.timezone` | `string \| null` | no | max length 100 |
+| `body.title` | `string \| null` | no | max length 255 |
+| `body.tools_platforms` | `Array<string> \| null` | no |  |
+| `body.topics_of_interest` | `Array<string> \| null` | no |  |
+| `body.twitter_url` | `string \| null` | no |  |
+| `body.voice_tone` | `string \| null` | no | max length 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.teamMembers.updateMyTeamMember({ body: {} });
+```
+
+---
+
+<a id="op-updateteammember"></a>
+
+### `g8.api.teamMembers.updateTeamMember(input)`
+
+**Update Team Member**
+
+- HTTP: `PATCH /api/v1/team-members/{team_member_id}`
+- operationId: `update_team_member_team_members__team_member_id__patch` (also callable as `g8.api.call("update_team_member_team_members__team_member_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `team:write`
+
+Edit somebody else's roster record. Omitted fields are left alone.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `body` | `MemberUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.achievements` | `Array<string> \| null` | no |  |
+| `body.avatar_url` | `string \| null` | no |  |
+| `body.bio_full` | `string \| null` | no |  |
+| `body.bio_short` | `string \| null` | no |  |
+| `body.certifications` | `Array<string> \| null` | no |  |
+| `body.company` | `string \| null` | no | max length 255 |
+| `body.custom_notes` | `string \| null` | no |  |
+| `body.department` | `string \| null` | no | max length 100 |
+| `body.expertise_areas` | `Array<string> \| null` | no |  |
+| `body.languages` | `Array<string> \| null` | no |  |
+| `body.linkedin_url` | `string \| null` | no |  |
+| `body.name` | `string \| null` | no | min length 1, max length 255 |
+| `body.personal_interests` | `Array<string> \| null` | no |  |
+| `body.personal_website` | `string \| null` | no |  |
+| `body.phone` | `string \| null` | no | max length 50 |
+| `body.preferences` | `Record<string, unknown> \| null` | no | Merged into the member's preferences blob, key by key. |
+| `body.responsibilities` | `string \| null` | no |  |
+| `body.timezone` | `string \| null` | no | max length 100 |
+| `body.title` | `string \| null` | no | max length 255 |
+| `body.tools_platforms` | `Array<string> \| null` | no |  |
+| `body.topics_of_interest` | `Array<string> \| null` | no |  |
+| `body.twitter_url` | `string \| null` | no |  |
+| `body.voice_tone` | `string \| null` | no | max length 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.teamMembers.updateTeamMember({ path: { team_member_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updateteammembernote"></a>
+
+### `g8.api.teamMembers.updateTeamMemberNote(input)`
+
+**Update Team Member Note**
+
+- HTTP: `PUT /api/v1/team-members/{team_member_id}/notes/{note_id}`
+- operationId: `update_team_member_note_team_members__team_member_id__notes__note_id__put` (also callable as `g8.api.call("update_team_member_note_team_members__team_member_id__notes__note_id__put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `team:write`
+
+Rewrite a note. `content` REPLACES the whole body rather than appending.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.team_member_id` | `string` | yes | Team member id. |
+| `path.note_id` | `string` | yes | Note id. |
+| `body` | `MemberNoteUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`MemberNoteUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.content` | `string` | yes | Updated note content. |
+| `body.mentioned_users` | `Array<MemberNoteMention>` | 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.teamMembers.updateTeamMemberNote({
+  path: { team_member_id: "id", note_id: "id" },
+  body: { content: "example" },
+});
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-memberdesktopeducationitem"></a>
+
+### `MemberDesktopEducationItem`
+
+Mirrors `team_members.DesktopEducationItem`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `dates` | `string \| null` | no |  |
+| `degree` | `string \| null` | no |  |
+| `field` | `string \| null` | no |  |
+| `school` | `string \| null` | no |  |
+
+<a id="type-memberdesktopexperienceitem"></a>
+
+### `MemberDesktopExperienceItem`
+
+Mirrors `team_members.DesktopExperienceItem`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `company` | `string \| null` | no |  |
+| `companyUrl` | `string \| null` | no |  |
+| `dates` | `string \| null` | no | `<start> - <end>`; an end of `Present` marks the current role. |
+| `description` | `string \| null` | no |  |
+| `duration` | `string \| null` | no |  |
+| `employment_type` | `string \| null` | no |  |
+| `location` | `string \| null` | no |  |
+| `title` | `string \| null` | no |  |
+
+<a id="type-memberdesktopinterestitem"></a>
+
+### `MemberDesktopInterestItem`
+
+Mirrors `team_members.DesktopInterestItem`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `name` | `string` | yes |  |
+| `type` | `string \| null` | no |  |
+
+<a id="type-memberdesktopskillitem"></a>
+
+### `MemberDesktopSkillItem`
+
+Mirrors `team_members.DesktopSkillItem`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `name` | `string` | yes |  |
+| `endorsements` | `integer \| null` | no |  |
+
+<a id="type-memberjobhistoryitem"></a>
+
+### `MemberJobHistoryItem`
+
+Mirrors `team_members.JobHistoryItem`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `company` | `string \| null` | no |  |
+| `description` | `string \| null` | no |  |
+| `duration` | `string \| null` | no |  |
+| `end_date` | `string \| null` | no |  |
+| `is_current` | `boolean` | no | default `false` |
+| `location` | `string \| null` | no |  |
+| `start_date` | `string \| null` | no |  |
+| `title` | `string \| null` | no |  |
+
+<a id="type-membernotemention"></a>
+
+### `MemberNoteMention`
+
+Mirrors `team_members.TeamMemberMentionedUserDto`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `name` | `string` | yes |  |
+| `email` | `string \| null` | no |  |