@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/orgGovernance.md

@@ -0,0 +1,623 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.orgGovernance`: Org Governance
+
+17 operations (8 read, 6 write, 3 destructive).
+
+No hand-written client covers this area. Call it through `g8.api.orgGovernance.*` 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: [orgGovernance.d.ts](orgGovernance.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`assignSecurityRole`](#op-assignsecurityrole) | `PUT /api/v1/org/infrastructure/security-roles/{role_id}` | write | `account:write` | Assign Security Role |
+| [`blockAiConnection`](#op-blockaiconnection) | `POST /api/v1/org/ai-connections/{user_id}/blocks` | write | `account:write` | Block Ai Connection |
+| [`deleteAiConnectionActivity`](#op-deleteaiconnectionactivity) | `DELETE /api/v1/org/ai-connections/{user_id}/activity` | destructive | `account:delete` | Delete Ai Connection Activity |
+| [`getAiConnectionSummary`](#op-getaiconnectionsummary) | `GET /api/v1/org/ai-connections/{user_id}/summary` | read | `account:read` | Get Ai Connection Summary |
+| [`getAiConnectionsConfig`](#op-getaiconnectionsconfig) | `GET /api/v1/org/ai-connections/config` | read | `account:read` | Get Ai Connections Config |
+| [`getInfrastructureProfile`](#op-getinfrastructureprofile) | `GET /api/v1/org/infrastructure` | read | `account:read` | Get Infrastructure Profile |
+| [`getSuppressionSettings`](#op-getsuppressionsettings) | `GET /api/v1/org/suppression-settings` | read | `account:read` | Get Suppression Settings |
+| [`listAiConnectionCalls`](#op-listaiconnectioncalls) | `GET /api/v1/org/ai-connections/{user_id}/calls` | read | `account:read` | List Ai Connection Calls |
+| [`listAiConnections`](#op-listaiconnections) | `GET /api/v1/org/ai-connections` | read | `account:read` | List Ai Connections |
+| [`listRepLimits`](#op-listreplimits) | `GET /api/v1/org/rep-limits` | read | `account:read` | List Rep Limits |
+| [`listSecurityRoles`](#op-listsecurityroles) | `GET /api/v1/org/infrastructure/security-roles` | read | `account:read` | List Security Roles |
+| [`resumeAiConnection`](#op-resumeaiconnection) | `DELETE /api/v1/org/ai-connections/{user_id}/blocks` | destructive | `account:delete` | Resume Ai Connection |
+| [`setRepLimitsOverride`](#op-setreplimitsoverride) | `PUT /api/v1/org/rep-limits/{user_id}` | write | `account:write` | Set Rep Limits Override |
+| [`unassignSecurityRole`](#op-unassignsecurityrole) | `DELETE /api/v1/org/infrastructure/security-roles/{role_id}` | destructive | `account:delete` | Unassign Security Role |
+| [`updateAiConnectionsConfig`](#op-updateaiconnectionsconfig) | `PUT /api/v1/org/ai-connections/config` | write | `account:write` | Update Ai Connections Config |
+| [`updateInfrastructureProfile`](#op-updateinfrastructureprofile) | `PUT /api/v1/org/infrastructure` | write | `account:write` | Update Infrastructure Profile |
+| [`updateSuppressionSettings`](#op-updatesuppressionsettings) | `PUT /api/v1/org/suppression-settings` | write | `account:write` | Update Suppression Settings |
+
+---
+
+<a id="op-assignsecurityrole"></a>
+
+### `g8.api.orgGovernance.assignSecurityRole(input)`
+
+**Assign Security Role**
+
+- HTTP: `PUT /api/v1/org/infrastructure/security-roles/{role_id}`
+- operationId: `assign_security_role_org_infrastructure_security_roles__role_id__put` (also callable as `g8.api.call("assign_security_role_org_infrastructure_security_roles__role_id__put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Make a team member responsible for a security role.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.role_id` | `string` | yes | Security role id. |
+| `body` | `SecurityRoleAssignRequest` | yes | Request body; fields below. |
+
+Body fields (`SecurityRoleAssignRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.role_id` | `string` | yes | Must match the `role_id` in the path. |
+| `body.team_member_id` | `string` | yes | Team-member id or the person's user id. |
+| `body.user_email` | `string \| null` | no | Required when this creates the team member. |
+| `body.user_name` | `string \| null` | no | Required when this creates the team member. |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.assignSecurityRole({
+  path: { role_id: "id" },
+  body: { role_id: "id", team_member_id: "id" },
+});
+```
+
+---
+
+<a id="op-blockaiconnection"></a>
+
+### `g8.api.orgGovernance.blockAiConnection(input)`
+
+**Block Ai Connection**
+
+- HTTP: `POST /api/v1/org/ai-connections/{user_id}/blocks`
+- operationId: `block_ai_connection_org_ai_connections__user_id__blocks_post` (also callable as `g8.api.call("block_ai_connection_org_ai_connections__user_id__blocks_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Block a member's AI client (or all of them) from calling graph8.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.user_id` | `string` | yes | The org member's user id. |
+| `body` | `AiConnectionBlockRequest` | yes | Request body; fields below. |
+
+Body fields (`AiConnectionBlockRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.client_key` | `string \| null` | no | Only this client. Omit to block every client. |
+| `body.reason` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.blockAiConnection({ path: { user_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-deleteaiconnectionactivity"></a>
+
+### `g8.api.orgGovernance.deleteAiConnectionActivity(input)`
+
+**Delete Ai Connection Activity**
+
+- HTTP: `DELETE /api/v1/org/ai-connections/{user_id}/activity`
+- operationId: `delete_ai_connection_activity_org_ai_connections__user_id__activity_delete` (also callable as `g8.api.call("delete_ai_connection_activity_org_ai_connections__user_id__activity_delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `account:delete`
+
+Permanently delete a member's recorded AI-client activity.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.user_id` | `string` | yes | The org member's user id. |
+| `query.client_key` | `string \| null` | no | Only this client's records. |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `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.orgGovernance.deleteAiConnectionActivity({ path: { user_id: "id" } });
+```
+
+---
+
+<a id="op-getaiconnectionsummary"></a>
+
+### `g8.api.orgGovernance.getAiConnectionSummary(input)`
+
+**Get Ai Connection Summary**
+
+- HTTP: `GET /api/v1/org/ai-connections/{user_id}/summary`
+- operationId: `get_ai_connection_summary_org_ai_connections__user_id__summary_get` (also callable as `g8.api.call("get_ai_connection_summary_org_ai_connections__user_id__summary_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+One member's AI-client usage over 30 days, by day and tool.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.user_id` | `string` | yes | The org member's user id. |
+| `query.client_key` | `string \| null` | no | Only this AI client. |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.getAiConnectionSummary({ path: { user_id: "id" } });
+```
+
+---
+
+<a id="op-getaiconnectionsconfig"></a>
+
+### `g8.api.orgGovernance.getAiConnectionsConfig(input?)`
+
+**Get Ai Connections Config**
+
+- HTTP: `GET /api/v1/org/ai-connections/config`
+- operationId: `get_ai_connections_config_org_ai_connections_config_get` (also callable as `g8.api.call("get_ai_connections_config_org_ai_connections_config_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+What is recorded about AI-client calls, and for how long.
+
+**Input**: none.
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.getAiConnectionsConfig();
+```
+
+---
+
+<a id="op-getinfrastructureprofile"></a>
+
+### `g8.api.orgGovernance.getInfrastructureProfile(input?)`
+
+**Get Infrastructure Profile**
+
+- HTTP: `GET /api/v1/org/infrastructure`
+- operationId: `get_infrastructure_profile_org_infrastructure_get` (also callable as `g8.api.call("get_infrastructure_profile_org_infrastructure_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+The provider catalogue per category and the org's current selections.
+
+**Input**: none.
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.getInfrastructureProfile();
+```
+
+---
+
+<a id="op-getsuppressionsettings"></a>
+
+### `g8.api.orgGovernance.getSuppressionSettings(input?)`
+
+**Get Suppression Settings**
+
+- HTTP: `GET /api/v1/org/suppression-settings`
+- operationId: `get_suppression_settings_org_suppression_settings_get` (also callable as `g8.api.call("get_suppression_settings_org_suppression_settings_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Whether a contact's opt-out on one channel covers every channel.
+
+**Input**: none.
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.getSuppressionSettings();
+```
+
+---
+
+<a id="op-listaiconnectioncalls"></a>
+
+### `g8.api.orgGovernance.listAiConnectionCalls(input)`
+
+**List Ai Connection Calls**
+
+- HTTP: `GET /api/v1/org/ai-connections/{user_id}/calls`
+- operationId: `list_ai_connection_calls_org_ai_connections__user_id__calls_get` (also callable as `g8.api.call("list_ai_connection_calls_org_ai_connections__user_id__calls_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+One member's recorded AI-client calls, newest first, cursor-paged.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.user_id` | `string` | yes | The org member's user id. |
+| `query.client_key` | `string \| null` | no |  |
+| `query.tool_name` | `string \| null` | no |  |
+| `query.status` | `"success" \| "error" \| null` | no |  |
+| `query.from` | `string \| null` | no | ISO timestamp, inclusive. |
+| `query.to` | `string \| null` | no | ISO timestamp, exclusive. |
+| `query.cursor` | `string \| null` | no |  |
+| `query.limit` | `integer` | no | default `50` |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.listAiConnectionCalls({ path: { user_id: "id" } });
+```
+
+---
+
+<a id="op-listaiconnections"></a>
+
+### `g8.api.orgGovernance.listAiConnections(input?)`
+
+**List Ai Connections**
+
+- HTTP: `GET /api/v1/org/ai-connections`
+- operationId: `list_ai_connections_org_ai_connections_get` (also callable as `g8.api.call("list_ai_connections_org_ai_connections_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Every org member's connected AI clients, with 30-day call counts.
+
+**Input**: none.
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.listAiConnections();
+```
+
+---
+
+<a id="op-listreplimits"></a>
+
+### `g8.api.orgGovernance.listRepLimits(input?)`
+
+**List Rep Limits**
+
+- HTTP: `GET /api/v1/org/rep-limits`
+- operationId: `list_rep_limits_org_rep_limits_get` (also callable as `g8.api.call("list_rep_limits_org_rep_limits_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Every member's limits and current usage.
+
+**Input**: none.
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.listRepLimits();
+```
+
+---
+
+<a id="op-listsecurityroles"></a>
+
+### `g8.api.orgGovernance.listSecurityRoles(input?)`
+
+**List Security Roles**
+
+- HTTP: `GET /api/v1/org/infrastructure/security-roles`
+- operationId: `list_security_roles_org_infrastructure_security_roles_get` (also callable as `g8.api.call("list_security_roles_org_infrastructure_security_roles_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+The security-responsibility roles and who holds each.
+
+**Input**: none.
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.listSecurityRoles();
+```
+
+---
+
+<a id="op-resumeaiconnection"></a>
+
+### `g8.api.orgGovernance.resumeAiConnection(input)`
+
+**Resume Ai Connection**
+
+- HTTP: `DELETE /api/v1/org/ai-connections/{user_id}/blocks`
+- operationId: `resume_ai_connection_org_ai_connections__user_id__blocks_delete` (also callable as `g8.api.call("resume_ai_connection_org_ai_connections__user_id__blocks_delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `account:delete`
+
+Lift a block.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.user_id` | `string` | yes | The org member's user id. |
+| `query.client_key` | `string \| null` | no | Only this client. Omit to lift every block. |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `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.orgGovernance.resumeAiConnection({ path: { user_id: "id" } });
+```
+
+---
+
+<a id="op-setreplimitsoverride"></a>
+
+### `g8.api.orgGovernance.setRepLimitsOverride(input)`
+
+**Set Rep Limits Override**
+
+- HTTP: `PUT /api/v1/org/rep-limits/{user_id}`
+- operationId: `set_rep_limits_override_org_rep_limits__user_id__put` (also callable as `g8.api.call("set_rep_limits_override_org_rep_limits__user_id__put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Override one member's limits, or `reset` them to the role default.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.user_id` | `string` | yes | The member's user id. |
+| `body` | `RepLimitsOverrideRequest` | yes | Request body; fields below. |
+
+Body fields (`RepLimitsOverrideRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.max_companies` | `integer \| null` | no | Null = explicitly unlimited. min 0 |
+| `body.max_contacts` | `integer \| null` | no | Null = explicitly unlimited. min 0 |
+| `body.monthly_credit_budget` | `integer \| null` | no | Null = explicitly unlimited. min 0 |
+| `body.reset` | `boolean` | no | Delete the override; the role default applies again. default `false` |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.setRepLimitsOverride({ path: { user_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-unassignsecurityrole"></a>
+
+### `g8.api.orgGovernance.unassignSecurityRole(input)`
+
+**Unassign Security Role**
+
+- HTTP: `DELETE /api/v1/org/infrastructure/security-roles/{role_id}`
+- operationId: `unassign_security_role_org_infrastructure_security_roles__role_id__delete` (also callable as `g8.api.call("unassign_security_role_org_infrastructure_security_roles__role_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `account:delete`
+
+Clear who holds a security role. The role itself stays.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.role_id` | `string` | yes | Security role id. |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `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.orgGovernance.unassignSecurityRole({ path: { role_id: "id" } });
+```
+
+---
+
+<a id="op-updateaiconnectionsconfig"></a>
+
+### `g8.api.orgGovernance.updateAiConnectionsConfig(input)`
+
+**Update Ai Connections Config**
+
+- HTTP: `PUT /api/v1/org/ai-connections/config`
+- operationId: `update_ai_connections_config_org_ai_connections_config_put` (also callable as `g8.api.call("update_ai_connections_config_org_ai_connections_config_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Change what is recorded about AI-client calls and how long it is kept.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `AiConnectionsConfigRequest` | yes | Request body; fields below. |
+
+Body fields (`AiConnectionsConfigRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.capture_detail` | `boolean` | no | Record call inputs/outputs, not just counts. default `true` |
+| `body.retention_days` | `30 \| 90 \| 365` | no | default `90` |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.updateAiConnectionsConfig({ body: {} });
+```
+
+---
+
+<a id="op-updateinfrastructureprofile"></a>
+
+### `g8.api.orgGovernance.updateInfrastructureProfile(input)`
+
+**Update Infrastructure Profile**
+
+- HTTP: `PUT /api/v1/org/infrastructure`
+- operationId: `update_infrastructure_profile_org_infrastructure_put` (also callable as `g8.api.call("update_infrastructure_profile_org_infrastructure_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Set the org's provider selections, category by category.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `InfrastructureProfileUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`InfrastructureProfileUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.selections` | `Record<string, OrgInfrastructureSelection>` | yes | Category id -> selection. |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.updateInfrastructureProfile({ body: { selections: {} } });
+```
+
+---
+
+<a id="op-updatesuppressionsettings"></a>
+
+### `g8.api.orgGovernance.updateSuppressionSettings(input)`
+
+**Update Suppression Settings**
+
+- HTTP: `PUT /api/v1/org/suppression-settings`
+- operationId: `update_suppression_settings_org_suppression_settings_put` (also callable as `g8.api.call("update_suppression_settings_org_suppression_settings_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Set the opt-out scope. Applies to opt-outs from now on; existing ones keep their scope.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `SuppressionSettingsRequest` | yes | Request body; fields below. |
+
+Body fields (`SuppressionSettingsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.contact_optout_scope` | `"channel" \| "all"` | yes | `channel`: an opt-out stays on its channel. `all`: it covers all outreach. |
+
+**Returns** `ApiResponse_OrgGovernancePayload_`: the envelope `{ data: OrgGovernancePayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.orgGovernance.updateSuppressionSettings({ body: { contact_optout_scope: "channel" } });
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-orginfrastructureselection"></a>
+
+### `OrgInfrastructureSelection`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `custom_name` | `string \| null` | no | Used when `other` is among `provider_ids`. |
+| `notes` | `string \| null` | no |  |
+| `provider_ids` | `Array<string> \| null` | no |  |