@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/organizationSettings.d.ts

@@ -0,0 +1,626 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.organizationSettings` (Organization Settings): 22 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"get_campaign_generation_settings_org_settings_campaign_generation_get">;
+ *
+ * Reference with examples: organizationSettings.md
+ */
+/* eslint-disable */
+
+/** `g8.api.organizationSettings.<member>` -> the operationId it calls. */
+export interface OrganizationSettingsMembers {
+  getCampaignGenerationSettings: "get_campaign_generation_settings_org_settings_campaign_generation_get";
+  getComplianceSettings: "get_compliance_settings_org_settings_compliance_get";
+  getContentSources: "get_content_sources_org_content_sources_get";
+  getDocFolderTemplate: "get_doc_folder_template_org_settings_docs_folders__scope__get";
+  getDocSettings: "get_doc_settings_org_settings_docs_get";
+  getDocumentPrioritySettings: "get_document_priority_settings_org_settings_document_priority_get";
+  getLeadQualificationBackfillStatus: "get_lead_qualification_backfill_status_org_settings_lead_qualification_backfill_status_get";
+  getLeadQualificationSettings: "get_lead_qualification_settings_org_settings_lead_qualification_get";
+  getMeetingExtractionSettings: "get_meeting_extraction_settings_org_settings_docs_meetings_get";
+  getOrgSettings: "get_org_settings_org_settings_get";
+  getTaskSettings: "get_task_settings_org_settings_tasks_get";
+  triggerLeadQualificationBackfill: "trigger_lead_qualification_backfill_org_settings_lead_qualification_backfill_post";
+  updateCampaignGenerationSettings: "update_campaign_generation_settings_org_settings_campaign_generation_put";
+  updateComplianceSettings: "update_compliance_settings_org_settings_compliance_put";
+  updateContentSources: "update_content_sources_org_content_sources_put";
+  updateDocFolderTemplate: "update_doc_folder_template_org_settings_docs_folders__scope__put";
+  updateDocSettings: "update_doc_settings_org_settings_docs__scope__put";
+  updateDocumentPrioritySettings: "update_document_priority_settings_org_settings_document_priority_put";
+  updateLeadQualificationSettings: "update_lead_qualification_settings_org_settings_lead_qualification_put";
+  updateMeetingExtractionSettings: "update_meeting_extraction_settings_org_settings_docs_meetings_put";
+  updateOrgSettings: "update_org_settings_org_settings_put";
+  updateTaskSettings: "update_task_settings_org_settings_tasks_put";
+}
+
+/** Input and output of every `g8.api.organizationSettings` operation, keyed by operationId. */
+export interface OrganizationSettingsOperations {
+  /**
+   * GET /org/settings/campaign-generation
+   * Get Campaign Generation Settings
+   * tier: read · scope: account:read
+   */
+  get_campaign_generation_settings_org_settings_campaign_generation_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/settings/compliance
+   * Get Compliance Settings
+   * tier: read · scope: account:read
+   */
+  get_compliance_settings_org_settings_compliance_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/content-sources
+   * Get Content Sources
+   * tier: read · scope: account:read
+   */
+  get_content_sources_org_content_sources_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/settings/docs/folders/{scope}
+   * Get Doc Folder Template
+   * tier: read · scope: account:read
+   */
+  get_doc_folder_template_org_settings_docs_folders__scope__get: {
+    input: {
+    path: {
+      /** Which record type's folder tree. `accounts` is the canonical company template; `companies` is accepted as its synonym. */
+      scope: "companies" | "accounts" | "prospects" | "contacts" | "campaigns" | "global";
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/settings/docs
+   * Get Doc Settings
+   * tier: read · scope: account:read
+   */
+  get_doc_settings_org_settings_docs_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/settings/document-priority
+   * Get Document Priority Settings
+   * tier: read · scope: account:read
+   */
+  get_document_priority_settings_org_settings_document_priority_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/settings/lead-qualification/backfill-status
+   * Get Lead Qualification Backfill Status
+   * tier: read · scope: account:read
+   */
+  get_lead_qualification_backfill_status_org_settings_lead_qualification_backfill_status_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/settings/lead-qualification
+   * Get Lead Qualification Settings
+   * tier: read · scope: account:read
+   */
+  get_lead_qualification_settings_org_settings_lead_qualification_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/settings/docs/meetings
+   * Get Meeting Extraction Settings
+   * tier: read · scope: account:read
+   */
+  get_meeting_extraction_settings_org_settings_docs_meetings_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/settings
+   * Get Org Settings
+   * tier: read · scope: account:read
+   */
+  get_org_settings_org_settings_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * GET /org/settings/tasks
+   * Get Task Settings
+   * tier: read · scope: account:read
+   */
+  get_task_settings_org_settings_tasks_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * POST /org/settings/lead-qualification/backfill
+   * Trigger Lead Qualification Backfill
+   * tier: write · scope: account:write
+   */
+  trigger_lead_qualification_backfill_org_settings_lead_qualification_backfill_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/settings/campaign-generation
+   * Update Campaign Generation Settings
+   * tier: write · scope: account:write
+   */
+  update_campaign_generation_settings_org_settings_campaign_generation_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CampaignGenerationUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/settings/compliance
+   * Update Compliance Settings
+   * tier: write · scope: account:write
+   */
+  update_compliance_settings_org_settings_compliance_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ComplianceSettingsUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/content-sources
+   * Update Content Sources
+   * tier: write · scope: account:write
+   */
+  update_content_sources_org_content_sources_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ContentSourcesUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/settings/docs/folders/{scope}
+   * Update Doc Folder Template
+   * tier: write · scope: account:write
+   */
+  update_doc_folder_template_org_settings_docs_folders__scope__put: {
+    input: {
+    path: {
+      /** Which record type's folder tree. `accounts` is the canonical company template; `companies` is accepted as its synonym. */
+      scope: "companies" | "accounts" | "prospects" | "contacts" | "campaigns" | "global";
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: FolderTemplateUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/settings/docs/{scope}
+   * Update Doc Settings
+   * tier: write · scope: account:write
+   */
+  update_doc_settings_org_settings_docs__scope__put: {
+    input: {
+    path: {
+      /** Which generation scope these defaults apply to. */
+      scope: "contacts" | "accounts" | "prospects" | "campaigns" | "global";
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DocSettingsUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/settings/document-priority
+   * Update Document Priority Settings
+   * tier: write · scope: account:write
+   */
+  update_document_priority_settings_org_settings_document_priority_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DocumentPriorityUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/settings/lead-qualification
+   * Update Lead Qualification Settings
+   * tier: write · scope: account:write
+   */
+  update_lead_qualification_settings_org_settings_lead_qualification_put: {
+    input: {
+    query?: {
+      /** 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. */
+      backfill?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LeadQualificationSettingsUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/settings/docs/meetings
+   * Update Meeting Extraction Settings
+   * tier: write · scope: account:write
+   */
+  update_meeting_extraction_settings_org_settings_docs_meetings_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MeetingExtractionSettingsUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/settings
+   * Update Org Settings
+   * tier: write · scope: account:write
+   */
+  update_org_settings_org_settings_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: OrgSettingsUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+  /**
+   * PUT /org/settings/tasks
+   * Update Task Settings
+   * tier: write · scope: account:write
+   */
+  update_task_settings_org_settings_tasks_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: TaskSettingsUpdateRequest;
+  };
+    output: ApiResponse_StudioPayload_;
+  };
+}
+
+// 21 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_StudioPayload_ {
+  data: StudioPayload;
+  pagination?: PaginationMeta | null;
+}
+
+/**
+ * Mirrors `UpdateCampaignGenerationSettingsRequest`.
+ *
+ * Both default to TRUE, so an empty body turns both toggles ON. That is the
+ * app's shape and it is a real trap: a partial body is not a partial update.
+ */
+export interface CampaignGenerationUpdateRequest {
+  /** Generate ad images alongside a new campaign. */
+  auto_generate_ad_images?: boolean;
+  /** Generate a landing page alongside a new campaign. */
+  auto_generate_landing_page?: boolean;
+}
+
+/** Mirrors `campaign_builder.routers.org_settings.CertificationStatus`. */
+export interface ComplianceCertification {
+  /** Date the certification was achieved (YYYY-MM-DD). */
+  achieved_date?: string | null;
+  /** Whether the organization holds this certification. */
+  enabled?: boolean;
+  /** Library document id for the uploaded report or certificate. */
+  report_doc_id?: string | null;
+}
+
+/**
+ * Mirrors `UpdateComplianceSettingsRequest`.
+ *
+ * A PARTIAL patch keyed by certification id: only the ids you send are
+ * touched, and an id the product does not support is ignored rather than
+ * rejected - which is the app's behaviour, not a choice made here. Read
+ * `GET /org/settings/compliance` for the supported ids.
+ */
+export interface ComplianceSettingsUpdateRequest {
+  /** Certification id -> status. Unknown ids are ignored by the server. */
+  certifications: Record<string, ComplianceCertification>;
+}
+
+/**
+ * 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.
+ */
+export interface ContentSourceItem {
+  /** Owned types only. The single primary website, mirrored to the org's `primary_website_url`. At most one source may set it. */
+  primary?: boolean;
+  /** `website`/`blog`/`docs`/`developers` are properties you OWN; `linkedin`/`reddit`/`twitter` are external channels. */
+  type: "website" | "blog" | "docs" | "developers" | "linkedin" | "reddit" | "twitter";
+  /** Full URL - the site URL for an owned property, the profile URL for an external channel. */
+  url: string;
+}
+
+/**
+ * Mirrors `UpdateContentSourcesRequest`.
+ *
+ * REPLACES the whole list. There is no partial update: send every source you
+ * want to keep, or it is removed.
+ */
+export interface ContentSourcesUpdateRequest {
+  /** The complete set of content sources. Anything omitted is deleted. */
+  sources: Array<ContentSourceItem>;
+}
+
+/**
+ * Mirrors `UpdateDocSettingsRequest`.
+ *
+ * `mandatory_doc_ids` omitted means LEAVE THE CURRENT MANDATORY SET ALONE.
+ * Sending `[]` CLEARS it. The two are different instructions and only one is
+ * destructive.
+ */
+export interface DocSettingsUpdateRequest {
+  /** Document type ids generated by default for this scope. */
+  default_doc_ids: Array<string>;
+  /** Document type ids a user cannot uncheck. Omit to leave the current set unchanged; send an empty list to clear it. */
+  mandatory_doc_ids?: Array<string> | null;
+}
+
+/**
+ * Mirrors `UpdateDocumentPrioritySettingsRequest`.
+ *
+ * Both fields have defaults, so a partial body silently RESETS the field you
+ * left out to the product default rather than leaving it alone. Send both.
+ */
+export interface DocumentPriorityUpdateRequest {
+  /** Priority assigned to AI-generated documents. */
+  default_generated_priority?: "high" | "medium" | "low";
+  /** Priority assigned to user-uploaded documents. */
+  default_upload_priority?: "high" | "medium" | "low";
+}
+
+/** Mirrors `campaign_builder.schemas.settings.ClientFolderTemplateItem`. */
+export interface FolderTemplateItem {
+  /** Optional helper text. */
+  description?: string | null;
+  /** Stable key used for mapping (e.g. `transcripts`). */
+  key: string;
+  /** When true the folder cannot be renamed or removed. */
+  locked?: boolean;
+  /** Display name in the folder tree. */
+  name: string;
+}
+
+/** Mirrors `UpdateClientFolderTemplateRequest`. REPLACES the template. */
+export interface FolderTemplateUpdateRequest {
+  /** The complete folder template. Anything omitted is removed. */
+  folders?: Array<FolderTemplateItem>;
+}
+
+/** Mirrors `UpdateLeadQualificationSettingsRequest`. Partial update. */
+export interface LeadQualificationSettingsUpdateRequest {
+  /** Extra URL patterns that count as a high-intent page view. */
+  custom_page_patterns?: Array<string> | null;
+  /** Signal group -> event name -> enabled. */
+  event_groups?: Record<string, Record<string, boolean>> | null;
+  /** Signal group -> URL patterns. */
+  page_patterns?: Record<string, Array<string>> | null;
+  /** Master switch for turning visitor events into qualified leads. */
+  qualification_enabled?: boolean | null;
+}
+
+/** Org-defined field to extract from meeting transcripts. */
+export interface MeetingExtractionCustomField {
+  /** Output type expected from the extractor */
+  field_type?: "text" | "boolean" | "list";
+  /** Instruction describing what to extract */
+  instruction?: string;
+  /** Stable key for the extracted field */
+  key?: string;
+  /** Display label shown in admin and downstream UI */
+  label: string;
+}
+
+/** Vocabulary term or acronym with optional meaning/explanation. */
+export interface MeetingExtractionGlossaryTerm {
+  /** Optional explanation of what the term means or why it matters */
+  explanation?: string;
+  /** A term, acronym, or phrase the extractor should recognize */
+  term: string;
+}
+
+/** Transcript extraction settings for one meeting scope. */
+export interface MeetingExtractionScopeSettings {
+  /** Org-defined custom fields to extract */
+  custom_fields?: Array<MeetingExtractionCustomField>;
+  /** Vocabulary terms, acronyms, and product names to recognize */
+  custom_terms?: Array<MeetingExtractionGlossaryTerm>;
+  /** Structured outputs that should always be extracted */
+  extract_fields?: Array<string>;
+  /** Signals and topics the extractor should prioritize */
+  listen_for?: Array<string>;
+}
+
+/**
+ * Mirrors `campaign_builder.schemas.settings.UpdateMeetingExtractionSettingsRequest`.
+ *
+ * Every field defaults to an EMPTY block, and the app treats the request as
+ * the new state for each scope it receives - so omitting a scope is not the
+ * same as sending it empty. Send the whole object you read back.
+ *
+ * The nested blocks are the app's own models; see the module docstring.
+ */
+export interface MeetingExtractionSettingsUpdateRequest {
+  /** Meetings with an existing customer. */
+  customer?: MeetingExtractionScopeSettings;
+  /** Internal meetings - every attendee is on an internal domain. */
+  internal?: MeetingExtractionScopeSettings;
+  /** Company identity the extractor grounds on: canonical name, internal domains, aliases. */
+  meeting_grounding?: MeetingGroundingSettings;
+  /** Meetings with a prospect. */
+  prospect?: MeetingExtractionScopeSettings;
+  /** Applied to every meeting, on top of the per-scope block. */
+  shared?: MeetingExtractionScopeSettings;
+}
+
+/** Alias, brand, or product name that should resolve to a canonical entity. */
+export interface MeetingGroundingAlias {
+  /** Brand, alias, or product term as it may appear in transcripts */
+  alias: string;
+  /** Canonical company or product name this alias resolves to */
+  canonical_name: string;
+  /** Optional explanation of the relationship or how this alias should be interpreted */
+  explanation?: string;
+}
+
+/** Org-level grounding facts used to interpret meeting participants and transcript wording. */
+export interface MeetingGroundingSettings {
+  /** Known brand, alias, or product names that resolve to canonical entities */
+  brand_aliases?: Array<MeetingGroundingAlias>;
+  /** Canonical internal company name that should be used in summaries and task interpretation */
+  canonical_company_name?: string;
+  /** Email domains that identify internal attendees */
+  internal_domains?: Array<string>;
+  /** Rules that explain how participant and domain evidence should be interpreted */
+  participant_rules?: Array<string>;
+}
+
+/**
+ * Mirrors `campaign_builder.routers.org_settings.UpdateOrgSettingsRequest`.
+ *
+ * `email_domain` is the auto-join domain: anyone signing up with an address
+ * at that domain joins THIS organisation without an invite. It is the widest
+ * blast radius on this surface, which is why the route is admin-gated and the
+ * handler re-checks the caller's org role on top.
+ */
+export interface OrgSettingsUpdateRequest {
+  /** 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. */
+  email_domain?: string | null;
+  /** Organization display name. PropelAuth owns it; a rejected rename aborts the whole update. */
+  org_name?: string | null;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}
+
+/**
+ * An open envelope for one settings block, document or brand artefact.
+ *
+ * OPEN on purpose. These surfaces are configuration and generated content,
+ * and both grow: a new toggle on a settings block or a new field on a
+ * generated document must reach a caller on the day it ships, not on the day
+ * somebody remembers to widen a mirror. A closed response model here would
+ * silently DROP the new key, which reads to the caller as "the product does
+ * not have that setting".
+ *
+ * The request side is the opposite and is mirrored exactly - see the module
+ * docstring for why the asymmetry is deliberate.
+ */
+export type StudioPayload = Record<string, unknown>;
+
+/**
+ * Mirrors `UpdateTaskSettingsRequest`. Partial update, but not an EMPTY one.
+ *
+ * The app refuses a patch that sets nothing (422) rather than no-opping, and
+ * that refusal is worth keeping: an empty body is always a caller bug, and a
+ * silent 200 hides it.
+ *
+ * `default_visibility` and `parent_completion_mode` are Literals here where
+ * the app takes `str` and rejects an unknown value from inside the handler.
+ * Same outcome, one layer earlier, and the legal values are in the schema.
+ */
+export interface TaskSettingsUpdateRequest {
+  /** Default visibility for newly created tasks. */
+  default_visibility?: ("public" | "team" | "private") | null;
+  /** When false, hide @ autocomplete in note and reply composers. */
+  mentions_enabled?: boolean | null;
+  /** When false, hide the global Quick Note shortcut and its command-palette action. */
+  notes_anywhere_enabled?: boolean | null;
+  /** When false, suppress mention-triggered bell notifications. */
+  notify_on_mention?: boolean | null;
+  /** How a parent task completes relative to its subtasks. */
+  parent_completion_mode?: ("manual" | "auto_complete" | "require_subtasks_done") | null;
+  /** When false, hide the floating 'Add note' bubble on text selection. */
+  selection_toolbar_enabled?: boolean | null;
+}