@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/organizationSettings.md

@@ -0,0 +1,911 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.organizationSettings`: Organization Settings
+
+22 operations (11 read, 11 write).
+
+No hand-written client covers this area. Call it through `g8.api.organizationSettings.*` 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: [organizationSettings.d.ts](organizationSettings.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`getCampaignGenerationSettings`](#op-getcampaigngenerationsettings) | `GET /api/v1/org/settings/campaign-generation` | read | `account:read` | Get Campaign Generation Settings |
+| [`getComplianceSettings`](#op-getcompliancesettings) | `GET /api/v1/org/settings/compliance` | read | `account:read` | Get Compliance Settings |
+| [`getContentSources`](#op-getcontentsources) | `GET /api/v1/org/content-sources` | read | `account:read` | Get Content Sources |
+| [`getDocFolderTemplate`](#op-getdocfoldertemplate) | `GET /api/v1/org/settings/docs/folders/{scope}` | read | `account:read` | Get Doc Folder Template |
+| [`getDocSettings`](#op-getdocsettings) | `GET /api/v1/org/settings/docs` | read | `account:read` | Get Doc Settings |
+| [`getDocumentPrioritySettings`](#op-getdocumentprioritysettings) | `GET /api/v1/org/settings/document-priority` | read | `account:read` | Get Document Priority Settings |
+| [`getLeadQualificationBackfillStatus`](#op-getleadqualificationbackfillstatus) | `GET /api/v1/org/settings/lead-qualification/backfill-status` | read | `account:read` | Get Lead Qualification Backfill Status |
+| [`getLeadQualificationSettings`](#op-getleadqualificationsettings) | `GET /api/v1/org/settings/lead-qualification` | read | `account:read` | Get Lead Qualification Settings |
+| [`getMeetingExtractionSettings`](#op-getmeetingextractionsettings) | `GET /api/v1/org/settings/docs/meetings` | read | `account:read` | Get Meeting Extraction Settings |
+| [`getOrgSettings`](#op-getorgsettings) | `GET /api/v1/org/settings` | read | `account:read` | Get Org Settings |
+| [`getTaskSettings`](#op-gettasksettings) | `GET /api/v1/org/settings/tasks` | read | `account:read` | Get Task Settings |
+| [`triggerLeadQualificationBackfill`](#op-triggerleadqualificationbackfill) | `POST /api/v1/org/settings/lead-qualification/backfill` | write | `account:write` | Trigger Lead Qualification Backfill |
+| [`updateCampaignGenerationSettings`](#op-updatecampaigngenerationsettings) | `PUT /api/v1/org/settings/campaign-generation` | write | `account:write` | Update Campaign Generation Settings |
+| [`updateComplianceSettings`](#op-updatecompliancesettings) | `PUT /api/v1/org/settings/compliance` | write | `account:write` | Update Compliance Settings |
+| [`updateContentSources`](#op-updatecontentsources) | `PUT /api/v1/org/content-sources` | write | `account:write` | Update Content Sources |
+| [`updateDocFolderTemplate`](#op-updatedocfoldertemplate) | `PUT /api/v1/org/settings/docs/folders/{scope}` | write | `account:write` | Update Doc Folder Template |
+| [`updateDocSettings`](#op-updatedocsettings) | `PUT /api/v1/org/settings/docs/{scope}` | write | `account:write` | Update Doc Settings |
+| [`updateDocumentPrioritySettings`](#op-updatedocumentprioritysettings) | `PUT /api/v1/org/settings/document-priority` | write | `account:write` | Update Document Priority Settings |
+| [`updateLeadQualificationSettings`](#op-updateleadqualificationsettings) | `PUT /api/v1/org/settings/lead-qualification` | write | `account:write` | Update Lead Qualification Settings |
+| [`updateMeetingExtractionSettings`](#op-updatemeetingextractionsettings) | `PUT /api/v1/org/settings/docs/meetings` | write | `account:write` | Update Meeting Extraction Settings |
+| [`updateOrgSettings`](#op-updateorgsettings) | `PUT /api/v1/org/settings` | write | `account:write` | Update Org Settings |
+| [`updateTaskSettings`](#op-updatetasksettings) | `PUT /api/v1/org/settings/tasks` | write | `account:write` | Update Task Settings |
+
+---
+
+<a id="op-getcampaigngenerationsettings"></a>
+
+### `g8.api.organizationSettings.getCampaignGenerationSettings(input?)`
+
+**Get Campaign Generation Settings**
+
+- HTTP: `GET /api/v1/org/settings/campaign-generation`
+- operationId: `get_campaign_generation_settings_org_settings_campaign_generation_get` (also callable as `g8.api.call("get_campaign_generation_settings_org_settings_campaign_generation_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Whether a new campaign auto-generates a landing page and ad images.
+
+Worth reading before `POST /campaigns`: these decide what that call
+produces beyond the campaign itself, and both cost generation time.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getCampaignGenerationSettings();
+```
+
+---
+
+<a id="op-getcompliancesettings"></a>
+
+### `g8.api.organizationSettings.getComplianceSettings(input?)`
+
+**Get Compliance Settings**
+
+- HTTP: `GET /api/v1/org/settings/compliance`
+- operationId: `get_compliance_settings_org_settings_compliance_get` (also callable as `g8.api.call("get_compliance_settings_org_settings_compliance_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Which certifications this organisation claims, and the supported list.
+
+Generated content cites these. A certification switched on here is one the
+product will assert to a prospect, so the write side is admin-gated twice.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getComplianceSettings();
+```
+
+---
+
+<a id="op-getcontentsources"></a>
+
+### `g8.api.organizationSettings.getContentSources(input?)`
+
+**Get Content Sources**
+
+- HTTP: `GET /api/v1/org/content-sources`
+- operationId: `get_content_sources_org_content_sources_get` (also callable as `g8.api.call("get_content_sources_org_content_sources_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+The properties this organisation owns, and the channels it posts to.
+
+What intelligence gathering and content generation read as "us". The one
+source flagged `primary` is mirrored to the org's primary website, which is
+the domain most of Studio is generated against.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getContentSources();
+```
+
+---
+
+<a id="op-getdocfoldertemplate"></a>
+
+### `g8.api.organizationSettings.getDocFolderTemplate(input)`
+
+**Get Doc Folder Template**
+
+- HTTP: `GET /api/v1/org/settings/docs/folders/{scope}`
+- operationId: `get_doc_folder_template_org_settings_docs_folders__scope__get` (also callable as `g8.api.call("get_doc_folder_template_org_settings_docs_folders__scope__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+The folder tree new documents for this scope are filed into.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.scope` | `"companies" \| "accounts" \| "prospects" \| "contacts" \| "campaigns" \| "global"` | yes | Which record type's folder tree. `accounts` is the canonical company template; `companies` is accepted as its synonym. |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getDocFolderTemplate({ path: { scope: "companies" } });
+```
+
+---
+
+<a id="op-getdocsettings"></a>
+
+### `g8.api.organizationSettings.getDocSettings(input?)`
+
+**Get Doc Settings**
+
+- HTTP: `GET /api/v1/org/settings/docs`
+- operationId: `get_doc_settings_org_settings_docs_get` (also callable as `g8.api.call("get_doc_settings_org_settings_docs_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Which documents are generated by default, for every scope at once.
+
+The source of the `default_doc_ids` a contact, account, prospect, campaign
+or global generation starts from. `mandatory_doc_ids` are the ones a user
+cannot switch off in the UI.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getDocSettings();
+```
+
+---
+
+<a id="op-getdocumentprioritysettings"></a>
+
+### `g8.api.organizationSettings.getDocumentPrioritySettings(input?)`
+
+**Get Document Priority Settings**
+
+- HTTP: `GET /api/v1/org/settings/document-priority`
+- operationId: `get_document_priority_settings_org_settings_document_priority_get` (also callable as `g8.api.call("get_document_priority_settings_org_settings_document_priority_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Default priority for uploaded and for AI-generated documents.
+
+Priority decides which document wins when two say different things, so
+this is the tie-break rule the whole library is read through.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getDocumentPrioritySettings();
+```
+
+---
+
+<a id="op-getleadqualificationbackfillstatus"></a>
+
+### `g8.api.organizationSettings.getLeadQualificationBackfillStatus(input?)`
+
+**Get Lead Qualification Backfill Status**
+
+- HTTP: `GET /api/v1/org/settings/lead-qualification/backfill-status`
+- operationId: `get_lead_qualification_backfill_status_org_settings_lead_qualification_backfill_status_get` (also callable as `g8.api.call("get_lead_qualification_backfill_status_org_settings_lead_qualification_backfill_status_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Progress of the backfill job for this organisation.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getLeadQualificationBackfillStatus();
+```
+
+---
+
+<a id="op-getleadqualificationsettings"></a>
+
+### `g8.api.organizationSettings.getLeadQualificationSettings(input?)`
+
+**Get Lead Qualification Settings**
+
+- HTTP: `GET /api/v1/org/settings/lead-qualification`
+- operationId: `get_lead_qualification_settings_org_settings_lead_qualification_get` (also callable as `g8.api.call("get_lead_qualification_settings_org_settings_lead_qualification_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Which visitor events turn into a qualified lead, and on which pages.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getLeadQualificationSettings();
+```
+
+---
+
+<a id="op-getmeetingextractionsettings"></a>
+
+### `g8.api.organizationSettings.getMeetingExtractionSettings(input?)`
+
+**Get Meeting Extraction Settings**
+
+- HTTP: `GET /api/v1/org/settings/docs/meetings`
+- operationId: `get_meeting_extraction_settings_org_settings_docs_meetings_get` (also callable as `g8.api.call("get_meeting_extraction_settings_org_settings_docs_meetings_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+How a meeting transcript is read: grounding, fields, glossary.
+
+`meeting_grounding` is what tells the extractor which attendees are YOURS -
+the canonical company name, the internal email domains and the brand
+aliases. Get it wrong and every meeting is classified as external.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getMeetingExtractionSettings();
+```
+
+---
+
+<a id="op-getorgsettings"></a>
+
+### `g8.api.organizationSettings.getOrgSettings(input?)`
+
+**Get Org Settings**
+
+- HTTP: `GET /api/v1/org/settings`
+- operationId: `get_org_settings_org_settings_get` (also callable as `g8.api.call("get_org_settings_org_settings_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+The organisation's name, auto-join domain and signup URL.
+
+`email_domain` is the auto-join domain: anyone signing up with an address
+at it joins THIS organisation with no invite. Read it before you trust the
+org's membership to be invite-only.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getOrgSettings();
+```
+
+---
+
+<a id="op-gettasksettings"></a>
+
+### `g8.api.organizationSettings.getTaskSettings(input?)`
+
+**Get Task Settings**
+
+- HTTP: `GET /api/v1/org/settings/tasks`
+- operationId: `get_task_settings_org_settings_tasks_get` (also callable as `g8.api.call("get_task_settings_org_settings_tasks_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `account:read`
+
+Default task visibility, and the note-taking toggles beside it.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.getTaskSettings();
+```
+
+---
+
+<a id="op-triggerleadqualificationbackfill"></a>
+
+### `g8.api.organizationSettings.triggerLeadQualificationBackfill(input?)`
+
+**Trigger Lead Qualification Backfill**
+
+- HTTP: `POST /api/v1/org/settings/lead-qualification/backfill`
+- operationId: `trigger_lead_qualification_backfill_org_settings_lead_qualification_backfill_post` (also callable as `g8.api.call("trigger_lead_qualification_backfill_org_settings_lead_qualification_backfill_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Queue a backfill over every enabled signal group, last 30 days.
+
+CREATES LEAD RECORDS from traffic that already happened. Asynchronous -
+poll `GET /org/settings/lead-qualification/backfill-status` for progress.
+The 30-day window is the app's and is not a parameter.
+
+**Input**: none.
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.triggerLeadQualificationBackfill();
+```
+
+---
+
+<a id="op-updatecampaigngenerationsettings"></a>
+
+### `g8.api.organizationSettings.updateCampaignGenerationSettings(input)`
+
+**Update Campaign Generation Settings**
+
+- HTTP: `PUT /api/v1/org/settings/campaign-generation`
+- operationId: `update_campaign_generation_settings_org_settings_campaign_generation_put` (also callable as `g8.api.call("update_campaign_generation_settings_org_settings_campaign_generation_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 campaign generation toggles.
+
+BOTH default to true, so an empty body turns both ON. A partial body is
+not a partial update here.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CampaignGenerationUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`CampaignGenerationUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.auto_generate_ad_images` | `boolean` | no | Generate ad images alongside a new campaign. default `true` |
+| `body.auto_generate_landing_page` | `boolean` | no | Generate a landing page alongside a new campaign. default `true` |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateCampaignGenerationSettings({ body: {} });
+```
+
+---
+
+<a id="op-updatecompliancesettings"></a>
+
+### `g8.api.organizationSettings.updateComplianceSettings(input)`
+
+**Update Compliance Settings**
+
+- HTTP: `PUT /api/v1/org/settings/compliance`
+- operationId: `update_compliance_settings_org_settings_compliance_put` (also callable as `g8.api.call("update_compliance_settings_org_settings_compliance_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Patch certification status, keyed by certification id.
+
+PARTIAL: only the ids you send are touched. An id the product does not
+support is IGNORED rather than rejected - that is the app's behaviour, so
+read the response back rather than assuming the write landed.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `ComplianceSettingsUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`ComplianceSettingsUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.certifications` | `Record<string, ComplianceCertification>` | yes | Certification id -> status. Unknown ids are ignored by the server. |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateComplianceSettings({ body: { certifications: {} } });
+```
+
+---
+
+<a id="op-updatecontentsources"></a>
+
+### `g8.api.organizationSettings.updateContentSources(input)`
+
+**Update Content Sources**
+
+- HTTP: `PUT /api/v1/org/content-sources`
+- operationId: `update_content_sources_org_content_sources_put` (also callable as `g8.api.call("update_content_sources_org_content_sources_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+REPLACE the content sources. Anything omitted is deleted.
+
+At most one owned source may be `primary`, and setting it moves the org's
+primary website - which changes what future Studio documents are generated
+about. That is the widest side effect on this route.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `ContentSourcesUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`ContentSourcesUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.sources` | `Array<ContentSourceItem>` | yes | The complete set of content sources. Anything omitted is deleted. |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateContentSources({
+  body: { sources: [{ type: "website", url: "https://example.com" }] },
+});
+```
+
+---
+
+<a id="op-updatedocfoldertemplate"></a>
+
+### `g8.api.organizationSettings.updateDocFolderTemplate(input)`
+
+**Update Doc Folder Template**
+
+- HTTP: `PUT /api/v1/org/settings/docs/folders/{scope}`
+- operationId: `update_doc_folder_template_org_settings_docs_folders__scope__put` (also callable as `g8.api.call("update_doc_folder_template_org_settings_docs_folders__scope__put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Replace the folder tree for this scope.
+
+REPLACES. A folder missing from the body is removed from the template -
+existing documents keep their path, but nothing new is filed there.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.scope` | `"companies" \| "accounts" \| "prospects" \| "contacts" \| "campaigns" \| "global"` | yes | Which record type's folder tree. `accounts` is the canonical company template; `companies` is accepted as its synonym. |
+| `body` | `FolderTemplateUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`FolderTemplateUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.folders` | `Array<FolderTemplateItem>` | no | The complete folder template. Anything omitted is removed. |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateDocFolderTemplate({ path: { scope: "companies" }, body: {} });
+```
+
+---
+
+<a id="op-updatedocsettings"></a>
+
+### `g8.api.organizationSettings.updateDocSettings(input)`
+
+**Update Doc Settings**
+
+- HTTP: `PUT /api/v1/org/settings/docs/{scope}`
+- operationId: `update_doc_settings_org_settings_docs__scope__put` (also callable as `g8.api.call("update_doc_settings_org_settings_docs__scope__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 default documents for ONE scope.
+
+`mandatory_doc_ids` omitted leaves the current mandatory set alone; sending
+an empty list CLEARS it. The two are different instructions and only one is
+destructive.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.scope` | `"contacts" \| "accounts" \| "prospects" \| "campaigns" \| "global"` | yes | Which generation scope these defaults apply to. |
+| `body` | `DocSettingsUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`DocSettingsUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.default_doc_ids` | `Array<string>` | yes | Document type ids generated by default for this scope. |
+| `body.mandatory_doc_ids` | `Array<string> \| null` | no | Document type ids a user cannot uncheck. Omit to leave the current set unchanged; send an empty list to clear it. |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateDocSettings({ path: { scope: "contacts" }, body: { default_doc_ids: ["id"] } });
+```
+
+---
+
+<a id="op-updatedocumentprioritysettings"></a>
+
+### `g8.api.organizationSettings.updateDocumentPrioritySettings(input)`
+
+**Update Document Priority Settings**
+
+- HTTP: `PUT /api/v1/org/settings/document-priority`
+- operationId: `update_document_priority_settings_org_settings_document_priority_put` (also callable as `g8.api.call("update_document_priority_settings_org_settings_document_priority_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 default document priorities.
+
+BOTH fields have defaults, so a partial body RESETS the one you left out.
+Send both.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `DocumentPriorityUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`DocumentPriorityUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.default_generated_priority` | `"high" \| "medium" \| "low"` | no | Priority assigned to AI-generated documents. default `"medium"` |
+| `body.default_upload_priority` | `"high" \| "medium" \| "low"` | no | Priority assigned to user-uploaded documents. default `"high"` |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateDocumentPrioritySettings({ body: {} });
+```
+
+---
+
+<a id="op-updateleadqualificationsettings"></a>
+
+### `g8.api.organizationSettings.updateLeadQualificationSettings(input)`
+
+**Update Lead Qualification Settings**
+
+- HTTP: `PUT /api/v1/org/settings/lead-qualification`
+- operationId: `update_lead_qualification_settings_org_settings_lead_qualification_put` (also callable as `g8.api.call("update_lead_qualification_settings_org_settings_lead_qualification_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Update lead qualification. Partial - omitted fields are left alone.
+
+`backfill=true` is the dangerous half: it walks the last 30 days of traffic
+and creates leads from every event you just switched on. Do it deliberately,
+or leave it false and use `POST .../lead-qualification/backfill` once you
+are happy with the settings.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `LeadQualificationSettingsUpdateRequest` | yes | Request body; fields below. |
+| `query.backfill` | `boolean` | no | Also create leads from newly-enabled events in the last 30 days. This CREATES RECORDS for traffic that already happened - it is not a dry run, and there is no undo. default `false` |
+
+Body fields (`LeadQualificationSettingsUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.custom_page_patterns` | `Array<string> \| null` | no | Extra URL patterns that count as a high-intent page view. |
+| `body.event_groups` | `Record<string, Record<string, boolean>> \| null` | no | Signal group -> event name -> enabled. |
+| `body.page_patterns` | `Record<string, Array<string>> \| null` | no | Signal group -> URL patterns. |
+| `body.qualification_enabled` | `boolean \| null` | no | Master switch for turning visitor events into qualified leads. |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateLeadQualificationSettings({ body: {} });
+```
+
+---
+
+<a id="op-updatemeetingextractionsettings"></a>
+
+### `g8.api.organizationSettings.updateMeetingExtractionSettings(input)`
+
+**Update Meeting Extraction Settings**
+
+- HTTP: `PUT /api/v1/org/settings/docs/meetings`
+- operationId: `update_meeting_extraction_settings_org_settings_docs_meetings_put` (also callable as `g8.api.call("update_meeting_extraction_settings_org_settings_docs_meetings_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Replace the meeting extraction settings.
+
+Declared BEFORE `PUT /org/settings/docs/{scope}`: the other way round the
+parameter route matches first, binds `scope` to "meetings", and the Literal
+rejects it - a 422 on a route that exists.
+
+Every block defaults to EMPTY, so omitting one is not the same as leaving
+it alone. Read the current settings, change what you need, send the whole
+object back.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `MeetingExtractionSettingsUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`MeetingExtractionSettingsUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.customer` | `MeetingExtractionScopeSettings` | no | Meetings with an existing customer. |
+| `body.internal` | `MeetingExtractionScopeSettings` | no | Internal meetings - every attendee is on an internal domain. |
+| `body.meeting_grounding` | `MeetingGroundingSettings` | no | Company identity the extractor grounds on: canonical name, internal domains, aliases. |
+| `body.prospect` | `MeetingExtractionScopeSettings` | no | Meetings with a prospect. |
+| `body.shared` | `MeetingExtractionScopeSettings` | no | Applied to every meeting, on top of the per-scope block. |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateMeetingExtractionSettings({ body: {} });
+```
+
+---
+
+<a id="op-updateorgsettings"></a>
+
+### `g8.api.organizationSettings.updateOrgSettings(input)`
+
+**Update Org Settings**
+
+- HTTP: `PUT /api/v1/org/settings`
+- operationId: `update_org_settings_org_settings_put` (also callable as `g8.api.call("update_org_settings_org_settings_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `account:write`
+
+Rename the organisation, or set its auto-join email domain.
+
+SETTING `email_domain` WIDENS WHO CAN JOIN. Anyone who signs up with an
+address at that domain becomes a member without an invite. Admin-gated, and
+the handler re-checks the caller's org role on top.
+
+The rename happens FIRST and against PropelAuth, so a rejected name aborts
+the whole update rather than half-applying it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `OrgSettingsUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`OrgSettingsUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.email_domain` | `string \| null` | no | Email domain for auto-join signup (e.g. `graph8.com`). Anyone who signs up with an address at this domain joins this organization with no invite. Normalised: scheme, `www.` and trailing slash are stripped and the value is lowercased. |
+| `body.org_name` | `string \| null` | no | Organization display name. PropelAuth owns it; a rejected rename aborts the whole update. |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateOrgSettings({ body: {} });
+```
+
+---
+
+<a id="op-updatetasksettings"></a>
+
+### `g8.api.organizationSettings.updateTaskSettings(input)`
+
+**Update Task Settings**
+
+- HTTP: `PUT /api/v1/org/settings/tasks`
+- operationId: `update_task_settings_org_settings_tasks_put` (also callable as `g8.api.call("update_task_settings_org_settings_tasks_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 default task visibility and note-taking toggles.
+
+`default_visibility` is a privilege-sensitive setting: moving it to
+`public` exposes every task created afterwards to the whole organisation.
+Admin-gated, and the handler re-checks the role.
+
+An EMPTY patch is refused (422) rather than no-opped, because an empty body
+on this route is always a caller bug.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `TaskSettingsUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`TaskSettingsUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.default_visibility` | `"public" \| "team" \| "private" \| null` | no | Default visibility for newly created tasks. |
+| `body.mentions_enabled` | `boolean \| null` | no | When false, hide @ autocomplete in note and reply composers. |
+| `body.notes_anywhere_enabled` | `boolean \| null` | no | When false, hide the global Quick Note shortcut and its command-palette action. |
+| `body.notify_on_mention` | `boolean \| null` | no | When false, suppress mention-triggered bell notifications. |
+| `body.parent_completion_mode` | `"manual" \| "auto_complete" \| "require_subtasks_done" \| null` | no | How a parent task completes relative to its subtasks. |
+| `body.selection_toolbar_enabled` | `boolean \| null` | no | When false, hide the floating 'Add note' bubble on text selection. |
+
+**Returns** `ApiResponse_StudioPayload_`: the envelope `{ data: StudioPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.organizationSettings.updateTaskSettings({ body: {} });
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-compliancecertification"></a>
+
+### `ComplianceCertification`
+
+Mirrors `campaign_builder.routers.org_settings.CertificationStatus`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `achieved_date` | `string \| null` | no | Date the certification was achieved (YYYY-MM-DD). |
+| `enabled` | `boolean` | no | Whether the organization holds this certification. default `false` |
+| `report_doc_id` | `string \| null` | no | Library document id for the uploaded report or certificate. |
+
+<a id="type-contentsourceitem"></a>
+
+### `ContentSourceItem`
+
+Mirrors `campaign_builder.routers.org_settings.ContentSourceItem`. `extra="forbid"` matches the app: a typo'd key on a content source is a silently ignored instruction otherwise, and the list is REPLACED wholesale on every write, so a dropped key is a dropped source.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `type` | `"website" \| "blog" \| "docs" \| "developers" \| "linkedin" \| "reddit" \| "twitter"` | yes | `website`/`blog`/`docs`/`developers` are properties you OWN; `linkedin`/`reddit`/`twitter` are external channels. |
+| `url` | `string` | yes | Full URL - the site URL for an owned property, the profile URL for an external channel. |
+| `primary` | `boolean` | no | Owned types only. The single primary website, mirrored to the org's `primary_website_url`. At most one source may set it. default `false` |
+
+<a id="type-foldertemplateitem"></a>
+
+### `FolderTemplateItem`
+
+Mirrors `campaign_builder.schemas.settings.ClientFolderTemplateItem`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `key` | `string` | yes | Stable key used for mapping (e.g. `transcripts`). |
+| `name` | `string` | yes | Display name in the folder tree. |
+| `description` | `string \| null` | no | Optional helper text. |
+| `locked` | `boolean` | no | When true the folder cannot be renamed or removed. default `false` |
+
+<a id="type-meetingextractionscopesettings"></a>
+
+### `MeetingExtractionScopeSettings`
+
+Transcript extraction settings for one meeting scope.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `custom_fields` | `Array<MeetingExtractionCustomField>` | no | Org-defined custom fields to extract |
+| `custom_terms` | `Array<MeetingExtractionGlossaryTerm>` | no | Vocabulary terms, acronyms, and product names to recognize |
+| `extract_fields` | `Array<string>` | no | Structured outputs that should always be extracted |
+| `listen_for` | `Array<string>` | no | Signals and topics the extractor should prioritize |
+
+<a id="type-meetinggroundingsettings"></a>
+
+### `MeetingGroundingSettings`
+
+Org-level grounding facts used to interpret meeting participants and transcript wording.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `brand_aliases` | `Array<MeetingGroundingAlias>` | no | Known brand, alias, or product names that resolve to canonical entities |
+| `canonical_company_name` | `string` | no | Canonical internal company name that should be used in summaries and task interpretation default `""` |
+| `internal_domains` | `Array<string>` | no | Email domains that identify internal attendees |
+| `participant_rules` | `Array<string>` | no | Rules that explain how participant and domain evidence should be interpreted |