@graph8/sdk 0.245.0 → 0.260.0

package/docs/api/notes.d.ts

@@ -0,0 +1,517 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.notes` (Notes): 19 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"create_company_note_companies__company_id__notes_post">;
+ *
+ * Reference with examples: notes.md
+ */
+/* eslint-disable */
+
+/** `g8.api.notes.<member>` -> the operationId it calls. */
+export interface NotesMembers {
+  createCompanyNote: "create_company_note_companies__company_id__notes_post";
+  createDealNote: "create_deal_note_deals__deal_id__notes_post";
+  createNote: "create_note_contacts__contact_id__notes_post";
+  createNoteReply: "create_note_reply_notes__note_id__replies_post";
+  createRecordNote: "create_record_note_notes_post";
+  deleteNote: "delete_note_notes__note_id__delete";
+  deleteNoteReply: "delete_note_reply_notes_replies__reply_id__delete";
+  linkNoteRecord: "link_note_record_notes__note_id__records_post";
+  listCompanyNotes: "list_company_notes_companies__company_id__notes_get";
+  listDealNotes: "list_deal_notes_deals__deal_id__notes_get";
+  listNoteReplies: "list_note_replies_notes__note_id__replies_get";
+  listNotes: "list_notes_contacts__contact_id__notes_get";
+  listNotesForContacts: "list_notes_for_contacts_notes_batch_post";
+  listNotesForRecord: "list_notes_for_record_notes_get";
+  reopenNoteThread: "reopen_note_thread_notes__note_id__resolve_delete";
+  resolveNoteThread: "resolve_note_thread_notes__note_id__resolve_post";
+  unlinkNoteRecord: "unlink_note_record_notes__note_id__records_delete";
+  updateNote: "update_note_notes__note_id__patch";
+  updateNoteReply: "update_note_reply_notes_replies__reply_id__put";
+}
+
+/** Input and output of every `g8.api.notes` operation, keyed by operationId. */
+export interface NotesOperations {
+  /**
+   * POST /companies/{company_id}/notes
+   * Create Company Note
+   * tier: write · scope: notes:write
+   */
+  create_company_note_companies__company_id__notes_post: {
+    input: {
+    path: {
+      /** Company ID (mashup_companies.id) */
+      company_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NoteCreateRequest;
+  };
+    output: ApiResponse_NoteResponse_;
+  };
+  /**
+   * POST /deals/{deal_id}/notes
+   * Create Deal Note
+   * tier: write · scope: notes:write
+   */
+  create_deal_note_deals__deal_id__notes_post: {
+    input: {
+    path: {
+      /** Deal ID (UUID) */
+      deal_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NoteCreateRequest;
+  };
+    output: ApiResponse_NoteResponse_;
+  };
+  /**
+   * POST /contacts/{contact_id}/notes
+   * Create Note
+   * tier: write · scope: notes:write
+   */
+  create_note_contacts__contact_id__notes_post: {
+    input: {
+    path: {
+      /** Contact ID */
+      contact_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NoteCreateRequest;
+  };
+    output: ApiResponse_NoteResponse_;
+  };
+  /**
+   * POST /notes/{note_id}/replies
+   * Create Note Reply
+   * tier: write · scope: notes:write
+   */
+  create_note_reply_notes__note_id__replies_post: {
+    input: {
+    path: {
+      /** Note id (UUID). */
+      note_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NoteReplyCreateRequest;
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * POST /notes
+   * Create Record Note
+   * tier: write · scope: notes:write
+   */
+  create_record_note_notes_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: RecordNoteCreateRequest;
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * DELETE /notes/{note_id}
+   * Delete Note
+   * tier: destructive · scope: notes:delete
+   */
+  delete_note_notes__note_id__delete: {
+    input: {
+    path: {
+      /** Note ID */
+      note_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * DELETE /notes/replies/{reply_id}
+   * Delete Note Reply
+   * tier: destructive · scope: notes:delete
+   */
+  delete_note_reply_notes_replies__reply_id__delete: {
+    input: {
+    path: {
+      /** Reply id (UUID). */
+      reply_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * POST /notes/{note_id}/records
+   * Link Note Record
+   * tier: write · scope: notes:write
+   */
+  link_note_record_notes__note_id__records_post: {
+    input: {
+    path: {
+      /** Note id (UUID). */
+      note_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NoteRecordLinkRequest;
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /companies/{company_id}/notes
+   * List Company Notes
+   * tier: read · scope: notes:read
+   */
+  list_company_notes_companies__company_id__notes_get: {
+    input: {
+    path: {
+      /** Company ID (mashup_companies.id) */
+      company_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_NoteResponse__;
+  };
+  /**
+   * GET /deals/{deal_id}/notes
+   * List Deal Notes
+   * tier: read · scope: notes:read
+   */
+  list_deal_notes_deals__deal_id__notes_get: {
+    input: {
+    path: {
+      /** Deal ID (UUID) */
+      deal_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_NoteResponse__;
+  };
+  /**
+   * GET /notes/{note_id}/replies
+   * List Note Replies
+   * tier: read · scope: notes:read
+   */
+  list_note_replies_notes__note_id__replies_get: {
+    input: {
+    path: {
+      /** Note id (UUID). */
+      note_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmCollectionPayload_;
+  };
+  /**
+   * GET /contacts/{contact_id}/notes
+   * List Notes
+   * tier: read · scope: notes:read
+   */
+  list_notes_contacts__contact_id__notes_get: {
+    input: {
+    path: {
+      /** Contact ID */
+      contact_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_NoteResponse__;
+  };
+  /**
+   * POST /notes/batch
+   * List Notes For Contacts
+   * tier: read · scope: notes:read
+   */
+  list_notes_for_contacts_notes_batch_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NoteBatchRequest;
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /notes
+   * List Notes For Record
+   * tier: read · scope: notes:read
+   */
+  list_notes_for_record_notes_get: {
+    input: {
+    query: {
+      /** Record type, e.g. `contact`, `company`, `deal`. */
+      entity_type: string;
+      /** Id of that record. */
+      entity_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmCollectionPayload_;
+  };
+  /**
+   * DELETE /notes/{note_id}/resolve
+   * Reopen Note Thread
+   * tier: destructive · scope: notes:delete
+   */
+  reopen_note_thread_notes__note_id__resolve_delete: {
+    input: {
+    path: {
+      /** Note id (UUID). */
+      note_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * POST /notes/{note_id}/resolve
+   * Resolve Note Thread
+   * tier: write · scope: notes:write
+   */
+  resolve_note_thread_notes__note_id__resolve_post: {
+    input: {
+    path: {
+      /** Note id (UUID). */
+      note_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body?: ResolveThreadRequest;
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * DELETE /notes/{note_id}/records
+   * Unlink Note Record
+   * tier: destructive · scope: notes:delete
+   */
+  unlink_note_record_notes__note_id__records_delete: {
+    input: {
+    path: {
+      /** Note id (UUID). */
+      note_id: string;
+    };
+    query: {
+      /** Record type to unlink. */
+      entity_type: string;
+      /** Record id to unlink. */
+      entity_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * PATCH /notes/{note_id}
+   * Update Note
+   * tier: write · scope: notes:write
+   */
+  update_note_notes__note_id__patch: {
+    input: {
+    path: {
+      /** Note ID */
+      note_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NoteUpdateRequest;
+  };
+    output: ApiResponse_NoteResponse_;
+  };
+  /**
+   * PUT /notes/replies/{reply_id}
+   * Update Note Reply
+   * tier: write · scope: notes:write
+   */
+  update_note_reply_notes_replies__reply_id__put: {
+    input: {
+    path: {
+      /** Reply id (UUID). */
+      reply_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NoteReplyUpdateRequest;
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+}
+
+// 18 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_CrmCollectionPayload_ {
+  data: CrmCollectionPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_CrmRecordPayload_ {
+  data: CrmRecordPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_NoteResponse_ {
+  data: NoteResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_dict_ {
+  data: Record<string, unknown>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_NoteResponse__ {
+  data: Array<NoteResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+/** An open envelope for a LIST result, so a bare list keeps its shape. */
+export interface CrmCollectionPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * An open envelope for one record, one dashboard or one job receipt.
+ *
+ * Open because most of these reads are COMPUTED shapes - an engagement
+ * summary, a next-best-step, an intelligence status - that grow with the
+ * product, and dropping a field from an advisory read makes it say "nothing
+ * to report" rather than "we did not tell you".
+ */
+export type CrmRecordPayload = Record<string, unknown>;
+
+/** Mirrors `BatchNotesRequest`. */
+export interface NoteBatchRequest {
+  /** Contacts whose notes to read in one call. */
+  contact_ids: Array<string>;
+}
+
+export interface NoteCreateRequest {
+  /** Note content (plain text or markdown) */
+  content: string;
+}
+
+/** Mirrors `contacts.usecases.notes.cmd.MentionedUser`. */
+export interface NoteMentionedUser {
+  /** Email address. */
+  email?: string | null;
+  /** User id. */
+  id: string;
+  /** Display name. */
+  name: string;
+}
+
+/** Mirrors `NoteRecordRequest`. */
+export interface NoteRecordLinkRequest {
+  /** Record id. */
+  entity_id: string;
+  /** Record type. */
+  entity_type: string;
+}
+
+/** Post a reply on a note's discussion thread. Internal to the org. */
+export interface NoteReplyCreateRequest {
+  /** Avatar to show beside the reply. */
+  author_avatar_url?: string | null;
+  /** Reply text. */
+  body: string;
+  /** Users to notify. */
+  mentioned_user_ids?: Array<string>;
+}
+
+/** Edit a note reply. Author only. */
+export interface NoteReplyUpdateRequest {
+  /** Replacement text. */
+  body: string;
+}
+
+export interface NoteResponse {
+  content: string;
+  created_at?: string | null;
+  created_by?: string | null;
+  created_by_name?: string | null;
+  entity_id: string;
+  entity_type: string;
+  id: string;
+  read_only?: boolean;
+  updated_at?: string | null;
+}
+
+export interface NoteUpdateRequest {
+  /** Updated note content */
+  content: 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;
+}
+
+/** Mirrors `GlobalNoteCreateRequest`. */
+export interface RecordNoteCreateRequest {
+  /** Note body. */
+  content: string;
+  /** Id of that record. */
+  entity_id?: string;
+  /** Record type the note is attached to. */
+  entity_type?: string;
+  /** Teammates mentioned in the note. */
+  mentioned_users?: Array<NoteMentionedUser>;
+  /** Further records to attach, each `{entity_type, entity_id}`. */
+  records?: Array<Record<string, unknown>> | null;
+  /** Where the note was taken. */
+  source_url?: string | null;
+}
+
+/**
+ * Mark a discussion thread resolved.
+ *
+ * Distinct from completing the task: a task can be done with an unresolved
+ * thread and vice versa. Idempotent - re-resolving returns the existing row.
+ */
+export interface ResolveThreadRequest {
+  /** Why it was resolved. */
+  resolution_note?: string | null;
+}