@graph8/sdk 0.251.0 → 0.262.0

package/docs/api/customerSuccess.d.ts

@@ -0,0 +1,491 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.customerSuccess` (Customer success): 19 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"archive_transcript_customer_success_transcripts__transcript_id__archive_patch">;
+ *
+ * Reference with examples: customerSuccess.md
+ */
+/* eslint-disable */
+
+/** `g8.api.customerSuccess.<member>` -> the operationId it calls. */
+export interface CustomerSuccessMembers {
+  archiveTranscript: "archive_transcript_customer_success_transcripts__transcript_id__archive_patch";
+  connectDriveFolder: "connect_drive_folder_customer_success_companies__company_id__drive_folder_post";
+  disconnectDriveFolder: "disconnect_drive_folder_customer_success_companies__company_id__drive_folder_delete";
+  getBrief: "get_brief_customer_success_companies__company_id__brief_get";
+  getCompanyContext: "get_company_context_customer_success_companies__company_id__context_get";
+  getCompanyInbox: "get_company_inbox_customer_success_companies__company_id__inbox_get";
+  getContactInbox: "get_contact_inbox_customer_success_contacts__contact_id__inbox_get";
+  getDriveFolder: "get_drive_folder_customer_success_companies__company_id__drive_folder_get";
+  getDriveFolderFiles: "get_drive_folder_files_customer_success_companies__company_id__drive_folder_files_get";
+  getTranscript: "get_transcript_customer_success_companies__company_id__transcripts__transcript_id__get";
+  linkTranscriptToAccount: "link_transcript_to_account_customer_success_transcripts__transcript_id__link_patch";
+  linkTranscriptToMeeting: "link_transcript_to_meeting_customer_success_meetings__meeting_id__link_transcript_patch";
+  listCompanyMeetings: "list_company_meetings_customer_success_companies__company_id__meetings_get";
+  listCompanyTranscripts: "list_company_transcripts_customer_success_companies__company_id__transcripts_get";
+  listUnlinkedTranscripts: "list_unlinked_transcripts_customer_success_companies__company_id__unlinked_transcripts_get";
+  synthesizeBrief: "synthesize_brief_customer_success_companies__company_id__brief_synthesize_post";
+  triggerCompanySync: "trigger_company_sync_customer_success_companies__company_id__sync_post";
+  unarchiveTranscript: "unarchive_transcript_customer_success_transcripts__transcript_id__unarchive_patch";
+  unlinkTranscriptFromMeeting: "unlink_transcript_from_meeting_customer_success_meetings__meeting_id__unlink_transcript_patch";
+}
+
+/** Input and output of every `g8.api.customerSuccess` operation, keyed by operationId. */
+export interface CustomerSuccessOperations {
+  /**
+   * PATCH /customer-success/transcripts/{transcript_id}/archive
+   * Archive Transcript
+   * tier: destructive · scope: companies:delete
+   */
+  archive_transcript_customer_success_transcripts__transcript_id__archive_patch: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /customer-success/companies/{company_id}/drive-folder
+   * Connect Drive Folder
+   * tier: write · scope: companies:write
+   */
+  connect_drive_folder_customer_success_companies__company_id__drive_folder_post: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CustomerSuccessDriveFolderConnectRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * DELETE /customer-success/companies/{company_id}/drive-folder
+   * Disconnect Drive Folder
+   * tier: destructive · scope: companies:delete
+   */
+  disconnect_drive_folder_customer_success_companies__company_id__drive_folder_delete: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    query?: {
+      /** Select the mapping by Google Drive folder id. */
+      folder_id?: string | null;
+      /** Select the mapping by Library folder key. */
+      local_folder_key?: string | null;
+      /** Select the mapping by Library folder id. */
+      library_folder_id?: string | null;
+      /** Select the mapping by Library folder path. */
+      library_folder_path?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /customer-success/companies/{company_id}/brief
+   * Get Brief
+   * tier: read · scope: companies:read
+   */
+  get_brief_customer_success_companies__company_id__brief_get: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /customer-success/companies/{company_id}/context
+   * Get Company Context
+   * tier: read · scope: companies:read
+   */
+  get_company_context_customer_success_companies__company_id__context_get: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /customer-success/companies/{company_id}/inbox
+   * Get Company Inbox
+   * tier: read · scope: companies:read
+   */
+  get_company_inbox_customer_success_companies__company_id__inbox_get: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    query?: {
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * GET /customer-success/contacts/{contact_id}/inbox
+   * Get Contact Inbox
+   * tier: read · scope: companies:read
+   */
+  get_contact_inbox_customer_success_contacts__contact_id__inbox_get: {
+    input: {
+    path: {
+      /** Contact id. */
+      contact_id: string;
+    };
+    query?: {
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * GET /customer-success/companies/{company_id}/drive-folder
+   * Get Drive Folder
+   * tier: read · scope: companies:read
+   */
+  get_drive_folder_customer_success_companies__company_id__drive_folder_get: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /customer-success/companies/{company_id}/drive-folder-files
+   * Get Drive Folder Files
+   * tier: read · scope: companies:read
+   */
+  get_drive_folder_files_customer_success_companies__company_id__drive_folder_files_get: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    query?: {
+      /** Select the mapping by Google Drive folder id. */
+      folder_id?: string | null;
+      /** Select the mapping by Library folder key. */
+      local_folder_key?: string | null;
+      /** Select the mapping by Library folder id. */
+      library_folder_id?: string | null;
+      /** Select the mapping by Library folder path. */
+      library_folder_path?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /customer-success/companies/{company_id}/transcripts/{transcript_id}
+   * Get Transcript
+   * tier: read · scope: companies:read
+   */
+  get_transcript_customer_success_companies__company_id__transcripts__transcript_id__get: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PATCH /customer-success/transcripts/{transcript_id}/link
+   * Link Transcript To Account
+   * tier: write · scope: companies:write
+   */
+  link_transcript_to_account_customer_success_transcripts__transcript_id__link_patch: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CustomerSuccessTranscriptLinkRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PATCH /customer-success/meetings/{meeting_id}/link-transcript
+   * Link Transcript To Meeting
+   * tier: write · scope: companies:write
+   */
+  link_transcript_to_meeting_customer_success_meetings__meeting_id__link_transcript_patch: {
+    input: {
+    path: {
+      /** Calendar meeting id. */
+      meeting_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CustomerSuccessMeetingTranscriptLinkRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /customer-success/companies/{company_id}/meetings
+   * List Company Meetings
+   * tier: read · scope: companies:read
+   */
+  list_company_meetings_customer_success_companies__company_id__meetings_get: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    query?: {
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * GET /customer-success/companies/{company_id}/transcripts
+   * List Company Transcripts
+   * tier: read · scope: companies:read
+   */
+  list_company_transcripts_customer_success_companies__company_id__transcripts_get: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    query?: {
+      /** Only calls this person was on. */
+      participant_email?: string | null;
+      /** Filter by transcript kind. */
+      transcript_type?: string | null;
+      /** Include archived transcripts. */
+      include_archived?: boolean;
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * GET /customer-success/companies/{company_id}/unlinked-transcripts
+   * List Unlinked Transcripts
+   * tier: read · scope: companies:read
+   */
+  list_unlinked_transcripts_customer_success_companies__company_id__unlinked_transcripts_get: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    query?: {
+      /** Only transcripts from this date (YYYY-MM-DD). */
+      date?: string | null;
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * POST /customer-success/companies/{company_id}/brief/synthesize
+   * Synthesize Brief
+   * tier: billable · scope: knowledge:run
+   */
+  synthesize_brief_customer_success_companies__company_id__brief_synthesize_post: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /customer-success/companies/{company_id}/sync
+   * Trigger Company Sync
+   * tier: external · scope: integrations:run
+   */
+  trigger_company_sync_customer_success_companies__company_id__sync_post: {
+    input: {
+    path: {
+      /** Company id. */
+      company_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PATCH /customer-success/transcripts/{transcript_id}/unarchive
+   * Unarchive Transcript
+   * tier: write · scope: companies:write
+   */
+  unarchive_transcript_customer_success_transcripts__transcript_id__unarchive_patch: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PATCH /customer-success/meetings/{meeting_id}/unlink-transcript
+   * Unlink Transcript From Meeting
+   * tier: write · scope: companies:write
+   */
+  unlink_transcript_from_meeting_customer_success_meetings__meeting_id__unlink_transcript_patch: {
+    input: {
+    path: {
+      /** Calendar meeting id. */
+      meeting_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+}
+
+// 8 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_OrgListPayload_ {
+  data: OrgListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OrgPayload_ {
+  data: OrgPayload;
+  pagination?: PaginationMeta | null;
+}
+
+/** Mirrors `csm.DriveFolderConnectRequest`. */
+export interface CustomerSuccessDriveFolderConnectRequest {
+  /** Google Drive folder id. */
+  folder_id: string;
+  /** Folder name, as shown in Drive. */
+  folder_name: string;
+  label?: string | null;
+  /** Library folder id. REPLACES any other mapping to the same Library folder. */
+  library_folder_id?: string | null;
+  library_folder_path?: string | null;
+  /** Which Library folder the files land in. Derived when omitted. */
+  local_folder_key?: string | null;
+  local_folder_name?: string | null;
+}
+
+/** Mirrors `csm.LinkTranscriptToMeetingRequest`. */
+export interface CustomerSuccessMeetingTranscriptLinkRequest {
+  /** The transcript to attach to this meeting. */
+  transcript_id: string;
+}
+
+/** Mirrors `csm.LinkTranscriptRequest`. */
+export interface CustomerSuccessTranscriptLinkRequest {
+  /** The account the transcript belongs to. */
+  account_id: string;
+}
+
+/**
+ * An open envelope for a LIST result, so a bare list keeps its shape.
+ *
+ * Most of these handlers return a bare `list[...]`; a few return a named
+ * envelope (`{"team_members": [...], "total": n}`). Both are reachable as
+ * `items`, and a named envelope KEEPS its own key as well so a caller
+ * already reading the app's shape is not broken by the wrapper.
+ */
+export interface OrgListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * An open envelope for a single role, team, member or account record.
+ *
+ * Open on purpose. The app's own response models on this surface grow with
+ * the product - `RoleResponse` gained `rep_limits` and `manages_role_slugs`,
+ * `TeamResponse` gained channel counts and a campaign count - and a pinned
+ * mirror would SILENTLY DROP whatever it had not caught up on. A dropped
+ * permission in a role read is the worst possible kind of stale: it reads as
+ * "they do not have it".
+ */
+export type OrgPayload = Record<string, unknown>;
+
+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;
+}