@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/documents.d.ts

@@ -0,0 +1,895 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.documents` (Documents): 35 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"approve_questionnaire_answer_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__approve_post">;
+ *
+ * Reference with examples: documents.md
+ */
+/* eslint-disable */
+
+/** `g8.api.documents.<member>` -> the operationId it calls. */
+export interface DocumentsMembers {
+  approveQuestionnaireAnswer: "approve_questionnaire_answer_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__approve_post";
+  createAccountCorrespondence: "create_account_correspondence_accounts__account_id__correspondence_post";
+  createLibraryDocument: "create_library_document_library_documents_post";
+  createLibraryFolder: "create_library_folder_library_folders_post";
+  deleteAccountCorrespondence: "delete_account_correspondence_accounts__account_id__correspondence__correspondence_id__delete";
+  deleteLibraryDocument: "delete_library_document_library_documents__document_id__delete";
+  deleteLibraryFolder: "delete_library_folder_library_folders__folder_id__delete";
+  deleteSecurityQuestionnaire: "delete_security_questionnaire_accounts__account_id__security_questionnaires__questionnaire_id__delete";
+  downloadLibraryDocument: "download_library_document_library_documents__document_id__download_get";
+  downloadSecurityQuestionnaire: "download_security_questionnaire_accounts__account_id__security_questionnaires__questionnaire_id__download_get";
+  escalateQuestionnaireQuestion: "escalate_questionnaire_question_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__escalate_post";
+  flagQuestionnaireAnswer: "flag_questionnaire_answer_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__mark_wrong_post";
+  getLibraryDocument: "get_library_document_library_documents__document_id__get";
+  getLibraryTree: "get_library_tree_library_tree_get";
+  getSecurityQuestionnaire: "get_security_questionnaire_accounts__account_id__security_questionnaires__questionnaire_id__get";
+  getSecurityQuestionnaireStatus: "get_security_questionnaire_status_accounts__account_id__security_questionnaires__questionnaire_id__status_get";
+  importAccountCorrespondence: "import_account_correspondence_accounts__account_id__correspondence_import_post";
+  listAccountCorrespondence: "list_account_correspondence_accounts__account_id__correspondence_get";
+  listLibraryDocuments: "list_library_documents_library_documents_get";
+  listLibraryFolders: "list_library_folders_library_folders_get";
+  listSecurityQuestionnaires: "list_security_questionnaires_accounts__account_id__security_questionnaires_get";
+  reextractAllLibraryDocuments: "reextract_all_library_documents_library_documents_reextract_all_post";
+  reextractLibraryDocument: "reextract_library_document_library_documents__document_id__reextract_post";
+  refreshLibraryDocument: "refresh_library_document_library_documents__document_id__refresh_post";
+  renameLibraryFolder: "rename_library_folder_library_folders__folder_id__put";
+  restoreLibraryDocument: "restore_library_document_library_documents__document_id__restore_post";
+  saveQuestionnaireAnswerToLibrary: "save_questionnaire_answer_to_library_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__save_to_library_post";
+  skipQuestionnaireQuestion: "skip_questionnaire_question_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__mark_skip_post";
+  updateLibraryDocument: "update_library_document_library_documents__document_id__put";
+  updateQuestionnaireAnswer: "update_questionnaire_answer_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__patch";
+  updateSecurityQuestionnaire: "update_security_questionnaire_accounts__account_id__security_questionnaires__questionnaire_id__patch";
+  uploadAccountCorrespondence: "upload_account_correspondence_accounts__account_id__correspondence_upload_post";
+  uploadLibraryDocument: "upload_library_document_library_documents_upload_post";
+  uploadLibraryDocuments: "upload_library_documents_library_documents_upload_batch_post";
+  uploadSecurityQuestionnaire: "upload_security_questionnaire_accounts__account_id__security_questionnaires_post";
+}
+
+/** Input and output of every `g8.api.documents` operation, keyed by operationId. */
+export interface DocumentsOperations {
+  /**
+   * POST /accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/approve
+   * Approve Questionnaire Answer
+   * tier: write · scope: companies:write
+   */
+  approve_questionnaire_answer_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__approve_post: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+      /** Question id (UUID), from the questionnaire detail read. */
+      question_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /accounts/{account_id}/correspondence
+   * Create Account Correspondence
+   * tier: write · scope: companies:write
+   */
+  create_account_correspondence_accounts__account_id__correspondence_post: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CorrespondenceCreateRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /library/documents
+   * Create Library Document
+   * tier: write · scope: knowledge:write
+   */
+  create_library_document_library_documents_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LibraryDocumentCreateRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /library/folders
+   * Create Library Folder
+   * tier: write · scope: knowledge:write
+   */
+  create_library_folder_library_folders_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LibraryFolderCreateRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * DELETE /accounts/{account_id}/correspondence/{correspondence_id}
+   * Delete Account Correspondence
+   * tier: destructive · scope: companies:delete
+   */
+  delete_account_correspondence_accounts__account_id__correspondence__correspondence_id__delete: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** The record to remove. */
+      correspondence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: void;
+  };
+  /**
+   * DELETE /library/documents/{document_id}
+   * Delete Library Document
+   * tier: destructive · scope: knowledge:delete
+   */
+  delete_library_document_library_documents__document_id__delete: {
+    input: {
+    path: {
+      /** Document id. */
+      document_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * DELETE /library/folders/{folder_id}
+   * Delete Library Folder
+   * tier: destructive · scope: knowledge:delete
+   */
+  delete_library_folder_library_folders__folder_id__delete: {
+    input: {
+    path: {
+      /** Folder id. */
+      folder_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * DELETE /accounts/{account_id}/security-questionnaires/{questionnaire_id}
+   * Delete Security Questionnaire
+   * tier: destructive · scope: companies:delete
+   */
+  delete_security_questionnaire_accounts__account_id__security_questionnaires__questionnaire_id__delete: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: void;
+  };
+  /**
+   * GET /library/documents/{document_id}/download
+   * Download Library Document
+   * tier: read · scope: knowledge:read
+   */
+  download_library_document_library_documents__document_id__download_get: {
+    input: {
+    path: {
+      /** Document id. */
+      document_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: void;
+  };
+  /**
+   * GET /accounts/{account_id}/security-questionnaires/{questionnaire_id}/download
+   * Download Security Questionnaire
+   * tier: read · scope: companies:read
+   */
+  download_security_questionnaire_accounts__account_id__security_questionnaires__questionnaire_id__download_get: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: void;
+  };
+  /**
+   * POST /accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/escalate
+   * Escalate Questionnaire Question
+   * tier: write · scope: companies:write
+   */
+  escalate_questionnaire_question_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__escalate_post: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+      /** Question id (UUID), from the questionnaire detail read. */
+      question_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body?: QuestionNoteRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/mark-wrong
+   * Flag Questionnaire Answer
+   * tier: write · scope: companies:write
+   */
+  flag_questionnaire_answer_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__mark_wrong_post: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+      /** Question id (UUID), from the questionnaire detail read. */
+      question_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body?: QuestionNoteRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * GET /library/documents/{document_id}
+   * Get Library Document
+   * tier: read · scope: knowledge:read
+   */
+  get_library_document_library_documents__document_id__get: {
+    input: {
+    path: {
+      /** Document id. */
+      document_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * GET /library/tree
+   * Get Library Tree
+   * tier: read · scope: knowledge:read
+   */
+  get_library_tree_library_tree_get: {
+    input: {
+    query?: {
+      /** Whose library to read. `campaign` and `account` additionally need the matching id below; without it the app reads the GLOBAL library, which is a different set of documents rather than an error. */
+      context_type?: "global" | "campaign" | "account";
+      /** Campaign id. Only read when `context_type` is `campaign`. */
+      campaign_id?: string | null;
+      /** Account id. Only read when `context_type` is `account`. */
+      account_id?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * GET /accounts/{account_id}/security-questionnaires/{questionnaire_id}
+   * Get Security Questionnaire
+   * tier: read · scope: companies:read
+   */
+  get_security_questionnaire_accounts__account_id__security_questionnaires__questionnaire_id__get: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * GET /accounts/{account_id}/security-questionnaires/{questionnaire_id}/status
+   * Get Security Questionnaire Status
+   * tier: read · scope: companies:read
+   */
+  get_security_questionnaire_status_accounts__account_id__security_questionnaires__questionnaire_id__status_get: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /accounts/{account_id}/correspondence/import
+   * Import Account Correspondence
+   * tier: write · scope: companies:write
+   */
+  import_account_correspondence_accounts__account_id__correspondence_import_post: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CorrespondenceImportRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * GET /accounts/{account_id}/correspondence
+   * List Account Correspondence
+   * tier: read · scope: companies:read
+   */
+  list_account_correspondence_accounts__account_id__correspondence_get: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+    };
+    query?: {
+      /** `email`, `linkedin` or `call_notes`. Omit for all. */
+      channel?: string | null;
+      /** Only what was said to or by this person. */
+      stakeholder_id?: string | null;
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentListPayload_;
+  };
+  /**
+   * GET /library/documents
+   * List Library Documents
+   * tier: read · scope: knowledge:read
+   */
+  list_library_documents_library_documents_get: {
+    input: {
+    query?: {
+      /** Whose library to read. `campaign` and `account` additionally need the matching id below; without it the app reads the GLOBAL library, which is a different set of documents rather than an error. */
+      context_type?: "global" | "campaign" | "account";
+      /** Campaign id. Only read when `context_type` is `campaign`. */
+      campaign_id?: string | null;
+      /** Account id. Only read when `context_type` is `account`. */
+      account_id?: string | null;
+      /** Only this folder. */
+      folder_path?: string | null;
+      /** Include soft-deleted documents, which is how you find something to pass to `/documents/{id}/restore`. */
+      include_deleted?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentListPayload_;
+  };
+  /**
+   * GET /library/folders
+   * List Library Folders
+   * tier: read · scope: knowledge:read
+   */
+  list_library_folders_library_folders_get: {
+    input: {
+    query?: {
+      /** Whose library to read. `campaign` and `account` additionally need the matching id below; without it the app reads the GLOBAL library, which is a different set of documents rather than an error. */
+      context_type?: "global" | "campaign" | "account";
+      /** Campaign id. Only read when `context_type` is `campaign`. */
+      campaign_id?: string | null;
+      /** Account id. Only read when `context_type` is `account`. */
+      account_id?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentListPayload_;
+  };
+  /**
+   * GET /accounts/{account_id}/security-questionnaires
+   * List Security Questionnaires
+   * tier: read · scope: companies:read
+   */
+  list_security_questionnaires_accounts__account_id__security_questionnaires_get: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+    };
+    query?: {
+      /** Only questionnaires in this state: `processing`, `completed`, `needs_review` or `failed`. Omit for all. */
+      status?: string | null;
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentListPayload_;
+  };
+  /**
+   * POST /library/documents/reextract-all
+   * Reextract All Library Documents
+   * tier: write · scope: knowledge:write
+   */
+  reextract_all_library_documents_library_documents_reextract_all_post: {
+    input: {
+    query?: {
+      /** Limit to one folder. Omit to re-extract EVERY PDF and DOCX in the library, which on a large library is a long job. */
+      folder_path?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /library/documents/{document_id}/reextract
+   * Reextract Library Document
+   * tier: write · scope: knowledge:write
+   */
+  reextract_library_document_library_documents__document_id__reextract_post: {
+    input: {
+    path: {
+      /** Document id. */
+      document_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /library/documents/{document_id}/refresh
+   * Refresh Library Document
+   * tier: write · scope: knowledge:write
+   */
+  refresh_library_document_library_documents__document_id__refresh_post: {
+    input: {
+    path: {
+      /** Document id. */
+      document_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * PUT /library/folders/{folder_id}
+   * Rename Library Folder
+   * tier: write · scope: knowledge:write
+   */
+  rename_library_folder_library_folders__folder_id__put: {
+    input: {
+    path: {
+      /** Folder id. */
+      folder_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LibraryFolderRenameRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /library/documents/{document_id}/restore
+   * Restore Library Document
+   * tier: write · scope: knowledge:write
+   */
+  restore_library_document_library_documents__document_id__restore_post: {
+    input: {
+    path: {
+      /** Document id. */
+      document_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/save-to-library
+   * Save Questionnaire Answer To Library
+   * tier: write · scope: companies:write
+   */
+  save_questionnaire_answer_to_library_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__save_to_library_post: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+      /** Question id (UUID), from the questionnaire detail read. */
+      question_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}/mark-skip
+   * Skip Questionnaire Question
+   * tier: write · scope: companies:write
+   */
+  skip_questionnaire_question_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__mark_skip_post: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+      /** Question id (UUID), from the questionnaire detail read. */
+      question_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body?: QuestionNoteRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * PUT /library/documents/{document_id}
+   * Update Library Document
+   * tier: write · scope: knowledge:write
+   */
+  update_library_document_library_documents__document_id__put: {
+    input: {
+    path: {
+      /** Document id. */
+      document_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LibraryDocumentUpdateRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * PATCH /accounts/{account_id}/security-questionnaires/{questionnaire_id}/questions/{question_id}
+   * Update Questionnaire Answer
+   * tier: write · scope: companies:write
+   */
+  update_questionnaire_answer_accounts__account_id__security_questionnaires__questionnaire_id__questions__question_id__patch: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+      /** Question id (UUID), from the questionnaire detail read. */
+      question_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: QuestionAnswerUpdateRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * PATCH /accounts/{account_id}/security-questionnaires/{questionnaire_id}
+   * Update Security Questionnaire
+   * tier: write · scope: companies:write
+   */
+  update_security_questionnaire_accounts__account_id__security_questionnaires__questionnaire_id__patch: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+      /** Questionnaire id (UUID). */
+      questionnaire_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: QuestionnaireUpdateRequest;
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /accounts/{account_id}/correspondence/upload
+   * Upload Account Correspondence
+   * tier: write · scope: companies:write
+   */
+  upload_account_correspondence_accounts__account_id__correspondence_upload_post: {
+    input: {
+    path: {
+      /** The account. */
+      account_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /library/documents/upload
+   * Upload Library Document
+   * tier: write · scope: knowledge:write
+   */
+  upload_library_document_library_documents_upload_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+  /**
+   * POST /library/documents/upload-batch
+   * Upload Library Documents
+   * tier: write · scope: knowledge:write
+   */
+  upload_library_documents_library_documents_upload_batch_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentListPayload_;
+  };
+  /**
+   * POST /accounts/{account_id}/security-questionnaires
+   * Upload Security Questionnaire
+   * tier: billable · scope: knowledge:run
+   */
+  upload_security_questionnaire_accounts__account_id__security_questionnaires_post: {
+    input: {
+    path: {
+      /** The account the questionnaire came from. */
+      account_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_DocumentPayload_;
+  };
+}
+
+// 14 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_DocumentListPayload_ {
+  data: DocumentListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_DocumentPayload_ {
+  data: DocumentPayload;
+  pagination?: PaginationMeta | null;
+}
+
+/**
+ * One piece of correspondence with an account.
+ *
+ * Mirrors `campaign_builder.routers.correspondence.CorrespondenceCreate`.
+ *
+ * `channel` and `direction` are NOT closed here, because the app does not
+ * close them either: it stores whatever it is given. The values it reads
+ * elsewhere are `email` / `linkedin` / `call_notes` and `inbound` /
+ * `outbound`, and a value outside those is accepted and simply never matched
+ * by a filter.
+ */
+export interface CorrespondenceCreateRequest {
+  /** `email`, `linkedin` or `call_notes`. */
+  channel: string;
+  /** The body. Indexed for retrieval. */
+  content: string;
+  /** When it happened - NOT when it was recorded. Required. */
+  correspondence_date: string;
+  /** `inbound` or `outbound`. */
+  direction: string;
+  /** Your id for this message. The app uses it to skip duplicates on `/correspondence/import`, so send it to make an import re-runnable. */
+  external_id?: string | null;
+  /** The person at the account, when known. */
+  stakeholder_id?: string | null;
+  subject?: string | null;
+}
+
+/**
+ * Bulk import. Mirrors `correspondence.ImportCorrespondenceRequest`.
+ *
+ * Partial success is the normal outcome: the response reports `imported`,
+ * `skipped` and `errors` and the HTTP status stays 200, so read the body
+ * rather than the status.
+ */
+export interface CorrespondenceImportRequest {
+  /** The records. Bounded at 500 by this contract - the app has no ceiling, and an unbounded body on a synchronous per-row insert is a request that times out halfway through having written some rows. */
+  items: Array<CorrespondenceCreateRequest>;
+}
+
+/**
+ * An open envelope for a LIST result, so a bare list keeps its shape.
+ *
+ * `items` is always present and always the list, whichever key the app used
+ * for it - so a caller can page one way rather than learning six key names.
+ */
+export interface DocumentListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * An open envelope for one document, folder or questionnaire.
+ *
+ * Open on purpose: a Library document carries extraction metadata, a
+ * questionnaire carries per-provider processing detail, and a generated deal
+ * document carries `structured_data` and `highlights` whose shape is the
+ * generator's rather than this contract's. Pinning those would silently drop
+ * whatever the app learned to return that this file had not caught up on.
+ */
+export type DocumentPayload = Record<string, unknown>;
+
+/**
+ * Create a TEXT document in the Library.
+ *
+ * Mirrors `campaign_builder.routers.library.CreateDocumentRequest`. For a
+ * file, use `POST /library/documents/upload` instead - this path stores the
+ * `content` string verbatim and runs no extraction.
+ */
+export interface LibraryDocumentCreateRequest {
+  /** REQUIRED when `context_type` is `account`. */
+  account_id?: string | null;
+  /** REQUIRED when `context_type` is `campaign`. */
+  campaign_id?: string | null;
+  /** The document text. Stored verbatim. */
+  content: string;
+  /** Whose library this belongs to. */
+  context_type?: "global" | "campaign" | "account";
+  /** The Copilot session that produced it, when `source` is `copilot`. */
+  copilot_session_id?: string | null;
+  /** How the document is listed. */
+  display_name: string;
+  /** Stored file name. */
+  file_name: string;
+  /** Where it lands, e.g. `Library/Case Studies`. The folder must already exist. */
+  folder_path: string;
+  /** Where the text came from; `manual` or `copilot` are what the app writes. NOT validated by the app, so any value is accepted and stored as given. */
+  source?: string;
+}
+
+/**
+ * Edit a Library document.
+ *
+ * Mirrors `library.UpdateDocumentRequest`. Every field is optional and an
+ * omitted field is LEFT ALONE - this is a partial update despite the PUT
+ * verb, which is the app's own shape.
+ */
+export interface LibraryDocumentUpdateRequest {
+  /** Replaces the whole document body when given. */
+  content?: string | null;
+  display_name?: string | null;
+  /** Moves the document to another folder when given. */
+  folder_path?: string | null;
+  /** Free-form metadata. REPLACES the stored object rather than merging. */
+  meta_data?: Record<string, unknown> | null;
+}
+
+/** Create a Library folder. Mirrors `library.CreateFolderRequest`. */
+export interface LibraryFolderCreateRequest {
+  /** REQUIRED when `context_type` is `account`. */
+  account_id?: string | null;
+  /** REQUIRED when `context_type` is `campaign`. */
+  campaign_id?: string | null;
+  context_type?: "global" | "campaign" | "account";
+  /** Folder name, not a path. */
+  name: string;
+  /** Where it hangs. `Library` is the root. */
+  parent_path?: string;
+}
+
+/** Rename a Library folder. Mirrors `library.RenameFolderRequest`. */
+export interface LibraryFolderRenameRequest {
+  /** The new name. Documents inside keep their ids. */
+  name: string;
+}
+
+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;
+}
+
+/**
+ * Replace one question's answer.
+ *
+ * Mirrors `security_questionnaires.UpdateAnswerRequest`. This is the human
+ * edit: the answer becomes the one the filled workbook carries.
+ */
+export interface QuestionAnswerUpdateRequest {
+  /** The edited answer text. */
+  final_answer: string;
+}
+
+/**
+ * The note attached to an escalate / skip / mark-wrong decision.
+ *
+ * Mirrors `security_questionnaires.EscalateRequest`. One model in the app
+ * serves all three routes, so it is one model here too rather than three
+ * identical ones that could drift apart.
+ */
+export interface QuestionNoteRequest {
+  /** Why. Shown to whoever picks the question up. */
+  notes?: string | null;
+}
+
+/**
+ * Rename a questionnaire.
+ *
+ * Mirrors `security_questionnaires.UpdateQuestionnaireRequest`. Metadata
+ * only - it never touches an answer.
+ */
+export interface QuestionnaireUpdateRequest {
+  /** User-friendly name for the questionnaire. */
+  display_name?: string | null;
+}